azure_bare_metal_instances

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

Overview

Name	azure_bare_metal_instances
Type	Resource
Id	azure.bare_metal_infrastructure.azure_bare_metal_instances

Fields

vw_azure_bare_metal_instances

Name	Datatype	Description
azureBareMetalInstanceName	text	field from the properties object
azure_bare_metal_instance_id	text	field from the properties object
hardware_profile	text	field from the properties object
hw_revision	text	field from the properties object
location	text	The geo-location where the resource lives
network_profile	text	field from the properties object
os_profile	text	field from the properties object
partner_node_id	text	field from the properties object
power_state	text	field from the properties object
provisioning_state	text	field from the properties object
proximity_placement_group	text	field from the properties object
resourceGroupName	text	field from the properties object
storage_profile	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

azure_bare_metal_instances

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Describes the properties of an Azure Bare Metal Instance.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	azureBareMetalInstanceName, resourceGroupName, subscriptionId	Gets an Azure Bare Metal Instance for the specified subscription, resource group, and instance name.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	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	azureBareMetalInstanceName, resourceGroupName, subscriptionId	Creates an Azure Bare Metal Instance for the specified subscription, resource group, and instance name.
delete	DELETE	azureBareMetalInstanceName, resourceGroupName, subscriptionId	Deletes an Azure Bare Metal Instance for the specified subscription, resource group, and instance name.
update	UPDATE	azureBareMetalInstanceName, resourceGroupName, subscriptionId	Patches the Tags field of a Azure Bare Metal Instance for the specified subscription, resource group, and instance name.
restart	EXEC	azureBareMetalInstanceName, resourceGroupName, subscriptionId	The operation to restart an Azure Bare Metal Instance
shutdown	EXEC	azureBareMetalInstanceName, resourceGroupName, subscriptionId	The operation to shutdown an Azure Bare Metal Instance
start	EXEC	azureBareMetalInstanceName, resourceGroupName, subscriptionId	The operation to start an Azure Bare Metal instance

SELECT examples

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

vw_azure_bare_metal_instances

SELECT
azureBareMetalInstanceName,
azure_bare_metal_instance_id,
hardware_profile,
hw_revision,
location,
network_profile,
os_profile,
partner_node_id,
power_state,
provisioning_state,
proximity_placement_group,
resourceGroupName,
storage_profile,
subscriptionId,
tags
FROM azure.bare_metal_infrastructure.vw_azure_bare_metal_instances
WHERE subscriptionId = '{{ subscriptionId }}';

azure_bare_metal_instances

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

INSERT example

Use the following StackQL query and manifest file to create a new azure_bare_metal_instances resource.

All Properties

/*+ create */
INSERT INTO azure.bare_metal_infrastructure.azure_bare_metal_instances (
azureBareMetalInstanceName,
resourceGroupName,
subscriptionId,
properties,
tags,
location
)
SELECT 
'{{ azureBareMetalInstanceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: hardwareProfile
          value:
            - name: hardwareType
              value: string
            - name: azureBareMetalInstanceSize
              value: string
        - name: storageProfile
          value:
            - name: nfsIpAddress
              value: string
            - name: osDisks
              value:
                - - name: name
                    value: string
                  - name: diskSizeGB
                    value: integer
                  - name: lun
                    value: integer
        - name: osProfile
          value:
            - name: computerName
              value: string
            - name: osType
              value: string
            - name: version
              value: string
            - name: sshPublicKey
              value: string
        - name: networkProfile
          value:
            - name: networkInterfaces
              value:
                - - name: ipAddress
                    value: string
            - name: circuitId
              value: string
        - name: azureBareMetalInstanceId
          value: string
        - name: powerState
          value: string
        - name: proximityPlacementGroup
          value: string
        - name: hwRevision
          value: string
        - name: partnerNodeId
          value: string
        - name: provisioningState
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a azure_bare_metal_instances resource.

/*+ update */
UPDATE azure.bare_metal_infrastructure.azure_bare_metal_instances
SET 
tags = '{{ tags }}'
WHERE 
azureBareMetalInstanceName = '{{ azureBareMetalInstanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified azure_bare_metal_instances resource.

/*+ delete */
DELETE FROM azure.bare_metal_infrastructure.azure_bare_metal_instances
WHERE azureBareMetalInstanceName = '{{ azureBareMetalInstanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';