Try SpotterGet Azure Cosmos DB Account facts
| "added in version" 0.1.2 of azure.azcollection"
Authors: Zim Kalinowski (@zikalino)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Get facts of Azure Cosmos DB Account.
- 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
name:
description:
- Cosmos DB database account name.
type: str
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
elements: str
type: list
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
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
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
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
retrieve_keys:
choices:
- all
- readonly
description:
- Retrieve keys and connection strings.
type: str
resource_group:
description:
- Name of an Azure resource group.
type: str
subscription_id:
description:
- Your Azure subscription Id.
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
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
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
retrieve_connection_strings:
description:
- Retrieve connection strings.
type: bool
accounts:
contains:
connection_strings:
contains:
connection_string:
description:
- Description of connection string.
returned: always
sample: Primary SQL Connection String
type: str
description:
description:
- Connection string.
returned: always
sample: AccountEndpoint=https://testaccount.documents.azure.com:443/;AccountKey=xxxxx
type: str
description:
- List of connection strings.
returned: when requested
type: list
consistency_policy:
contains:
default_consistency_level:
description:
- Default consistency level.
returned: always
sample: session
type: str
max_interval_in_seconds:
description:
- Maximum interval in seconds.
returned: always
sample: 5
type: int
max_staleness_prefix:
description:
- Maximum staleness prefix.
returned: always
sample: 100
type: int
description:
- Consistency policy.
returned: always
type: complex
database_account_offer_type:
description:
- Offer type.
returned: always
sample: Standard
type: str
document_endpoint:
description:
- Document endpoint.
returned: always
sample: https://testaccount.documents.azure.com:443/
type: str
enable_automatic_failover:
description:
- Enable automatic failover.
returned: always
sample: true
type: bool
enable_cassandra:
description:
- Enable Cassandra.
returned: always
sample: true
type: bool
enable_free_tier:
description:
- If enabled the account is free-tier.
returned: always
sample: true
type: bool
version_added: 1.10.0
version_added_collection: azure.azcollection
enable_gremlin:
description:
- Enable Gremlin.
returned: always
sample: true
type: bool
enable_multiple_write_locations:
description:
- Enable multiple write locations.
returned: always
sample: true
type: bool
enable_table:
description:
- Enable Table.
returned: always
sample: true
type: bool
failover_policies:
contains:
failover_priority:
description:
- Failover priority.
returned: always
sample: 0
type: int
id:
description:
- Read location ID.
returned: always
sample: testaccount-eastus
type: str
name:
description:
- Location name.
returned: always
sample: eastus
type: str
description:
- The list of new failover policies for the failover priority change.
returned: always
type: complex
id:
description:
- 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
type: str
ip_range_filter:
description:
- (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
type: str
ip_rules:
description:
- 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
type: list
version_added: 1.10.0
version_added_collection: azure.azcollection
is_virtual_network_filter_enabled:
description:
- Enable virtual network filter.
returned: always
sample: true
type: bool
kind:
description:
- Indicates the type of database account.
returned: always
sample: global_document_db
type: str
location:
description:
- The location of the resource group to which the resource belongs.
returned: always
sample: westus
type: str
mongo_version:
description:
- Server version for the MongoDB account.
- Only used for c(kind) = i(mongo_db); otherwise value is null/none.
returned: always
sample: '4.0'
type: str
version_added: 1.10.0
version_added_collection: azure.azcollection
name:
description:
- The name of the database account.
returned: always
sample: testaccount
type: str
primary_master_key:
description:
- Primary master key.
returned: when requested
sample: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
type: str
primary_readonly_master_key:
description:
- Primary master key.
returned: when requested
sample: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
type: str
provisioning_state:
description:
- Provisioning state of Cosmos DB.
returned: always
sample: Succeeded
type: str
public_network_access:
description:
- If public network access is allowed to the server.
returned: always
sample: Enabled
type: str
version_added: 1.10.0
version_added_collection: azure.azcollection
read_locations:
contains:
document_endpoint:
description:
- Document endpoint.
returned: always
sample: https://testaccount-eastus.documents.azure.com:443/
type: str
failover_priority:
description:
- Failover priority.
returned: always
sample: 0
type: int
id:
description:
- Read location ID.
returned: always
sample: testaccount-eastus
type: str
name:
description:
- Location name.
returned: always
sample: eastus
type: str
provisioning_state:
description:
- Provisioning state.
returned: always
sample: Succeeded
type: str
description:
- Read locations.
returned: always
type: complex
resource_group:
description:
- Name of an Azure resource group.
returned: always
sample: myResourceGroup
type: str
secondary_master_key:
description:
- Primary master key.
returned: when requested
sample: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
type: str
secondary_readonly_master_key:
description:
- Primary master key.
returned: when requested
sample: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
type: str
tags:
description:
- Tags assigned to the resource. Dictionary of "string":"string" pairs.
returned: always
sample:
tag1: abc
type: dict
virtual_network_rules:
contains:
ignore_missing_v_net_service_endpoint:
description:
- Create Cosmos DB account without existing virtual network service endpoint.
type: bool
subnet:
description:
- Resource id of a subnet.
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNet
works/testvnet/subnets/testsubnet1
type: str
description:
- List of Virtual Network ACL rules configured for the Cosmos DB account.
type: list
write_locations:
contains:
document_endpoint:
description:
- Document endpoint.
returned: always
sample: https://testaccount-eastus.documents.azure.com:443/
type: str
failover_priority:
description:
- Failover priority.
returned: always
sample: 0
type: int
id:
description:
- Read location ID.
returned: always
sample: testaccount-eastus
type: str
name:
description:
- Location name.
returned: always
sample: eastus
type: str
provisioning_state:
description:
- Provisioning state.
returned: always
sample: Succeeded
type: str
description:
- Write locations.
returned: always
type: complex
description: A list of dictionaries containing facts for Database Account.
returned: always
type: complex