virtual_machine_scale_set_vm_run_commands

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

Overview

Name	virtual_machine_scale_set_vm_run_commands
Type	Resource
Id	azure.compute.virtual_machine_scale_set_vm_run_commands

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Describes the properties of a Virtual Machine run command.
tags	object	Resource tags
type	string	Resource type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Describes the properties of a Virtual Machine run command.
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, vmScaleSetName, instanceId, runCommandName, subscriptionId	$expand	The operation to get the VMSS VM run command.
list	select	resourceGroupName, vmScaleSetName, instanceId, subscriptionId	$expand	The operation to get all run commands of an instance in Virtual Machine Scaleset.
create_or_update	insert	resourceGroupName, vmScaleSetName, instanceId, runCommandName, subscriptionId		The operation to create or update the VMSS VM run command.
update	update	resourceGroupName, vmScaleSetName, instanceId, runCommandName, subscriptionId		The operation to update the VMSS VM run command.
delete	delete	resourceGroupName, vmScaleSetName, instanceId, runCommandName, subscriptionId		The operation to delete the VMSS VM run command.

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
instanceId	string	The instance ID of the virtual machine.
resourceGroupName	string	The name of the resource group.
runCommandName	string	The name of the virtual machine run command.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vmScaleSetName	string	The name of the VM scale set.
$expand	string	The expand expression to apply on the operation.

SELECT examples

get

The operation to get the VMSS VM run command.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.virtual_machine_scale_set_vm_run_commands
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND vmScaleSetName = '{{ vmScaleSetName }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND runCommandName = '{{ runCommandName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list

The operation to get all run commands of an instance in Virtual Machine Scaleset.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.virtual_machine_scale_set_vm_run_commands
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND vmScaleSetName = '{{ vmScaleSetName }}' -- required
AND instanceId = '{{ instanceId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

The operation to create or update the VMSS VM run command.

INSERT INTO azure.compute.virtual_machine_scale_set_vm_run_commands (
data__properties,
data__location,
data__tags,
resourceGroupName,
vmScaleSetName,
instanceId,
runCommandName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ vmScaleSetName }}',
'{{ instanceId }}',
'{{ runCommandName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_machine_scale_set_vm_run_commands
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_machine_scale_set_vm_run_commands resource.
    - name: vmScaleSetName
      value: string
      description: Required parameter for the virtual_machine_scale_set_vm_run_commands resource.
    - name: instanceId
      value: string
      description: Required parameter for the virtual_machine_scale_set_vm_run_commands resource.
    - name: runCommandName
      value: string
      description: Required parameter for the virtual_machine_scale_set_vm_run_commands resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the virtual_machine_scale_set_vm_run_commands resource.
    - name: properties
      value: object
      description: |
        Describes the properties of a Virtual Machine run command.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

UPDATE examples

update

The operation to update the VMSS VM run command.

UPDATE azure.compute.virtual_machine_scale_set_vm_run_commands
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND vmScaleSetName = '{{ vmScaleSetName }}' --required
AND instanceId = '{{ instanceId }}' --required
AND runCommandName = '{{ runCommandName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

The operation to delete the VMSS VM run command.

DELETE FROM azure.compute.virtual_machine_scale_set_vm_run_commands
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND vmScaleSetName = '{{ vmScaleSetName }}' --required
AND instanceId = '{{ instanceId }}' --required
AND runCommandName = '{{ runCommandName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;