azure_rm_sqlmanagedinstance

Manage SQL managed instances

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_sqlmanagedinstance

Synopsis

Manage SQL managed instances

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.
administrator_login	string			Administrator username for the managed instance.
Can only be specified when the managed instance is being created (and is required for creation).
administrator_login_password	string			The administrator login password (required for managed instance creation).
administrators	string			The Azure Active Directory administrator 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.
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.
collation	string			Collation of the managed instance.
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.
dns_zone	string			The Dns Zone that the managed instance is in.
dns_zone_partner	string			The resource ID of another managed instance whose DNS zone this managed instance will share after creation.
identity	dict			Identity for the Object
instance_pool_id	string			The ID of the instance pool this managed server belongs to.
key_id	string			A CMK URI of the key to use for encryption.
license_type	string			The license type.
Possible values are C(LicenseIncluded) and C(BasePrice).
Discounted AHB price for bringing your own SQL licenses.
Regular price inclusive of a new SQL license.
location	string			The location of the sql managed instance.
log_mode	string			Parent argument.
log_path	string			Parent argument.
maintenance_configuration_id	string			Specifies maintenance configuration ID to apply to this managed instance.
managed_instance_create_mode	string			Specifies the mode of database creation.
minimal_tls_version	string			Minimal TLS version. Allowed values C(None), C(1.0), C(1.1), C(1.2).
name	string	yes		The name of the sql managed instance.
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			The resource id of a user assigned identity to be used by default.
private_endpoint_connections	list			List of private endpoint connections on a managed instance.
profile	string			Security profile found in ~/.azure/credentials file.
proxy_override	string			Connection type used for connecting to the instance.
public_data_endpoint_enabled	bool			Whether or not the public data endpoint is enabled.
resource_group	string	yes		The name of the resource group.
restore_point_in_time	string			Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
sku	dict			An ARM Resource SKU.
source_managed_instance_id	string			The resource identifier of the source managed instance associated with create operation of this instance.
state	string		`present`	State of the sql managed instance.
Use C(present) to create or update a automation runbook and use C(absent) to delete.
storage_account_type	string			The storage account type used to store backups for this instance.
storage_size_in_gb	int			Storage size in GB.
Minimum value is C(32). Maximum value is C(8192).
Increments of 32 GB allowed only.
subnet_id	string			Subnet resource ID for the managed instance.
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.
timezone_id	string			ID of the timezone.
Allowed values are timezones supported by Windows.
Windows keeps details on supported timezones.
v_cores	int			The number of vCores.
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.
zone_redundant	bool			Whether or not the multi-az is enabled.

Example

yaml

- name: Create sql managed instance
  azure.azcollection.azure_rm_sqlmanagedinstance:
    resource_group: "{{ resource_group }}"
    name: testmanagedinstance
    subnet_id: subnet_id
    sku:
      name: GP_Gen5
      tier: GeneralPurpose
      family: Gen5
      capacity: 5
    identity:
      type: SystemAssigned
    administrator_login: azureuser
    administrator_login_password: "{{ password }}"
    storage_size_in_gb: 256
    v_cores: 8

- name: Delete sql managed instance
  azure.azcollection.azure_rm_sqlmanagedinstance:
    resource_group: "{{ resource_group }}"
    name: testmanagedinstance
    state: absent