azure.azcollection.azure_rm_sqlserver module – Manage SQL 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_sqlserver.
New in azure.azcollection 0.1.2
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
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 |
|---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Password of the SQL administrator account for server (required for server creation). |
|
Username of the SQL administrator account for server. Once created it cannot be changed. |
|
The Azure Active Directory identity of the server. |
|
Type of the Azure AD administrator. Default: |
|
Azure AD only authentication enabled. Choices:
|
|
Login name of the Azure AD administrator. |
|
Principal Type of the Azure AD administrator. Choices:
|
|
SID (object ID) of the Azure AD administrator. |
|
Tenant ID of the Azure AD administrator. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
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:
|
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Whether or not the admin_password should be updated for an existing server. If Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
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 Choices:
|
|
Specifies the managed identity to be used with SqlServer. If a string, the Managed identity type is based on the name. Possible values include If a dict with the keys type, user_assigned_identities Possible values for type include Possible values for user_assigned_identities include a dict with id and append. Possible values for id is a list of user assigned identities ID’s Possible values for append is a boolean of True to append identities or False to overwrite with new id‘s. The string format is (deprecated) and the new dict format should be used going forward. |
|
Resource location. |
|
Parent argument. |
|
Parent argument. |
|
Require clients to use a specified TLS version. Choices:
|
|
The name of the server. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Specifies the primary User Assigned Identity to use. This is required if you are using Managed Identity type of UserAssigned |
|
Security profile found in ~/.azure/credentials file. |
|
Whether or not public endpoint access is allowed for the server. Choices:
|
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
|
Whether or not to restrict outbound network access for this server. Choices:
|
|
Azure client secret. Use when authenticating with a Service Principal. |
|
State of the SQL server. Use Choices:
|
|
Your Azure subscription Id. |
|
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. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
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. |
|
The version of the server. For example |
|
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 logincommand.
Examples
- name: Create (or update) SQL Server
azure_rm_sqlserver:
resource_group: myResourceGroup
name: server_name
location: westus
admin_username: mylogin
admin_password: "{{ password }}"
- name: Change SQL Server admin password
azure_rm_sqlserver:
resource_group: myResourceGroup
name: server_name
location: westus
admin_password: "{{ password }}"
change_admin_password: true
- name: Create SQL Server with Azure Active Directory admin
azure_rm_sqlserver:
resource_group: myResourceGroup
name: server_name
location: westus
admin_username: mylogin
admin_password: "{{ password }}"
administrators:
principal_type: Group
login: MySqlAdminGroup
sid: "{{ MySqlAdminGroup.object_id }}"
tenant_id: "{{ my_tenant_id }}"
azure_ad_only_authentication: false
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The fully qualified domain name of the server. Returned: always Sample: |
|
Resource ID. Returned: always Sample: |
|
The state of the server. Returned: always Sample: |
|
The version of the server. Returned: always Sample: |