azure.azcollection.azure_rm_recoveryservicesvault module – Create, update and delete Azure Recovery Services vault

Note

This module is part of the azure.azcollection collection (version 4.2.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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_recoveryservicesvault.

New in azure.azcollection 1.1.0

Synopsis

• Create, update or delete Azure Recovery Services vault.

• Configure the public network access, security, encryption, redundancy and monitoring settings of the vault.

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.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
ad_user string	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in azure.azcollection 0.0.1	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in azure.azcollection 0.0.1	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. Default: "latest"
append_tags boolean	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. Choices: false true ← (default)
auth_source string added in azure.azcollection 0.0.1	Controls the source of the credentials to use for authentication. Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable. When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli. When set to env, the credentials will be read from the environment variables. When set to credential_file, it will read the profile from ~/.azure/credentials. When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 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. Choices: "auto" ← (default) "cli" "credential_file" "env" "msi"
cert_validation_mode string added in azure.azcollection 0.0.1	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. Choices: "ignore" "validate"
client_id string	Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the AZURE_CLIENT_ID environment variable.
cloud_environment string added in azure.azcollection 0.0.1	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. Default: "AzureCloud"
disable_instance_discovery boolean added in azure.azcollection 2.3.0	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 AZURE_DISABLE_INSTANCE_DISCOVERY environment variable. Choices: false ← (default) true
encryption dictionary added in azure.azcollection 4.2.0	Customer managed key (CMK) encryption settings of the vault. The managed identity used to access the key vault must be assigned to the vault through identity. CMK encryption cannot be disabled once enabled.
infrastructure_encryption string	Enable or disable double (infrastructure) encryption. Can only be set on a vault which has no protected items, and cannot be changed afterwards. Choices: "Enabled" "Disabled"
kek_identity dictionary	The managed identity used to access the customer managed key.
use_system_assigned_identity boolean	Whether to use the system assigned identity of the vault. Set to false when using user_assigned_identity. Choices: false true
user_assigned_identity string	Resource ID of the user assigned identity.
key_vault_properties dictionary	Properties of the key vault which hosts the customer managed key.
key_uri string	The key URI of the customer managed key.
identity dictionary	Identity for the Object
type string	Type of the managed identity Choices: "SystemAssigned" "UserAssigned" "SystemAssigned, UserAssigned" "None" ← (default)
user_assigned_identities dictionary	User Assigned Managed Identities and its options Default: {}
append boolean	If the list of identities has to be appended to current identities (true) or if it has to replace current identities (false) Choices: false true ← (default)
id list / elements=string	List of the user assigned identities IDs associated to the Object Default: []
location string / required	Azure Resource location.
log_mode string	Parent argument.
log_path string	Parent argument.
monitoring_settings dictionary added in azure.azcollection 4.2.0	Monitoring and alerting settings of the vault. Alert settings which are not specified keep their current value, or default to Enabled when the vault has no monitoring settings yet.
azure_monitor_alert_settings dictionary	Settings for Azure Monitor based alerts.
alerts_for_all_failover_issues string	Enable or disable built-in Azure Monitor alerts for all failover issues. Choices: "Enabled" "Disabled"
alerts_for_all_job_failures string	Enable or disable built-in Azure Monitor alerts for all job failures. Choices: "Enabled" "Disabled"
alerts_for_all_replication_issues string	Enable or disable built-in Azure Monitor alerts for all replication issues. Choices: "Enabled" "Disabled"
classic_alert_settings dictionary	Settings for the classic alert solution.
alerts_for_critical_operations string	Enable or disable classic alerts for critical operations. Choices: "Enabled" "Disabled"
email_notifications_for_site_recovery string	Enable or disable classic email notifications for Site Recovery. Choices: "Enabled" "Disabled"
name string / required	The name of the Azure Recovery Service Vault.
oidc_token string added in azure.azcollection 3.17.0	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 AZURE_FEDERATED_TOKEN environment variable.
oidc_token_file_path path added in azure.azcollection 3.17.0	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 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 added in azure.azcollection 4.2.0	Whether the vault accepts traffic from public networks. Choices: "Enabled" "Disabled"
redundancy_settings dictionary added in azure.azcollection 4.2.0	Backup storage redundancy settings of the vault. Storage redundancy can only be changed before any item is protected in the vault.
cross_region_restore string	Cross region restore state of the vault. Only valid when redundancy_settings.standard_tier_storage_redundancy=GeoRedundant. Cannot be disabled once enabled. Choices: "Enabled" "Disabled"
standard_tier_storage_redundancy string	The storage redundancy type of the vault. Choices: "LocallyRedundant" "GeoRedundant" "ZoneRedundant"
resource_group string / required	The name of the resource group.
secret string	Azure client secret. Use when authenticating with a Service Principal.
security_settings dictionary added in azure.azcollection 4.2.0	Security settings of the vault. Only the settings you specify are changed, the others keep their current values.
immutability_settings dictionary	Immutability settings of the vault.
configuration dictionary	Immutability configuration of the vault. Only used when state=Unlocked or state=Locked. When not set, type=AsPerPolicy is used.
duration_in_days integer	Immutability duration in days, between 30 and 36135. Required when type=TimeBased. Azure does not allow reducing the immutability duration while immutability is enabled.
type string	AsPerPolicy inherits the immutability duration from the backup policies. TimeBased uses the fixed duration_in_days. Choices: "AsPerPolicy" "TimeBased"
state string	Immutability state of the vault. Locked cannot be reverted. Choices: "Disabled" "Unlocked" "Locked"
soft_delete_settings dictionary	Soft delete settings of the vault. Once changed through this module, the vault no longer accepts soft delete changes from azure.azcollection.azure_rm_recoveryservicesvaultconfig.
enhanced_security_state string	Soft delete and security settings for hybrid workloads. AlwaysON cannot be reverted. Choices: "Enabled" "Disabled" "AlwaysON"
soft_delete_retention_period_in_days integer	Number of days deleted backup data is retained in the soft deleted state. Valid range is 14 to 180.
soft_delete_state string	Soft delete state for cloud workloads. AlwaysON cannot be reverted. Azure rejects Disabled when secure by default soft delete is enforced for the region. Choices: "Enabled" "Disabled" "AlwaysON"
state string	Assert the state of the protection item. Use present for Creating Azure Recovery Service Vault. Use absent for Deleting Azure Recovery Service Vault. Choices: "present" ← (default) "absent"
subscription_id string	Your Azure subscription Id.
tags dictionary	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 added in azure.azcollection 1.14.0	The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined.
x509_certificate_path path added in azure.azcollection 1.14.0	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.

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 OIDC, pass client_id, tenant and oidc_token or oidc_token_file_path, or set environment variables AZURE_CLIENT_ID, AZURE_TENANT and AZURE_FEDERATED_TOKEN or AZURE_FEDERATED_TOKEN_FILE.

• 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: Create/Update Azure Recovery Service vault
  azure_rm_recoveryservicesvault:
    resource_group: 'myResourceGroup'
    name: 'testVault'
    location: 'westeurope'
    state: 'present'
- name: Configure security, redundancy and monitoring settings of a Recovery Service vault
  azure_rm_recoveryservicesvault:
    resource_group: 'myResourceGroup'
    name: 'testVault'
    location: 'westeurope'
    public_network_access: Enabled
    security_settings:
      soft_delete_settings:
        soft_delete_state: AlwaysON
        soft_delete_retention_period_in_days: 30
      immutability_settings:
        state: Unlocked
    redundancy_settings:
      standard_tier_storage_redundancy: GeoRedundant
      cross_region_restore: Enabled
    monitoring_settings:
      azure_monitor_alert_settings:
        alerts_for_all_job_failures: Enabled
      classic_alert_settings:
        alerts_for_critical_operations: Disabled

- name: Encrypt a Recovery Service vault with a customer managed key
  azure_rm_recoveryservicesvault:
    resource_group: 'myResourceGroup'
    name: 'testVault'
    location: 'westeurope'
    identity:
      type: UserAssigned
      user_assigned_identities:
        id:
          - "/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"
    encryption:
      key_vault_properties:
        key_uri: https://mykeyvault.vault.azure.net/keys/mykey
      kek_identity:
        use_system_assigned_identity: false
        user_assigned_identity: "/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"
      infrastructure_encryption: Disabled

- name: Delete Recovery Service Vault
  azure_rm_recoveryservicesvault:
    resource_group: 'myResourceGroup'
    name: 'testVault'
    location: 'westeurope'
    state: 'absent'

Return Values

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

Key	Description
response complex	The response about the current state of the recovery services vault. Deprecated, will be removed in version 5.0.0. Use state instead, which returns the same information in snake_case. Returned: always
etag string	A unique read-only string that changes whenever the resource create. Returned: always Sample: "datetime'2020-09-16T02%3A44%3A27.834293Z'"
id string	Resource ID. Returned: always Sample: "/subscriptions/xxxxxxx/resourceGroups/resourcegroup_name/             providers/Microsoft.RecoveryServices/vaults/rev_name"
location string	The location of the resource. Returned: always Sample: "eastus"
name string	Name of the recovery services vault name. Returned: always Sample: "revault_name"
properties dictionary	The recovery service vault properties. Returned: always Sample: {"privateEndpointStateForBackup": "None", "privateEndpointStateForSiteRecovery": "None", "provisioningState": "Succeeded"}
sku string	The sku type of the recovery service vault. Returned: always Sample: "Standard"
tags dictionary	The resource tags. Returned: when-used Sample: {"key1": "value"}
type string	The type of the recovery service vault. Returned: always Sample: "Microsoft.RecoveryServices/vaults"
state complex added in azure.azcollection 4.2.0	The current state of the recovery services vault, with snake_case keys. Returned: when the vault exists
etag string	A unique read-only string that changes whenever the resource is updated. Returned: always Sample: "W/datetime'2026-10-22T02%3A44%3A27.834293Z'"
id string	Resource ID. Returned: always Sample: "/subscriptions/xxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.RecoveryServices/vaults/testVault"
identity dictionary	The managed identity of the recovery services vault. Returned: when-used Sample: {"principal_id": "xxxxxxx", "tenant_id": "xxxxxxx", "type": "SystemAssigned"}
location string	The location of the resource. Returned: always Sample: "eastus"
name string	Name of the recovery services vault. Returned: always Sample: "testVault"
properties dictionary	The recovery services vault properties. The settings managed by this module use the same names as the module options, for example properties.security_settings.soft_delete_settings. Returned: always Sample: {"monitoring_settings": {"azure_monitor_alert_settings": {"alerts_for_all_job_failures": "Enabled"}, "classic_alert_settings": {"alerts_for_critical_operations": "Disabled"}}, "provisioning_state": "Succeeded", "public_network_access": "Enabled", "redundancy_settings": {"cross_region_restore": "Disabled", "standard_tier_storage_redundancy": "LocallyRedundant"}, "security_settings": {"immutability_settings": {"state": "Unlocked"}, "soft_delete_settings": {"enhanced_security_state": "Enabled", "soft_delete_retention_period_in_days": 30, "soft_delete_state": "AlwaysON"}}}
sku dictionary	The SKU of the recovery services vault. Returned: always Sample: {"name": "Standard"}
tags dictionary	The resource tags. Returned: when-used Sample: {"key1": "value"}
type string	The type of the recovery services vault. Returned: always Sample: "Microsoft.RecoveryServices/vaults"

Authors

• Suyeb Ansari (@suyeb786)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)