azure.azcollection.azure_rm_backuppolicy module – Manage Azure Backup Policy
Note
This module is part of the azure.azcollection collection (version 1.16.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_backuppolicy.
New in azure.azcollection 1.4.0
Synopsis
Create and delete instance of Azure 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 |
|---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
Defines the type of resource the policy will be applied to. Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
The amount of days to retain backups. Does not apply to Weekly frequency. |
|
How many days to retain instant recovery snapshots. |
|
Parent argument. |
|
Parent argument. |
|
The name of the backup policy. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The name of the resource group the vault is in. |
|
List of days to execute the schedule. Does not apply to Daily frequency. |
|
The frequency to run the policy. Choices:
|
|
The hour to run backups. Valid choices are on 24 hour scale (0-23). |
|
The amount of weeks between backups. Backup every schedule_weekly_frequency week(s). Azure will default behavior to running weekly if this is left blank. Does not apply to Daily frequency. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Assert the state of the backup policy. Use Choices:
|
|
Your Azure subscription Id. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
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. |
|
Timezone to apply schedule_run_time. Default: |
|
The name of the Recovery Services Vault the policy belongs to. |
|
The amount of weeks to retain backups. |
|
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 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 logincommand.
Examples
- name: Delete a backup policy
azure_rm_backuppolicy:
vault_name: Vault_Name
name: Policy_Name
resource_group: Resource_Group_Name
state: absent
- name: Create a daily VM backup policy
azure_rm_backuppolicy:
vault_name: Vault_Name
name: Policy_Name
resource_group: Resource_Group_Name
state: present
backup_management_type: "AzureIaasVM"
schedule_run_frequency: "Daily"
instant_recovery_snapshot_retention: 2
daily_retention_count: 12
time_zone: "Pacific Standard Time"
schedule_run_time: 14
- name: Create a weekly VM backup policy
azure.azcollection.azure_rm_backuppolicy:
vault_name: Vault_Name
name: Policy_Name
resource_group: Resource_Group_Name
state: present
backup_management_type: "AzureIaasVM"
schedule_run_frequency: "Weekly"
instant_recovery_snapshot_retention: 5
weekly_retention_count: 4
schedule_days:
- "Monday"
- "Wednesday"
- "Friday"
time_zone: "Pacific Standard Time"
schedule_run_time: 8
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Id of specified backup policy. Returned: always Sample: |
|
Location of backup policy. Returned: always Sample: |
|
Name of backup policy. Returned: always Sample: |
|
Type of backup policy. Returned: always Sample: |