edge_machines

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

Overview

Name	edge_machines
Type	Resource
Id	azure_stack.azure_stack_hci.edge_machines

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.
arcGatewayResourceId	string	Link to Arc Gateway ARM resource Id.
arcMachineResourceGroupId	string	Optional property to create arc machine in custom resource group.
arcMachineResourceId	string	Arc machine instance resource id.
claimedBy	string	Tracks the ID of the consuming resource, setting the machine as in-use.
cloudId	string	Unique, immutable resource id.
connectivityStatus	string	machine connectivity status. Known values are: "NotSpecified", "Disconnected", and "Connected". (NotSpecified, Disconnected, Connected)
devicePoolResourceId	string	A machine can only be assigned to single device pool.
edgeMachineKind	string	Edge Machine type. Known values are: "Standard" and "Dedicated". (Standard, Dedicated)
identity	object	The managed service identities assigned to this resource.
lastSyncTimestamp	string (date-time)	Last time data updated to service.
location	string	The geo-location where the resource lives. Required.
machineState	string	OS configuration status details. Known values are: "Created", "Registering", "Unpurposed", "Transitioning", "Purposed", "Updating", "Resetting", "Failed", and "Preparing". (Created, Registering, Unpurposed, Transitioning, Purposed, Updating, Resetting, Failed, Preparing)
operationDetails	array	operation status details for edge machine.
ownershipVoucherDetails	object	Ownership voucher details for provisioned machine.
provisioningDetails	object	Details for device provisioning.
provisioningState	string	The provisioning state of a resource. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
reportedProperties	object	Reported properties for edge machine.
siteDetails	object	Service fetches common configuration from site.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
arcGatewayResourceId	string	Link to Arc Gateway ARM resource Id.
arcMachineResourceGroupId	string	Optional property to create arc machine in custom resource group.
arcMachineResourceId	string	Arc machine instance resource id.
claimedBy	string	Tracks the ID of the consuming resource, setting the machine as in-use.
cloudId	string	Unique, immutable resource id.
connectivityStatus	string	machine connectivity status. Known values are: "NotSpecified", "Disconnected", and "Connected". (NotSpecified, Disconnected, Connected)
devicePoolResourceId	string	A machine can only be assigned to single device pool.
edgeMachineKind	string	Edge Machine type. Known values are: "Standard" and "Dedicated". (Standard, Dedicated)
identity	object	The managed service identities assigned to this resource.
lastSyncTimestamp	string (date-time)	Last time data updated to service.
location	string	The geo-location where the resource lives. Required.
machineState	string	OS configuration status details. Known values are: "Created", "Registering", "Unpurposed", "Transitioning", "Purposed", "Updating", "Resetting", "Failed", and "Preparing". (Created, Registering, Unpurposed, Transitioning, Purposed, Updating, Resetting, Failed, Preparing)
operationDetails	array	operation status details for edge machine.
ownershipVoucherDetails	object	Ownership voucher details for provisioned machine.
provisioningDetails	object	Details for device provisioning.
provisioningState	string	The provisioning state of a resource. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
reportedProperties	object	Reported properties for edge machine.
siteDetails	object	Service fetches common configuration from site.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
arcGatewayResourceId	string	Link to Arc Gateway ARM resource Id.
arcMachineResourceGroupId	string	Optional property to create arc machine in custom resource group.
arcMachineResourceId	string	Arc machine instance resource id.
claimedBy	string	Tracks the ID of the consuming resource, setting the machine as in-use.
cloudId	string	Unique, immutable resource id.
connectivityStatus	string	machine connectivity status. Known values are: "NotSpecified", "Disconnected", and "Connected". (NotSpecified, Disconnected, Connected)
devicePoolResourceId	string	A machine can only be assigned to single device pool.
edgeMachineKind	string	Edge Machine type. Known values are: "Standard" and "Dedicated". (Standard, Dedicated)
identity	object	The managed service identities assigned to this resource.
lastSyncTimestamp	string (date-time)	Last time data updated to service.
location	string	The geo-location where the resource lives. Required.
machineState	string	OS configuration status details. Known values are: "Created", "Registering", "Unpurposed", "Transitioning", "Purposed", "Updating", "Resetting", "Failed", and "Preparing". (Created, Registering, Unpurposed, Transitioning, Purposed, Updating, Resetting, Failed, Preparing)
operationDetails	array	operation status details for edge machine.
ownershipVoucherDetails	object	Ownership voucher details for provisioned machine.
provisioningDetails	object	Details for device provisioning.
provisioningState	string	The provisioning state of a resource. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
reportedProperties	object	Reported properties for edge machine.
siteDetails	object	Service fetches common configuration from site.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, edge_machine_name, subscription_id		Get an edge machine.
list_by_resource_group	select	resource_group_name, subscription_id		List all edge machines in a resource group.
list_by_subscription	select	subscription_id		List all edge machines in a subscription.
create_or_update	insert	resource_group_name, edge_machine_name, subscription_id, location		Create or update an edge machine.
update	update	resource_group_name, edge_machine_name, subscription_id		Update an edge machine.
create_or_update	replace	resource_group_name, edge_machine_name, subscription_id, location		Create or update an edge machine.
delete	delete	resource_group_name, edge_machine_name, subscription_id		Delete an edge machine.

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
edge_machine_name	string	Name of Device. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get an edge machine.

