- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# azure_rm_cosmosdbaccount – Manage Azure Database Account instance

New in version 2.8.

- Synopsis

- Requirements

- Parameters

- Notes

- See Also

- Examples

- Return Values

- Status

## 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

- azure >= 2.0.0

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
ad_user string |  | Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in 2.6 |  | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 2.5 | Default: "latest" | Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags boolean | Choices: no yes ← | 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 added in 2.5 | Choices: auto cli credential_file env msi | Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `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 `msi` was added in Ansible 2.6.
cert_validation_mode string added in 2.5 | Choices: ignore validate | 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 `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable.
client_id string |  | Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 2.4 | Default: "AzureCloud" | For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable.
consistency_policy - |  | The consistency policy for the Cosmos DB account.
| default_consistency_level - | Choices: eventual session bounded_staleness strong consistent_prefix | The default consistency level and configuration settings of the Cosmos DB account. Required when state=present.
| max_interval_in_seconds integer |  | 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.
| max_staleness_prefix integer |  | 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 - |  | Database account offer type, for example Standard Required when state=present.
enable_automatic_failover boolean | Choices: no yes | 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.
enable_cassandra boolean | Choices: no yes | Enable Cassandra.
enable_gremlin boolean | Choices: no yes | Enable Gremlin.
enable_multiple_write_locations boolean | Choices: no yes | Enables the account to write in multiple locations
enable_table boolean | Choices: no yes | Enable Table.
geo_rep_locations list |  | An array that contains the georeplication locations enabled for the Cosmos DB account. Required when state=present.
| failover_priority integer |  | 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.
| name - |  | The name of the region.
ip_range_filter - |  | 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.
is_virtual_network_filter_enabled boolean | Choices: no yes | Flag to indicate whether to enable/disable Virtual Network ACL rules.
kind - | Choices: global_document_db mongo_db parse | Indicates the type of database account. This can only be set at database account creation.
location - |  | The location of the resource group to which the resource belongs. Required when state=present.
name - / required |  | Cosmos DB database account name.
password string |  | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string |  | Security profile found in ~/.azure/credentials file.
resource_group - / required |  | Name of an Azure resource group.
secret string |  | Azure client secret. Use when authenticating with a Service Principal.
state - | Choices: absent present ← | Assert the state of the Database Account. Use `present` to create or update an Database Account and `absent` to delete it.
subscription_id string |  | Your Azure subscription Id.
tags dictionary |  | 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.
tenant string |  | Azure tenant ID. Use when authenticating with a Service Principal.
virtual_network_rules list |  | List of Virtual Network ACL rules configured for the Cosmos DB account.
| ignore_missing_vnet_service_endpoint boolean | Choices: no yes | Create Cosmos DB account without existing virtual network service endpoint.
| subnet - |  | 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'

## 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 login` command.

## 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_range_filter: 10.10.10.10
        enable_multiple_write_locations: yes
        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 | Returned | Description
--- | --- | ---
id string | always | The unique resource identifier of the database account. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/myData baseAccount

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Zim Kalinowski (@zikalino)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.