azure.azcollection.azure_rm_backupazurevm – Архивирование виртуальной машины Azure с помощью Azure Backup

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в книге задач укажите: azure.azcollection.azure_rm_backupazurevm.

Новое в версии 1.1.0: коллекции azure.azcollection

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Архивирование виртуальной машины Azure с помощью Azure Backup.
Включение/обновление защиты для виртуальной машины Azure.
Запуск резервного копирования по требованию для защищенной виртуальной машины Azure.
Отключение защиты, но сохранение существующих данных.
Отключение защиты и удаление данных.

Требования

Ниже приведены требования к хосту, на котором будет выполняться данный модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с учетными данными службы.
adfs_authority_url строка добавлено в 0.0.1 коллекции azure.azcollection		URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile строка добавлено в 0.0.1 коллекции azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags логическое значение	Варианты: no yes ←	Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 коллекции azure.azcollection	Варианты: auto ← cli credential_file env msi	Определяет источник учетных данных для аутентификации. Также может быть задан через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в значение `auto` (по умолчанию), приоритет имеет параметры модуля -> `env` -> `credential_file` -> `cli`. При установке в `env`, учетные данные будут считываться из переменных среды При установке в `credential_file`, профиль будет считан из `~/.azure/credentials`. При установке в `cli`, учетные данные будут взяты из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут быть использованы для указания идентификатора подписки, если их несколько, в противном случае используется стандартная подписка az cli. При установке в `msi`, машина должна быть ресурсом Azure с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут быть использованы для указания идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, в противном случае выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6.
backup_policy_id строка / обязательно		Идентификатор политики резервного копирования, присутствующий в хранилище Recovery Services, указанном в поле recovery_vault_name.
cert_validation_mode строка добавлено в 0.0.1 коллекции azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-конечных точек. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Можно также задать в файле профиля учетных данных или переменной среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с учетными данными службы.
cloud_environment строка добавлено в 0.0.1 коллекции azure.azcollection	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL метаданных конечной точки обнаружения (требуется для Azure Stack). Можно также задать в файле профиля учетных данных или переменной среды `AZURE_CLOUD_ENVIRONMENT`.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с учетными данными службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
recovery_vault_name строка / обязательно		Имя хранилища Recovery Services Azure.
resource_group строка / обязательно		Имя группы ресурсов.
resource_id строка / обязательно		Идентификатор ресурса виртуальной машины Azure.
secret строка		Секретный ключ клиента Azure. Используется при аутентификации с учетными данными службы.
state строка	Варианты: create ← update delete stop backup	Устанавливает состояние элемента защиты. Используйте `create` для включения защиты виртуальной машины Azure. Используйте `update` для изменения политики защиты. Используйте `stop` для отключения защиты, но сохранения существующих данных. Используйте `delete` для отключения защиты и удаления данных. Используйте `backup` для резервного копирования по требованию.
subscription_id строка		Ваш идентификатор подписки Azure.
tags словарь		Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные тегов объекта будут обновлены с использованием предоставленных значений. Для удаления тегов установите параметр append_tags в значение false.
tenant строка		Идентификатор клиента Azure. Используется при аутентификации с учетными данными службы.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или выполнить вход до запуска задач или книги задач с помощью az login.
Аутентификация также возможна с использованием учетных данных службы или пользователя Active Directory.
Для аутентификации с помощью учетных данных службы передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации с помощью пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные могут храниться в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также возможно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

Авторизация с помощью Azure CLI: Как выполнить аутентификацию, используя команду az login.

Примеры

- name: Enabling/Updating protection for the Azure VM
  azure_rm_backupazurevm:
    resource_group: 'myResourceGroup'
    recovery_vault_name: 'testVault'
    resource_id: '/subscriptions/00000000-0000-0000-0000-000000000000/         resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/testVM'
    backup_policy_id: '/subscriptions/00000000-0000-0000-0000-000000000000/         resourceGroups/myResourceGroup/providers/microsoft.recoveryservices/vaults/testVault/backupPolicies/ProdPolicy'
    state: 'create'
- name: Stop protection but retain existing data
  azure_rm_backupazurevm:
    resource_group: 'myResourceGroup'
    recovery_vault_name: 'testVault'
    resource_id: '/subscriptions/00000000-0000-0000-0000-000000000000/         resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/testVM'
    state: 'stop'
- name: Stop protection and delete data
  azure_rm_backupazurevm:
    resource_group: 'myResourceGroup'
    recovery_vault_name: 'testVault'
    resource_id: '/subscriptions/00000000-0000-0000-0000-000000000000/         resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/testVM'
    state: 'delete'
- name: Trigger an on-demand backup for a protected Azure VM
  azure_rm_backupazurevm:
    resource_group: 'myResourceGroup'
    recovery_vault_name: 'testVault'
    resource_id: '/subscriptions/00000000-0000-0000-0000-000000000000/         resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/testVM'
    backup_policy_id: '/subscriptions/00000000-0000-0000-0000-000000000000/         resourceGroups/myResourceGroup/providers/microsoft.recoveryservices/vaults/testVault/backupPolicies/ProdPolicy'
    state: 'backup'

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
id строка	всегда	Подробности защиты резервного копирования ВМ. Пример: {"response":{"id":"protection_id","name":"protection_item_name","properties":{}}}

Авторы

Suyeb Ansari (@suyeb786)
Pallavi Chaudhari (@PallaviC2510)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_backupazurevm_module.html