standby_container_group_pools

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

Overview

Name	standby_container_group_pools
Type	Resource
Id	azure.standby_pools.standby_container_group_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, standbyContainerGroupPoolName		Get a StandbyContainerGroupPoolResource
list_by_resource_group	select	subscriptionId, resourceGroupName		List StandbyContainerGroupPoolResource resources by resource group
list_by_subscription	select	subscriptionId		List StandbyContainerGroupPoolResource resources by subscription ID
create_or_update	insert	subscriptionId, resourceGroupName, standbyContainerGroupPoolName		Create a StandbyContainerGroupPoolResource
update	update	subscriptionId, resourceGroupName, standbyContainerGroupPoolName		Update a StandbyContainerGroupPoolResource
delete	delete	subscriptionId, resourceGroupName, standbyContainerGroupPoolName		Delete a StandbyContainerGroupPoolResource

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.
standbyContainerGroupPoolName	string	Name of the standby container group pool
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a StandbyContainerGroupPoolResource

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

list_by_resource_group

List StandbyContainerGroupPoolResource resources by resource group

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

list_by_subscription

List StandbyContainerGroupPoolResource resources by subscription ID

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

INSERT examples

create_or_update

Create a StandbyContainerGroupPoolResource

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

Manifest

# Description fields are for documentation purposes
- name: standby_container_group_pools
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the standby_container_group_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the standby_container_group_pools resource.
    - name: standbyContainerGroupPoolName
      value: string
      description: Required parameter for the standby_container_group_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 StandbyContainerGroupPoolResource

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

DELETE examples

delete

Delete a StandbyContainerGroupPoolResource

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