virtual_machines

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

Overview

Name	virtual_machines
Type	Resource
Id	azure_extras.network_cloud.virtual_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.
adminUsername	string	The name of the administrator to which the ssh public keys will be added into the authorized keys. Required.
availabilityZone	string	The cluster availability zone containing this virtual machine.
bareMetalMachineId	string	The resource ID of the bare metal machine that hosts the virtual machine.
bootMethod	string	Selects the boot method for the virtual machine. Known values are: "BIOS" and "UEFI". (BIOS, UEFI)
cloudServicesNetworkAttachment	object	NetworkAttachment represents the single network attachment.
clusterId	string	The resource ID of the cluster the virtual machine is created for.
consoleExtendedLocation	object	The extended location to use for creation of a VM console resource.
cpuCores	integer	The number of CPU cores in the virtual machine. Required.
detailedStatus	string	The more detailed status of the virtual machine. Known values are: "Available", "Error", "Provisioning", "Running", "Scheduling", "Stopped", "Terminating", and "Unknown". (Available, Error, Provisioning, Running, Scheduling, Stopped, Terminating, Unknown)
detailedStatusMessage	string	The descriptive message about the current detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
identity	object	The managed service identities assigned to this resource.
isolateEmulatorThread	string	Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. Known values are: "False" and "True". (False, True)
location	string	The geo-location where the resource lives. Required.
memorySizeGB	integer	The memory size of the virtual machine. Allocations are measured in gibibytes. Required.
networkAttachments	array	The list of network attachments to the virtual machine.
networkData	string	Field Deprecated: The Base64 encoded cloud-init network data. The networkDataContent property will be used in preference to this property.
networkDataContent	string	The Base64 encoded cloud-init network data.
placementHints	array	The scheduling hints for the virtual machine.
powerState	string	The power state of the virtual machine. Known values are: "Off", "On", and "Unknown". (Off, On, Unknown)
provisioningState	string	The provisioning state of the virtual machine. Known values are: "Accepted", "Canceled", "Failed", "Provisioning", and "Succeeded". (Accepted, Canceled, Failed, Provisioning, Succeeded)
sshPublicKeys	array	The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername.
storageProfile	object	The storage profile that specifies size and other parameters about the disks related to the virtual machine. Required.
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".
userData	string	Field Deprecated: The Base64 encoded cloud-init user data. The userDataContent property will be used in preference to this property.
userDataContent	string	The Base64 encoded cloud-init user data.
virtioInterface	string	Field Deprecated, use virtualizationModel instead. The type of the virtio interface. Known values are: "Modern" and "Transitional". (Modern, Transitional)
vmDeviceModel	string	The type of the device model to use. Known values are: "T1", "T2", and "T3". (T1, T2, T3)
vmImage	string	The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. Required.
vmImageRepositoryCredentials	object	The credentials used to login to the image repository that has access to the specified image.
volumes	array	The resource IDs of volumes that are attached to the virtual machine.

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.
adminUsername	string	The name of the administrator to which the ssh public keys will be added into the authorized keys. Required.
availabilityZone	string	The cluster availability zone containing this virtual machine.
bareMetalMachineId	string	The resource ID of the bare metal machine that hosts the virtual machine.
bootMethod	string	Selects the boot method for the virtual machine. Known values are: "BIOS" and "UEFI". (BIOS, UEFI)
cloudServicesNetworkAttachment	object	NetworkAttachment represents the single network attachment.
clusterId	string	The resource ID of the cluster the virtual machine is created for.
consoleExtendedLocation	object	The extended location to use for creation of a VM console resource.
cpuCores	integer	The number of CPU cores in the virtual machine. Required.
detailedStatus	string	The more detailed status of the virtual machine. Known values are: "Available", "Error", "Provisioning", "Running", "Scheduling", "Stopped", "Terminating", and "Unknown". (Available, Error, Provisioning, Running, Scheduling, Stopped, Terminating, Unknown)
detailedStatusMessage	string	The descriptive message about the current detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
identity	object	The managed service identities assigned to this resource.
isolateEmulatorThread	string	Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. Known values are: "False" and "True". (False, True)
location	string	The geo-location where the resource lives. Required.
memorySizeGB	integer	The memory size of the virtual machine. Allocations are measured in gibibytes. Required.
networkAttachments	array	The list of network attachments to the virtual machine.
networkData	string	Field Deprecated: The Base64 encoded cloud-init network data. The networkDataContent property will be used in preference to this property.
networkDataContent	string	The Base64 encoded cloud-init network data.
placementHints	array	The scheduling hints for the virtual machine.
powerState	string	The power state of the virtual machine. Known values are: "Off", "On", and "Unknown". (Off, On, Unknown)
provisioningState	string	The provisioning state of the virtual machine. Known values are: "Accepted", "Canceled", "Failed", "Provisioning", and "Succeeded". (Accepted, Canceled, Failed, Provisioning, Succeeded)
sshPublicKeys	array	The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername.
storageProfile	object	The storage profile that specifies size and other parameters about the disks related to the virtual machine. Required.
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".
userData	string	Field Deprecated: The Base64 encoded cloud-init user data. The userDataContent property will be used in preference to this property.
userDataContent	string	The Base64 encoded cloud-init user data.
virtioInterface	string	Field Deprecated, use virtualizationModel instead. The type of the virtio interface. Known values are: "Modern" and "Transitional". (Modern, Transitional)
vmDeviceModel	string	The type of the device model to use. Known values are: "T1", "T2", and "T3". (T1, T2, T3)
vmImage	string	The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. Required.
vmImageRepositoryCredentials	object	The credentials used to login to the image repository that has access to the specified image.
volumes	array	The resource IDs of volumes that are attached to the virtual machine.

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.
adminUsername	string	The name of the administrator to which the ssh public keys will be added into the authorized keys. Required.
availabilityZone	string	The cluster availability zone containing this virtual machine.
bareMetalMachineId	string	The resource ID of the bare metal machine that hosts the virtual machine.
bootMethod	string	Selects the boot method for the virtual machine. Known values are: "BIOS" and "UEFI". (BIOS, UEFI)
cloudServicesNetworkAttachment	object	NetworkAttachment represents the single network attachment.
clusterId	string	The resource ID of the cluster the virtual machine is created for.
consoleExtendedLocation	object	The extended location to use for creation of a VM console resource.
cpuCores	integer	The number of CPU cores in the virtual machine. Required.
detailedStatus	string	The more detailed status of the virtual machine. Known values are: "Available", "Error", "Provisioning", "Running", "Scheduling", "Stopped", "Terminating", and "Unknown". (Available, Error, Provisioning, Running, Scheduling, Stopped, Terminating, Unknown)
detailedStatusMessage	string	The descriptive message about the current detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
identity	object	The managed service identities assigned to this resource.
isolateEmulatorThread	string	Field Deprecated, the value will be ignored if provided. The indicator of whether one of the specified CPU cores is isolated to run the emulator thread for this virtual machine. Known values are: "False" and "True". (False, True)
location	string	The geo-location where the resource lives. Required.
memorySizeGB	integer	The memory size of the virtual machine. Allocations are measured in gibibytes. Required.
networkAttachments	array	The list of network attachments to the virtual machine.
networkData	string	Field Deprecated: The Base64 encoded cloud-init network data. The networkDataContent property will be used in preference to this property.
networkDataContent	string	The Base64 encoded cloud-init network data.
placementHints	array	The scheduling hints for the virtual machine.
powerState	string	The power state of the virtual machine. Known values are: "Off", "On", and "Unknown". (Off, On, Unknown)
provisioningState	string	The provisioning state of the virtual machine. Known values are: "Accepted", "Canceled", "Failed", "Provisioning", and "Succeeded". (Accepted, Canceled, Failed, Provisioning, Succeeded)
sshPublicKeys	array	The list of ssh public keys. Each key will be added to the virtual machine using the cloud-init ssh_authorized_keys mechanism for the adminUsername.
storageProfile	object	The storage profile that specifies size and other parameters about the disks related to the virtual machine. Required.
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".
userData	string	Field Deprecated: The Base64 encoded cloud-init user data. The userDataContent property will be used in preference to this property.
userDataContent	string	The Base64 encoded cloud-init user data.
virtioInterface	string	Field Deprecated, use virtualizationModel instead. The type of the virtio interface. Known values are: "Modern" and "Transitional". (Modern, Transitional)
vmDeviceModel	string	The type of the device model to use. Known values are: "T1", "T2", and "T3". (T1, T2, T3)
vmImage	string	The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image. Required.
vmImageRepositoryCredentials	object	The credentials used to login to the image repository that has access to the specified image.
volumes	array	The resource IDs of volumes that are attached to the virtual machine.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, virtual_machine_name, subscription_id		Get properties of the provided virtual machine.
list_by_resource_group	select	resource_group_name, subscription_id	$top, $skipToken	Get a list of virtual machines in the provided resource group.
list_by_subscription	select	subscription_id	$top, $skipToken	Get a list of virtual machines in the provided subscription.
create_or_update	insert	resource_group_name, virtual_machine_name, subscription_id, location, properties, extendedLocation		Create a new virtual machine or update the properties of the existing virtual machine.
update	update	resource_group_name, virtual_machine_name, subscription_id		Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.
create_or_update	replace	resource_group_name, virtual_machine_name, subscription_id, location, properties, extendedLocation		Create a new virtual machine or update the properties of the existing virtual machine.
delete	delete	resource_group_name, virtual_machine_name, subscription_id		Delete the provided virtual machine.
assign_relay	exec	resource_group_name, virtual_machine_name, subscription_id, machineId		Assigns a relay to the specified Microsoft.HybridCompute machine associated with the provided virtual machine.
power_off	exec	resource_group_name, virtual_machine_name, subscription_id		Power off the provided virtual machine.
reimage	exec	resource_group_name, virtual_machine_name, subscription_id		Reimage the provided virtual machine.
restart	exec	resource_group_name, virtual_machine_name, subscription_id		Restart the provided virtual machine.
start	exec	resource_group_name, virtual_machine_name, subscription_id		Start the provided virtual 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_machine_name	string	The name of the virtual machine. Required.
$skipToken	string	The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get properties of the provided virtual machine.

