pools

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

Overview

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

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
poolName	string	Pool Object
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get a Pool

SELECT
location,
properties,
tags
FROM azure.container_storage.pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND poolName = '{{ poolName }}' -- required
;

list_by_resource_group

List Pool resources by resource group

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

list_by_subscription

List Pool resources by subscription ID

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

INSERT examples

create_or_update

Create a Pool

INSERT INTO azure.container_storage.pools (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
poolName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ poolName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: pools
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the pools resource.
    - name: poolName
      value: string
      description: Required parameter for the 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 Pool

UPDATE azure.container_storage.pools
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND poolName = '{{ poolName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete a Pool

DELETE FROM azure.container_storage.pools
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND poolName = '{{ poolName }}' --required
;