elastic_pools

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

Overview

Name	elastic_pools
Type	Resource
Id	azure.sql.elastic_pools

Fields

vw_elastic_pools

Name	Datatype	Description
availability_zone	text	field from the properties object
creation_date	text	field from the properties object
elasticPoolName	text	field from the properties object
high_availability_replica_count	text	field from the properties object
kind	text	Kind of elastic pool. This is metadata used for the Azure portal experience.
license_type	text	field from the properties object
location	text	Resource location.
maintenance_configuration_id	text	field from the properties object
max_size_bytes	text	field from the properties object
min_capacity	text	field from the properties object
per_database_settings	text	field from the properties object
preferred_enclave_type	text	field from the properties object
resourceGroupName	text	field from the properties object
serverName	text	field from the properties object
sku	text	An ARM Resource SKU.
state	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
zone_redundant	text	field from the properties object

elastic_pools

Name	Datatype	Description
kind	string	Kind of elastic pool. This is metadata used for the Azure portal experience.
location	string	Resource location.
properties	object	Properties of an elastic pool
sku	object	An ARM Resource SKU.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	elasticPoolName, resourceGroupName, serverName, subscriptionId	Gets an elastic pool.
list_by_server	SELECT	resourceGroupName, serverName, subscriptionId	Gets all elastic pools in a server.
create_or_update	INSERT	elasticPoolName, resourceGroupName, serverName, subscriptionId, data__location	Creates or updates an elastic pool.
delete	DELETE	elasticPoolName, resourceGroupName, serverName, subscriptionId	Deletes an elastic pool.
update	UPDATE	elasticPoolName, resourceGroupName, serverName, subscriptionId	Updates an elastic pool.
failover	EXEC	elasticPoolName, resourceGroupName, serverName, subscriptionId	Failovers an elastic pool.

SELECT examples

Gets all elastic pools in a server.

vw_elastic_pools

SELECT
availability_zone,
creation_date,
elasticPoolName,
high_availability_replica_count,
kind,
license_type,
location,
maintenance_configuration_id,
max_size_bytes,
min_capacity,
per_database_settings,
preferred_enclave_type,
resourceGroupName,
serverName,
sku,
state,
subscriptionId,
tags,
zone_redundant
FROM azure.sql.vw_elastic_pools
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';

elastic_pools

SELECT
kind,
location,
properties,
sku,
tags
FROM azure.sql.elastic_pools
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.sql.elastic_pools (
elasticPoolName,
resourceGroupName,
serverName,
subscriptionId,
data__location,
location,
tags,
sku,
properties
)
SELECT 
'{{ elasticPoolName }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ 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: kind
      value: string
    - name: properties
      value:
        - name: state
          value: string
        - name: creationDate
          value: string
        - name: maxSizeBytes
          value: integer
        - name: minCapacity
          value: number
        - name: perDatabaseSettings
          value:
            - name: minCapacity
              value: number
            - name: maxCapacity
              value: number
        - name: zoneRedundant
          value: boolean
        - name: licenseType
          value: string
        - name: maintenanceConfigurationId
          value: string
        - name: highAvailabilityReplicaCount
          value: integer
        - name: preferredEnclaveType
          value: string
        - name: availabilityZone
          value: string

UPDATE example

Updates a elastic_pools resource.

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

DELETE example

Deletes the specified elastic_pools resource.

/*+ delete */
DELETE FROM azure.sql.elastic_pools
WHERE elasticPoolName = '{{ elasticPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';