SELECT
id,
name,
adminUsername,
availabilityZone,
bareMetalMachineId,
bootMethod,
cloudServicesNetworkAttachment,
clusterId,
consoleExtendedLocation,
cpuCores,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
identity,
isolateEmulatorThread,
location,
memorySizeGB,
networkAttachments,
networkData,
networkDataContent,
placementHints,
powerState,
provisioningState,
sshPublicKeys,
storageProfile,
systemData,
tags,
type,
userData,
userDataContent,
virtioInterface,
vmDeviceModel,
vmImage,
vmImageRepositoryCredentials,
volumes
FROM azure_extras.network_cloud.virtual_machines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_machine_name = '{{ virtual_machine_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get a list of virtual machines in the provided resource group.

SELECT
id,
name,
adminUsername,
availabilityZone,
bareMetalMachineId,
bootMethod,
cloudServicesNetworkAttachment,
clusterId,
consoleExtendedLocation,
cpuCores,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
identity,
isolateEmulatorThread,
location,
memorySizeGB,
networkAttachments,
networkData,
networkDataContent,
placementHints,
powerState,
provisioningState,
sshPublicKeys,
storageProfile,
systemData,
tags,
type,
userData,
userDataContent,
virtioInterface,
vmDeviceModel,
vmImage,
vmImageRepositoryCredentials,
volumes
FROM azure_extras.network_cloud.virtual_machines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Get a list of virtual machines in the provided subscription.

