azure.azcollection.azure_rm_sqlelasticpool module – Manage SQL Elastic Pool instance

Note

This module is part of the azure.azcollection collection (version 1.17.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_sqlelasticpool.

New in azure.azcollection 1.14.0

Synopsis

  • Create, update and delete instance of SQL Elastic Pool.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • The host that executes this module must have the azure.azcollection collection installed via galaxy

  • All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection

  • Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter

Comments

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

Default: "latest"

append_tags

boolean

Use to control if tags field is canonical or just appends to existing tags.

When canonical, any tags not found in the tags parameter will be removed from the object’s metadata.

Choices:

  • false

  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.

When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.

The msi was added in Ansible 2.6.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal.

cloud_environment

string

added in azure.azcollection 0.0.1

For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.

Default: "AzureCloud"

license_type

string

The license type to apply for this elastic pool.

Choices:

  • "LicenseIncluded" ← (default)

  • "BasePrice"

location

string

Resource location. If not set, location from the resource group will be used as default.

log_mode

string

Parent argument.

log_path

string

Parent argument.

maintenance_configuration_id

string

Maintenance configuration id assigned to the elastic pool.

max_size_bytes

string

The max size of the elasticpool expressed in bytes.

If not create_mode=default, this value is ignored.

To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities). referred to by operationId:’Capabilities_ListByLocation’.

name

string / required

The name of the elastic pool to be operated on (updated or created).

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

per_elasticpool_settings

dictionary

The per database settings for the elastic pool.

max_capacity

float

The maximum capacity all databases are guaranteed.

min_capacity

float

The minimum capacity all databases are guaranteed.

profile

string

Security profile found in ~/.azure/credentials file.

resource_group

string / required

The name of the resource group that contains the resource.

You can obtain this value from the Azure Resource Manager API or the portal.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

server_name

string / required

The name of the server.

sku

dictionary

The sku of the elastic pool. The Elastic PoolEditions enumeration contains all the valid sku.

capacity

integer

Capacity of the particular SKU.

family

string

If the service has different generations of hardware, for the same SKU, then that can be used here

name

string / required

Name of the elastic pool SKU, typically, a letter + Number code, e.g. P3

size

string

Size of the particular SKU

tier

string

The tier or edition of the particular SKU, e.g. Basic, Premium

state

string

Assert the state of the SQL Elastic Pool. Use present to create or update an SQL Elastic Pool and absent to delete it.

Choices:

  • "absent"

  • "present" ← (default)

subscription_id

string

Your Azure subscription Id.

tags

dictionary

Dictionary of string:string pairs to assign as metadata to the object.

Metadata tags on the object will be updated with any provided values.

To remove tags set append_tags option to false.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.

zone_redundant

boolean

Is this elasticpool is zone redundant? It means the replicas of this elasticpool will be spread across multiple availability zones.

Choices:

  • false ← (default)

  • true

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

  • Authentication is also possible using a service principal or Active Directory user.

  • To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create (or update) SQL Elastic Pool
  azure_rm_elastic_pool:
    resource_group: myResourceGroup
    server_name: sqlcrudtest-5961
    name: testEP
    zone_redundant: False
    sku:
      name: GP_Gen5
      family: Gen5
      capacity: 3
    tags:
      key1: value1

- name: Delete SQL Elastic Pool
  azure_rm_elastic_pool:
    resource_group: myResourceGroup
    server_name: sqlcrudtest-5961
    name: testEP
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

elastic_pool

complex

A list of dictionaries containing facts for SQL Elastic Pool.

Returned: always

id

string

Resource ID.

Returned: always

Sample: "/subscriptions/xxx-xxx/resourceGroups/testrg/providers/Microsoft.Sql/servers/sqlsrvfredsqldb/elasticPools/fedelastic01"

license_type

string

The license type to apply for this elastic pool.

Returned: always

Sample: "LicenseIncluded"

location

string

Resource location.

Returned: always

Sample: "eastus"

maintenance_configuration_id

string

Maintenance configuration id assigned to the elastic pool.

Returned: always

Sample: "/subscriptions/xxx-xxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default"

max_size_bytes

string

The storage limit for the database elastic pool in bytes.

Returned: always

Sample: "34359738368"

name

string

Elastic Pool name.

Returned: always

Sample: "testEP"

per_database_settings

complex

The per database settings for the elastic pool.

Returned: always

max_capacity

float

The maximum capacity any one database can consume.

Returned: always

Sample: 2.0

min_capacity

float

The minimum capacity all databases are guaranteed

Returned: always

Sample: 0.0

sku

complex

The name and tier of the SKU.

Returned: always

capacity

integer

The SKU capacity.

Returned: always

Sample: 2

family

string

If the service has different generations of hardware, for the same SKU, then that can be captured here.

Returned: always

Sample: "Gen5"

name

string

The name of the SKU.

Returned: always

Sample: "GP_Gen5"

size

string

Size of the particular SKU.

Returned: always

tier

string

The SKU tier.

Returned: always

Sample: "GeneralPurpose"

tags

dictionary

Resource tags.

Returned: always

Sample: {"taga": "aaa", "tagb": "bbb"}

zone_redundant

boolean

Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

Returned: always

Sample: true

Authors

  • xuzhang3 (@xuzhang3)

  • Fred Sun (@Fred-sun)