standby_virtual_machine_pool_runtime_views

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

Overview

Name	standby_virtual_machine_pool_runtime_views
Type	Resource
Id	azure.standby_pool.standby_virtual_machine_pool_runtime_views

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.
instanceCountSummary	array	A list containing the counts of virtual machines in each possible power state for each zone if enabled, as known by the StandbyPool resource provider. If zones are not enabled on the attached VMSS, the list will contain a single entry without zone values. Note: any resources in the Running state may still be installing extensions / not fully provisioned. Required.
prediction	object	Displays prediction information of the standby pool.
provisioningState	string	Displays the provisioning state of the standby pool. Known values are: "Succeeded", "Failed", "Canceled", and "Deleting". (Succeeded, Failed, Canceled, Deleting)
status	object	Display status of the standby pool.
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".

list_by_standby_pool

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.
instanceCountSummary	array	A list containing the counts of virtual machines in each possible power state for each zone if enabled, as known by the StandbyPool resource provider. If zones are not enabled on the attached VMSS, the list will contain a single entry without zone values. Note: any resources in the Running state may still be installing extensions / not fully provisioned. Required.
prediction	object	Displays prediction information of the standby pool.
provisioningState	string	Displays the provisioning state of the standby pool. Known values are: "Succeeded", "Failed", "Canceled", and "Deleting". (Succeeded, Failed, Canceled, Deleting)
status	object	Display status of the standby pool.
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".

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, runtime_view, subscription_id		Get a StandbyVirtualMachinePoolRuntimeViewResource.
list_by_standby_pool	select	resource_group_name, standby_virtual_machine_pool_name, subscription_id		List StandbyVirtualMachinePoolRuntimeViewResource 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.
runtime_view	string	The unique identifier for the runtime view. The input string should be the word 'latest', which will get the latest runtime view of the pool, otherwise the request will fail with NotFound exception. Required.
standby_virtual_machine_pool_name	string	Name of the standby virtual machine pool. Required.
subscription_id	string

SELECT examples

get

Get a StandbyVirtualMachinePoolRuntimeViewResource.

SELECT
id,
name,
instanceCountSummary,
prediction,
provisioningState,
status,
systemData,
type
FROM azure.standby_pool.standby_virtual_machine_pool_runtime_views
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND standby_virtual_machine_pool_name = '{{ standby_virtual_machine_pool_name }}' -- required
AND runtime_view = '{{ runtime_view }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_standby_pool

List StandbyVirtualMachinePoolRuntimeViewResource resources by StandbyVirtualMachinePoolResource.

SELECT
id,
name,
instanceCountSummary,
prediction,
provisioningState,
status,
systemData,
type
FROM azure.standby_pool.standby_virtual_machine_pool_runtime_views
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
;