standby_virtual_machines

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

Overview

Name	standby_virtual_machines
Type	Resource
Id	azure.standby_pool.standby_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.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", and "Deleting". (Succeeded, Failed, Canceled, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachineResourceId	string	Resource id of the virtual machine. Required.

list_by_standby_virtual_machine_pool_resource

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.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", and "Deleting". (Succeeded, Failed, Canceled, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachineResourceId	string	Resource id of the virtual machine. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, standby_virtual_machine_pool_name, standby_virtual_machine_name, subscription_id		Get a StandbyVirtualMachineResource.
list_by_standby_virtual_machine_pool_resource	select	resource_group_name, standby_virtual_machine_pool_name, subscription_id		List StandbyVirtualMachineResource resources by StandbyVirtualMachinePoolResource.

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.
standby_virtual_machine_name	string	Name of the standby virtual machine. Required.
standby_virtual_machine_pool_name	string	Name of the standby virtual machine pool. Required.
subscription_id	string

SELECT examples

get

Get a StandbyVirtualMachineResource.

SELECT
id,
name,
provisioningState,
systemData,
type,
virtualMachineResourceId
FROM azure.standby_pool.standby_virtual_machines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND standby_virtual_machine_pool_name = '{{ standby_virtual_machine_pool_name }}' -- required
AND standby_virtual_machine_name = '{{ standby_virtual_machine_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_standby_virtual_machine_pool_resource

List StandbyVirtualMachineResource resources by StandbyVirtualMachinePoolResource.

SELECT
id,
name,
provisioningState,
systemData,
type,
virtualMachineResourceId
FROM azure.standby_pool.standby_virtual_machines
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND standby_virtual_machine_pool_name = '{{ standby_virtual_machine_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;