archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update azure_rm_cosmosdbaccount related module document (#56624)

Browse Source 
* update azure_rm_cosmosdbaccount_facts document
pull/56816/head
Fred-sun 5 years ago committed by Alicia Cozine
parent 16fb3ffbda
commit 22d2c6282a
2 changed files with 27 additions and 25 deletions
Show Stats Download Patch File Download Diff File

34
lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount.py
Unescape Escape View File

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_cosmosdbaccount module: azure_rm_cosmosdbaccount
version_added: "2.8" version_added: "2.8"
short_description: Manage Azure Database Account instance. short_description: Manage Azure Database Account instance
description: description:
- Create, update and delete instance of Azure Database Account. - Create, update and delete instance of Azure Database Account.
@ -33,7 +33,7 @@ options:
location: location:
description: description:
- The location of the resource group to which the resource belongs. - The location of the resource group to which the resource belongs.
- Required when C(state) is I(present). - Required when I(state=present).
kind: kind:
description: description:
- Indicates the type of database account. This can only be set at database account creation. - Indicates the type of database account. This can only be set at database account creation.
@ -48,7 +48,7 @@ options:
default_consistency_level: default_consistency_level:
description: description:
- The default consistency level and configuration settings of the Cosmos DB account. - The default consistency level and configuration settings of the Cosmos DB account.
- Required when C(state) is I(present). - Required when I(state=present).
choices: choices:
- 'eventual' - 'eventual'
- 'session' - 'session'
@ -57,18 +57,18 @@ options:
- 'consistent_prefix' - 'consistent_prefix'
max_staleness_prefix: max_staleness_prefix:
description: description:
- "When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range - When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated.
for this value is 1 - 2,147,483,647. Required when I(default_consistency_policy) is set to C(bounded_staleness)." - Accepted range for this value is 1 - 2,147,483,647. Required when I(default_consistency_policy=bounded_staleness).
type: int type: int
max_interval_in_seconds: max_interval_in_seconds:
description: description:
- "When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. - 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 I(default_consistency_policy) is set to C(bounded_staleness)." - Accepted range for this value is 5 - 86400. Required when I(default_consistency_policy=bounded_staleness).
type: int type: int
geo_rep_locations: geo_rep_locations:
description: description:
- An array that contains the georeplication locations enabled for the Cosmos DB account. - An array that contains the georeplication locations enabled for the Cosmos DB account.
- Required when C(state) is I(present). - Required when I(state=present).
type: list type: list
suboptions: suboptions:
name: name:
@ -76,25 +76,27 @@ options:
- The name of the region. - The name of the region.
failover_priority: failover_priority:
description: description:
- "The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = - The failover priority of the region. A failover priority of 0 indicates a write region.
(total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists." - 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.
type: int type: int
database_account_offer_type: database_account_offer_type:
description: description:
- Database account offer type, for example I(Standard) - Database account offer type, for example I(Standard)
- Required when C(state) is I(present). - Required when I(state=present).
ip_range_filter: ip_range_filter:
description: description:
- "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 - Cosmos DB Firewall support. This value specifies the set of IP addresses or IP address ranges.
of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces." - 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: is_virtual_network_filter_enabled:
description: description:
- Flag to indicate whether to enable/disable Virtual Network ACL rules. - Flag to indicate whether to enable/disable Virtual Network ACL rules.
type: bool type: bool
enable_automatic_failover: enable_automatic_failover:
description: description:
- "Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will - Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage.
result in a new write region for the account and is chosen based on the failover priorities configured for the account." - Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
type: bool type: bool
enable_cassandra: enable_cassandra:
description: description:
@ -140,7 +142,7 @@ extends_documentation_fragment:
- azure_tags - azure_tags
author: author:
- "Zim Kalinowski (@zikalino)" - Zim Kalinowski (@zikalino)
''' '''

18
lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount_facts.py
Unescape Escape View File

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_cosmosdbaccount_facts module: azure_rm_cosmosdbaccount_facts
version_added: "2.8" version_added: "2.8"
short_description: Get Azure Cosmos DB Account facts. short_description: Get Azure Cosmos DB Account facts
description: description:
- Get facts of Azure Cosmos DB Account. - Get facts of Azure Cosmos DB Account.
@ -47,7 +47,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Zim Kalinowski (@zikalino)" - Zim Kalinowski (@zikalino)
''' '''
@ -125,7 +125,7 @@ accounts:
sample: 100 sample: 100
failover_policies: failover_policies:
description: description:
- Read locations - The list of new failover policies for the failover priority change.
returned: always returned: always
type: complex type: complex
contains: contains:
@ -149,7 +149,7 @@ accounts:
sample: testaccount-eastus sample: testaccount-eastus
read_locations: read_locations:
description: description:
- Read locations - Read locations.
returned: always returned: always
type: complex type: complex
contains: contains:
@ -185,7 +185,7 @@ accounts:
sample: Succeeded sample: Succeeded
write_locations: write_locations:
description: description:
- Write locations - Write locations.
returned: always returned: always
type: complex type: complex
contains: contains:
@ -245,7 +245,7 @@ accounts:
sample: true sample: true
enable_cassandra: enable_cassandra:
description: description:
- Enable Cassandra - Enable Cassandra.
returned: always returned: always
type: bool type: bool
sample: true sample: true
@ -339,10 +339,10 @@ accounts:
q3dpJxJga76h9BZkK2BJJrDzSO6DDn6yKads017OZBZ1YZWyq1cW4iuvA==" q3dpJxJga76h9BZkK2BJJrDzSO6DDn6yKads017OZBZ1YZWyq1cW4iuvA=="
tags: tags:
description: description:
- Tags - Tags assigned to the resource. Dictionary of "string":"string" pairs.
returned: always returned: always
type: complex type: dict
sample: {} sample: { "tag1":"abc" }
''' '''
from ansible.module_utils.azure_rm_common import AzureRMModuleBase from ansible.module_utils.azure_rm_common import AzureRMModuleBase

Write Preview
Loading…
Cancel
Save