Documentation

azure_rm_keyvault - Manage Key Vault instance.

New in version 2.5.

Synopsis

  • Create, update and delete instance of Key Vault.

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
access_policies
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.
secrets
    Choices:
  • get
  • list
  • set
  • delete
  • backup
  • restore
  • recover
  • purge
List of permissions to secrets
application_id
Application ID of the client making request on behalf of a principal
keys
    Choices:
  • encrypt
  • decrypt
  • wrapkey
  • unwrapkey
  • sign
  • verify
  • get
  • list
  • create
  • update
  • import
  • delete
  • backup
  • restore
  • recover
  • purge
List of permissions to keys
tenant_id
The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
Current keyvault tenant_id value will be used if not specified.
certificates
    Choices:
  • get
  • list
  • delete
  • create
  • import
  • update
  • managecontacts
  • getissuers
  • listissuers
  • setissuers
  • deleteissuers
  • manageissuers
  • recover
  • purge
List of permissions to certificates
storage
List of permissions to storage accounts
object_id
required
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 show sp --id <application id>".
ad_user
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url
(added in 2.6)
Default:
None
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
(added in 2.5)
Default:
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.
auth_source
(added in 2.5)
    Choices:
  • auto
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.
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.
When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.
The msi was added in Ansible 2.6.
cert_validation_mode
(added in 2.5)
    Choices:
  • validate
  • ignore
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
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.
enable_soft_delete
bool
    Choices:
  • no
  • yes
Property to specify whether the soft delete functionality is enabled for this key vault.
enabled_for_deployment
bool
    Choices:
  • no
  • yes
Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
enabled_for_disk_encryption
bool
    Choices:
  • no
  • yes
Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
enabled_for_template_deployment
bool
    Choices:
  • no
  • yes
Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
location
Resource location. If not set, location from the resource group will be used as default.
password
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile
Security profile found in ~/.azure/credentials file.
recover_mode
bool
    Choices:
  • no
  • yes
Create vault in recovery mode.
resource_group
required
The name of the Resource Group to which the server belongs.
secret
Azure client secret. Use when authenticating with a Service Principal.
sku
SKU details
name
required
    Choices:
  • standard
  • premium
SKU name to specify whether the key vault is a standard vault or a premium vault.
family
required
SKU family name
state
    Choices:
  • absent
  • present ←
Assert the state of the KeyVault. Use 'present' to create or update an KeyVault and 'absent' to delete it.
subscription_id
Your Azure subscription Id.
tenant
Azure tenant ID. Use when authenticating with a Service Principal.
vault_name
required
Name of the vault
vault_tenant
The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.

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 instance of Key Vault
  azure_rm_keyvault:
    resource_group: myresourcegroup
    vault_name: samplekeyvault
    enabled_for_deployment: yes
    vault_tenant: 72f98888-8666-4144-9199-2d7cd0111111
    sku:
      name: standard
    access_policies:
      - tenant_id: 72f98888-8666-4144-9199-2d7cd0111111
        object_id: 99998888-8666-4144-9199-2d7cd0111111
        keys:
          - get
          - list

Return Values

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

Key Returned Description
id
str
always
The Azure Resource Manager resource ID for the key vault.

Sample:
id


Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Zim Kalinowski (@zikalino)

Hint

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