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_pool.standby_container_group_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.
containerGroupProperties	object	Specifies container group properties of standby container group pools. Required.
elasticityProfile	object	Specifies elasticity profile of standby container group pools. Required.
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".
zones	array	Specifies zones of standby container group pools.

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.
containerGroupProperties	object	Specifies container group properties of standby container group pools. Required.
elasticityProfile	object	Specifies elasticity profile of standby container group pools. Required.
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".
zones	array	Specifies zones of standby container group pools.

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.
containerGroupProperties	object	Specifies container group properties of standby container group pools. Required.
elasticityProfile	object	Specifies elasticity profile of standby container group pools. Required.
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".
zones	array	Specifies zones of standby container group pools.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, standby_container_group_pool_name, subscription_id		Get a StandbyContainerGroupPoolResource.
list_by_resource_group	select	resource_group_name, subscription_id		List StandbyContainerGroupPoolResource resources by resource group.
list_by_subscription	select	subscription_id		List StandbyContainerGroupPoolResource resources by subscription ID.
create_or_update	insert	resource_group_name, standby_container_group_pool_name, subscription_id, location		Create a StandbyContainerGroupPoolResource.
update	update	resource_group_name, standby_container_group_pool_name, subscription_id		Update a StandbyContainerGroupPoolResource.
create_or_update	replace	resource_group_name, standby_container_group_pool_name, subscription_id, location		Create a StandbyContainerGroupPoolResource.
delete	delete	resource_group_name, standby_container_group_pool_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
standby_container_group_pool_name	string	Name of the standby container group pool. Required.
subscription_id	string

SELECT examples

get

Get a StandbyContainerGroupPoolResource.

SELECT
id,
name,
containerGroupProperties,
elasticityProfile,
location,
provisioningState,
systemData,
tags,
type,
zones
FROM azure.standby_pool.standby_container_group_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND standby_container_group_pool_name = '{{ standby_container_group_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List StandbyContainerGroupPoolResource resources by resource group.

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

list_by_subscription

List StandbyContainerGroupPoolResource resources by subscription ID.

SELECT
id,
name,
containerGroupProperties,
elasticityProfile,
location,
provisioningState,
systemData,
tags,
type,
zones
FROM azure.standby_pool.standby_container_group_pools
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a StandbyContainerGroupPoolResource.

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

Manifest

# Description fields are for documentation purposes
- name: standby_container_group_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the standby_container_group_pools resource.
  - name: standby_container_group_pool_name
    value: "{{ standby_container_group_pool_name }}"
    description: Required parameter for the standby_container_group_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the standby_container_group_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 }}
        refillPolicy: "{{ refillPolicy }}"
        dynamicSizing:
          enabled: {{ enabled }}
      containerGroupProperties:
        containerGroupProfile:
          id: "{{ id }}"
          revision: {{ revision }}
        subnetIds:
          - id: "{{ id }}"
      zones:
        - "{{ zones }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a StandbyContainerGroupPoolResource.

UPDATE azure.standby_pool.standby_container_group_pools
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND standby_container_group_pool_name = '{{ standby_container_group_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a StandbyContainerGroupPoolResource.

REPLACE azure.standby_pool.standby_container_group_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND standby_container_group_pool_name = '{{ standby_container_group_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 StandbyContainerGroupPoolResource.

DELETE FROM azure.standby_pool.standby_container_group_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND standby_container_group_pool_name = '{{ standby_container_group_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;