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

The following fields are returned by SELECT queries:

get

The resource has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: BareMetalMachineProperties represents the properties of a bare metal machine.)
tags	object	Resource tags.

list_by_resource_group

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: BareMetalMachineProperties represents the properties of a bare metal machine.)
tags	object	Resource tags.

list_by_subscription

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: BareMetalMachineProperties represents the properties of a bare metal machine.)
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, bareMetalMachineName		Get properties of the provided bare metal machine.
list_by_resource_group	select	subscriptionId, resourceGroupName		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	subscriptionId, resourceGroupName, bareMetalMachineName, 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.
update	update	subscriptionId, resourceGroupName, bareMetalMachineName		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.
delete	delete	subscriptionId, resourceGroupName, bareMetalMachineName		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.
cordon	exec	subscriptionId, resourceGroupName, bareMetalMachineName		Cordon the provided bare metal machine's Kubernetes node.
power_off	exec	subscriptionId, resourceGroupName, bareMetalMachineName		Power off the provided bare metal machine.
reimage	exec	subscriptionId, resourceGroupName, bareMetalMachineName		Reimage the provided bare metal machine.
replace	exec	subscriptionId, resourceGroupName, bareMetalMachineName		Replace the provided bare metal machine.
restart	exec	subscriptionId, resourceGroupName, bareMetalMachineName		Restart the provided bare metal machine.
run_command	exec	subscriptionId, resourceGroupName, bareMetalMachineName, script, limitTimeSeconds		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	subscriptionId, resourceGroupName, bareMetalMachineName, commands, 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	subscriptionId, resourceGroupName, bareMetalMachineName, commands, 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	subscriptionId, resourceGroupName, bareMetalMachineName		Start the provided bare metal machine.
uncordon	exec	subscriptionId, resourceGroupName, bareMetalMachineName		Uncordon the provided bare metal machine's Kubernetes node.

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
bareMetalMachineName	string	The name of the bare metal machine.
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

Get properties of the provided bare metal machine.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.bare_metal_machines
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND bareMetalMachineName = '{{ bareMetalMachineName }}' -- required
;

list_by_resource_group

Get a list of bare metal machines in the provided resource group.

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

list_by_subscription

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

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

INSERT examples

create_or_update

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.

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

Manifest

# Description fields are for documentation purposes
- name: bare_metal_machines
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the bare_metal_machines resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the bare_metal_machines resource.
    - name: bareMetalMachineName
      value: string
      description: Required parameter for the bare_metal_machines resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the cluster associated with the resource.
    - name: properties
      value: object
      description: |
        The list of the resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

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.

UPDATE azure.nexus.bare_metal_machines
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND bareMetalMachineName = '{{ bareMetalMachineName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

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.

DELETE FROM azure.nexus.bare_metal_machines
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND bareMetalMachineName = '{{ bareMetalMachineName }}' --required
;

Lifecycle Methods

cordon

Cordon the provided bare metal machine's Kubernetes node.

EXEC azure.nexus.bare_metal_machines.cordon 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bareMetalMachineName='{{ bareMetalMachineName }}' --required 
@@json=
'{
"evacuate": "{{ evacuate }}"
}'
;

power_off

Power off the provided bare metal machine.

EXEC azure.nexus.bare_metal_machines.power_off 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bareMetalMachineName='{{ bareMetalMachineName }}' --required 
@@json=
'{
"skipShutdown": "{{ skipShutdown }}"
}'
;

reimage

Reimage the provided bare metal machine.

EXEC azure.nexus.bare_metal_machines.reimage 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bareMetalMachineName='{{ bareMetalMachineName }}' --required
;

replace

Replace the provided bare metal machine.

EXEC azure.nexus.bare_metal_machines.replace 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bareMetalMachineName='{{ bareMetalMachineName }}' --required 
@@json=
'{
"bmcCredentials": "{{ bmcCredentials }}", 
"bmcMacAddress": "{{ bmcMacAddress }}", 
"bootMacAddress": "{{ bootMacAddress }}", 
"machineName": "{{ machineName }}", 
"serialNumber": "{{ serialNumber }}"
}'
;

restart

Restart the provided bare metal machine.

EXEC azure.nexus.bare_metal_machines.restart 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bareMetalMachineName='{{ bareMetalMachineName }}' --required
;

run_command

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.

EXEC azure.nexus.bare_metal_machines.run_command 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bareMetalMachineName='{{ bareMetalMachineName }}' --required 
@@json=
'{
"arguments": "{{ arguments }}", 
"limitTimeSeconds": {{ limitTimeSeconds }}, 
"script": "{{ script }}"
}'
;

run_data_extracts

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.

EXEC azure.nexus.bare_metal_machines.run_data_extracts 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bareMetalMachineName='{{ bareMetalMachineName }}' --required 
@@json=
'{
"commands": "{{ commands }}", 
"limitTimeSeconds": {{ limitTimeSeconds }}
}'
;

run_read_commands

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.

EXEC azure.nexus.bare_metal_machines.run_read_commands 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bareMetalMachineName='{{ bareMetalMachineName }}' --required 
@@json=
'{
"commands": "{{ commands }}", 
"limitTimeSeconds": {{ limitTimeSeconds }}
}'
;

start

Start the provided bare metal machine.

EXEC azure.nexus.bare_metal_machines.start 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bareMetalMachineName='{{ bareMetalMachineName }}' --required
;

uncordon

Uncordon the provided bare metal machine's Kubernetes node.

EXEC azure.nexus.bare_metal_machines.uncordon 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@bareMetalMachineName='{{ bareMetalMachineName }}' --required
;