azure.azcollection.azure_rm_backuppolicy – Manage Azure Backup Policy¶
Note
This plugin is part of the azure.azcollection collection (version 1.5.0).
To install it use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_backuppolicy
.
New in version 1.4.0: of azure.azcollection
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.7
azure >= 2.0.0
Parameters¶
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: 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:
Authors¶
Cole Neubauer(@coleneubauer)