azure.azcollection.azure_rm_dataprotectionbackupinstancedisk module – Manage Azure Disk Backup instance (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_dataprotectionbackupinstancedisk.

New in azure.azcollection 4.2.0

Synopsis

• Configure or remove backup protection for an Azure managed disk under a Backup vault.

• The Backup vault must have a system-assigned or user-assigned managed identity granted Disk Snapshot Contributor on the snapshot resource group and Disk Backup Reader on the disk before this module can succeed.

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"
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"
backup_policy_id string	The resource ID of the Disk Backup policy to apply. Required when state=present.
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
disk_id string	The resource ID of the Azure managed disk to protect. Required when state=present.
friendly_name string	A friendly name for the backup instance.
identity dictionary	Identity used by this backup instance to perform data operations. This identity must already be assigned to the Backup vault, and must be granted Disk Snapshot Contributor on the snapshot resource group and Disk Backup Reader on the disk.
type string	Type of the managed identity to use. When not specified, the current identity is left unchanged (or Azure’s own system-assigned default applies on first creation). Choices: "SystemAssigned" "UserAssigned"
user_assigned_identity string	The resource ID of the user-assigned managed identity to use. Required when identity.type=UserAssigned.
location string	Azure location. Defaults to the resource group’s location.
log_mode string	Parent argument.
log_path string	Parent argument.
name string / required	The name of the backup instance.
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.
resource_group string / required	The name of the resource group.
secret string	Azure client secret. Use when authenticating with a Service Principal.
snapshot_resource_group string	The name of the resource group where disk snapshots are stored. Defaults to the disk’s own resource group when not specified. Must be in the same subscription as disk_id; cross-subscription snapshot storage is not supported by the Azure Backup service.
state string	Use present to create or update and absent to delete. Choices: "absent" "present" ← (default)
subscription_id string	Your Azure subscription Id.
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.
vault_name string / required	The name of the Backup vault the instance belongs to.
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: Configure backup for a managed disk
  azure_rm_dataprotectionbackupinstancedisk:
    resource_group: myResourceGroup
    vault_name: mybackupvault
    name: mydiskbackupinstance
    location: eastus
    disk_id: /subscriptions/xxxx-xxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/mydisk
    backup_policy_id: >-
        /subscriptions/xxxx-xxxx/resourceGroups/myResourceGroup/providers/Microsoft.DataProtection/backupVaults/mybackupvault/backupPolicies/mydiskbackuppolicy

- name: Configure backup for a managed disk using a user-assigned identity
  azure_rm_dataprotectionbackupinstancedisk:
    resource_group: myResourceGroup
    vault_name: mybackupvault
    name: mydiskbackupinstance
    location: eastus
    disk_id: /subscriptions/xxxx-xxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/mydisk
    backup_policy_id: >-
        /subscriptions/xxxx-xxxx/resourceGroups/myResourceGroup/providers/Microsoft.DataProtection/backupVaults/mybackupvault/backupPolicies/mydiskbackuppolicy
    identity:
      type: UserAssigned
      user_assigned_identity: >-
          /subscriptions/xxxx-xxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myuai

- name: Remove backup protection for a managed disk
  azure_rm_dataprotectionbackupinstancedisk:
    resource_group: myResourceGroup
    vault_name: mybackupvault
    name: mydiskbackupinstance
    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 instance. Returned: always Sample: "/subscriptions/xxxx-xxxx/resourceGroups/myResourceGroup/providers/Microsoft.DataProtection/backupVaults/mybackupvault/backupInstances/mydiskbackupinstance"

Authors

• Zun Yang (@zunyangc)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)