instance_pools

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

Overview

Name	instance_pools
Type	Resource
Id	azure.sql.instance_pools

Fields

vw_instance_pools

Name	Datatype	Description
dns_zone	text	field from the properties object
instancePoolName	text	field from the properties object
license_type	text	field from the properties object
location	text	Resource location.
maintenance_configuration_id	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	An ARM Resource SKU.
subnet_id	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
v_cores	text	field from the properties object

instance_pools

Name	Datatype	Description
location	string	Resource location.
properties	object	Properties of an instance pool.
sku	object	An ARM Resource SKU.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	instancePoolName, resourceGroupName, subscriptionId	Gets an instance pool.
list	SELECT	subscriptionId	Gets a list of all instance pools in the subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets a list of instance pools in the resource group
create_or_update	INSERT	instancePoolName, resourceGroupName, subscriptionId, data__location	Creates or updates an instance pool.
delete	DELETE	instancePoolName, resourceGroupName, subscriptionId	Deletes an instance pool
update	UPDATE	instancePoolName, resourceGroupName, subscriptionId	Updates an instance pool.

SELECT examples

Gets a list of all instance pools in the subscription.

vw_instance_pools

SELECT
dns_zone,
instancePoolName,
license_type,
location,
maintenance_configuration_id,
resourceGroupName,
sku,
subnet_id,
subscriptionId,
tags,
v_cores
FROM azure.sql.vw_instance_pools
WHERE subscriptionId = '{{ subscriptionId }}';

instance_pools

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

INSERT example

Use the following StackQL query and manifest file to create a new instance_pools resource.

All Properties

/*+ create */
INSERT INTO azure.sql.instance_pools (
instancePoolName,
resourceGroupName,
subscriptionId,
data__location,
location,
tags,
sku,
properties
)
SELECT 
'{{ instancePoolName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer
    - name: properties
      value:
        - name: subnetId
          value: string
        - name: vCores
          value: integer
        - name: licenseType
          value: string
        - name: dnsZone
          value: string
        - name: maintenanceConfigurationId
          value: string

UPDATE example

Updates a instance_pools resource.

/*+ update */
UPDATE azure.sql.instance_pools
SET 
sku = '{{ sku }}',
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
instancePoolName = '{{ instancePoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified instance_pools resource.

/*+ delete */
DELETE FROM azure.sql.instance_pools
WHERE instancePoolName = '{{ instancePoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';