azure_rm_sqlserver

Manage SQL Server instance

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_sqlserver

Synopsis

Manage SQL Server instance

Parameters

Name	Type	Required	Default	Description
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
admin_password	string			Password of the SQL administrator account for server (required for server creation).
admin_username	string			Username of the SQL administrator account for server. Once created it cannot be changed.
administrators	dict			The Azure Active Directory identity of the server.
api_profile	string		`latest`	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.
append_tags	bool		`true`	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		`auto`	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.
cert_validation_mode	string			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.
change_admin_password	bool		`false`	Whether or not the I(admin_password) should be updated for an existing server. If C(true), the password is the only value which will be updated.
client_id	string			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.
cloud_environment	string		`AzureCloud`	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.
disable_instance_discovery	bool		`false`	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.
identity	raw			Specifies the managed identity to be used with SqlServer.
If a string, the Managed identity type is based on the name.
Possible values include C(SystemAssigned) and C(None).
If a dict with the keys I(type), I(user_assigned_identities)
Possible values for I(type) include C(SystemAssigned, C(UserAssigned), C(SystemAssigned, UserAssigned), and C(None).
Possible values for I(user_assigned_identities) include a dict with I(id) and I(append).
Possible values for I(id) is a list of user assigned identities ID’s
Possible values for I(append) is a boolean of True to append identities or False to overwrite with new I(id)’s.
The string format is (deprecated) and the new dict format should be used going forward.
location	string			Resource location.
log_mode	string			Parent argument.
log_path	string			Parent argument.
minimal_tls_version	string			Require clients to use a specified TLS version.
name	string	yes		The name of the server.
oidc_token	string			Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
This token is exchanged with Azure AD using OIDC federated identity.
Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.
Can also be set via the C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
The file must contain only raw token.
This method is commonly used in platforms that materialize OIDC tokens as files
Can also be set via the C(AZURE_FEDERATED_TOKEN_FILE) environment variable.
password	string			Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
primary_user_assigned_identity_id	string			Specifies the primary User Assigned Identity to use.
This is required if you are using Managed Identity type of UserAssigned
profile	string			Security profile found in ~/.azure/credentials file.
public_network_access	string			Whether or not public endpoint access is allowed for the server.
resource_group	string	yes		The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
restrict_outbound_network_access	string			Whether or not to restrict outbound network access for this server.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
state	string		`present`	State of the SQL server. Use C(present) to create or update a server and use C(absent) to delete a server.
subscription_id	string			Your Azure subscription Id.
tags	dict			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			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.
version	string			The version of the server. For example C(12.0).
x509_certificate_path	string			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.

Example

yaml

- name: Create (or update) SQL Server
  azure.azcollection.azure_rm_sqlserver:
    resource_group: myResourceGroup
    name: server_name
    location: westus
    admin_username: mylogin
    admin_password: "{{ password }}"

- name: Change SQL Server admin password
  azure.azcollection.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.azcollection.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