machines

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

Overview

Name	machines
Type	Resource
Id	azure.hybrid_compute.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.
adFqdn	string	Specifies the AD fully qualified display name.
agentConfiguration	object	Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM.
agentUpgrade	object	The info of the machine w.r.t Agent Upgrade.
agentVersion	string	The hybrid machine agent full version.
clientPublicKey	string	Public Key that the client provides to be used during initial resource onboarding.
cloudMetadata	object	The metadata of the cloud environment (Azure/GCP/AWS/OCI...).
detectedProperties	object	Detected properties from the machine.
displayName	string	Specifies the hybrid machine display name.
dnsFqdn	string	Specifies the DNS fully qualified display name.
domainName	string	Specifies the Windows domain name.
errorDetails	array	Details about the error state.
extensions	array	Machine Extensions information (deprecated field).
firmwareProfile	object	Information about the machine's firmware.
hardwareProfile	object	Information about the machine's hardware.
hardwareResourceId	string	Specifies the resource ID of the associated hardware device. Only settable by HCI RP.
identity	object	Identity for the resource.
identityKeyStore	string	Specifies the identity key store a machine is using. Known values are: "TPM" and "Default". (TPM, Default)
kind	string	Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. Known values are: "AVS", "HCI", "SCVMM", "VMware", "EPS", "GCP", and "AWS". (AVS, HCI, SCVMM, VMware, EPS, GCP, AWS)
lastStatusChange	string (date-time)	The time of the last status change.
licenseProfile	object	Specifies the License related properties for a machine.
location	string	The geo-location where the resource lives. Required.
locationData	object	Metadata pertaining to the geographic location of the resource.
machineFqdn	string	Specifies the hybrid machine FQDN.
mssqlDiscovered	string	Specifies whether any MS SQL instance is discovered on the machine.
networkProfile	object	Information about the network the machine is on.
osEdition	string	The edition of the Operating System.
osName	string	The Operating System running on the hybrid machine.
osProfile	object	Specifies the operating system settings for the hybrid machine.
osSku	string	Specifies the Operating System product SKU.
osType	string	The type of Operating System (windows/linux).
osVersion	string	The version of Operating System running on the hybrid machine.
parentClusterResourceId	string	The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any.
privateLinkScopeResourceId	string	The resource id of the private link scope this machine is assigned to, if any.
provisioningState	string	The provisioning state, which only appears in the response.
resources	array	The list of extensions affiliated to the machine.
serviceStatuses	object	Statuses of dependent services that are reported back to ARM.
status	string	The status of the hybrid machine agent. Known values are: "Connected", "Disconnected", "Error", and "AwaitingConnection". (Connected, Disconnected, Error, AwaitingConnection)
storageProfile	object	Information about the machine's storage.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tpmEkCertificate	string	Endorsement Key Certificate of the Trusted Platform Module (TPM) that the client provides to be used during initial resource onboarding.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vmId	string	Specifies the hybrid machine unique ID.
vmUuid	string	Specifies the Arc Machine's unique SMBIOS ID.

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.
adFqdn	string	Specifies the AD fully qualified display name.
agentConfiguration	object	Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM.
agentUpgrade	object	The info of the machine w.r.t Agent Upgrade.
agentVersion	string	The hybrid machine agent full version.
clientPublicKey	string	Public Key that the client provides to be used during initial resource onboarding.
cloudMetadata	object	The metadata of the cloud environment (Azure/GCP/AWS/OCI...).
detectedProperties	object	Detected properties from the machine.
displayName	string	Specifies the hybrid machine display name.
dnsFqdn	string	Specifies the DNS fully qualified display name.
domainName	string	Specifies the Windows domain name.
errorDetails	array	Details about the error state.
extensions	array	Machine Extensions information (deprecated field).
firmwareProfile	object	Information about the machine's firmware.
hardwareProfile	object	Information about the machine's hardware.
hardwareResourceId	string	Specifies the resource ID of the associated hardware device. Only settable by HCI RP.
identity	object	Identity for the resource.
identityKeyStore	string	Specifies the identity key store a machine is using. Known values are: "TPM" and "Default". (TPM, Default)
kind	string	Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. Known values are: "AVS", "HCI", "SCVMM", "VMware", "EPS", "GCP", and "AWS". (AVS, HCI, SCVMM, VMware, EPS, GCP, AWS)
lastStatusChange	string (date-time)	The time of the last status change.
licenseProfile	object	Specifies the License related properties for a machine.
location	string	The geo-location where the resource lives. Required.
locationData	object	Metadata pertaining to the geographic location of the resource.
machineFqdn	string	Specifies the hybrid machine FQDN.
mssqlDiscovered	string	Specifies whether any MS SQL instance is discovered on the machine.
networkProfile	object	Information about the network the machine is on.
osEdition	string	The edition of the Operating System.
osName	string	The Operating System running on the hybrid machine.
osProfile	object	Specifies the operating system settings for the hybrid machine.
osSku	string	Specifies the Operating System product SKU.
osType	string	The type of Operating System (windows/linux).
osVersion	string	The version of Operating System running on the hybrid machine.
parentClusterResourceId	string	The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any.
privateLinkScopeResourceId	string	The resource id of the private link scope this machine is assigned to, if any.
provisioningState	string	The provisioning state, which only appears in the response.
resources	array	The list of extensions affiliated to the machine.
serviceStatuses	object	Statuses of dependent services that are reported back to ARM.
status	string	The status of the hybrid machine agent. Known values are: "Connected", "Disconnected", "Error", and "AwaitingConnection". (Connected, Disconnected, Error, AwaitingConnection)
storageProfile	object	Information about the machine's storage.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tpmEkCertificate	string	Endorsement Key Certificate of the Trusted Platform Module (TPM) that the client provides to be used during initial resource onboarding.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vmId	string	Specifies the hybrid machine unique ID.
vmUuid	string	Specifies the Arc Machine's unique SMBIOS ID.

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.
adFqdn	string	Specifies the AD fully qualified display name.
agentConfiguration	object	Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM.
agentUpgrade	object	The info of the machine w.r.t Agent Upgrade.
agentVersion	string	The hybrid machine agent full version.
clientPublicKey	string	Public Key that the client provides to be used during initial resource onboarding.
cloudMetadata	object	The metadata of the cloud environment (Azure/GCP/AWS/OCI...).
detectedProperties	object	Detected properties from the machine.
displayName	string	Specifies the hybrid machine display name.
dnsFqdn	string	Specifies the DNS fully qualified display name.
domainName	string	Specifies the Windows domain name.
errorDetails	array	Details about the error state.
extensions	array	Machine Extensions information (deprecated field).
firmwareProfile	object	Information about the machine's firmware.
hardwareProfile	object	Information about the machine's hardware.
hardwareResourceId	string	Specifies the resource ID of the associated hardware device. Only settable by HCI RP.
identity	object	Identity for the resource.
identityKeyStore	string	Specifies the identity key store a machine is using. Known values are: "TPM" and "Default". (TPM, Default)
kind	string	Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. Known values are: "AVS", "HCI", "SCVMM", "VMware", "EPS", "GCP", and "AWS". (AVS, HCI, SCVMM, VMware, EPS, GCP, AWS)
lastStatusChange	string (date-time)	The time of the last status change.
licenseProfile	object	Specifies the License related properties for a machine.
location	string	The geo-location where the resource lives. Required.
locationData	object	Metadata pertaining to the geographic location of the resource.
machineFqdn	string	Specifies the hybrid machine FQDN.
mssqlDiscovered	string	Specifies whether any MS SQL instance is discovered on the machine.
networkProfile	object	Information about the network the machine is on.
osEdition	string	The edition of the Operating System.
osName	string	The Operating System running on the hybrid machine.
osProfile	object	Specifies the operating system settings for the hybrid machine.
osSku	string	Specifies the Operating System product SKU.
osType	string	The type of Operating System (windows/linux).
osVersion	string	The version of Operating System running on the hybrid machine.
parentClusterResourceId	string	The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any.
privateLinkScopeResourceId	string	The resource id of the private link scope this machine is assigned to, if any.
provisioningState	string	The provisioning state, which only appears in the response.
resources	array	The list of extensions affiliated to the machine.
serviceStatuses	object	Statuses of dependent services that are reported back to ARM.
status	string	The status of the hybrid machine agent. Known values are: "Connected", "Disconnected", "Error", and "AwaitingConnection". (Connected, Disconnected, Error, AwaitingConnection)
storageProfile	object	Information about the machine's storage.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tpmEkCertificate	string	Endorsement Key Certificate of the Trusted Platform Module (TPM) that the client provides to be used during initial resource onboarding.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vmId	string	Specifies the hybrid machine unique ID.
vmUuid	string	Specifies the Arc Machine's unique SMBIOS ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, machine_name, subscription_id	$expand	Retrieves information about the model view or the instance view of a hybrid machine.
list_by_resource_group	select	resource_group_name, subscription_id	$expand	Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.
list_by_subscription	select	subscription_id		Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.
create_or_update	insert	resource_group_name, machine_name, subscription_id, location	$expand	The operation to create or update a hybrid machine. Please note some properties can be set only during machine creation.
update	update	resource_group_name, machine_name, subscription_id		The operation to update a hybrid machine.
create_or_update	replace	resource_group_name, machine_name, subscription_id, location	$expand	The operation to create or update a hybrid machine. Please note some properties can be set only during machine creation.
delete	delete	resource_group_name, machine_name, subscription_id		The operation to delete a hybrid machine.
assess_patches	exec	resource_group_name, name, subscription_id		The operation to assess patches on a hybrid machine identity in Azure.
install_patches	exec	resource_group_name, name, subscription_id, maximumDuration, rebootSetting		The operation to install patches on a hybrid machine identity in Azure.

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
machine_name	string	The name of the hybrid machine. Required.
name	string	The name of the hybrid machine. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	Expands referenced resources. Default value is None.

