Documentation

azure_rm_sqlserver - Manage SQL Server instance

New in version 2.5.

Synopsis

  • Create, update and delete instance of SQL Server

Requirements

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

  • python >= 2.7
  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults Comments
ad_user Default:
None
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
admin_password
The administrator login password (required for server creation).
admin_username
Administrator username for the server. Once created it cannot be changed.
api_profile
(added in 2.5)
    Choices:
  • latest ←
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.
append_tags Default:
yes
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.
auth_source
(added in 2.5)
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
Controls the source of the credentials to use for authentication.
auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.
When set to cli, the credentials will be sources from the default Azure CLI profile.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
cert_validation_mode
(added in 2.5)
    Choices:
  • validate
  • ignore
Default:
None
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.
client_id Default:
None
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
(added in 2.4)
Default:
AzureCloud
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.
identity
The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resour ce. Possible values include: 'SystemAssigned'
location
Resource location.
name
required
The name of the server.
password Default:
None
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile Default:
None
Security profile found in ~/.azure/credentials file.
resource_group
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 Default:
None
Azure client secret. Use when authenticating with a Service Principal.
subscription_id Default:
None
Your Azure subscription Id.
tags Default:
None
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.
tenant Default:
None
Azure tenant ID. Use when authenticating with a Service Principal.
version
The version of the server. For example '12.0'.

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.

Examples

- name: Create (or update) SQL Server
  azure_rm_sqlserver:
    resource_group: resource_group
    name: server_name
    location: westus
    admin_username: mylogin
    admin_password: Testpasswordxyz12!

Return Values

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

Key Returned Description
fully_qualified_domain_name
str
always
The fully qualified domain name of the server.

Sample:
sqlcrudtest-4645.database.windows.net
id
str
always
Resource ID.

Sample:
/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645
state
str
always
The state of the server.

Sample:
state
version
str
always
The version of the server.

Sample:
12.0


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Zim Kalinowski (@zikalino)

Hint

If you notice any issues in this documentation you can edit this document to improve it.