azure.azcollection.azure_rm_cosmosdbaccount module – Manage Azure Database Account instance
Note
This module is part of the azure.azcollection collection (version 2.7.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_cosmosdbaccount.
New in azure.azcollection 0.1.2
Synopsis
Create, update and delete instance of Azure Database Account.
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. |
|
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:
|
|
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: |
|
The consistency policy for the Cosmos DB account. |
|
The default consistency level and configuration settings of the Cosmos DB account. Required when state=present. Choices:
|
|
When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when default_consistency_policy=bounded_staleness. |
|
When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 - 2,147,483,647. Required when default_consistency_policy=bounded_staleness. |
|
Database account offer type, for example Standard Required when state=present. |
|
The primary identity to access key vault in CMK related features. e.g. ‘FirstPartyIdentity’, ‘SystemAssignedIdentity’ and more. User-assigned identities are specified in format ‘UserAssignedIdentity=<resource ID of the user-assigned identity>’. |
|
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:
|
|
Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account. Choices:
|
|
Enable Cassandra. Choices:
|
|
If enabled the account is free-tier. Choices:
|
|
Enable Gremlin. Choices:
|
|
Enables the account to write in multiple locations Choices:
|
|
Enable Table. Choices:
|
|
An array that contains the georeplication locations enabled for the Cosmos DB account. Required when state=present. |
|
The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. |
|
The name of the region. |
|
Identity for the Object |
|
Type of the managed identity Choices:
|
|
User Assigned Managed Identities and its options Default: |
|
If the list of identities has to be appended to current identities (true) or if it has to replace current identities (false) Choices:
|
|
List of the user assigned identities IDs associated to the Object Default: |
|
(deprecated) Cosmos DB Firewall support. This value specifies the set of IP addresses or IP address ranges. In CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces. This value has been deprecated, and will be removed in a later version. Use ip_rules instead. |
|
The IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs. |
|
Flag to indicate whether to enable/disable Virtual Network ACL rules. Choices:
|
|
Indicates the type of database account. This can only be set at database account creation. Choices:
|
|
The location of the resource group to which the resource belongs. Required when state=present. |
|
Parent argument. |
|
Parent argument. |
|
Server version for the MongoDB account, such as c(3.2) or c(4.0). Only used when c(kind) = i(mongo_db). |
|
Cosmos DB database account name. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Enables or disables public network access to server. Choices:
|
|
Name of an Azure resource group. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Assert the state of the Database Account. 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. |
|
List of Virtual Network ACL rules configured for the Cosmos DB account. |
|
Create Cosmos DB account without existing virtual network service endpoint. Choices:
|
|
It can be a string containing resource id of a subnet. It can be a dictionary containing ‘resource_group’, ‘virtual_network_name’ and ‘subnet_name’ |
|
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 Cosmos DB Account - min
azure_rm_cosmosdbaccount:
resource_group: myResourceGroup
name: myDatabaseAccount
location: westus
geo_rep_locations:
- name: southcentralus
failover_priority: 0
database_account_offer_type: Standard
- name: Create Cosmos DB Account - max
azure_rm_cosmosdbaccount:
resource_group: myResourceGroup
name: myDatabaseAccount
location: westus
kind: mongo_db
geo_rep_locations:
- name: southcentralus
failover_priority: 0
database_account_offer_type: Standard
ip_rules:
- 10.10.10.10
enable_multiple_write_locations: true
virtual_network_rules:
- subnet: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVi
rtualNetwork/subnets/mySubnet"
consistency_policy:
default_consistency_level: bounded_staleness
max_staleness_prefix: 10
max_interval_in_seconds: 1000
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The unique resource identifier of the database account. Returned: always Sample: |