SELECT
id,
name,
arcGatewayResourceId,
arcMachineResourceGroupId,
arcMachineResourceId,
claimedBy,
cloudId,
connectivityStatus,
devicePoolResourceId,
edgeMachineKind,
identity,
lastSyncTimestamp,
location,
machineState,
operationDetails,
ownershipVoucherDetails,
provisioningDetails,
provisioningState,
reportedProperties,
siteDetails,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci.edge_machines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND edge_machine_name = '{{ edge_machine_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all edge machines in a resource group.

SELECT
id,
name,
arcGatewayResourceId,
arcMachineResourceGroupId,
arcMachineResourceId,
claimedBy,
cloudId,
connectivityStatus,
devicePoolResourceId,
edgeMachineKind,
identity,
lastSyncTimestamp,
location,
machineState,
operationDetails,
ownershipVoucherDetails,
provisioningDetails,
provisioningState,
reportedProperties,
siteDetails,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci.edge_machines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List all edge machines in a subscription.

SELECT
id,
name,
arcGatewayResourceId,
arcMachineResourceGroupId,
arcMachineResourceId,
claimedBy,
cloudId,
connectivityStatus,
devicePoolResourceId,
edgeMachineKind,
identity,
lastSyncTimestamp,
location,
machineState,
operationDetails,
ownershipVoucherDetails,
provisioningDetails,
provisioningState,
reportedProperties,
siteDetails,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci.edge_machines
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update an edge machine.

