azure.azcollection.azure_rm_cosmosdbaccount_info module – Get Azure Cosmos DB Account facts

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_info.

New in azure.azcollection 0.1.2

Synopsis

  • Get facts of Azure Cosmos DB 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

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

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.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 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.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

cloud_environment

string

added in azure.azcollection 0.0.1

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.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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 AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

  • false ← (default)

  • true

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string

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

string

Name of an Azure resource group.

retrieve_connection_strings

boolean

Retrieve connection strings.

Choices:

  • false

  • true

retrieve_keys

string

Retrieve keys and connection strings.

Choices:

  • "all"

  • "readonly"

secret

string

Azure client secret. Use when authenticating with a Service Principal.

subscription_id

string

Your Azure subscription Id.

tags

list / elements=string

Limit results by providing a list of tags. Format tags as ‘key’ or ‘key:value’.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

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.

x509_certificate_path

path

added in azure.azcollection 1.14.0

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

Examples

- name: Get instance of Database Account
  azure_rm_cosmosdbaccount_info:
    resource_group: myResourceGroup
    name: testaccount

- name: List instances of Database Account
  azure_rm_cosmosdbaccount_info:
    resource_group: myResourceGroup
    tags:
      - key
      - key:value

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

accounts

complex

A list of dictionaries containing facts for Database Account.

Returned: always

connection_strings

list / elements=string

List of connection strings.

Returned: when requested

connection_string

string

Description of connection string.

Returned: always

Sample: "Primary SQL Connection String"

description

string

Connection string.

Returned: always

Sample: "AccountEndpoint=https://testaccount.documents.azure.com:443/;AccountKey=xxxxx"

consistency_policy

complex

Consistency policy.

Returned: always

default_consistency_level

string

Default consistency level.

Returned: always

Sample: "session"

max_interval_in_seconds

integer

Maximum interval in seconds.

Returned: always

Sample: 5

max_staleness_prefix

integer

Maximum staleness prefix.

Returned: always

Sample: 100

database_account_offer_type

string

Offer type.

Returned: always

Sample: "Standard"

document_endpoint

string

Document endpoint.

Returned: always

Sample: "https://testaccount.documents.azure.com:443/"

enable_automatic_failover

boolean

Enable automatic failover.

Returned: always

Sample: true

enable_cassandra

boolean

Enable Cassandra.

Returned: always

Sample: true

enable_free_tier

boolean

added in azure.azcollection 1.10.0

If enabled the account is free-tier.

Returned: always

Sample: true

enable_gremlin

boolean

Enable Gremlin.

Returned: always

Sample: true

enable_multiple_write_locations

boolean

Enable multiple write locations.

Returned: always

Sample: true

enable_table

boolean

Enable Table.

Returned: always

Sample: true

failover_policies

complex

The list of new failover policies for the failover priority change.

Returned: always

failover_priority

integer

Failover priority.

Returned: always

Sample: 0

id

string

Read location ID.

Returned: always

Sample: "testaccount-eastus"

name

string

Location name.

Returned: always

Sample: "eastus"

id

string

The unique resource identifier of the database account.

Returned: always

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccount s/testaccount"

ip_range_filter

string

(deprecated) Enabled IP range filter.

This value has been deprecated, and will be removed in a later version. Use c(ip_rules) instead.

Returned: always

Sample: "10.10.10.10"

ip_rules

list / elements=string

added in azure.azcollection 1.10.0

The IP addresses or IP address ranges in CIDR form included as the allowed list of client IPs.

Returned: always

Sample: ["10.10.10.10", "20.20.20.20/28"]

is_virtual_network_filter_enabled

boolean

Enable virtual network filter.

Returned: always

Sample: true

kind

string

Indicates the type of database account.

Returned: always

Sample: "global_document_db"

location

string

The location of the resource group to which the resource belongs.

Returned: always

Sample: "westus"

mongo_version

string

added in azure.azcollection 1.10.0

Server version for the MongoDB account.

Only used for c(kind) = i(mongo_db); otherwise value is null/none.

Returned: always

Sample: "4.0"

name

string

The name of the database account.

Returned: always

Sample: "testaccount"

primary_master_key

string

Primary master key.

Returned: when requested

Sample: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

primary_readonly_master_key

string

Primary master key.

Returned: when requested

Sample: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

provisioning_state

string

Provisioning state of Cosmos DB.

Returned: always

Sample: "Succeeded"

public_network_access

string

added in azure.azcollection 1.10.0

If public network access is allowed to the server.

Returned: always

Sample: "Enabled"

read_locations

complex

Read locations.

Returned: always

document_endpoint

string

Document endpoint.

Returned: always

Sample: "https://testaccount-eastus.documents.azure.com:443/"

failover_priority

integer

Failover priority.

Returned: always

Sample: 0

id

string

Read location ID.

Returned: always

Sample: "testaccount-eastus"

name

string

Location name.

Returned: always

Sample: "eastus"

provisioning_state

string

Provisioning state.

Returned: always

Sample: "Succeeded"

resource_group

string

Name of an Azure resource group.

Returned: always

Sample: "myResourceGroup"

secondary_master_key

string

Primary master key.

Returned: when requested

Sample: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

secondary_readonly_master_key

string

Primary master key.

Returned: when requested

Sample: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

tags

dictionary

Tags assigned to the resource. Dictionary of “string”:”string” pairs.

Returned: always

Sample: {"tag1": "abc"}

virtual_network_rules

list / elements=string

List of Virtual Network ACL rules configured for the Cosmos DB account.

Returned: success

ignore_missing_v_net_service_endpoint

boolean

Create Cosmos DB account without existing virtual network service endpoint.

Returned: success

subnet

string

Resource id of a subnet.

Returned: success

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNet works/testvnet/subnets/testsubnet1"

write_locations

complex

Write locations.

Returned: always

document_endpoint

string

Document endpoint.

Returned: always

Sample: "https://testaccount-eastus.documents.azure.com:443/"

failover_priority

integer

Failover priority.

Returned: always

Sample: 0

id

string

Read location ID.

Returned: always

Sample: "testaccount-eastus"

name

string

Location name.

Returned: always

Sample: "eastus"

provisioning_state

string

Provisioning state.

Returned: always

Sample: "Succeeded"

Authors

  • Zim Kalinowski (@zikalino)