mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Update document related with azure_rm_keyvault module (#57110)
This commit is contained in:
Fred-sun
Alicia Cozine
parent
163d3efbf8
commit
ba18dd713a
3 changed files with 34 additions and 30 deletions
|
|
@ -17,7 +17,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: azure_rm_keyvault
|
||||
version_added: "2.5"
|
||||
short_description: Manage Key Vault instance.
|
||||
short_description: Manage Key Vault instance
|
||||
description:
|
||||
- Create, update and delete instance of Key Vault.
|
||||
|
||||
|
|
@ -28,7 +28,7 @@ options:
|
|||
required: True
|
||||
vault_name:
|
||||
description:
|
||||
- Name of the vault
|
||||
- Name of the vault.
|
||||
required: True
|
||||
location:
|
||||
description:
|
||||
|
|
@ -38,11 +38,11 @@ options:
|
|||
- The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
|
||||
sku:
|
||||
description:
|
||||
- SKU details
|
||||
- SKU details.
|
||||
suboptions:
|
||||
family:
|
||||
description:
|
||||
- SKU family name
|
||||
- SKU family name.
|
||||
name:
|
||||
description:
|
||||
- SKU name to specify whether the key vault is a standard vault or a premium vault.
|
||||
|
|
@ -52,8 +52,8 @@ options:
|
|||
- 'premium'
|
||||
access_policies:
|
||||
description:
|
||||
- "An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's
|
||||
tenant ID."
|
||||
- An array of 0 to 16 identities that have access to the key vault.
|
||||
- All identities in the array must use the same tenant ID as the key vault's tenant ID.
|
||||
suboptions:
|
||||
tenant_id:
|
||||
description:
|
||||
|
|
@ -61,16 +61,16 @@ options:
|
|||
- Current keyvault C(tenant_id) value will be used if not specified.
|
||||
object_id:
|
||||
description:
|
||||
- "The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be
|
||||
unique for the list of access policies."
|
||||
- The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault.
|
||||
- The object ID must be unique for the list of access policies.
|
||||
- Please note this is not application id. Object id can be obtained by running "az ad sp show --id <application id>".
|
||||
required: True
|
||||
application_id:
|
||||
description:
|
||||
- Application ID of the client making request on behalf of a principal
|
||||
- Application ID of the client making request on behalf of a principal.
|
||||
keys:
|
||||
description:
|
||||
- List of permissions to keys
|
||||
- List of permissions to keys.
|
||||
choices:
|
||||
- 'encrypt'
|
||||
- 'decrypt'
|
||||
|
|
@ -90,7 +90,7 @@ options:
|
|||
- 'purge'
|
||||
secrets:
|
||||
description:
|
||||
- List of permissions to secrets
|
||||
- List of permissions to secrets.
|
||||
choices:
|
||||
- 'get'
|
||||
- 'list'
|
||||
|
|
@ -102,7 +102,7 @@ options:
|
|||
- 'purge'
|
||||
certificates:
|
||||
description:
|
||||
- List of permissions to certificates
|
||||
- List of permissions to certificates.
|
||||
choices:
|
||||
- 'get'
|
||||
- 'list'
|
||||
|
|
@ -120,7 +120,7 @@ options:
|
|||
- 'purge'
|
||||
storage:
|
||||
description:
|
||||
- List of permissions to storage accounts
|
||||
- List of permissions to storage accounts.
|
||||
enabled_for_deployment:
|
||||
description:
|
||||
- Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
|
||||
|
|
@ -154,7 +154,7 @@ extends_documentation_fragment:
|
|||
- azure_tags
|
||||
|
||||
author:
|
||||
- "Zim Kalinowski (@zikalino)"
|
||||
- Zim Kalinowski (@zikalino)
|
||||
|
||||
'''
|
||||
|
||||
|
|
|
|||
|
|
@ -15,10 +15,11 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: azure_rm_keyvaultkey
|
||||
version_added: 2.5
|
||||
short_description: Use Azure KeyVault keys.
|
||||
short_description: Use Azure KeyVault keys
|
||||
description:
|
||||
- Create or delete a key within a given keyvault. By using Key Vault, you can encrypt
|
||||
keys and secrets (such as authentication keys, storage account keys, data encryption keys, .PFX files, and passwords).
|
||||
- Create or delete a key within a given keyvault.
|
||||
- By using Key Vault, you can encrypt keys and secrets.
|
||||
- Such as authentication keys, storage account keys, data encryption keys, .PFX files, and passwords.
|
||||
options:
|
||||
keyvault_uri:
|
||||
description:
|
||||
|
|
@ -39,8 +40,7 @@ options:
|
|||
- PEM password.
|
||||
state:
|
||||
description:
|
||||
- Assert the state of the key. Use C(present) to create a key and
|
||||
C(absent) to delete a key.
|
||||
- Assert the state of the key. Use C(present) to create a key and C(absent) to delete a key.
|
||||
default: present
|
||||
choices:
|
||||
- absent
|
||||
|
|
@ -51,7 +51,7 @@ extends_documentation_fragment:
|
|||
- azure_tags
|
||||
|
||||
author:
|
||||
- "Ian Philpot (@iphilpot)"
|
||||
- Ian Philpot (@iphilpot)
|
||||
|
||||
'''
|
||||
|
||||
|
|
@ -70,12 +70,14 @@ EXAMPLES = '''
|
|||
|
||||
RETURN = '''
|
||||
state:
|
||||
description: Current state of the key.
|
||||
description:
|
||||
- Current state of the key.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
key_id:
|
||||
description: key resource path.
|
||||
description:
|
||||
- key resource path.
|
||||
type: str
|
||||
example: https://contoso.vault.azure.net/keys/hello/e924f053839f4431b35bc54393f98423
|
||||
'''
|
||||
|
|
|
|||
|
|
@ -15,10 +15,11 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: azure_rm_keyvaultsecret
|
||||
version_added: 2.5
|
||||
short_description: Use Azure KeyVault Secrets.
|
||||
short_description: Use Azure KeyVault Secrets
|
||||
description:
|
||||
- Create or delete a secret within a given keyvault. By using Key Vault, you can encrypt
|
||||
keys and secrets (such as authentication keys, storage account keys, data encryption keys, .PFX files, and passwords).
|
||||
- Create or delete a secret within a given keyvault.
|
||||
- By using Key Vault, you can encrypt keys and secrets.
|
||||
- Such as authentication keys, storage account keys, data encryption keys, .PFX files, and passwords.
|
||||
options:
|
||||
keyvault_uri:
|
||||
description:
|
||||
|
|
@ -33,8 +34,7 @@ options:
|
|||
- Secret to be secured by keyvault.
|
||||
state:
|
||||
description:
|
||||
- Assert the state of the subnet. Use C(present) to create or update a secret and
|
||||
C(absent) to delete a secret .
|
||||
- Assert the state of the subnet. Use C(present) to create or update a secret and C(absent) to delete a secret .
|
||||
default: present
|
||||
choices:
|
||||
- absent
|
||||
|
|
@ -45,7 +45,7 @@ extends_documentation_fragment:
|
|||
- azure_tags
|
||||
|
||||
author:
|
||||
- "Ian Philpot (@iphilpot)"
|
||||
- Ian Philpot (@iphilpot)
|
||||
|
||||
'''
|
||||
|
||||
|
|
@ -68,12 +68,14 @@ EXAMPLES = '''
|
|||
|
||||
RETURN = '''
|
||||
state:
|
||||
description: Current state of the secret.
|
||||
description:
|
||||
- Current state of the secret.
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
secret_id:
|
||||
description: Secret resource path.
|
||||
description:
|
||||
- Secret resource path.
|
||||
type: str
|
||||
example: https://contoso.vault.azure.net/secrets/hello/e924f053839f4431b35bc54393f98423
|
||||
'''
|
||||
|
|
|
|||
Loading…
Reference in a new issue