azure_rm_keyvault

Manage Key Vault instance

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_keyvault

Synopsis

Manage Key Vault instance

Parameters

Name	Type	Required	Default	Description
access_policies	list			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.
It is mutually exclusive with I(hsm_name)
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
administrators	list		`[]`	List of administrator OID’s for data plane operations for Managed HSM.
It is mutually exclusive with I(vault_name)
api_profile	string		`latest`	Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags	bool		`true`	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	string		`auto`	Controls the source of the credentials to use for authentication.
Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli).
When set to C(env), the credentials will be read from the environment variables.
When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.
When set to C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
cert_validation_mode	string			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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable.
client_id	string			Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).
Can also be set via the C(AZURE_CLIENT_ID) environment variable.
cloud_environment	string		`AzureCloud`	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
disable_instance_discovery	bool		`false`	Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to True, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy.
Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable.
enable_purge_protection	bool		`false`	Property specifying whether protection against purge is enabled for this vault.
enable_rbac_authorization	bool			Property that controls how data actions are authorized.
When I(enable_rbac_authorization=true), the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored.
When I(enable_rbac_authorization=false), the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored.
If null or not specified, the value of this property will not change.
Starting with API version 2026-02-01, Azure defaults this to true (RBAC) if not specified.
enable_soft_delete	bool		`true`	Property to specify whether the soft delete functionality is enabled for this key vault.
enabled_for_deployment	bool			Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
It is mutually exclusive with I(hsm_name)
enabled_for_disk_encryption	bool			Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
It is mutually exclusive with I(hsm_name)
enabled_for_template_deployment	bool			Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
It is mutually exclusive with I(hsm_name)
hsm_name	string			Name of the HSM.
It is mutually exclusive with I(vault_name)
identity	dict			Identity for the HSM, not valid for vault_name.
It is mutually exclusive with I(vault_name)
is_purge_deleted	bool		`false`	Whether permanently deletes the specified vault. aka Purges the deleted Azure key vault
Default value is C(True)
When I(is_purge_deleted) is specified, the I(location) has to be configured. If not configured, the default locatioin of the resource group will be used.
location	string			Resource location. If not set, location from the resource group will be used as default.
log_mode	string			Parent argument.
log_path	string			Parent argument.
network_acls	dict			A collection of rules governing the accessibility of the vault from specific network locations.
oidc_token	string			Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
This token is exchanged with Azure AD using OIDC federated identity.
Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.
Can also be set via the C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
The file must contain only raw token.
This method is commonly used in platforms that materialize OIDC tokens as files
Can also be set via the C(AZURE_FEDERATED_TOKEN_FILE) environment variable.
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.
public_network_access	string			Property to specify whether the vault will accept traffic from public internet.
recover_mode	bool			Create vault in recovery mode.
resource_group	string	yes		The name of the Resource Group to which the server belongs.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
sku	dict			SKU details.
soft_delete_retention_in_days	int			Property specifying the number of days to retain deleted vaults.
state	string		`present`	Assert the state of the KeyVault. Use C(present) to create or update an KeyVault and C(absent) to delete it.
subscription_id	string			Your Azure subscription Id.
tags	dict			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.
Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.
Azure Front Door doesn’t support the use of
Azure Automation and Azure CDN only support 15 tags on resources.
tenant	string			Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint	string			The thumbprint of the private key specified in I(x509_certificate_path).
Use when authenticating with a Service Principal.
Required if I(x509_certificate_path) is defined.
vault_name	string			Name of the vault.
It is mutually exclusive with I(hsm_name)
vault_tenant	string			The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
x509_certificate_path	string			Path to the X509 certificate used to create the service principal in PEM format.
The certificate must be appended to the private key.
Use when authenticating with a Service Principal.

Example

yaml

- name: Create instance of Key Vault
  azure.azcollection.azure_rm_keyvault:
    resource_group: myResourceGroup
    vault_name: samplekeyvault
    enabled_for_deployment: true
    enable_rbac_authorization: true
    vault_tenant: 72f98888-8666-4144-9199-2d7cd0111111
    sku:
      name: standard
      family: A
    access_policies:
      - tenant_id: 72f98888-8666-4144-9199-2d7cd0111111
        object_id: 99998888-8666-4144-9199-2d7cd0111111
        keys:
          - get
          - list