azure.azcollection.azure_rm_keyvaultsecret_info – Get Azure Key Vault secret facts
Note
This plugin is part of the azure.azcollection collection (version 1.10.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_keyvaultsecret_info
.
New in version 0.1.2: of azure.azcollection
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: “latest” |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: “AzureCloud” |
|
Parent argument. |
|
Parent argument. |
|
Secret name. If not set, will list all secrets in vault_uri. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Set to show_delete_secret=true to show deleted secrets. Set to show_deleted_secret=false to show not deleted secrets. Choices:
|
|
Your Azure subscription Id. |
|
Limit results by providing a list of tags. Format tags as ‘key’ or ‘key:value’. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
Vault uri where the secret stored in. |
|
Secret version. Set it to Set it to Set it to specific version to list specific version of a secret. eg. fd2682392a504455b79c90dd04a1bf46 Default: “current” |
Notes
Note
For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login
.Authentication is also possible using a service principal or Active Directory user.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
See Also
See also
- Sign in with Azure CLI
How to authenticate using the
az login
command.
Examples
- name: Get latest version of specific secret
azure_rm_keyvaultsecret_info:
vault_uri: "https://myVault.vault.azure.net"
name: mySecret
- name: List all versions of specific secret
azure_rm_keyvaultsecret_info:
vault_uri: "https://myVault.vault.azure.net"
name: mySecret
version: all
- name: List specific version of specific secret
azure_rm_keyvaultsecret_info:
vault_uri: "https://myVault.vault.azure.net"
name: mySecret
version: fd2682392a504455b79c90dd04a1bf46
- name: List all secrets in specific key vault
azure_rm_keyvaultsecret_info:
vault_uri: "https://myVault.vault.azure.net"
- name: List deleted secrets in specific key vault
azure_rm_keyvaultsecret_info:
vault_uri: "https://myVault.vault.azure.net"
show_deleted_secret: True
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of secrets in Azure Key Vault. Returned: always |
|
Secret attributes. Returned: success |
|
Creation datetime. Returned: always Sample: “2019-04-25T07:26:49+00:00” |
|
Indicate whether the secret is enabled. Returned: always Sample: true |
|
Expiration datetime. Returned: success Sample: “2019-04-25T07:26:49+00:00” |
|
Not before datetime. Returned: success Sample: “2019-04-25T07:26:49+00:00” |
|
Reflects the deletion recovery level currently in effect for secrets in the current vault. If it contains ‘Purgeable’ the secret can be permanently deleted by a privileged user, Otherwise, only the system can purge the secret, at the end of the retention interval. Returned: always Sample: “Recoverable+Purgeable” |
|
Update datetime. Returned: always Sample: “2019-04-25T07:26:49+00:00” |
|
Content type (optional) Returned: always Sample: “mysecrettype” |
|
secret value. Returned: always Sample: “mysecretvault” |
|
Secret identifier. Returned: always Sample: “https://myVault.vault.azure.net/flexsecret/secret1/fd2682392a504455b79c90dd04a1bf46” |
|
Tags of the secret. Returned: always Sample: {“delete”: “on-exit”} |
|
Secret version. Returned: always Sample: “fd2682392a504455b79c90dd04a1bf46” |
Authors
Jose Angel Munoz (@imjoseangel)