standby_virtual_machine_pools

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

Overview

Name	standby_virtual_machine_pools
Type	Resource
Id	azure.standby_pool.standby_virtual_machine_pools

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.
attachedVirtualMachineScaleSetId	string	Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticityProfile	object	Specifies the elasticity profile of the standby virtual machine pools.
location	string	The geo-location where the resource lives. Required.
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.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachineState	string	Specifies the desired state of virtual machines in the pool. Required. Known values are: "Running", "Deallocated", and "Hibernated". (Running, Deallocated, Hibernated)

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.
attachedVirtualMachineScaleSetId	string	Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticityProfile	object	Specifies the elasticity profile of the standby virtual machine pools.
location	string	The geo-location where the resource lives. Required.
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.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachineState	string	Specifies the desired state of virtual machines in the pool. Required. Known values are: "Running", "Deallocated", and "Hibernated". (Running, Deallocated, Hibernated)

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.
attachedVirtualMachineScaleSetId	string	Specifies the fully qualified resource ID of a virtual machine scale set the pool is attached to.
elasticityProfile	object	Specifies the elasticity profile of the standby virtual machine pools.
location	string	The geo-location where the resource lives. Required.
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.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachineState	string	Specifies the desired state of virtual machines in the pool. Required. Known values are: "Running", "Deallocated", and "Hibernated". (Running, Deallocated, Hibernated)

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, subscription_id		Get a StandbyVirtualMachinePoolResource.
list_by_resource_group	select	resource_group_name, subscription_id		List StandbyVirtualMachinePoolResource resources by resource group.
list_by_subscription	select	subscription_id		List StandbyVirtualMachinePoolResource resources by subscription ID.
create_or_update	insert	resource_group_name, standby_virtual_machine_pool_name, subscription_id, location		Create a StandbyVirtualMachinePoolResource.
update	update	resource_group_name, standby_virtual_machine_pool_name, subscription_id		Update a StandbyVirtualMachinePoolResource.
create_or_update	replace	resource_group_name, standby_virtual_machine_pool_name, subscription_id, location		Create a StandbyVirtualMachinePoolResource.
delete	delete	resource_group_name, standby_virtual_machine_pool_name, subscription_id		Delete a 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_pool_name	string	Name of the standby virtual machine pool. Required.
subscription_id	string

SELECT examples

get

Get a StandbyVirtualMachinePoolResource.

SELECT
id,
name,
attachedVirtualMachineScaleSetId,
elasticityProfile,
location,
provisioningState,
systemData,
tags,
type,
virtualMachineState
FROM azure.standby_pool.standby_virtual_machine_pools
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
;

list_by_resource_group

List StandbyVirtualMachinePoolResource resources by resource group.

SELECT
id,
name,
attachedVirtualMachineScaleSetId,
elasticityProfile,
location,
provisioningState,
systemData,
tags,
type,
virtualMachineState
FROM azure.standby_pool.standby_virtual_machine_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List StandbyVirtualMachinePoolResource resources by subscription ID.

SELECT
id,
name,
attachedVirtualMachineScaleSetId,
elasticityProfile,
location,
provisioningState,
systemData,
tags,
type,
virtualMachineState
FROM azure.standby_pool.standby_virtual_machine_pools
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a StandbyVirtualMachinePoolResource.

INSERT INTO azure.standby_pool.standby_virtual_machine_pools (
tags,
location,
properties,
resource_group_name,
standby_virtual_machine_pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ standby_virtual_machine_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: standby_virtual_machine_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the standby_virtual_machine_pools resource.
  - name: standby_virtual_machine_pool_name
    value: "{{ standby_virtual_machine_pool_name }}"
    description: Required parameter for the standby_virtual_machine_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the standby_virtual_machine_pools 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 resource-specific properties for this resource.
    value:
      elasticityProfile:
        maxReadyCapacity: {{ maxReadyCapacity }}
        minReadyCapacity: {{ minReadyCapacity }}
        postProvisioningDelay: "{{ postProvisioningDelay }}"
        dynamicSizing:
          enabled: {{ enabled }}
      virtualMachineState: "{{ virtualMachineState }}"
      attachedVirtualMachineScaleSetId: "{{ attachedVirtualMachineScaleSetId }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a StandbyVirtualMachinePoolResource.

UPDATE azure.standby_pool.standby_virtual_machine_pools
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
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
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a StandbyVirtualMachinePoolResource.

REPLACE azure.standby_pool.standby_virtual_machine_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
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
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a StandbyVirtualMachinePoolResource.

DELETE FROM azure.standby_pool.standby_virtual_machine_pools
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
;