cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

update azure_rm_containerregisty document (#56560)

Browse source
This commit is contained in:
Fred-sun 2019-05-17 14:34:28 +08:00 committed by Yunge Zhu
parent 06c050e9bd
commit ba8846ab74
2 changed files with 23 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
lib/ansible/modules/cloud/azure/azure_rm_containerregistry.py
View file

@ -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
'''

18
lib/ansible/modules/cloud/azure/azure_rm_containerregistry_facts.py
View file

@ -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" }
'''