azure.azcollection.azure_rm_mysqlflexibleserver module – Manage MySQL Flexible Server instance

Note

This module is part of the azure.azcollection collection (version 3.1.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_mysqlflexibleserver.

New in azure.azcollection 2.7.0

Synopsis

  • Create, update and delete instance of MySQL Flexible Server.

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.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.

administrator_login

string

The administrator’s login name of a server.

Can only be specified when the server is being created (and is required for creation).

administrator_login_password

string

The password of the administrator login.

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"

availability_zone

string

Availability Zone information of the server.

backup

dictionary

Backup related properties of a server.

backup_retention_days

integer

Backup retention days for the server.

geo_redundant_backup

string

Whether or not geo redundant backup is enabled.

Choices:

  • "Enabled"

  • "Disabled"

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 or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

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"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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 AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

  • false ← (default)

  • true

high_availability

dictionary

High availability related properties of a server.

mode

string

High availability mode for a server.

Choices:

  • "Disabled"

  • "ZoneRedundant"

  • "SameZone"

standby_availability_zone

string

Vailability zone of the standby server.

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.

name

string / required

The name of the server.

network

dictionary

Network related properties of a server.

delegated_subnet_resource_id

string

Delegated subnet resource id used to setup vnet for a server.

private_dns_zone_resource_id

string

Private DNS zone resource id.

password

string

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

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.

restore_point_in_time

string

Restore point creation time (ISO8601 format), specifying the time to restore from.

secret

string

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

sku

dictionary

The SKU (pricing tier) of the server.

name

string / required

The name of the sku, e.g. Standard_D32s_v3.

tier

string / required

The tier of the particular SKU,

Choices:

  • "Burstable"

  • "GeneralPurpose"

  • "MemoryOptimized"

source_server_resource_id

string

The source MySQL server id.

state

string

Assert the state of the MySQL Flexible Server. Use present to create or update a server and absent to delete it.

Choices:

  • "absent"

  • "present" ← (default)

status

string

Set the server state.

Choices:

  • "restart"

  • "start"

  • "stop"

  • "failover"

storage

dictionary

Storage Profile properties of a server.

auto_grow

string

Enable Storage Auto Grow or not.

Choices:

  • "Disabled"

  • "Enabled"

iops

integer

Storage IOPS for a server.

storage_size_gb

integer

Max storage size allowed for a server.

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.

version

string

Server version.

Choices:

  • "5.7"

  • "8.0.21"

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.

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 mysql flexible server
  azure_rm_mysqlflexibleserver:
    resource_group: "{{ resource_group }}"
    name: postflexible{{ rpfx }}
    sku:
      name: Standard_D2ds_v4
      tier: GeneralPurpose
    administrator_login: azureuser
    administrator_login_password: Fred@0329
    location: northeurope
    version: 5.7
    storage:
      storage_size_gb: 128
      iops: 500
      auto_grow: Enabled
    high_availability:
      mode: ZoneRedundant
      standby_availability_zone: 3
    backup:
      backup_retention_days: 7
      geo_redundant_backup: Disabled
    availability_zone: 1

Return Values

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

Key

Description

servers

complex

The facts of the flexible servers.

Returned: always

administrator_login_password

string

The administrator’s login name of a server.

Returned: always

Sample: "serveradmin"

availability_zone

string

Availability Zone information of the server.

Returned: always

Sample: "1"

backup

complex

Backup related properties of a server.

Returned: success

backup_retention_days

integer

Backup retention days for the server.

Returned: always

Sample: 7

geo_redundant_backup

string

Whether or not geo redundant backup is enabled.

Returned: always

Sample: "Disabled"

fully_qualified_domain_name

string

The fully qualified domain name of a server.

Returned: always

Sample: "myabdud1223.mys.database.azure.com"

high_availability

complex

High availability related properties of a server.

Returned: always

mode

string

High availability mode for a server.

Returned: always

Sample: "Disabled"

standby_availability_zone

string

Availability zone of the standby server.

Returned: always

Sample: "Availability zone of the standby server."

id

string

Resource ID.

Returned: always

Sample: "/subscriptions/xxxx-xxxx/resourceGroups/testRG/providers/Microsoft.DBforMySQL/flexibleServers/server01"

location

string

The location the resource resides in.

Returned: always

Sample: "eastus"

name

string

Resource name.

Returned: always

Sample: "server01"

network

complex

Network related properties of a server.

Returned: always

delegated_subnet_resource_id

string

Delegated subnet resource id used to setup vnet for a server.

Returned: always

private_dns_zone_resource_id

string

Private DNS zone resource id.

Returned: always

resource_group

string

Resource group name.

Returned: always

Sample: "testRG"

restore_point_in_time

string

Restore point creation time (ISO8601 format), specifying the time to restore from.

Returned: always

sku

complex

The SKU of the server.

Returned: always

name

string

The name of the SKU.

Returned: always

Sample: "Standard_D32s_v3"

tier

string

The tier of the particular SKU.

Returned: always

Sample: "GeneralPurpose"

source_server_resource_id

string

The source MySQL server id.

Returned: always

state

string

A state of a server that is visible to user.

Returned: always

Sample: "Ready"

status

string

Set server state.

Returned: success

Can only return:

  • "restart"

  • "start"

  • "stop"

  • "failover"

storage

complex

Storage related properties of a server.

Returned: always

auto_grow

string

Enable Storage Auto Grow or not.

Returned: always

Sample: "Disabled"

iops

integer

Storage IOPS for a server.

Returned: always

Sample: 684

storage_size_gb

integer

Max storage size allowed for a server.

Returned: always

Sample: 128000

tags

dictionary

Tags assigned to the resource. Dictionary of string:string pairs.

Returned: always

Sample: {"tag1": "abc"}

type

string

The type of the resource.

Returned: always

Sample: "Microsoft.DBforMySQL/flexibleServers"

version

string

Server version.

Returned: always

Sample: "5.7"

Authors

  • xuzhang3 (@xuzhang3)

  • Fred-sun (@Fred-sun)