azure_rm_keyvaultsecret - Use Azure KeyVault Secrets.

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis

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).

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	Default: None	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
api_profile (added in 2.5)	Choices: latest ←	Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags	Default: yes	Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
auth_source (added in 2.5)	Choices: auto ← cli credential_file env	Controls the source of the credentials to use for authentication. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable.
cert_validation_mode (added in 2.5)	Choices: validate ignore Default: None	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 `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable.
client_id	Default: None	Azure client ID. Use when authenticating with a Service Principal.
cloud_environment (added in 2.4)	Default: AzureCloud	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable.
keyvault_uri required		URI of the keyvault endpoint.
password	Default: None	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile	Default: None	Security profile found in ~/.azure/credentials file.
secret	Default: None	Azure client secret. Use when authenticating with a Service Principal.
secret_name required		Name of the keyvault secret.
secret_value		Secret to be secured by keyvault. aliases: secret
state	Choices: absent present ←	Assert the state of the subnet. Use 'present' to create or update a secret and 'absent' to delete a secret .
subscription_id	Default: None	Your Azure subscription Id.
tags	Default: None	Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.
tenant	Default: None	Azure tenant ID. Use when authenticating with a Service Principal.

Notes

Note

For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.

Examples

- name: Create a secret
  azure_rm_keyvaultsecret:
    secret_name: MySecret
    secret_value: My_Pass_Sec
    keyvault_uri: https://contoso.vault.azure.net/
    tags:
        testing: testing
        delete: never

- name: Delete a secret
  azure_rm_keyvaultsecret:
    secret_name: MySecret
    keyvault_uri: https://contoso.vault.azure.net/
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
state complex		success	Current state of the secret.
	secret_id str		Secret resource path.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

Ian Philpot (@tripdubroot)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/azure_rm_keyvaultsecret_module.html