INSERT INTO azure_stack.azure_stack_hci.edge_machines (
tags,
location,
properties,
identity,
resource_group_name,
edge_machine_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ edge_machine_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: edge_machines
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the edge_machines resource.
  - name: edge_machine_name
    value: "{{ edge_machine_name }}"
    description: Required parameter for the edge_machines resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the edge_machines resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      edgeMachineKind: "{{ edgeMachineKind }}"
      provisioningState: "{{ provisioningState }}"
      cloudId: "{{ cloudId }}"
      arcMachineResourceGroupId: "{{ arcMachineResourceGroupId }}"
      arcMachineResourceId: "{{ arcMachineResourceId }}"
      arcGatewayResourceId: "{{ arcGatewayResourceId }}"
      siteDetails:
        siteResourceId: "{{ siteResourceId }}"
        deviceConfiguration:
          network:
            networkAdapters:
              - ipAssignmentType: "{{ ipAssignmentType }}"
                ipAddress: "{{ ipAddress }}"
                adapterName: "{{ adapterName }}"
                macAddress: "{{ macAddress }}"
                ipAddressRange:
                  startIp: "{{ startIp }}"
                  endIp: "{{ endIp }}"
                gateway: "{{ gateway }}"
                subnetMask: "{{ subnetMask }}"
                dnsAddressArray: "{{ dnsAddressArray }}"
                vlanId: "{{ vlanId }}"
          hostName: "{{ hostName }}"
          webProxy:
            connectionUri: "{{ connectionUri }}"
            port: "{{ port }}"
            bypassList:
              - "{{ bypassList }}"
          time:
            primaryTimeServer: "{{ primaryTimeServer }}"
            secondaryTimeServer: "{{ secondaryTimeServer }}"
            timeZone: "{{ timeZone }}"
          storage:
            partitionSize: "{{ partitionSize }}"
      ownershipVoucherDetails:
        ownershipVoucher: "{{ ownershipVoucher }}"
        ownerKeyType: "{{ ownerKeyType }}"
        validationDetails:
          validationStatus: "{{ validationStatus }}"
          serialNumber: "{{ serialNumber }}"
          id: "{{ id }}"
          manufacturer: "{{ manufacturer }}"
          modelName: "{{ modelName }}"
          version: "{{ version }}"
          azureMachineId: "{{ azureMachineId }}"
          error:
            code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details:
              - code: "{{ code }}"
                message: "{{ message }}"
                target: "{{ target }}"
                details: "{{ details }}"
                additionalInfo: "{{ additionalInfo }}"
            additionalInfo:
              - type: "{{ type }}"
                info: "{{ info }}"
      provisioningDetails:
        osProfile:
          osName: "{{ osName }}"
          osType: "{{ osType }}"
          osVersion: "{{ osVersion }}"
          osImageLocation: "{{ osImageLocation }}"
          vsrVersion: "{{ vsrVersion }}"
          imageHash: "{{ imageHash }}"
          gpgPubKey: "{{ gpgPubKey }}"
          operationType: "{{ operationType }}"
        userDetails:
          - userName: "{{ userName }}"
            secretType: "{{ secretType }}"
            secretLocation: "{{ secretLocation }}"
            sshPubKey: "{{ sshPubKey }}"
      devicePoolResourceId: "{{ devicePoolResourceId }}"
      machineState: "{{ machineState }}"
      connectivityStatus: "{{ connectivityStatus }}"
      claimedBy: "{{ claimedBy }}"
      reportedProperties:
        lastUpdated: "{{ lastUpdated }}"
        networkProfile:
          nicDetails:
            - adapterName: "{{ adapterName }}"
              interfaceDescription: "{{ interfaceDescription }}"
              componentId: "{{ componentId }}"
              driverVersion: "{{ driverVersion }}"
              ip4Address: "{{ ip4Address }}"
              subnetMask: "{{ subnetMask }}"
              defaultGateway: "{{ defaultGateway }}"
              dnsServers: "{{ dnsServers }}"
              defaultIsolationId: "{{ defaultIsolationId }}"
              macAddress: "{{ macAddress }}"
              slot: "{{ slot }}"
              switchName: "{{ switchName }}"
              nicType: "{{ nicType }}"
              vlanId: "{{ vlanId }}"
              nicStatus: "{{ nicStatus }}"
              rdmaCapability: "{{ rdmaCapability }}"
          switchDetails:
            - switchName: "{{ switchName }}"
              switchType: "{{ switchType }}"
              extensions: "{{ extensions }}"
        osProfile:
          bootType: "{{ bootType }}"
          assemblyVersion: "{{ assemblyVersion }}"
          osType: "{{ osType }}"
          osSku: "{{ osSku }}"
          osVersion: "{{ osVersion }}"
          buildNumber: "{{ buildNumber }}"
          baseImageVersion: "{{ baseImageVersion }}"
          imageVersion: "{{ imageVersion }}"
        hardwareProfile:
          cpuCores: {{ cpuCores }}
          cpuSockets: {{ cpuSockets }}
          memoryCapacityInGb: {{ memoryCapacityInGb }}
          model: "{{ model }}"
          manufacturer: "{{ manufacturer }}"
          serialNumber: "{{ serialNumber }}"
          processorType: "{{ processorType }}"
        storageProfile:
          poolableDisksCount: {{ poolableDisksCount }}
        sbeDeploymentPackageInfo:
          code: "{{ code }}"
          message: "{{ message }}"
          sbeManifest: "{{ sbeManifest }}"
        extensionProfile:
          extensions:
            - extensionName: "{{ extensionName }}"
              state: "{{ state }}"
              errorDetails: "{{ errorDetails }}"
              extensionResourceId: "{{ extensionResourceId }}"
              typeHandlerVersion: "{{ typeHandlerVersion }}"
              managedBy: "{{ managedBy }}"
      operationDetails:
        - name: "{{ name }}"
          id: "{{ id }}"
          type: "{{ type }}"
          resourceId: "{{ resourceId }}"
          description: "{{ description }}"
          status: "{{ status }}"
          error:
            code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details:
              - code: "{{ code }}"
                message: "{{ message }}"
                target: "{{ target }}"
                details: "{{ details }}"
                additionalInfo: "{{ additionalInfo }}"
            additionalInfo:
              - type: "{{ type }}"
                info: "{{ info }}"
      lastSyncTimestamp: "{{ lastSyncTimestamp }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update an edge machine.

UPDATE azure_stack.azure_stack_hci.edge_machines
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND edge_machine_name = '{{ edge_machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update an edge machine.

REPLACE azure_stack.azure_stack_hci.edge_machines
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND edge_machine_name = '{{ edge_machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete an edge machine.

DELETE FROM azure_stack.azure_stack_hci.edge_machines
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND edge_machine_name = '{{ edge_machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;