azure.azcollection.azure_rm_vmbackuppolicy module – Create or Delete Azure VM Backup Policy

Note

This module is part of the azure.azcollection collection (version 1.13.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.

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

New in version 1.1.0: of azure.azcollection

Synopsis

  • Create or Delete Azure VM Backup Policy.

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-azure.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 0.0.1 of azure.azcollection

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in 0.0.1 of azure.azcollection

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:

  • no

  • yes ← (default)

auth_source

string

added in 0.0.1 of azure.azcollection

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 0.0.1 of azure.azcollection

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.

cloud_environment

string

added in 0.0.1 of azure.azcollection

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”

count

integer

Count of duration types. Retention duration is obtained by the counting the duration type Count times.

Default: 1

log_mode

string

Parent argument.

log_path

string

Parent argument.

months

list / elements=string

List of months of year of yearly retention policy.

Default: [“January”]

name

string / required

Policy Name.

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.

state

string

Assert the state of the protection item.

Use present for Creating Backup Policy.

Use absent for Deleting Backup Policy.

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.

time

string

Retention times of retention policy in UTC.

Default: “12:00”

vault_name

string / required

Recovery Service Vault Name.

weekdays

list / elements=string

List of days of the week.

Default: [“Monday”]

weeks

list / elements=string

List of weeks of month.

Default: [“First”]

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 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 VM Backup Policy
  azure_rm_backvmuppolicy:
     name: 'myBackupPolicy'
     vault_name: 'myVault'
     resource_group: 'myResourceGroup'
     time: '18:00'
     weekdays: ['Monday', 'Thursday', 'Friday']
     weeks: ['First', 'Fourth']
     months: ['February', 'November']
     count: 4
     state: present
- name: Delete VM Backup Policy
  azure_rm_backvmuppolicy:
     name: 'myBackupPolicy'
     vault_name: 'myVault'
     resource_group: 'myResourceGroup'
     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 backup policy.

Returned: always

id

string

Resource ID.

Returned: always

Sample: “/subscriptions/xxxxxxx/resourceGroups/resourcegroup_name/ providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myBackup”

name

string

Backup Policy Name.

Returned: always

Sample: “myBackup”

properties

dictionary

The backup policy properties.

Returned: always

Sample: {“backupManagementType”: “AzureIaasVM”, “protectedItemsCount”: 0, “retentionPolicy”: {“monthlySchedule”: {“retentionDuration”: {“count”: 2, “durationType”: “Months”}, “retentionScheduleFormatType”: “Weekly”, “retentionScheduleWeekly”: {“daysOfTheWeek”: [“Wednesday”, “Thursday”], “weeksOfTheMonth”: [“First”, “Third”]}, “retentionTimes”: [“2018-01-24T10:00:00Z”]}, “retentionPolicyType”: “LongTermRetentionPolicy”, “weeklySchedule”: {“daysOfTheWeek”: [“Monday”, “Wednesday”, “Thursday”], “retentionDuration”: {“count”: 1, “durationType”: “Weeks”}, “retentionTimes”: [“2018-01-24T10:00:00Z”]}, “yearlySchedule”: {“monthsOfYear”: [“February”, “November”], “retentionDuration”: {“count”: 4, “durationType”: “Years”}, “retentionScheduleFormatType”: “Weekly”, “retentionScheduleWeekly”: {“daysOfTheWeek”: [“Monday”, “Thursday”], “weeksOfTheMonth”: [“Fourth”]}, “retentionTimes”: [“2018-01-24T10:00:00Z”]}}, “schedulePolicy”: {“schedulePolicyType”: “SimpleSchedulePolicy”, “scheduleRunDays”: [“Monday”, “Wednesday”, “Thursday”], “scheduleRunFrequency”: “Weekly”, “scheduleRunTimes”: [“2018-01-24T10:00:00Z”], “scheduleWeeklyFrequency”: 0}, “timeZone”: “Pacific Standard Time”}

type

string

Resource type.

Returned: always

Sample: “Microsoft.RecoveryServices/vaults/backupPolicies”

Authors

  • Suyeb Ansari (@suyeb786)