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

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, standbyVirtualMachinePoolName		Get a StandbyVirtualMachinePoolResource
list_by_resource_group	select	subscriptionId, resourceGroupName		List StandbyVirtualMachinePoolResource resources by resource group
list_by_subscription	select	subscriptionId		List StandbyVirtualMachinePoolResource resources by subscription ID
create_or_update	insert	subscriptionId, resourceGroupName, standbyVirtualMachinePoolName		Create a StandbyVirtualMachinePoolResource
update	update	subscriptionId, resourceGroupName, standbyVirtualMachinePoolName		Update a StandbyVirtualMachinePoolResource
delete	delete	subscriptionId, resourceGroupName, standbyVirtualMachinePoolName		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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
standbyVirtualMachinePoolName	string	Name of the standby virtual machine pool
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a StandbyVirtualMachinePoolResource

SELECT
location,
properties,
tags
FROM azure.standby_pools.standby_virtual_machine_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND standbyVirtualMachinePoolName = '{{ standbyVirtualMachinePoolName }}' -- required
;

list_by_resource_group

List StandbyVirtualMachinePoolResource resources by resource group

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

list_by_subscription

List StandbyVirtualMachinePoolResource resources by subscription ID

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

INSERT examples

create_or_update

Create a StandbyVirtualMachinePoolResource

INSERT INTO azure.standby_pools.standby_virtual_machine_pools (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
standbyVirtualMachinePoolName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ standbyVirtualMachinePoolName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: standby_virtual_machine_pools
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the standby_virtual_machine_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the standby_virtual_machine_pools resource.
    - name: standbyVirtualMachinePoolName
      value: string
      description: Required parameter for the standby_virtual_machine_pools resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a StandbyVirtualMachinePoolResource

UPDATE azure.standby_pools.standby_virtual_machine_pools
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND standbyVirtualMachinePoolName = '{{ standbyVirtualMachinePoolName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete a StandbyVirtualMachinePoolResource

DELETE FROM azure.standby_pools.standby_virtual_machine_pools
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND standbyVirtualMachinePoolName = '{{ standbyVirtualMachinePoolName }}' --required
;