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

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.
dnsZone	string	The Dns Zone that the managed instance pool is in.
licenseType	string	The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). Required. Known values are: "LicenseIncluded" and "BasePrice". (LicenseIncluded, BasePrice)
location	string	The geo-location where the resource lives. Required.
maintenanceConfigurationId	string	Specifies maintenance configuration id to apply to this managed instance.
sku	object	The name and tier of the SKU.
subnetId	string	Resource ID of the subnet to place this instance pool in. Required.
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".
vCores	integer	Count of vCores belonging to this instance pool. Required.

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.
dnsZone	string	The Dns Zone that the managed instance pool is in.
licenseType	string	The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). Required. Known values are: "LicenseIncluded" and "BasePrice". (LicenseIncluded, BasePrice)
location	string	The geo-location where the resource lives. Required.
maintenanceConfigurationId	string	Specifies maintenance configuration id to apply to this managed instance.
sku	object	The name and tier of the SKU.
subnetId	string	Resource ID of the subnet to place this instance pool in. Required.
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".
vCores	integer	Count of vCores belonging to this instance pool. Required.

list

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.
dnsZone	string	The Dns Zone that the managed instance pool is in.
licenseType	string	The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price). Required. Known values are: "LicenseIncluded" and "BasePrice". (LicenseIncluded, BasePrice)
location	string	The geo-location where the resource lives. Required.
maintenanceConfigurationId	string	Specifies maintenance configuration id to apply to this managed instance.
sku	object	The name and tier of the SKU.
subnetId	string	Resource ID of the subnet to place this instance pool in. Required.
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".
vCores	integer	Count of vCores belonging to this instance pool. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, instance_pool_name, subscription_id		Gets an instance pool.
list_by_resource_group	select	resource_group_name, subscription_id		Gets a list of instance pools in the resource group.
list	select	subscription_id		Gets a list of all instance pools in the subscription.
create_or_update	insert	resource_group_name, instance_pool_name, subscription_id, location		Creates or updates an instance pool.
update	update	resource_group_name, instance_pool_name, subscription_id		Updates an instance pool.
create_or_update	replace	resource_group_name, instance_pool_name, subscription_id, location		Creates or updates an instance pool.
delete	delete	resource_group_name, instance_pool_name, subscription_id		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
instance_pool_name	string	The name of the instance pool to be retrieved. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets an instance pool.

SELECT
id,
name,
dnsZone,
licenseType,
location,
maintenanceConfigurationId,
sku,
subnetId,
systemData,
tags,
type,
vCores
FROM azure.sql.instance_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND instance_pool_name = '{{ instance_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of instance pools in the resource group.

SELECT
id,
name,
dnsZone,
licenseType,
location,
maintenanceConfigurationId,
sku,
subnetId,
systemData,
tags,
type,
vCores
FROM azure.sql.instance_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of all instance pools in the subscription.

SELECT
id,
name,
dnsZone,
licenseType,
location,
maintenanceConfigurationId,
sku,
subnetId,
systemData,
tags,
type,
vCores
FROM azure.sql.instance_pools
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an instance pool.

INSERT INTO azure.sql.instance_pools (
tags,
location,
properties,
sku,
resource_group_name,
instance_pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ instance_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: instance_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the instance_pools resource.
  - name: instance_pool_name
    value: "{{ instance_pool_name }}"
    description: Required parameter for the instance_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the instance_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: |
      Resource properties.
    value:
      subnetId: "{{ subnetId }}"
      vCores: {{ vCores }}
      licenseType: "{{ licenseType }}"
      dnsZone: "{{ dnsZone }}"
      maintenanceConfigurationId: "{{ maintenanceConfigurationId }}"
  - name: sku
    description: |
      The name and tier of the SKU.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}

UPDATE examples

update

Updates an instance pool.

UPDATE azure.sql.instance_pools
SET 
sku = '{{ sku }}',
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND instance_pool_name = '{{ instance_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an instance pool.

REPLACE azure.sql.instance_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND instance_pool_name = '{{ instance_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes an instance pool.

DELETE FROM azure.sql.instance_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND instance_pool_name = '{{ instance_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;