From ba8846ab74c2c460a1586e9aba139f034c8aa988 Mon Sep 17 00:00:00 2001 From: Fred-sun <37327967+Fred-sun@users.noreply.github.com> Date: Fri, 17 May 2019 14:34:28 +0800 Subject: [PATCH] update azure_rm_containerregisty document (#56560) --- .../cloud/azure/azure_rm_containerregistry.py | 26 +++++++++---------- .../azure/azure_rm_containerregistry_facts.py | 18 +++++++------ 2 files changed, 23 insertions(+), 21 deletions(-) diff --git a/lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py b/lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py index 7a3cfa4de5..06e9d6fc1e 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py @@ -15,7 +15,7 @@ DOCUMENTATION = ''' --- module: azure_rm_containerregistry version_added: "2.5" -short_description: Manage an Azure Container Registry. +short_description: Manage an Azure Container Registry description: - Create, update and delete an Azure Container Registry. @@ -45,7 +45,7 @@ options: default: no sku: description: - - Specifies the SKU to use. Currently can be either Basic, Standard or Premium. + - Specifies the SKU to use. Currently can be either C(Basic), C(Standard) or C(Premium). default: Standard choices: - Basic @@ -82,67 +82,67 @@ EXAMPLES = ''' RETURN = ''' id: description: - - Resource ID + - Resource ID. returned: always type: str sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry name: description: - - Registry name + - Registry name. returned: always type: str sample: myregistry location: description: - - Resource location + - Resource location. returned: always type: str sample: westus admin_user_enabled: description: - - Is admin user enabled + - Is admin user enabled. returned: always type: bool sample: true sku: description: - - SKU + - The SKU name of the container registry. returned: always type: str sample: Standard provisioning_state: description: - - Provisioning state + - Provisioning state. returned: always type: str sample: Succeeded login_server: description: - - Registry login server + - Registry login server. returned: always type: str sample: myregistry.azurecr.io credentials: description: - - Passwords defined for the registry + - Passwords defined for the registry. returned: always type: complex contains: password: description: - - password value + - password value. returned: when registry exists and C(admin_user_enabled) is set type: str sample: pass1value password2: description: - - password2 value + - password2 value. returned: when registry exists and C(admin_user_enabled) is set type: str sample: pass2value tags: description: - - Tags + - Tags assigned to the resource. Dictionary of string:string parirs. returned: always type: dict ''' diff --git a/lib/ansible/modules/cloud/azure/azure_rm_containerregistry_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_containerregistry_facts.py index 53c7a574cb..06f3e4d75e 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_containerregistry_facts.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_containerregistry_facts.py @@ -17,7 +17,7 @@ DOCUMENTATION = ''' --- module: azure_rm_containerregistry_facts version_added: "2.7" -short_description: Get Azure Container Registry facts. +short_description: Get Azure Container Registry facts description: - Get facts for Container Registry. @@ -59,7 +59,8 @@ EXAMPLES = ''' RETURN = ''' registries: - description: A list of dictionaries containing facts for registries. + description: + - A list of dictionaries containing facts for registries. returned: always type: complex contains: @@ -93,10 +94,10 @@ registries: - The SKU name of the container registry. returned: always type: str - sample: classic + sample: Premium provisioning_state: description: - - Provisioning state of the container registry + - Provisioning state of the container registry. returned: always type: str sample: Succeeded @@ -108,7 +109,7 @@ registries: sample: acrd08521b.azurecr.io credentials: description: - - Credentials, fields will be empty if admin user is not enabled for ACR + - Credentials, fields will be empty if admin user is not enabled for ACR. return: when C(retrieve_credentials) is set and C(admin_user_enabled) is set on ACR type: complex contains: @@ -120,18 +121,19 @@ registries: sample: zim password: description: - - password value + - password value. returned: when registry exists and C(admin_user_enabled) is set type: str sample: pass1value password2: description: - - password2 value + - password2 value. returned: when registry exists and C(admin_user_enabled) is set type: str sample: pass2value tags: - description: Tags assigned to the resource. Dictionary of string:string pairs. + description: + - Tags assigned to the resource. Dictionary of string:string pairs. type: dict sample: { "tag1": "abc" } '''