SELECT
id,
name,
adminUsername,
availabilityZone,
bareMetalMachineId,
bootMethod,
cloudServicesNetworkAttachment,
clusterId,
consoleExtendedLocation,
cpuCores,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
identity,
isolateEmulatorThread,
location,
memorySizeGB,
networkAttachments,
networkData,
networkDataContent,
placementHints,
powerState,
provisioningState,
sshPublicKeys,
storageProfile,
systemData,
tags,
type,
userData,
userDataContent,
virtioInterface,
vmDeviceModel,
vmImage,
vmImageRepositoryCredentials,
volumes
FROM azure_extras.network_cloud.virtual_machines
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Create a new virtual machine or update the properties of the existing virtual machine.

INSERT INTO azure_extras.network_cloud.virtual_machines (
tags,
location,
properties,
extendedLocation,
identity,
resource_group_name,
virtual_machine_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ extendedLocation }}' /* required */,
'{{ identity }}',
'{{ resource_group_name }}',
'{{ virtual_machine_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_machines
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_machines resource.
  - name: virtual_machine_name
    value: "{{ virtual_machine_name }}"
    description: Required parameter for the virtual_machines resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_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 list of the resource properties. Required.
    value:
      adminUsername: "{{ adminUsername }}"
      bootMethod: "{{ bootMethod }}"
      cloudServicesNetworkAttachment:
        attachedNetworkId: "{{ attachedNetworkId }}"
        defaultGateway: "{{ defaultGateway }}"
        ipAllocationMethod: "{{ ipAllocationMethod }}"
        ipv4Address: "{{ ipv4Address }}"
        ipv6Address: "{{ ipv6Address }}"
        macAddress: "{{ macAddress }}"
        networkAttachmentName: "{{ networkAttachmentName }}"
      cpuCores: {{ cpuCores }}
      isolateEmulatorThread: "{{ isolateEmulatorThread }}"
      memorySizeGB: {{ memorySizeGB }}
      networkAttachments:
        - attachedNetworkId: "{{ attachedNetworkId }}"
          defaultGateway: "{{ defaultGateway }}"
          ipAllocationMethod: "{{ ipAllocationMethod }}"
          ipv4Address: "{{ ipv4Address }}"
          ipv6Address: "{{ ipv6Address }}"
          macAddress: "{{ macAddress }}"
          networkAttachmentName: "{{ networkAttachmentName }}"
      networkData: "{{ networkData }}"
      networkDataContent: "{{ networkDataContent }}"
      placementHints:
        - hintType: "{{ hintType }}"
          resourceId: "{{ resourceId }}"
          schedulingExecution: "{{ schedulingExecution }}"
          scope: "{{ scope }}"
      sshPublicKeys:
        - keyData: "{{ keyData }}"
      storageProfile:
        osDisk:
          createOption: "{{ createOption }}"
          deleteOption: "{{ deleteOption }}"
          diskSizeGB: {{ diskSizeGB }}
        volumeAttachments:
          - "{{ volumeAttachments }}"
      userData: "{{ userData }}"
      userDataContent: "{{ userDataContent }}"
      virtioInterface: "{{ virtioInterface }}"
      vmDeviceModel: "{{ vmDeviceModel }}"
      vmImage: "{{ vmImage }}"
      vmImageRepositoryCredentials:
        password: "{{ password }}"
        registryUrl: "{{ registryUrl }}"
        username: "{{ username }}"
      availabilityZone: "{{ availabilityZone }}"
      bareMetalMachineId: "{{ bareMetalMachineId }}"
      clusterId: "{{ clusterId }}"
      consoleExtendedLocation:
        name: "{{ name }}"
        type: "{{ type }}"
      detailedStatus: "{{ detailedStatus }}"
      detailedStatusMessage: "{{ detailedStatusMessage }}"
      powerState: "{{ powerState }}"
      volumes:
        - "{{ volumes }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location of the resource. This property is required when creating the resource. Required.
    value:
      name: "{{ name }}"
      type: "{{ type }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.

