From 22d2c6282a733f8c732ce1d09ecc9325eb2efe30 Mon Sep 17 00:00:00 2001 From: Fred-sun <37327967+Fred-sun@users.noreply.github.com> Date: Thu, 23 May 2019 03:55:10 +0800 Subject: [PATCH] Update azure_rm_cosmosdbaccount related module document (#56624) * update azure_rm_cosmosdbaccount_facts document --- .../cloud/azure/azure_rm_cosmosdbaccount.py | 34 ++++++++++--------- .../azure/azure_rm_cosmosdbaccount_facts.py | 18 +++++----- 2 files changed, 27 insertions(+), 25 deletions(-) diff --git a/lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount.py b/lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount.py index 6a530e38de..dbc1b961df 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount.py @@ -17,7 +17,7 @@ DOCUMENTATION = ''' --- module: azure_rm_cosmosdbaccount version_added: "2.8" -short_description: Manage Azure Database Account instance. +short_description: Manage Azure Database Account instance description: - Create, update and delete instance of Azure Database Account. @@ -33,7 +33,7 @@ options: location: description: - The location of the resource group to which the resource belongs. - - Required when C(state) is I(present). + - Required when I(state=present). kind: description: - Indicates the type of database account. This can only be set at database account creation. @@ -48,7 +48,7 @@ options: default_consistency_level: description: - 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: - 'eventual' - 'session' @@ -57,18 +57,18 @@ options: - 'consistent_prefix' max_staleness_prefix: description: - - "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 I(default_consistency_policy) is set to C(bounded_staleness)." + - 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 I(default_consistency_policy=bounded_staleness). type: int max_interval_in_seconds: description: - - "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)." + - 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=bounded_staleness). type: int geo_rep_locations: description: - 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 suboptions: name: @@ -76,25 +76,27 @@ options: - The name of the region. failover_priority: description: - - "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." + - 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. type: int database_account_offer_type: description: - Database account offer type, for example I(Standard) - - Required when C(state) is I(present). + - Required when I(state=present). ip_range_filter: 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 - of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces." + - 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: description: - Flag to indicate whether to enable/disable Virtual Network ACL rules. type: bool enable_automatic_failover: description: - - "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." + - 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. type: bool enable_cassandra: description: @@ -140,7 +142,7 @@ extends_documentation_fragment: - azure_tags author: - - "Zim Kalinowski (@zikalino)" + - Zim Kalinowski (@zikalino) ''' diff --git a/lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount_facts.py index bb43c856ed..d350dd2b02 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_cosmosdbaccount_facts.py @@ -17,7 +17,7 @@ DOCUMENTATION = ''' --- module: azure_rm_cosmosdbaccount_facts version_added: "2.8" -short_description: Get Azure Cosmos DB Account facts. +short_description: Get Azure Cosmos DB Account facts description: - Get facts of Azure Cosmos DB Account. @@ -47,7 +47,7 @@ extends_documentation_fragment: - azure author: - - "Zim Kalinowski (@zikalino)" + - Zim Kalinowski (@zikalino) ''' @@ -125,7 +125,7 @@ accounts: sample: 100 failover_policies: description: - - Read locations + - The list of new failover policies for the failover priority change. returned: always type: complex contains: @@ -149,7 +149,7 @@ accounts: sample: testaccount-eastus read_locations: description: - - Read locations + - Read locations. returned: always type: complex contains: @@ -185,7 +185,7 @@ accounts: sample: Succeeded write_locations: description: - - Write locations + - Write locations. returned: always type: complex contains: @@ -245,7 +245,7 @@ accounts: sample: true enable_cassandra: description: - - Enable Cassandra + - Enable Cassandra. returned: always type: bool sample: true @@ -339,10 +339,10 @@ accounts: q3dpJxJga76h9BZkK2BJJrDzSO6DDn6yKads017OZBZ1YZWyq1cW4iuvA==" tags: description: - - Tags + - Tags assigned to the resource. Dictionary of "string":"string" pairs. returned: always - type: complex - sample: {} + type: dict + sample: { "tag1":"abc" } ''' from ansible.module_utils.azure_rm_common import AzureRMModuleBase