SELECT examples

get

Retrieves information about the model view or the instance view of a hybrid machine.

SELECT
id,
name,
adFqdn,
agentConfiguration,
agentUpgrade,
agentVersion,
clientPublicKey,
cloudMetadata,
detectedProperties,
displayName,
dnsFqdn,
domainName,
errorDetails,
extensions,
firmwareProfile,
hardwareProfile,
hardwareResourceId,
identity,
identityKeyStore,
kind,
lastStatusChange,
licenseProfile,
location,
locationData,
machineFqdn,
mssqlDiscovered,
networkProfile,
osEdition,
osName,
osProfile,
osSku,
osType,
osVersion,
parentClusterResourceId,
privateLinkScopeResourceId,
provisioningState,
resources,
serviceStatuses,
status,
storageProfile,
systemData,
tags,
tpmEkCertificate,
type,
vmId,
vmUuid
FROM azure.hybrid_compute.machines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND machine_name = '{{ machine_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.

SELECT
id,
name,
adFqdn,
agentConfiguration,
agentUpgrade,
agentVersion,
clientPublicKey,
cloudMetadata,
detectedProperties,
displayName,
dnsFqdn,
domainName,
errorDetails,
extensions,
firmwareProfile,
hardwareProfile,
hardwareResourceId,
identity,
identityKeyStore,
kind,
lastStatusChange,
licenseProfile,
location,
locationData,
machineFqdn,
mssqlDiscovered,
networkProfile,
osEdition,
osName,
osProfile,
osSku,
osType,
osVersion,
parentClusterResourceId,
privateLinkScopeResourceId,
provisioningState,
resources,
serviceStatuses,
status,
storageProfile,
systemData,
tags,
tpmEkCertificate,
type,
vmId,
vmUuid
FROM azure.hybrid_compute.machines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_subscription

Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.

