virtual_machine_scale_set_vms

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

Overview

Name	virtual_machine_scale_set_vms
Type	Resource
Id	azure.compute.virtual_machine_scale_set_vms

Fields

vw_virtual_machine_scale_set_vms

Name	Datatype	Description
id	text	Resource Id
name	text	Resource name
additional_capabilities	text	field from the properties object
availability_set	text	field from the properties object
diagnostics_profile	text	field from the properties object
etag	text	Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates.
hardware_profile	text	field from the properties object
identity	text	Identity for the virtual machine.
instanceId	text	The virtual machine instance ID.
instance_id	text	field from the properties object
instance_view	text	field from the properties object
latest_model_applied	text	field from the properties object
license_type	text	field from the properties object
location	text	Resource location
model_definition_applied	text	field from the properties object
network_profile	text	field from the properties object
network_profile_configuration	text	field from the properties object
os_profile	text	field from the properties object
plan	text	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
protection_policy	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
resources	text	The virtual machine child extension resources.
security_profile	text	field from the properties object
sku	text	Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.
storage_profile	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags
time_created	text	field from the properties object
type	text	Resource type
user_data	text	field from the properties object
virtualMachineScaleSetName	text	field from the properties object
vmScaleSetName	text	field from the properties object
vm_id	text	field from the properties object
zones	text	The virtual machine zones.

virtual_machine_scale_set_vms

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
etag	string	Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates.
identity	object	Identity for the virtual machine.
instanceId	string	The virtual machine instance ID.
location	string	Resource location
plan	object	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
properties	object	Describes the properties of a virtual machine scale set virtual machine.
resources	array	The virtual machine child extension resources.
sku	object	Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.
tags	object	Resource tags
type	string	Resource type
zones	array	The virtual machine zones.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Gets a virtual machine from a VM scale set.
get_instance_view	SELECT	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Gets the status of a virtual machine from a VM scale set.
list	SELECT	resourceGroupName, subscriptionId, virtualMachineScaleSetName	Gets a list of all virtual machines in a VM scale sets.
delete	DELETE	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Deletes a virtual machine from a VM scale set.
update	REPLACE	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Updates a virtual machine of a VM scale set.
approve_rolling_upgrade	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.
attach_detach_data_disks	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Attach and detach data disks to/from a virtual machine in a VM scale set.
deallocate	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.
perform_maintenance	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Performs maintenance on a virtual machine in a VM scale set.
power_off	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.
redeploy	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.
reimage	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.
reimage_all	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.
restart	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Restarts a virtual machine in a VM scale set.
retrieve_boot_diagnostics_data	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.
run_command	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName, data__commandId	Run command on a virtual machine in a VM scale set.
simulate_eviction	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	The operation to simulate the eviction of spot virtual machine in a VM scale set.
start	EXEC	instanceId, resourceGroupName, subscriptionId, vmScaleSetName	Starts a virtual machine in a VM scale set.

SELECT examples

Gets a virtual machine from a VM scale set.

vw_virtual_machine_scale_set_vms

SELECT
id,
name,
additional_capabilities,
availability_set,
diagnostics_profile,
etag,
hardware_profile,
identity,
instanceId,
instance_id,
instance_view,
latest_model_applied,
license_type,
location,
model_definition_applied,
network_profile,
network_profile_configuration,
os_profile,
plan,
protection_policy,
provisioning_state,
resourceGroupName,
resources,
security_profile,
sku,
storage_profile,
subscriptionId,
tags,
time_created,
type,
user_data,
virtualMachineScaleSetName,
vmScaleSetName,
vm_id,
zones
FROM azure.compute.vw_virtual_machine_scale_set_vms
WHERE instanceId = '{{ instanceId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vmScaleSetName = '{{ vmScaleSetName }}';

virtual_machine_scale_set_vms

SELECT
id,
name,
etag,
identity,
instanceId,
location,
plan,
properties,
resources,
sku,
tags,
type,
zones
FROM azure.compute.virtual_machine_scale_set_vms
WHERE instanceId = '{{ instanceId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vmScaleSetName = '{{ vmScaleSetName }}';

REPLACE example

Replaces all fields in the specified virtual_machine_scale_set_vms resource.

/*+ update */
REPLACE azure.compute.virtual_machine_scale_set_vms
SET 
properties = '{{ properties }}',
plan = '{{ plan }}',
identity = '{{ identity }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE 
instanceId = '{{ instanceId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vmScaleSetName = '{{ vmScaleSetName }}';

DELETE example

Deletes the specified virtual_machine_scale_set_vms resource.

/*+ delete */
DELETE FROM azure.compute.virtual_machine_scale_set_vms
WHERE instanceId = '{{ instanceId }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vmScaleSetName = '{{ vmScaleSetName }}';