bare_metal_machines

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

Overview

Name	bare_metal_machines
Type	Resource
Id	azure.nexus.bare_metal_machines

Fields

vw_bare_metal_machines

Name	Datatype	Description
associated_resource_ids	text	field from the properties object
bareMetalMachineName	text	field from the properties object
bmc_connection_string	text	field from the properties object
bmc_credentials	text	field from the properties object
bmc_mac_address	text	field from the properties object
boot_mac_address	text	field from the properties object
cluster_id	text	field from the properties object
cordon_status	text	field from the properties object
detailed_status	text	field from the properties object
detailed_status_message	text	field from the properties object
extended_location	text	field from the properties object
hardware_inventory	text	field from the properties object
hardware_validation_status	text	field from the properties object
hybrid_aks_clusters_associated_ids	text	field from the properties object
kubernetes_node_name	text	field from the properties object
kubernetes_version	text	field from the properties object
location	text	The geo-location where the resource lives
machine_cluster_version	text	field from the properties object
machine_details	text	field from the properties object
machine_name	text	field from the properties object
machine_roles	text	field from the properties object
machine_sku_id	text	field from the properties object
oam_ipv4_address	text	field from the properties object
oam_ipv6_address	text	field from the properties object
os_image	text	field from the properties object
power_state	text	field from the properties object
provisioning_state	text	field from the properties object
rack_id	text	field from the properties object
rack_slot	text	field from the properties object
ready_state	text	field from the properties object
resourceGroupName	text	field from the properties object
runtime_protection_status	text	field from the properties object
secret_rotation_status	text	field from the properties object
serial_number	text	field from the properties object
service_tag	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
virtual_machines_associated_ids	text	field from the properties object

bare_metal_machines

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	bareMetalMachineName, resourceGroupName, subscriptionId	Get properties of the provided bare metal machine.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Get a list of bare metal machines in the provided resource group.
list_by_subscription	SELECT	subscriptionId	Get a list of bare metal machines in the provided subscription.
create_or_update	INSERT	bareMetalMachineName, resourceGroupName, subscriptionId, data__extendedLocation, data__properties	Create a new bare metal machine or update the properties of the existing one.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
delete	DELETE	bareMetalMachineName, resourceGroupName, subscriptionId	Delete the provided bare metal machine.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
update	UPDATE	bareMetalMachineName, resourceGroupName, subscriptionId	Patch properties of the provided bare metal machine, or update tags associated with the bare metal machine. Properties and tag updates can be done independently.
cordon	EXEC	bareMetalMachineName, resourceGroupName, subscriptionId	Cordon the provided bare metal machine's Kubernetes node.
power_off	EXEC	bareMetalMachineName, resourceGroupName, subscriptionId	Power off the provided bare metal machine.
reimage	EXEC	bareMetalMachineName, resourceGroupName, subscriptionId	Reimage the provided bare metal machine.
replace	EXEC	bareMetalMachineName, resourceGroupName, subscriptionId	Replace the provided bare metal machine.
restart	EXEC	bareMetalMachineName, resourceGroupName, subscriptionId	Restart the provided bare metal machine.
run_command	EXEC	bareMetalMachineName, resourceGroupName, subscriptionId, data__limitTimeSeconds, data__script	Run the command or the script on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
run_data_extracts	EXEC	bareMetalMachineName, resourceGroupName, subscriptionId, data__commands, data__limitTimeSeconds	Run one or more data extractions on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
run_read_commands	EXEC	bareMetalMachineName, resourceGroupName, subscriptionId, data__commands, data__limitTimeSeconds	Run one or more read-only commands on the provided bare metal machine. The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.
start	EXEC	bareMetalMachineName, resourceGroupName, subscriptionId	Start the provided bare metal machine.
uncordon	EXEC	bareMetalMachineName, resourceGroupName, subscriptionId	Uncordon the provided bare metal machine's Kubernetes node.

SELECT examples

Get a list of bare metal machines in the provided subscription.

vw_bare_metal_machines

