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

From Get docs
Ansible/docs/2.11/collections/azure/azcollection/azure rm cosmosdbaccount info module


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

Note

This plugin is part of the azure.azcollection collection (version 1.4.0).

To install it use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_cosmosdbaccount_info.


New in version 0.1.2: of azure.azcollection


Synopsis

  • Get facts of Azure Cosmos DB 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 0.0.1 of azure.azcollection

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

api_profile

string

added in 0.0.1 of azure.azcollection

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.

auth_source

string

added in 0.0.1 of azure.azcollection

  • auto

  • cli
  • credential_file
  • env
  • msi

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.

cert_validation_mode

string

added in 0.0.1 of azure.azcollection

  • 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 0.0.1 of azure.azcollection

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.

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

  • no
  • yes

Retrieve connection strings.

retrieve_keys

string

  • all
  • readonly

Retrieve keys and connection strings.

secret

string

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

subscription_id

string

Your Azure subscription Id.

tags

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.



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

Return Values

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

Key Returned Description

accounts

complex

always

A list of dictionaries containing facts for Database Account.


connection_strings

list / elements=string

when requested

List of connection strings.


connection_string

string

always

Description of connection string.


Sample:

Primary SQL Connection String

description

string

always

Connection string.


Sample:

consistency_policy

complex

always

Consistency policy.


default_consistency_level

string

always

Default consistency level.


Sample:

session

max_interval_in_seconds

integer

always

Maximum interval in seconds.


Sample:

5

max_staleness_prefix

integer

always

Maximum staleness prefix.


Sample:

100

database_account_offer_type

string

always

Offer type.


Sample:

Standard

document_endpoint

string

always

Document endpoint.


Sample:

enable_automatic_failover

boolean

always

Enable automatic failover.


Sample:

True

enable_cassandra

boolean

always

Enable Cassandra.


Sample:

True

enable_gremlin

boolean

always

Enable Gremlin.


Sample:

True

enable_multiple_write_locations

boolean

always

Enable multiple write locations.


Sample:

True

enable_table

boolean

always

Enable Table.


Sample:

True

failover_policies

complex

always

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


failover_priority

integer

always

Failover priority.


id

string

always

Read location ID.


Sample:

testaccount-eastus

name

string

always

Location name.


Sample:

eastus

id

string

always

The unique resource identifier of the database account.


Sample:

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

ip_range_filter

string

always

Enable IP range filter.


Sample:

10.10.10.10

is_virtual_network_filter_enabled

boolean

always

Enable virtual network filter.


Sample:

True

kind

string

always

Indicates the type of database account.


Sample:

global_document_db

location

string

always

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


Sample:

westus

name

string

always

The name of the database account.


Sample:

testaccount

primary_master_key

string

when requested

Primary master key.


Sample:

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

primary_readonly_master_key

string

when requested

Primary master key.


Sample:

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

provisioning_state

string

always

Provisioning state of Cosmos DB.


Sample:

Succeeded

read_locations

complex

always

Read locations.


document_endpoint

string

always

Document endpoint.


Sample:

failover_priority

integer

always

Failover priority.


id

string

always

Read location ID.


Sample:

testaccount-eastus

name

string

always

Location name.


Sample:

eastus

provisioning_state

string

always

Provisioning state.


Sample:

Succeeded

resource_group

string

always

Name of an Azure resource group.


Sample:

myResourceGroup

secondary_master_key

string

when requested

Primary master key.


Sample:

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

secondary_readonly_master_key

string

when requested

Primary master key.


Sample:

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

tags

dictionary

always

Tags assigned to the resource. Dictionary of "string":"string" pairs.


Sample:

{'tag1': 'abc'}

virtual_network_rules

list / elements=string

success

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


ignore_missing_vnet_service_endpoint

boolean

success

Create Cosmos DB account without existing virtual network service endpoint.


subnet

string

success

Resource id of a subnet.


Sample:

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

write_locations

complex

always

Write locations.


document_endpoint

string

always

Document endpoint.


Sample:

failover_priority

integer

always

Failover priority.


id

string

always

Read location ID.


Sample:

testaccount-eastus

name

string

always

Location name.


Sample:

eastus

provisioning_state

string

always

Provisioning state.


Sample:

Succeeded




Authors

  • Zim Kalinowski (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_cosmosdbaccount_info_module.html