SELECT
id,
name,
adFqdn,
agentConfiguration,
agentUpgrade,
agentVersion,
clientPublicKey,
cloudMetadata,
detectedProperties,
displayName,
dnsFqdn,
domainName,
errorDetails,
extensions,
firmwareProfile,
hardwareProfile,
hardwareResourceId,
identity,
identityKeyStore,
kind,
lastStatusChange,
licenseProfile,
location,
locationData,
machineFqdn,
mssqlDiscovered,
networkProfile,
osEdition,
osName,
osProfile,
osSku,
osType,
osVersion,
parentClusterResourceId,
privateLinkScopeResourceId,
provisioningState,
resources,
serviceStatuses,
status,
storageProfile,
systemData,
tags,
tpmEkCertificate,
type,
vmId,
vmUuid
FROM azure.hybrid_compute.machines
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

The operation to create or update a hybrid machine. Please note some properties can be set only during machine creation.

INSERT INTO azure.hybrid_compute.machines (
tags,
location,
properties,
identity,
kind,
resource_group_name,
machine_name,
subscription_id,
$expand
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ kind }}',
'{{ resource_group_name }}',
'{{ machine_name }}',
'{{ subscription_id }}',
'{{ $expand }}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
resources,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: machines
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the machines resource.
  - name: machine_name
    value: "{{ machine_name }}"
    description: Required parameter for the machines resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the 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: |
      Hybrid Compute Machine properties.
    value:
      locationData:
        name: "{{ name }}"
        city: "{{ city }}"
        district: "{{ district }}"
        countryOrRegion: "{{ countryOrRegion }}"
      agentConfiguration:
        proxyUrl: "{{ proxyUrl }}"
        incomingConnectionsPorts:
          - "{{ incomingConnectionsPorts }}"
        extensionsAllowList:
          - publisher: "{{ publisher }}"
            type: "{{ type }}"
        extensionsBlockList:
          - publisher: "{{ publisher }}"
            type: "{{ type }}"
        proxyBypass:
          - "{{ proxyBypass }}"
        extensionsEnabled: "{{ extensionsEnabled }}"
        guestConfigurationEnabled: "{{ guestConfigurationEnabled }}"
        configMode: "{{ configMode }}"
      serviceStatuses:
        extensionService:
          status: "{{ status }}"
          startupType: "{{ startupType }}"
        guestConfigurationService:
          status: "{{ status }}"
          startupType: "{{ startupType }}"
      hardwareProfile:
        totalPhysicalMemoryInBytes: {{ totalPhysicalMemoryInBytes }}
        numberOfCpuSockets: {{ numberOfCpuSockets }}
        processors:
          - name: "{{ name }}"
            numberOfCores: {{ numberOfCores }}
      storageProfile:
        disks:
          - path: "{{ path }}"
            diskType: "{{ diskType }}"
            generatedId: "{{ generatedId }}"
            id: "{{ id }}"
            name: "{{ name }}"
            maxSizeInBytes: {{ maxSizeInBytes }}
            usedSpaceInBytes: {{ usedSpaceInBytes }}
      firmwareProfile:
        serialNumber: "{{ serialNumber }}"
        type: "{{ type }}"
      cloudMetadata:
        provider: "{{ provider }}"
      agentUpgrade:
        desiredVersion: "{{ desiredVersion }}"
        correlationId: "{{ correlationId }}"
        enableAutomaticUpgrade: {{ enableAutomaticUpgrade }}
        lastAttemptDesiredVersion: "{{ lastAttemptDesiredVersion }}"
        lastAttemptTimestamp: "{{ lastAttemptTimestamp }}"
        lastAttemptStatus: "{{ lastAttemptStatus }}"
        lastAttemptMessage: "{{ lastAttemptMessage }}"
      osProfile:
        computerName: "{{ computerName }}"
        windowsConfiguration:
          patchSettings:
            assessmentMode: "{{ assessmentMode }}"
            patchMode: "{{ patchMode }}"
            enableHotpatching: {{ enableHotpatching }}
            status:
              hotpatchEnablementStatus: "{{ hotpatchEnablementStatus }}"
              error: "{{ error }}"
        linuxConfiguration:
          patchSettings:
            assessmentMode: "{{ assessmentMode }}"
            patchMode: "{{ patchMode }}"
            enableHotpatching: {{ enableHotpatching }}
            status:
              hotpatchEnablementStatus: "{{ hotpatchEnablementStatus }}"
              error: "{{ error }}"
      licenseProfile:
        licenseStatus: "{{ licenseStatus }}"
        licenseChannel: "{{ licenseChannel }}"
        softwareAssurance:
          softwareAssuranceCustomer: {{ softwareAssuranceCustomer }}
        esuProfile:
          assignedLicenseImmutableId: "{{ assignedLicenseImmutableId }}"
          esuKeys:
            - sku: "{{ sku }}"
              licenseStatus: {{ licenseStatus }}
          serverType: "{{ serverType }}"
          esuEligibility: "{{ esuEligibility }}"
          esuKeyState: "{{ esuKeyState }}"
          assignedLicense:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            systemData:
              createdBy: "{{ createdBy }}"
              createdByType: "{{ createdByType }}"
              createdAt: "{{ createdAt }}"
              lastModifiedBy: "{{ lastModifiedBy }}"
              lastModifiedByType: "{{ lastModifiedByType }}"
              lastModifiedAt: "{{ lastModifiedAt }}"
            tags: "{{ tags }}"
            location: "{{ location }}"
            properties:
              provisioningState: "{{ provisioningState }}"
              tenantId: "{{ tenantId }}"
              licenseType: "{{ licenseType }}"
              licenseDetails: "{{ licenseDetails }}"
          licenseAssignmentState: "{{ licenseAssignmentState }}"
        productProfile:
          subscriptionStatus: "{{ subscriptionStatus }}"
          productType: "{{ productType }}"
          enrollmentDate: "{{ enrollmentDate }}"
          billingStartDate: "{{ billingStartDate }}"
          disenrollmentDate: "{{ disenrollmentDate }}"
          billingEndDate: "{{ billingEndDate }}"
          error:
            code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details:
              - code: "{{ code }}"
                message: "{{ message }}"
                target: "{{ target }}"
                details: "{{ details }}"
                additionalInfo: "{{ additionalInfo }}"
            additionalInfo:
              - type: "{{ type }}"
                info: "{{ info }}"
          productFeatures:
            - name: "{{ name }}"
              subscriptionStatus: "{{ subscriptionStatus }}"
              enrollmentDate: "{{ enrollmentDate }}"
              billingStartDate: "{{ billingStartDate }}"
              disenrollmentDate: "{{ disenrollmentDate }}"
              billingEndDate: "{{ billingEndDate }}"
              error:
                code: "{{ code }}"
                message: "{{ message }}"
                target: "{{ target }}"
                details: "{{ details }}"
                additionalInfo: "{{ additionalInfo }}"
      provisioningState: "{{ provisioningState }}"
      status: "{{ status }}"
      lastStatusChange: "{{ lastStatusChange }}"
      errorDetails:
        - code: "{{ code }}"
          message: "{{ message }}"
          target: "{{ target }}"
          details: "{{ details }}"
          additionalInfo: "{{ additionalInfo }}"
      agentVersion: "{{ agentVersion }}"
      vmId: "{{ vmId }}"
      displayName: "{{ displayName }}"
      machineFqdn: "{{ machineFqdn }}"
      clientPublicKey: "{{ clientPublicKey }}"
      identityKeyStore: "{{ identityKeyStore }}"
      tpmEkCertificate: "{{ tpmEkCertificate }}"
      osName: "{{ osName }}"
      osVersion: "{{ osVersion }}"
      osType: "{{ osType }}"
      vmUuid: "{{ vmUuid }}"
      extensions:
        - name: "{{ name }}"
          type: "{{ type }}"
          typeHandlerVersion: "{{ typeHandlerVersion }}"
          status:
            code: "{{ code }}"
            level: "{{ level }}"
            displayStatus: "{{ displayStatus }}"
            message: "{{ message }}"
            time: "{{ time }}"
      osSku: "{{ osSku }}"
      osEdition: "{{ osEdition }}"
      domainName: "{{ domainName }}"
      adFqdn: "{{ adFqdn }}"
      dnsFqdn: "{{ dnsFqdn }}"
      privateLinkScopeResourceId: "{{ privateLinkScopeResourceId }}"
      parentClusterResourceId: "{{ parentClusterResourceId }}"
      hardwareResourceId: "{{ hardwareResourceId }}"
      mssqlDiscovered: "{{ mssqlDiscovered }}"
      detectedProperties: "{{ detectedProperties }}"
      networkProfile:
        networkInterfaces:
          - macAddress: "{{ macAddress }}"
            id: "{{ id }}"
            name: "{{ name }}"
            ipAddresses: "{{ ipAddresses }}"
  - name: identity
    description: |
      Identity for the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. Known values are: "AVS", "HCI", "SCVMM", "VMware", "EPS", "GCP", and "AWS".
    valid_values: ['AVS', 'HCI', 'SCVMM', 'VMware', 'EPS', 'GCP', 'AWS']
  - name: $expand
    value: "{{ $expand }}"
    description: Expands referenced resources. Default value is None.
    description: Expands referenced resources. Default value is None.

UPDATE examples

update

The operation to update a hybrid machine.

UPDATE azure.hybrid_compute.machines
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
kind = '{{ kind }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND machine_name = '{{ machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
resources,
systemData,
tags,
type;

REPLACE examples

create_or_update

The operation to create or update a hybrid machine. Please note some properties can be set only during machine creation.

REPLACE azure.hybrid_compute.machines
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND machine_name = '{{ machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND $expand = '{{ $expand}}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
resources,
systemData,
tags,
type;

DELETE examples

delete

The operation to delete a hybrid machine.

DELETE FROM azure.hybrid_compute.machines
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND machine_name = '{{ machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

assess_patches

The operation to assess patches on a hybrid machine identity in Azure.

EXEC azure.hybrid_compute.machines.assess_patches 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

install_patches

The operation to install patches on a hybrid machine identity in Azure.

EXEC azure.hybrid_compute.machines.install_patches 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"maximumDuration": "{{ maximumDuration }}", 
"rebootSetting": "{{ rebootSetting }}", 
"windowsParameters": "{{ windowsParameters }}", 
"linuxParameters": "{{ linuxParameters }}"
}'
;