Format azure_rm_keyvault_key_info module's document (#64580)

pull/64775/head
Fred-sun 5 years ago committed by Sandra McCann
parent 6a662b0ed0
commit 0b8b84c16f

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_keyvaultkey_info module: azure_rm_keyvaultkey_info
version_added: "2.9" version_added: "2.9"
short_description: Get Azure Key Vault key facts. short_description: Get Azure Key Vault key facts
description: description:
- Get facts of Azure Key Vault key. - Get facts of Azure Key Vault key.
@ -29,19 +29,19 @@ options:
type: str type: str
name: name:
description: description:
- Key name. If not set, will list all keys in vault_uri. - Key name. If not set, will list all keys in I(vault_uri).
type: str type: str
version: version:
description: description:
- Key version. - Key version.
- Set it to C(current) to show latest version of a key. - Set it to C(current) to show latest version of a key.
- Set it to C(all) to list all versions of a key. - Set it to C(all) to list all versions of a key.
- Set it to specific version to list specific version of a key. eg. fd2682392a504455b79c90dd04a1bf46 - Set it to specific version to list specific version of a key. eg. fd2682392a504455b79c90dd04a1bf46.
default: current default: current
type: str type: str
show_deleted_key: show_deleted_key:
description: description:
- Set to true to show deleted keys. Set to False to show not deleted keys. - Set to C(true) to show deleted keys. Set to C(false) to show not deleted keys.
type: bool type: bool
default: false default: false
tags: tags:
@ -53,7 +53,7 @@ extends_documentation_fragment:
- azure - azure
author: author:
- "Yunge Zhu (@yungezz)" - Yunge Zhu (@yungezz)
''' '''
@ -87,52 +87,62 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
keyvaults: keyvaults:
description: List of keys in Azure Key Vault. description:
- List of keys in Azure Key Vault.
returned: always returned: always
type: complex type: complex
contains: contains:
kid: kid:
description: Key identifier. description:
- Key identifier.
returned: always returned: always
type: str type: str
sample: "https://myVault.vault.azure.net/keys/key1/fd2682392a504455b79c90dd04a1bf46" sample: "https://myVault.vault.azure.net/keys/key1/fd2682392a504455b79c90dd04a1bf46"
permitted_operations: permitted_operations:
description: description:
- Permitted operations on the key - Permitted operations on the key.
type: list type: list
returned: always returned: always
sample: encrypt sample: encrypt
type: type:
description: Key type. description:
- Key type.
type: str type: str
returned: always returned: always
sample: RSA sample: RSA
version: version:
description: Key version. description:
- Key version.
type: str type: str
returned: always returned: always
sample: fd2682392a504455b79c90dd04a1bf46 sample: fd2682392a504455b79c90dd04a1bf46
key: key:
description: public part of a key. description:
- public part of a key.
contains: contains:
n: n:
description: RSA modules. description:
- RSA modules.
type: str type: str
e: e:
description: RSA public exponent. description:
- RSA public exponent.
type: str type: str
crv: crv:
description: Elliptic curve name. description:
- Elliptic curve name.
type: str type: str
x: x:
description: X component of an EC public key. description:
- X component of an EC public key.
type: str type: str
y: y:
description: Y component of an EC public key. description:
- Y component of an EC public key.
type: str type: str
managed: managed:
description: description:
- True if the key's lifetime is managed by key vault. - C(True) if the key's lifetime is managed by key vault.
type: bool type: bool
sample: True sample: True
tags: tags:
@ -140,7 +150,7 @@ keyvaults:
- Tags of the key. - Tags of the key.
returned: always returned: always
type: list type: list
sample: foo sample: [foo, ]
attributes: attributes:
description: description:
- Key attributes. - Key attributes.
@ -176,7 +186,7 @@ keyvaults:
recovery_level: recovery_level:
description: description:
- Reflects the deletion recovery level currently in effect for keys in the current vault. - Reflects the deletion recovery level currently in effect for keys in the current vault.
- If it contains 'Purgeable' the key can be permanently deleted by a privileged user, - If it contains C(Purgeable) the key can be permanently deleted by a privileged user.
- Otherwise, only the system can purge the key, at the end of the retention interval. - Otherwise, only the system can purge the key, at the end of the retention interval.
returned: always returned: always
type: str type: str

Loading…
Cancel
Save