instance_pools

Creates, updates, deletes, gets or lists an instance_pools resource.

Overview

Name	instance_pools
Type	Resource
Id	azure.sql.instance_pools

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specified instance pool.

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.
sku	object	An ARM Resource SKU.
tags	object	Resource tags.

list_by_resource_group

Successfully retrieved the list of instance pools.

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.
sku	object	An ARM Resource SKU.
tags	object	Resource tags.

list

Successfully retrieved the list of instance pools in a subscription.

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.
sku	object	An ARM Resource SKU.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, instancePoolName, subscriptionId		Gets an instance pool.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets a list of instance pools in the resource group
list	select	subscriptionId		Gets a list of all instance pools in the subscription.
create_or_update	insert	resourceGroupName, instancePoolName, subscriptionId, data__location		Creates or updates an instance pool.
update	update	resourceGroupName, instancePoolName, subscriptionId		Updates an instance pool.
delete	delete	resourceGroupName, instancePoolName, subscriptionId		Deletes an instance 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
instancePoolName	string	The name of the instance pool to be deleted
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets an instance pool.

SELECT
location,
properties,
sku,
tags
FROM azure.sql.instance_pools
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND instancePoolName = '{{ instancePoolName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Gets a list of instance pools in the resource group

SELECT
location,
properties,
sku,
tags
FROM azure.sql.instance_pools
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets a list of all instance pools in the subscription.

SELECT
location,
properties,
sku,
tags
FROM azure.sql.instance_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an instance pool.

INSERT INTO azure.sql.instance_pools (
data__location,
data__tags,
data__sku,
data__properties,
resourceGroupName,
instancePoolName,
subscriptionId
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ sku }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ instancePoolName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: instance_pools
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the instance_pools resource.
    - name: instancePoolName
      value: string
      description: Required parameter for the instance_pools resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the instance_pools resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: sku
      value: object
      description: |
        An ARM Resource SKU.
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

Updates an instance pool.

UPDATE azure.sql.instance_pools
SET 
data__sku = '{{ sku }}',
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND instancePoolName = '{{ instancePoolName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
sku,
tags;

DELETE examples

delete

Deletes an instance pool

DELETE FROM azure.sql.instance_pools
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND instancePoolName = '{{ instancePoolName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;