azure / azure.azcollection / 2.3.0 / module / azure_rm_sqlmanagedinstance Manage SQL managed instances | "added in version" 1.14.0 of azure.azcollection" Authors: xuzhang3 (@xuzhang3), Fred Sun (@Fred-sun)azure.azcollection.azure_rm_sqlmanagedinstance (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, or delete SQL managed instances.
- name: Create sql managed instance 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: Ft@password0329test storage_size_in_gb: 256 v_cores: 8
- name: Delete sql managed instance azure_rm_sqlmanagedinstance: resource_group: "{{ resource_group }}" name: testmanagedinstance state: absent
sku: description: - An ARM Resource SKU. suboptions: capacity: description: - The capacity of the managed instance in integer number of vcores. type: str family: description: - If the service has different generations of hardware, for the same SKU, then that can be captured here. type: str name: description: - The name of the SKU, typically, a letter add Number code. type: str size: description: - Size of the particular SKU. type: str tier: description: - The tier or edition of the particular SKU. type: str type: dict name: description: - The name of the sql managed instance. 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: - present - absent default: present description: - State of the sql managed instance. - Use C(present) to create or update a automation runbook and use C(absent) to delete. type: str key_id: description: - A CMK URI of the key to use for encryption. 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 v_cores: choices: - 8 - 16 - 24 - 32 - 40 - 64 - 80 description: - The number of vCores. type: int dns_zone: description: - The Dns Zone that the managed instance is in. type: str identity: description: - Azure Active Directory identity configuration for a resource. suboptions: principal_id: description: - The Azure Active Directory principal ID. type: str tenant_id: description: - The Azure Active Directory tenant id. type: str type: description: - The identity type. - Set this to C(SystemAssigned) in order to automatically create and assign an Azure Active Directory principal for the resource. type: str user_assigned_identities: description: - The resource ids of the user assigned identities to use. type: str type: dict location: description: - The location of the sql managed instance. 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 collation: description: - Collation of the managed instance. type: str subnet_id: description: - Subnet resource ID for the managed instance. 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 timezone_id: description: - ID of the timezone. - Allowed values are timezones supported by Windows. - Windows keeps details on supported timezones. type: str license_type: choices: - LicenseIncluded - BasePrice description: - 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. type: str administrators: description: - The Azure Active Directory administrator of the server. type: str proxy_override: choices: - Proxy - Redirect - Default description: - Connection type used for connecting to the instance. type: str resource_group: description: - The name of the resource group. required: true type: str zone_redundant: description: - Whether or not the multi-az is enabled. type: bool subscription_id: description: - Your Azure subscription Id. type: str dns_zone_partner: description: - The resource ID of another managed instance whose DNS zone this managed instance will share after creation. type: str instance_pool_id: description: - The ID of the instance pool this managed server belongs to. 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 storage_size_in_gb: description: - Storage size in GB. - Minimum value is C(32). Maximum value is C(8192). - Increments of 32 GB allowed only. type: int administrator_login: description: - Administrator username for the managed instance. - Can only be specified when the managed instance is being created (and is required for creation). type: str minimal_tls_version: choices: - None - '1.0' - '1.1' - '1.2' description: - Minimal TLS version. Allowed values C(None), C(1.0), C(1.1), C(1.2). type: str 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 storage_account_type: description: - The storage account type used to store backups for this instance. type: str restore_point_in_time: description: - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. type: str 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 source_managed_instance_id: description: - The resource identifier of the source managed instance associated with create operation of this instance. type: str administrator_login_password: description: - The administrator login password (required for managed instance creation). type: str maintenance_configuration_id: description: - Specifies maintenance configuration ID to apply to this managed instance. type: str managed_instance_create_mode: description: - Specifies the mode of database creation. type: str private_endpoint_connections: description: - List of private endpoint connections on a managed instance. elements: str type: list public_data_endpoint_enabled: description: - Whether or not the public data endpoint is enabled. type: bool primary_user_assigned_identity_id: description: - The resource id of a user assigned identity to be used by default. type: str
sql_managed_instance: contains: administrator_login: description: - Administrator username for the managed instance. returned: always sample: azureuser type: str administrators: description: - The Azure Active Directory administrator of the server. returned: always sample: null type: str collation: description: - The collation of the SQL managed instance. returned: always sample: SQL_Latin1_General_CP1_CI_AS type: str dns_zone: description: -The Dns Zone that the managed instance is in. returned: always sample: 8a23abba54cd type: str dns_zone_partner: description: - The resource ID of another managed instance whose DNS zone this managed instance will share after creation. returned: always sample: null type: str fully_qualified_domain_name: description: - The fully qualified domain name of the managed instance. returned: always sample: fredsqlinstance.8a23abba54cd.database.windows.net type: str id: description: - Resource ID. returned: always sample: /subscription/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Sql/managedInstances/fredsqlinstance type: str identity: contains: principal_id: description: - The Azure Active Directory principal ID. returned: always sample: 895c-xxx-xxxbe type: str tenant_id: description: - The Azure Active Directory tenant ID. returned: always sample: 72fxxxxx-xxxx-xxxx-xxxx-xxxxxx11db47 type: str type: description: - The identity type. returned: always sample: SystemAssigned type: str user_assigned_identities: description: - The resource ids of the user assigned identities to use. returned: always sample: null type: str description: - Azure Active Directory identity configuration for a resource. returned: always type: complex instance_pool_id: description: - The ID of the instance pool this managed server belongs to. returned: always sample: null type: str key_id: description: - A CMK URI of the key to use for encryption. returned: always sample: null type: str license_type: description: - The license type. returned: always sample: LicenseIncluded type: str location: description: - Resource location. returned: always sample: eastus type: str maintenance_configuration_id: description: - Specifies maintenance configuration ID to apply to this managed instance. returned: always sample: /subscriptions/xxx-xxxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default type: str managed_instance_create_mode: description: - Specifies the mode of database creation. returned: always sample: null type: str minimal_tls_version: description: - Minimal TLS version. Allowed values 'None', '1.0', '1.1', '1.2'. returned: always sample: 1.2 type: str name: description: - SQL managed instance name. returned: always sample: testmanagedinstance type: str primary_user_assigned_identity_id: description: - The resource id of a user assigned identity to be used by default. returned: always sample: null type: str private_endpoint_connections: description: - List of private endpoint connections on a managed instance. returned: always sample: [] type: list provisioning_state: description: - The Status of the SQL managed instance. returned: always sample: Successed type: str proxy_override: description: - Connection type used for connecting to the instance. returned: always sample: Proxy type: str public_data_endpoint_enabled: description: - Whether or not the public data endpoint is enabled. returned: always sample: false type: bool restore_point_in_time: description: - Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. returned: always sample: null type: str sku: contains: capacity: description: - The SKU capacity. returned: always sample: 2 type: int family: description: - If the service has different generations of hardware, for the same SKU, then that can be captured here. returned: always sample: Gen5 type: str name: description: - The name of the SKU. returned: always sample: BC_Gen4_2 type: str size: description: - Size of the particular SKU. returned: always sample: null type: str tier: description: - The SKU tier. returned: always sample: BusinessCritical type: str description: - An ARM Resource SKU. returned: always type: complex source_managed_instance_id: description: - The resource identifier of the source managed instance associated with create operation of this instance. returned: always sample: null type: str state: description: - The state of the managed instance. returned: always sample: Ready type: str storage_account_type: description: - The storage account type used to store backups for this instance. returned: always sample: GRS type: str storage_size_in_gb: description: - Storage size in GB. Minimum value 32. Maximum value 8192. returned: always sample: 256 type: int subnet_id: description: - Subnet resource ID for the managed instance. returned: always sample: /subscriptions/xxx-xxxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/vnet-smi/subnets/sqi_sub type: str tags: description: - Resource tags. returned: always sample: taga: aaa tagb: bbb type: dict timezone_id: description: - Id of the timezone. Allowed values are timezones supported by Windows. returned: always sample: UTC type: str type: description: - The SQL managed instance type. returned: always sample: Microsoft.Sql/managedInstances type: str v_cores: description: - The number of vCores. Allowed values 8, 16, 24, 32, 40, 64, 80. returned: always sample: 8 type: int zone_redundant: description: - Whether or not the multi-az is enabled. returned: always sample: false type: bool description: - A list of dictionaries containing facts for SQL Managed Instance. returned: always type: complex