azure.azcollection.azure_rm_keyvaultsecret_info – Get Azure Key Vault secret facts
azure.azcollection.azure_rm_keyvaultsecret_info – Get Azure Key Vault secret facts
Note
This plugin is part of the azure.azcollection collection (version 1.3.1).
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
Synopsis
- Get facts of Azure Key Vault secret.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- azure >= 2.0.0
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
ad_user string |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
adfs_authority_url string added in 0.0.1 of azure.azcollection |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | |
api_profile string added in 0.0.1 of azure.azcollection |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of |
auth_source string added in 0.0.1 of azure.azcollection |
|
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 |
cert_validation_mode string added in 0.0.1 of azure.azcollection |
|
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 |
client_id string |
Azure client ID. Use when authenticating with a Service Principal. | |
cloud_environment string added in 0.0.1 of azure.azcollection |
Default: "AzureCloud" |
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, |
name string |
Secret name. If not set, will list all secrets in vault_uri. | |
password string |
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
profile string |
Security profile found in ~/.azure/credentials file. | |
secret string |
Azure client secret. Use when authenticating with a Service Principal. | |
show_deleted_secret boolean |
|
Set to show_delete_secret=true to show deleted secrets. Set to show_deleted_secret=false to show not deleted secrets. |
subscription_id string |
Your Azure subscription Id. | |
tags dictionary |
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
tenant string |
Azure tenant ID. Use when authenticating with a Service Principal. | |
vault_uri string / required |
Vault uri where the secret stored in. | |
version string |
Default: "current" |
Secret version. Set it to Set it to Set it to specific version to list specific version of a secret. eg. fd2682392a504455b79c90dd04a1bf46 |
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
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 | Returned | Description | ||
---|---|---|---|---|
keyvaults complex |
always |
List of secrets in Azure Key Vault.
| ||
attributes dictionary |
success |
Secret attributes.
| ||
created string |
always |
Creation datetime.
Sample: 2019-04-25T07:26:49+00:00 | ||
enabled string |
always |
Indicate whether the secret is enabled.
Sample: True | ||
expires string |
success |
Expiration datetime.
Sample: 2019-04-25T07:26:49+00:00 | ||
not_before string |
success |
Not before datetime.
Sample: 2019-04-25T07:26:49+00:00 | ||
recovery_level string |
always |
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.
Sample: Recoverable+Purgeable | ||
updated string |
always |
Update datetime.
Sample: 2019-04-25T07:26:49+00:00 | ||
secret string |
always |
secret value.
Sample: mysecretvault | ||
sid string |
always |
Secret identifier.
Sample: | ||
tags dictionary |
always |
Tags of the secret.
Sample: {'delete': 'on-exit'} | ||
type string |
always |
Content type (optional)
Sample: mysecrettype | ||
version string |
always |
Secret version.
Sample: fd2682392a504455b79c90dd04a1bf46 |
Authors
- Jose Angel Munoz (@imjoseangel)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_keyvaultsecret_info_module.html