azure_rm_sqlserver – Manage SQL Server instance

From Get docs
Ansible/docs/2.8/modules/azure rm sqlserver module


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

string

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

adfs_authority_url

string

added in 2.6

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

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

string

added in 2.5

Default:

"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

boolean

  • no
  • 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

string

added in 2.5

  • auto
  • cli
  • credential_file
  • env
  • msi

Controls the source of the credentials to use for authentication.

If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.

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.

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.

cert_validation_mode

string

added in 2.5

  • ignore
  • validate

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

string

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

cloud_environment

string

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

-

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

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

state

-

  • absent
  • present

Assert the state of the SQL server. Use present to create or update a server and absent to delete 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.

tenant

string

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, 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 Server
  azure_rm_sqlserver:
    resource_group: myResourceGroup
    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

string

always

The fully qualified domain name of the server.


Sample:

sqlcrudtest-4645.database.windows.net

id

string

always

Resource ID.


Sample:

/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-4645

state

string

always

The state of the server.


Sample:

state

version

string

always

The version of the server.


Sample:

12.0




Status

Authors

  • Zim Kalinowski (@zikalino)

Hint

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


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_sqlserver_module.html