azure.azcollection.azure_rm_dataprotectionbackupvault module – Manage Azure Backup vault (Microsoft.DataProtection)

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

New in azure.azcollection 4.1.0

Synopsis

• Create, update and delete an Azure Backup vault used by the Azure Data Protection service.

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"
cost_management_settings dictionary	Cost management settings of the backup vault.
granularity_level string	Granularity level for cost management. Choices: "VaultLevel" "ProtectedItemLevel" "ProtectedItemWithParentTag"
datastore_type string	Specifies the type of the data store. Cannot be changed after the backup vault has been created. Choices: "ArchiveStore" "OperationalStore" "VaultStore" ← (default)
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
feature_settings dictionary	Feature settings of the backup vault.
cross_region_restore_settings dictionary	Cross region restore settings. Only valid when redundancy=GeoRedundant. Once enabled it cannot be disabled.
state string	Cross region restore state. Choices: "Disabled" "Enabled"
cross_subscription_restore_settings dictionary	Cross subscription restore settings.
state string	Cross subscription restore state. PermanentlyDisabled cannot be reverted once set. Choices: "Disabled" "PermanentlyDisabled" "Enabled"
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	Azure 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.
monitoring_settings dictionary	Monitoring settings of the backup vault.
azure_monitor_alert_settings dictionary	Settings for Azure Monitor based alerts.
alerts_for_all_job_failures string	Enable or disable Azure Monitor alerts for all job failures. Choices: "Enabled" "Disabled"
name string / required	The name of the backup 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.
redundancy string	Specifies the backup storage redundancy. Cannot be changed after the backup vault has been created. Choices: "GeoRedundant" "LocallyRedundant" ← (default) "ZoneRedundant"
replicated_regions list / elements=string	List of replicated regions for the backup vault.
resource_group string / required	The name of the resource group to which the backup vault belongs.
resource_guard_operation_requests list / elements=string	Resource guard operation requests on which LAC (least-access-control) check will be performed.
secret string	Azure client secret. Use when authenticating with a Service Principal.
security_settings dictionary	Security settings of the backup vault.
encryption_settings dictionary	Customer managed key (CMK) settings of the backup vault.
infrastructure_encryption string	Enabling or disabling double (infrastructure) encryption. Choices: "Enabled" "Disabled"
kek_identity dictionary	The managed identity used for the CMK.
identity_id string	Resource ID of the user assigned managed identity (required when identity_type=UserAssigned).
identity_type string	The identity type used to access the Key Vault. Choices: "SystemAssigned" "UserAssigned"
key_vault_properties dictionary	Properties of the Key Vault which hosts the CMK.
key_uri string	The key URI of the customer managed key.
state string	Encryption state of the backup vault. Choices: "Enabled" "Disabled"
immutability_settings dictionary	Immutability settings at vault level.
state string	Immutability state. Locked cannot be reverted once set. Choices: "Disabled" "Unlocked" "Locked"
soft_delete_settings dictionary	Soft delete related settings.
retention_duration_in_days float	Soft delete retention duration in days. Valid range is 14 to 180.
state string	State of soft delete. AlwaysOn cannot be reverted once set. Choices: "Off" "On" "AlwaysOn"
state string	Assert the state of the backup vault. Use present to create or update a backup vault and absent to delete it. Choices: "absent" "present" ← (default)
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 a Backup vault with a minimal configuration
  azure_rm_dataprotectionbackupvault:
    resource_group: myResourceGroup
    name: mybackupvault
    location: eastus
    datastore_type: VaultStore
    redundancy: LocallyRedundant
    identity:
      type: SystemAssigned
    tags:
      env: test

- name: Update Backup vault security, feature, monitoring and cost settings
  azure_rm_dataprotectionbackupvault:
    resource_group: myResourceGroup
    name: mybackupvault
    location: eastus
    datastore_type: VaultStore
    redundancy: GeoRedundant
    security_settings:
      soft_delete_settings:
        state: "On"
        retention_duration_in_days: 30
      immutability_settings:
        state: Unlocked
      encryption_settings:
        state: Enabled
        infrastructure_encryption: Enabled
        key_vault_properties:
          key_uri: https://mykeyvault.vault.azure.net/keys/mykey/1234
        kek_identity:
          identity_type: UserAssigned
          identity_id: /subscriptions/xxxx-xxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuai
    feature_settings:
      cross_subscription_restore_settings:
        state: Enabled
      cross_region_restore_settings:
        state: Enabled
    monitoring_settings:
      azure_monitor_alert_settings:
        alerts_for_all_job_failures: Enabled
    cost_management_settings:
      granularity_level: VaultLevel

- name: Delete a Backup vault
  azure_rm_dataprotectionbackupvault:
    resource_group: myResourceGroup
    name: mybackupvault
    state: absent

Return Values

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

Key	Description
id string	The Azure Resource Manager resource ID for the backup vault. Returned: always Sample: "/subscriptions/xxxx-xxxx/resourceGroups/myResourceGroup/providers/Microsoft.DataProtection/backupVaults/mybackupvault"

Authors

• Zun Yang (@zunyangc)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)