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
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
azureBareMetalInstanceId	string	Specifies the AzureBareMetal instance unique ID.
hardwareProfile	object	Specifies the hardware settings for the AzureBareMetal instance.
hwRevision	string	Hardware revision of an AzureBareMetal instance.
location	string	The geo-location where the resource lives. Required.
networkProfile	object	Specifies the network settings for the AzureBareMetal instance.
osProfile	object	Specifies the operating system settings for the AzureBareMetal instance.
partnerNodeId	string	ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance.
powerState	string	Resource power state. Known values are: "starting", "started", "stopping", "stopped", "restarting", and "unknown".
provisioningState	string	State of provisioning of the AzureBareMetalInstance. Known values are: "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating".
proximityPlacementGroup	string	Resource proximity placement group.
storageProfile	object	Specifies the storage settings for the AzureBareMetal instance disks.
systemData	object	The system metadata relating to this resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
azureBareMetalInstanceId	string	Specifies the AzureBareMetal instance unique ID.
hardwareProfile	object	Specifies the hardware settings for the AzureBareMetal instance.
hwRevision	string	Hardware revision of an AzureBareMetal instance.
location	string	The geo-location where the resource lives. Required.
networkProfile	object	Specifies the network settings for the AzureBareMetal instance.
osProfile	object	Specifies the operating system settings for the AzureBareMetal instance.
partnerNodeId	string	ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance.
powerState	string	Resource power state. Known values are: "starting", "started", "stopping", "stopped", "restarting", and "unknown".
provisioningState	string	State of provisioning of the AzureBareMetalInstance. Known values are: "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating".
proximityPlacementGroup	string	Resource proximity placement group.
storageProfile	object	Specifies the storage settings for the AzureBareMetal instance disks.
systemData	object	The system metadata relating to this resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
azureBareMetalInstanceId	string	Specifies the AzureBareMetal instance unique ID.
hardwareProfile	object	Specifies the hardware settings for the AzureBareMetal instance.
hwRevision	string	Hardware revision of an AzureBareMetal instance.
location	string	The geo-location where the resource lives. Required.
networkProfile	object	Specifies the network settings for the AzureBareMetal instance.
osProfile	object	Specifies the operating system settings for the AzureBareMetal instance.
partnerNodeId	string	ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance.
powerState	string	Resource power state. Known values are: "starting", "started", "stopping", "stopped", "restarting", and "unknown".
provisioningState	string	State of provisioning of the AzureBareMetalInstance. Known values are: "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating".
proximityPlacementGroup	string	Resource proximity placement group.
storageProfile	object	Specifies the storage settings for the AzureBareMetal instance disks.
systemData	object	The system metadata relating to this resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, azure_bare_metal_instance_name, subscription_id		Gets an Azure BareMetal instance. Gets an Azure BareMetal instance for the specified subscription, resource group, and instance name.
list_by_resource_group	select	resource_group_name, subscription_id		Gets a list of Azure BareMetal instances in the specified subscription and resource group. Gets a list of AzureBareMetal instances in the specified subscription and resource group. The operations returns various properties of each Azure BareMetal instance.
list_by_subscription	select	subscription_id		Gets a list of Azure BareMetal instances in the specified subscription. Gets a list of AzureBareMetal instances in the specified subscription. The operations returns various properties of each Azure BareMetal instance.
update	update	resource_group_name, azure_bare_metal_instance_name, subscription_id		Patches the Tags field of a Azure BareMetal instance. Patches the Tags field of a Azure BareMetal instance for the specified subscription, resource group, and instance name.

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
azure_bare_metal_instance_name	string	Name of the Azure BareMetal on Azure instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets an Azure BareMetal instance. Gets an Azure BareMetal instance for the specified subscription, resource group, and instance name.

SELECT
id,
name,
azureBareMetalInstanceId,
hardwareProfile,
hwRevision,
location,
networkProfile,
osProfile,
partnerNodeId,
powerState,
provisioningState,
proximityPlacementGroup,
storageProfile,
systemData,
tags,
type
FROM azure.bare_metal_infrastructure.azure_bare_metal_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND azure_bare_metal_instance_name = '{{ azure_bare_metal_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of Azure BareMetal instances in the specified subscription and resource group. Gets a list of AzureBareMetal instances in the specified subscription and resource group. The operations returns various properties of each Azure BareMetal instance.

SELECT
id,
name,
azureBareMetalInstanceId,
hardwareProfile,
hwRevision,
location,
networkProfile,
osProfile,
partnerNodeId,
powerState,
provisioningState,
proximityPlacementGroup,
storageProfile,
systemData,
tags,
type
FROM azure.bare_metal_infrastructure.azure_bare_metal_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets a list of Azure BareMetal instances in the specified subscription. Gets a list of AzureBareMetal instances in the specified subscription. The operations returns various properties of each Azure BareMetal instance.

SELECT
id,
name,
azureBareMetalInstanceId,
hardwareProfile,
hwRevision,
location,
networkProfile,
osProfile,
partnerNodeId,
powerState,
provisioningState,
proximityPlacementGroup,
storageProfile,
systemData,
tags,
type
FROM azure.bare_metal_infrastructure.azure_bare_metal_instances
WHERE subscription_id = '{{ subscription_id }}' -- required
;

UPDATE examples

update

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

UPDATE azure.bare_metal_infrastructure.azure_bare_metal_instances
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND azure_bare_metal_instance_name = '{{ azure_bare_metal_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;