azure / azure.azcollection / 2.3.0 / module / azure_rm_sqlserver Manage SQL Server instance | "added in version" 0.1.2 of azure.azcollection" Authors: Zim Kalinowski (@zikalino)azure.azcollection.azure_rm_sqlserver (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Create, update and delete instance of SQL Server.
- name: Create (or update) SQL Server azure_rm_sqlserver: resource_group: myResourceGroup name: server_name location: westus admin_username: mylogin admin_password: Testpasswordxyz12!
- name: Change SQL Server admin password azure_rm_sqlserver: resource_group: myResourceGroup name: server_name location: westus admin_password: NewPasswordx123! 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: Testpasswordxyz12! administrators: principal_type: Group login: MySqlAdminGroup sid: "{{ MySqlAdminGroup.object_id }}" tenant_id: "{{ my_tenant_id }}" azure_ad_only_authentication: false
name: description: - The name of the server. required: true type: str tags: description: - 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. type: dict state: choices: - absent - present default: present description: - State of the SQL server. Use C(present) to create or update a server and use C(absent) to delete a server. type: str secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str version: description: - The version of the server. For example C(12.0). type: str identity: description: - The identity type. Set this to C(SystemAssigned) in order to automatically create and assign an Azure Active Directory principal for the resource. - Possible values include C(SystemAssigned). type: str location: description: - Resource location. type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - 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. type: str thumbprint: description: - 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. type: str version_added: 1.14.0 version_added_collection: azure.azcollection api_profile: default: latest description: - 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. type: str version_added: 0.0.1 version_added_collection: azure.azcollection append_tags: default: true description: - 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. type: bool auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - 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. type: str version_added: 0.0.1 version_added_collection: azure.azcollection admin_password: description: - Password of the SQL administrator account for server (required for server creation). type: str admin_username: description: - Username of the SQL administrator account for server. Once created it cannot be changed. type: str administrators: description: - The Azure Active Directory identity of the server. suboptions: administrator_type: default: ActiveDirectory description: - Type of the Azure AD administrator. type: str azure_ad_only_authentication: description: - Azure AD only authentication enabled. type: bool login: description: - Login name of the Azure AD administrator. type: str principal_type: choices: - User - Group - Application description: - Principal Type of the Azure AD administrator. type: str sid: description: - SID (object ID) of the Azure AD administrator. type: str tenant_id: description: - Tenant ID of the Azure AD administrator. type: str type: dict version_added: 1.11.0 version_added_collection: azure.azcollection resource_group: description: - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. required: true type: str subscription_id: description: - Your Azure subscription Id. type: str cloud_environment: default: AzureCloud description: - 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. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection minimal_tls_version: choices: - '1.0' - '1.1' - '1.2' description: - Require clients to use a specified TLS version. type: str version_added: 1.11.0 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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. type: str version_added: 0.0.1 version_added_collection: azure.azcollection change_admin_password: default: false description: - 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. type: bool version_added: 1.11.0 version_added_collection: azure.azcollection public_network_access: choices: - Enabled - Disabled description: - Whether or not public endpoint access is allowed for the server. type: str version_added: 1.11.0 version_added_collection: azure.azcollection x509_certificate_path: description: - 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. type: path version_added: 1.14.0 version_added_collection: azure.azcollection disable_instance_discovery: default: false description: - 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. type: bool version_added: 2.3.0 version_added_collection: azure.azcollection restrict_outbound_network_access: choices: - Enabled - Disabled description: - Whether or not to restrict outbound network access for this server. type: str version_added: 1.11.0 version_added_collection: azure.azcollection
fully_qualified_domain_name: description: - The fully qualified domain name of the server. returned: always sample: sqlcrudtest-4645.database.windows.net type: str id: description: - Resource ID. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-4645 type: str state: description: - The state of the server. returned: always sample: state type: str version: description: - The version of the server. returned: always sample: 12.0 type: str