SELECT
associated_resource_ids,
bareMetalMachineName,
bmc_connection_string,
bmc_credentials,
bmc_mac_address,
boot_mac_address,
cluster_id,
cordon_status,
detailed_status,
detailed_status_message,
extended_location,
hardware_inventory,
hardware_validation_status,
hybrid_aks_clusters_associated_ids,
kubernetes_node_name,
kubernetes_version,
location,
machine_cluster_version,
machine_details,
machine_name,
machine_roles,
machine_sku_id,
oam_ipv4_address,
oam_ipv6_address,
os_image,
power_state,
provisioning_state,
rack_id,
rack_slot,
ready_state,
resourceGroupName,
runtime_protection_status,
secret_rotation_status,
serial_number,
service_tag,
subscriptionId,
tags,
virtual_machines_associated_ids
FROM azure.nexus.vw_bare_metal_machines
WHERE subscriptionId = '{{ subscriptionId }}';

bare_metal_machines

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.bare_metal_machines
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.nexus.bare_metal_machines (
bareMetalMachineName,
resourceGroupName,
subscriptionId,
data__extendedLocation,
data__properties,
extendedLocation,
properties,
tags,
location
)
SELECT 
'{{ bareMetalMachineName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__extendedLocation }}',
'{{ data__properties }}',
'{{ extendedLocation }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: string
    - name: properties
      value:
        - name: associatedResourceIds
          value:
            - string
        - name: bmcConnectionString
          value: string
        - name: bmcCredentials
          value:
            - name: password
              value: string
            - name: username
              value: string
        - name: bmcMacAddress
          value: string
        - name: bootMacAddress
          value: string
        - name: clusterId
          value: string
        - name: cordonStatus
          value: string
        - name: detailedStatus
          value: string
        - name: detailedStatusMessage
          value: string
        - name: hardwareInventory
          value:
            - name: additionalHostInformation
              value: string
            - name: interfaces
              value:
                - - name: linkStatus
                    value: string
                  - name: macAddress
                    value: string
                  - name: name
                    value: string
                  - name: networkInterfaceId
                    value: string
            - name: nics
              value:
                - - name: lldpNeighbor
                    value:
                      - name: portDescription
                        value: string
                      - name: portName
                        value: string
                      - name: systemDescription
                        value: string
                      - name: systemName
                        value: string
                  - name: macAddress
                    value: string
                  - name: name
                    value: string
        - name: hardwareValidationStatus
          value:
            - name: lastValidationTime
              value: string
            - name: result
              value: string
        - name: hybridAksClustersAssociatedIds
          value:
            - string
        - name: kubernetesNodeName
          value: string
        - name: kubernetesVersion
          value: string
        - name: machineClusterVersion
          value: string
        - name: machineDetails
          value: string
        - name: machineName
          value: string
        - name: machineRoles
          value:
            - string
        - name: machineSkuId
          value: string
        - name: oamIpv4Address
          value: string
        - name: oamIpv6Address
          value: string
        - name: osImage
          value: string
        - name: powerState
          value: string
        - name: provisioningState
          value: string
        - name: rackId
          value: string
        - name: rackSlot
          value: integer
        - name: readyState
          value: string
        - name: runtimeProtectionStatus
          value:
            - name: definitionsLastUpdated
              value: string
            - name: definitionsVersion
              value: string
            - name: scanCompletedTime
              value: string
            - name: scanScheduledTime
              value: string
            - name: scanStartedTime
              value: string
        - name: secretRotationStatus
          value:
            - - name: expirePeriodDays
                value: integer
              - name: lastRotationTime
                value: string
              - name: rotationPeriodDays
                value: integer
              - name: secretArchiveReference
                value:
                  - name: keyVaultId
                    value: string
                  - name: secretName
                    value: string
                  - name: secretVersion
                    value: string
              - name: secretType
                value: string
        - name: serialNumber
          value: string
        - name: serviceTag
          value: string
        - name: virtualMachinesAssociatedIds
          value:
            - string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a bare_metal_machines resource.

/*+ update */
UPDATE azure.nexus.bare_metal_machines
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
bareMetalMachineName = '{{ bareMetalMachineName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified bare_metal_machines resource.

/*+ delete */
DELETE FROM azure.nexus.bare_metal_machines
WHERE bareMetalMachineName = '{{ bareMetalMachineName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';