UPDATE azure_extras.network_cloud.virtual_machines
SET 
identity = '{{ identity }}',
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_machine_name = '{{ virtual_machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a new virtual machine or update the properties of the existing virtual machine.

REPLACE azure_extras.network_cloud.virtual_machines
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_machine_name = '{{ virtual_machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the provided virtual machine.

DELETE FROM azure_extras.network_cloud.virtual_machines
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_machine_name = '{{ virtual_machine_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

assign_relay

Assigns a relay to the specified Microsoft.HybridCompute machine associated with the provided virtual machine.

EXEC azure_extras.network_cloud.virtual_machines.assign_relay 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_machine_name='{{ virtual_machine_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"machineId": "{{ machineId }}", 
"relayType": "{{ relayType }}"
}'
;

power_off

Power off the provided virtual machine.

EXEC azure_extras.network_cloud.virtual_machines.power_off 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_machine_name='{{ virtual_machine_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"skipShutdown": "{{ skipShutdown }}"
}'
;

reimage

Reimage the provided virtual machine.

EXEC azure_extras.network_cloud.virtual_machines.reimage 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_machine_name='{{ virtual_machine_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

restart

Restart the provided virtual machine.

EXEC azure_extras.network_cloud.virtual_machines.restart 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_machine_name='{{ virtual_machine_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

start

Start the provided virtual machine.

EXEC azure_extras.network_cloud.virtual_machines.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_machine_name='{{ virtual_machine_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;