azure_bare_metal_instances

Creates, updates, deletes, gets or lists an azure_bare_metal_instances resource.

Overview

Name	azure_bare_metal_instances
Type	Resource
Id	azure.bare_metal_infrastructure.azure_bare_metal_instances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	AzureBareMetal instance properties
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	AzureBareMetal instance properties
tags	object	Resource tags.

list_by_subscription

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	AzureBareMetal instance properties
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, azureBareMetalInstanceName		Gets an Azure Bare Metal Instance for the specified subscription, resource group, and instance name.
list_by_resource_group	select	subscriptionId, resourceGroupName		Gets a list of Azure Bare Metal Instances in the specified subscription and resource group. The operations returns various properties of each Azure Bare Metal Instance.
list_by_subscription	select	subscriptionId		Returns a list of Azure Bare Metal Instances in the specified subscription. The operations returns various properties of each Azure Bare Metal Instance.
create	insert	subscriptionId, resourceGroupName, azureBareMetalInstanceName		Creates an Azure Bare Metal Instance for the specified subscription, resource group, and instance name.
update	update	subscriptionId, resourceGroupName, azureBareMetalInstanceName		Patches the Tags field of a Azure Bare Metal Instance for the specified subscription, resource group, and instance name.
delete	delete	subscriptionId, resourceGroupName, azureBareMetalInstanceName		Deletes an Azure Bare Metal Instance for the specified subscription, resource group, and instance name.
start	exec	subscriptionId, resourceGroupName, azureBareMetalInstanceName		The operation to start an Azure Bare Metal instance
restart	exec	subscriptionId, resourceGroupName, azureBareMetalInstanceName		The operation to restart an Azure Bare Metal Instance
shutdown	exec	subscriptionId, resourceGroupName, azureBareMetalInstanceName		The operation to shutdown an Azure Bare Metal Instance

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
azureBareMetalInstanceName	string	Name of the Azure Bare Metal Instance, also known as the ResourceName.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets an Azure Bare Metal Instance for the specified subscription, resource group, and instance name.

SELECT
location,
properties,
tags
FROM azure.bare_metal_infrastructure.azure_bare_metal_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND azureBareMetalInstanceName = '{{ azureBareMetalInstanceName }}' -- required
;

list_by_resource_group

Gets a list of Azure Bare Metal Instances in the specified subscription and resource group. The operations returns various properties of each Azure Bare Metal Instance.

SELECT
location,
properties,
tags
FROM azure.bare_metal_infrastructure.azure_bare_metal_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Returns a list of Azure Bare Metal Instances in the specified subscription. The operations returns various properties of each Azure Bare Metal Instance.

SELECT
location,
properties,
tags
FROM azure.bare_metal_infrastructure.azure_bare_metal_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates an Azure Bare Metal Instance for the specified subscription, resource group, and instance name.

INSERT INTO azure.bare_metal_infrastructure.azure_bare_metal_instances (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
azureBareMetalInstanceName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ azureBareMetalInstanceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: azure_bare_metal_instances
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the azure_bare_metal_instances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the azure_bare_metal_instances resource.
    - name: azureBareMetalInstanceName
      value: string
      description: Required parameter for the azure_bare_metal_instances resource.
    - name: properties
      value: object
      description: |
        AzureBareMetal instance properties
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Patches the Tags field of a Azure Bare Metal Instance for the specified subscription, resource group, and instance name.

UPDATE azure.bare_metal_infrastructure.azure_bare_metal_instances
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND azureBareMetalInstanceName = '{{ azureBareMetalInstanceName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes an Azure Bare Metal Instance for the specified subscription, resource group, and instance name.

DELETE FROM azure.bare_metal_infrastructure.azure_bare_metal_instances
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND azureBareMetalInstanceName = '{{ azureBareMetalInstanceName }}' --required
;

Lifecycle Methods

start

The operation to start an Azure Bare Metal instance

EXEC azure.bare_metal_infrastructure.azure_bare_metal_instances.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@azureBareMetalInstanceName='{{ azureBareMetalInstanceName }}' --required
;

restart

The operation to restart an Azure Bare Metal Instance

EXEC azure.bare_metal_infrastructure.azure_bare_metal_instances.restart 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@azureBareMetalInstanceName='{{ azureBareMetalInstanceName }}' --required 
@@json=
'{
"forceState": "{{ forceState }}"
}'
;

shutdown

The operation to shutdown an Azure Bare Metal Instance

EXEC azure.bare_metal_infrastructure.azure_bare_metal_instances.shutdown 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@azureBareMetalInstanceName='{{ azureBareMetalInstanceName }}' --required
;