Try SpotterManage SQL Elastic Pool instance
| "added in version" 1.14.0 of azure.azcollection"
Authors: xuzhang3 (@xuzhang3), Fred Sun (@Fred-sun)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Create, update and delete instance of SQL Elastic Pool.
- 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
sku:
description:
- The sku of the elastic pool. The Elastic PoolEditions enumeration contains all the
valid sku.
suboptions:
capacity:
description:
- Capacity of the particular SKU.
type: int
family:
description:
- If the service has different generations of hardware, for the same SKU, then
that can be used here
type: str
name:
description:
- Name of the elastic pool SKU, typically, a letter + Number code, e.g. P3
required: true
type: str
size:
description:
- Size of the particular SKU
type: str
tier:
description:
- The tier or edition of the particular SKU, e.g. Basic, Premium
type: str
type: dict
name:
description:
- The name of the elastic pool to be operated on (updated or created).
required: true
type: str
tags:
description:
- 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.
type: dict
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the SQL Elastic Pool. Use C(present) to create or update an
SQL Elastic Pool and C(absent) to delete it.
type: str
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
location:
description:
- Resource location. If not set, location from the resource group will be used as
default.
type: str
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
append_tags:
default: true
description:
- 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.
type: bool
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
server_name:
description:
- The name of the server.
required: true
type: str
license_type:
choices:
- LicenseIncluded
- BasePrice
default: LicenseIncluded
description:
- The license type to apply for this elastic pool.
type: str
max_size_bytes:
description:
- The max size of the elasticpool expressed in bytes.
- If not I(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'.
type: str
resource_group:
description:
- The name of the resource group that contains the resource.
- You can obtain this value from the Azure Resource Manager API or the portal.
required: true
type: str
zone_redundant:
default: false
description:
- Is this elasticpool is zone redundant? It means the replicas of this elasticpool
will be spread across multiple availability zones.
type: bool
subscription_id:
description:
- Your Azure subscription Id.
type: str
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
cert_validation_mode:
choices:
- ignore
- validate
description:
- 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
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
x509_certificate_path:
description:
- 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.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
per_elasticpool_settings:
description:
- The per database settings for the elastic pool.
suboptions:
max_capacity:
description:
- The maximum capacity all databases are guaranteed.
type: float
min_capacity:
description:
- The minimum capacity all databases are guaranteed.
type: float
type: dict
disable_instance_discovery:
default: false
description:
- Determines whether or not instance discovery is performed when attempting to authenticate.
Setting this to true will completely disable both instance discovery and authority
validation. This functionality is intended for use in scenarios where the metadata
endpoint cannot be reached such as in private clouds or Azure Stack. The process
of instance discovery entails retrieving authority metadata from https://login.microsoft.com/
to validate the authority. By setting this to **True**, the validation of the authority
is disabled. As a result, it is crucial to ensure that the configured authority
host is valid and trustworthy.
- Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
variable.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
maintenance_configuration_id:
description:
- Maintenance configuration id assigned to the elastic pool.
type: str
elastic_pool:
contains:
id:
description:
- Resource ID.
returned: always
sample: /subscriptions/xxx-xxx/resourceGroups/testrg/providers/Microsoft.Sql/servers/sqlsrvfredsqldb/elasticPools/fedelastic01
type: str
license_type:
description:
- The license type to apply for this elastic pool.
returned: always
sample: LicenseIncluded
type: str
location:
description:
- Resource location.
returned: always
sample: eastus
type: str
maintenance_configuration_id:
description:
- Maintenance configuration id assigned to the elastic pool.
returned: always
sample: /subscriptions/xxx-xxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default
type: str
max_size_bytes:
description:
- The storage limit for the database elastic pool in bytes.
returned: always
sample: 34359738368
type: str
name:
description:
- Elastic Pool name.
returned: always
sample: testEP
type: str
per_database_settings:
contains:
max_capacity:
description:
- The maximum capacity any one database can consume.
returned: always
sample: 2.0
type: float
min_capacity:
description:
- The minimum capacity all databases are guaranteed
returned: always
sample: 0.0
type: float
description:
- The per database settings for the elastic pool.
returned: always
type: complex
sku:
contains:
capacity:
description:
- The SKU capacity.
returned: always
sample: 2
type: int
family:
description:
- If the service has different generations of hardware, for the same SKU,
then that can be captured here.
returned: always
sample: Gen5
type: str
name:
description:
- The name of the SKU.
returned: always
sample: GP_Gen5
type: str
size:
description:
- Size of the particular SKU.
returned: always
sample: null
type: str
tier:
description:
- The SKU tier.
returned: always
sample: GeneralPurpose
type: str
description:
- The name and tier of the SKU.
returned: always
type: complex
tags:
description:
- Resource tags.
returned: always
sample:
taga: aaa
tagb: bbb
type: dict
zone_redundant:
description:
- 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
type: bool
description:
- A list of dictionaries containing facts for SQL Elastic Pool.
returned: always
type: complex