mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
update azure_rm_containerregisty document (#56560)
This commit is contained in:
parent
06c050e9bd
commit
ba8846ab74
2 changed files with 23 additions and 21 deletions
|
@ -15,7 +15,7 @@ DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: azure_rm_containerregistry
|
module: azure_rm_containerregistry
|
||||||
version_added: "2.5"
|
version_added: "2.5"
|
||||||
short_description: Manage an Azure Container Registry.
|
short_description: Manage an Azure Container Registry
|
||||||
description:
|
description:
|
||||||
- Create, update and delete an Azure Container Registry.
|
- Create, update and delete an Azure Container Registry.
|
||||||
|
|
||||||
|
@ -45,7 +45,7 @@ options:
|
||||||
default: no
|
default: no
|
||||||
sku:
|
sku:
|
||||||
description:
|
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
|
default: Standard
|
||||||
choices:
|
choices:
|
||||||
- Basic
|
- Basic
|
||||||
|
@ -82,67 +82,67 @@ EXAMPLES = '''
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
id:
|
id:
|
||||||
description:
|
description:
|
||||||
- Resource ID
|
- Resource ID.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry
|
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Registry name
|
- Registry name.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: myregistry
|
sample: myregistry
|
||||||
location:
|
location:
|
||||||
description:
|
description:
|
||||||
- Resource location
|
- Resource location.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: westus
|
sample: westus
|
||||||
admin_user_enabled:
|
admin_user_enabled:
|
||||||
description:
|
description:
|
||||||
- Is admin user enabled
|
- Is admin user enabled.
|
||||||
returned: always
|
returned: always
|
||||||
type: bool
|
type: bool
|
||||||
sample: true
|
sample: true
|
||||||
sku:
|
sku:
|
||||||
description:
|
description:
|
||||||
- SKU
|
- The SKU name of the container registry.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: Standard
|
sample: Standard
|
||||||
provisioning_state:
|
provisioning_state:
|
||||||
description:
|
description:
|
||||||
- Provisioning state
|
- Provisioning state.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: Succeeded
|
sample: Succeeded
|
||||||
login_server:
|
login_server:
|
||||||
description:
|
description:
|
||||||
- Registry login server
|
- Registry login server.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: myregistry.azurecr.io
|
sample: myregistry.azurecr.io
|
||||||
credentials:
|
credentials:
|
||||||
description:
|
description:
|
||||||
- Passwords defined for the registry
|
- Passwords defined for the registry.
|
||||||
returned: always
|
returned: always
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
contains:
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
- password value
|
- password value.
|
||||||
returned: when registry exists and C(admin_user_enabled) is set
|
returned: when registry exists and C(admin_user_enabled) is set
|
||||||
type: str
|
type: str
|
||||||
sample: pass1value
|
sample: pass1value
|
||||||
password2:
|
password2:
|
||||||
description:
|
description:
|
||||||
- password2 value
|
- password2 value.
|
||||||
returned: when registry exists and C(admin_user_enabled) is set
|
returned: when registry exists and C(admin_user_enabled) is set
|
||||||
type: str
|
type: str
|
||||||
sample: pass2value
|
sample: pass2value
|
||||||
tags:
|
tags:
|
||||||
description:
|
description:
|
||||||
- Tags
|
- Tags assigned to the resource. Dictionary of string:string parirs.
|
||||||
returned: always
|
returned: always
|
||||||
type: dict
|
type: dict
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -17,7 +17,7 @@ DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: azure_rm_containerregistry_facts
|
module: azure_rm_containerregistry_facts
|
||||||
version_added: "2.7"
|
version_added: "2.7"
|
||||||
short_description: Get Azure Container Registry facts.
|
short_description: Get Azure Container Registry facts
|
||||||
description:
|
description:
|
||||||
- Get facts for Container Registry.
|
- Get facts for Container Registry.
|
||||||
|
|
||||||
|
@ -59,7 +59,8 @@ EXAMPLES = '''
|
||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
registries:
|
registries:
|
||||||
description: A list of dictionaries containing facts for registries.
|
description:
|
||||||
|
- A list of dictionaries containing facts for registries.
|
||||||
returned: always
|
returned: always
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
contains:
|
||||||
|
@ -93,10 +94,10 @@ registries:
|
||||||
- The SKU name of the container registry.
|
- The SKU name of the container registry.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: classic
|
sample: Premium
|
||||||
provisioning_state:
|
provisioning_state:
|
||||||
description:
|
description:
|
||||||
- Provisioning state of the container registry
|
- Provisioning state of the container registry.
|
||||||
returned: always
|
returned: always
|
||||||
type: str
|
type: str
|
||||||
sample: Succeeded
|
sample: Succeeded
|
||||||
|
@ -108,7 +109,7 @@ registries:
|
||||||
sample: acrd08521b.azurecr.io
|
sample: acrd08521b.azurecr.io
|
||||||
credentials:
|
credentials:
|
||||||
description:
|
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
|
return: when C(retrieve_credentials) is set and C(admin_user_enabled) is set on ACR
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
contains:
|
||||||
|
@ -120,18 +121,19 @@ registries:
|
||||||
sample: zim
|
sample: zim
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
- password value
|
- password value.
|
||||||
returned: when registry exists and C(admin_user_enabled) is set
|
returned: when registry exists and C(admin_user_enabled) is set
|
||||||
type: str
|
type: str
|
||||||
sample: pass1value
|
sample: pass1value
|
||||||
password2:
|
password2:
|
||||||
description:
|
description:
|
||||||
- password2 value
|
- password2 value.
|
||||||
returned: when registry exists and C(admin_user_enabled) is set
|
returned: when registry exists and C(admin_user_enabled) is set
|
||||||
type: str
|
type: str
|
||||||
sample: pass2value
|
sample: pass2value
|
||||||
tags:
|
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
|
type: dict
|
||||||
sample: { "tag1": "abc" }
|
sample: { "tag1": "abc" }
|
||||||
'''
|
'''
|
||||||
|
|
Loading…
Reference in a new issue