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_pools.standby_virtual_machine_pools

Fields

vw_standby_virtual_machine_pools

Name	Datatype	Description
attached_virtual_machine_scale_set_id	text	field from the properties object
elasticity_profile	text	field from the properties object
location	text	The geo-location where the resource lives
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
standbyVirtualMachinePoolName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
virtual_machine_state	text	field from the properties object

standby_virtual_machine_pools

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Details of the StandbyVirtualMachinePool.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, standbyVirtualMachinePoolName, subscriptionId	Get a StandbyVirtualMachinePoolResource
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List StandbyVirtualMachinePoolResource resources by resource group
list_by_subscription	SELECT	subscriptionId	List StandbyVirtualMachinePoolResource resources by subscription ID
create_or_update	INSERT	resourceGroupName, standbyVirtualMachinePoolName, subscriptionId	Create a StandbyVirtualMachinePoolResource
delete	DELETE	resourceGroupName, standbyVirtualMachinePoolName, subscriptionId	Delete a StandbyVirtualMachinePoolResource
update	UPDATE	resourceGroupName, standbyVirtualMachinePoolName, subscriptionId	Update a StandbyVirtualMachinePoolResource

SELECT examples

List StandbyVirtualMachinePoolResource resources by subscription ID

vw_standby_virtual_machine_pools

SELECT
attached_virtual_machine_scale_set_id,
elasticity_profile,
location,
provisioning_state,
resourceGroupName,
standbyVirtualMachinePoolName,
subscriptionId,
tags,
virtual_machine_state
FROM azure.standby_pools.vw_standby_virtual_machine_pools
WHERE subscriptionId = '{{ subscriptionId }}';

standby_virtual_machine_pools

SELECT
location,
properties,
tags
FROM azure.standby_pools.standby_virtual_machine_pools
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new standby_virtual_machine_pools resource.

All Properties

/*+ create */
INSERT INTO azure.standby_pools.standby_virtual_machine_pools (
resourceGroupName,
standbyVirtualMachinePoolName,
subscriptionId,
properties,
tags,
location
)
SELECT 
'{{ resourceGroupName }}',
'{{ standbyVirtualMachinePoolName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: elasticityProfile
          value:
            - name: maxReadyCapacity
              value: integer
            - name: minReadyCapacity
              value: integer
        - name: virtualMachineState
          value: []
        - name: attachedVirtualMachineScaleSetId
          value: string
        - name: provisioningState
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a standby_virtual_machine_pools resource.

/*+ update */
UPDATE azure.standby_pools.standby_virtual_machine_pools
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND standbyVirtualMachinePoolName = '{{ standbyVirtualMachinePoolName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified standby_virtual_machine_pools resource.

/*+ delete */
DELETE FROM azure.standby_pools.standby_virtual_machine_pools
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND standbyVirtualMachinePoolName = '{{ standbyVirtualMachinePoolName }}'
AND subscriptionId = '{{ subscriptionId }}';