Модуль azure.azcollection.azure_rm_backupazurevm — резервное копирование виртуальной машины Azure с помощью Azure Backup

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для работы с этим модулем требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: azure.azcollection.azure_rm_backupazurevm.

Добавлено в azure.azcollection 1.1.0

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

Краткое описание

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

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 2.7
На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули из azure.azcollection
Полные инструкции по установке см. на странице https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user string	Имя пользователя Active Directory. Используйте этот параметр для аутентификации с помощью пользователя Active Directory, а не субъекта-службы.
adfs_authority_url string добавлено в azure.azcollection 0.0.1	URL-адрес центра Azure AD. Используйте этот параметр для аутентификации по имени пользователя и паролю при наличии собственного центра ADFS.
api_profile string добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
append_tags boolean	Определяет, является ли поле тегов каноническим или теги только добавляются к существующим. При каноническом режиме все теги, отсутствующие в параметре tags, удаляются из метаданных объекта. Варианты: `false` `true` ← (по умолчанию)
auth_source string добавлено в azure.azcollection 0.0.1	Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной окружения `ANSIBLE_AZURE_AUTH_SOURCE`. Если установлено значение `auto` (по умолчанию), порядок приоритета следующий: параметры модуля -> `env` -> `credential_file` -> `cli`. Если установлено значение `env`, учетные данные считываются из переменных окружения. Если установлено значение `credential_file`, профиль считывается из `~/.azure/credentials`. Если установлено значение `cli`, учетные данные берутся из профиля Azure CLI. Чтобы указать идентификатор подписки, если их несколько, можно использовать `subscription_id` или переменную окружения `AZURE_SUBSCRIPTION_ID`; в противном случае используется подписка Azure CLI по умолчанию. Если установлено значение `msi`, узел должен быть ресурсом Azure с включенным расширением MSI. Чтобы указать идентификатор подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать `subscription_id` или переменную окружения `AZURE_SUBSCRIPTION_ID`; в противном случае выбирается первая подписка. Параметр `msi` добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
backup_policy_id string / обязательный	Идентификатор политики резервного копирования в хранилище Recovery Services Vault, указанном в поле recovery_vault_name.
cert_validation_mode string добавлено в azure.azcollection 0.0.1	Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав `ignore`. Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используйте этот параметр для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной окружения `AZURE_CLIENT_ID`.
cloud_environment string добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Значение true полностью отключает обнаружение экземпляров и проверку центра. Этот параметр предназначен для сценариев, в которых невозможно получить доступ к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляров включает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Если установить значение True, проверка центра отключается. Поэтому крайне важно убедиться, что настроенный хост центра является допустимым и заслуживающим доверия. Задается в профиле файла учетных данных или с помощью переменной окружения `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
oidc_token string добавлено в azure.azcollection 3.17.0	Токен OpenID Connect (OIDC) (JWT), непосредственно используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной окружения `AZURE_FEDERATED_TOKEN`.
oidc_token_file_path path добавлено в azure.azcollection 3.17.0	Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только исходный токен. Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной окружения `AZURE_FEDERATED_TOKEN_FILE`.
password string	Пароль пользователя Active Directory. Используйте этот параметр для аутентификации с помощью пользователя Active Directory, а не субъекта-службы.
profile string	Профиль безопасности из файла ~/.azure/credentials.
recovery_point_expiry_time string добавлено в azure.azcollection 1.15.0	Время истечения срока действия точки восстановления в формате UTC. Используется, если параметр `state` имеет значение `backup`.
recovery_vault_name string / обязательный	Имя хранилища Azure Recovery Services Vault.
resource_group string / обязательный	Имя группы ресурсов.
resource_id string / обязательный	Идентификатор ресурса виртуальной машины Azure.
secret string	Секрет клиента Azure. Используйте этот параметр для аутентификации с помощью субъекта-службы.
state string	Задает требуемое состояние элемента защиты. Используйте `create`, чтобы включить защиту виртуальной машины Azure. Используйте `update`, чтобы изменить политику защиты. Используйте `stop`, чтобы остановить защиту с сохранением существующих данных. Используйте `delete`, чтобы остановить защиту и удалить данные. Используйте `backup` для резервного копирования по запросу. Варианты: `"create"` ← (по умолчанию) `"update"` `"delete"` `"stop"` `"backup"`
subscription_id string	Идентификатор вашей подписки Azure.
tags dictionary	Словарь пар «строка:строка», назначаемых объекту в качестве метаданных. Теги метаданных объекта будут обновлены с учетом всех переданных значений. Чтобы удалить теги, установите для параметра append_tags значение false. В настоящее время в тегах зон Azure DNS и служб Traffic Manager также нельзя использовать пробелы. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.
tenant string	Идентификатор клиента Azure. Используйте этот параметр для аутентификации с помощью субъекта-службы.
thumbprint string добавлено в azure.azcollection 1.14.0	Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте этот параметр для аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path.
x509_certificate_path path добавлено в azure.azcollection 1.14.0	Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Закрытый ключ должен быть добавлен в конец сертификата. Используйте этот параметр для аутентификации с помощью субъекта-службы.

Примечания

Примечание

Для аутентификации в Azure можно передать параметры, задать переменные окружения, использовать профиль из ~/.azure/credentials или выполнить вход перед запуском задач или сценария с помощью az login.
Также можно пройти аутентификацию с помощью субъекта-службы или пользователя Active Directory.
Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
Для аутентификации через субъект-службу передайте 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/<sub-id>/resourceGroups/my-rg/providers/Microsoft.Compute/virtualMachines/testVM'
    backup_policy_id: '/subscriptions/<sub-id>/resourceGroups/my-rg/providers/microsoft.recoveryservices/vaults/testVault/backupPolicies/ProdPolicy'
    state: 'create'
- name: Stop protection but retain existing data
  azure_rm_backupazurevm:
    resource_group: 'my-rg'
    recovery_vault_name: 'testVault'
    resource_id: '/subscriptions/<sub-id>/resourceGroups/my-rg/providers/Microsoft.Compute/virtualMachines/testVM'
    state: 'stop'
- name: Stop protection and delete data
  azure_rm_backupazurevm:
    resource_group: 'my-rg'
    recovery_vault_name: 'testVault'
    resource_id: '/subscriptions/<sub-id>/resourceGroups/my-rg/providers/Microsoft.Compute/virtualMachines/testVM'
    state: 'delete'
- name: Trigger an on-demand backup for a protected Azure VM
  azure_rm_backupazurevm:
    resource_group: 'my-rg'
    recovery_vault_name: 'testVault'
    resource_id: '/subscriptions/<sub-id>/resourceGroups/my-rg/providers/Microsoft.Compute/virtualMachines/testVM'
    backup_policy_id: '/subscriptions/<sub-id>/resourceGroups/my-rg/providers/microsoft.recoveryservices/vaults/testVault/backupPolicies/ProdPolicy'
    recovery_point_expiry_time: '2023-02-09T06:00:00Z'
    state: 'backup'

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

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

Ключ	Описание
id string	Сведения о защите резервной копии виртуальной машины. Возвращается: всегда Пример: `"{\"response\":{\"id\":\"protection_id\",\"name\":\"protection_item_name\",\"properties\":{}}}"`

Авторы

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

Ссылки на коллекцию

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