azure.azcollection.azure_rm_vmbackuppolicy_info – Получение деталей политики резервного копирования

Примечание

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

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

Для использования в плейбуке укажите: azure.azcollection.azure_rm_vmbackuppolicy_info.

Новое в версии 1.1.0: из azure.azcollection

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

Обзор

Получение деталей политики резервного копирования.

Требования

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

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 булево	Варианты: нет да ←	Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 из azure.azcollection	Варианты: авто ← 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.
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`.
name строка / обязательно		Имя политики.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью принципала службы.
subscription_id строка		Идентификатор вашей подписки Azure.
tags словарь		Словарь пар строка:строка для присвоения метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
tenant строка		Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы.
vault_name строка / обязательно		Имя хранилища Recovery Services Vault.

Примечания

Примечание

Для аутентификации с 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.

Примеры

azure_rm_backvmuppolicy_info:
  name: 'myBackupPolicy'
  vault_name: 'myVault'
  resource_group: 'myResourceGroup'

Значения возврата

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

Ключевые поля		Возвращаемое значение	Описание
response сложный тип		всегда	Ответ о текущем состоянии политики резервного копирования.
	id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxx/resourceGroups/resourcegroup_name/ providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myBackup
	name строка	всегда	Имя политики резервного копирования. Пример: myBackup
	properties словарь	всегда	Свойства политики резервного копирования. Пример: {'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 строка	всегда	Тип ресурса. Пример: Microsoft.RecoveryServices/vaults/backupPolicies

Авторы

Suyeb Ansari (@suyeb786)

© 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_vmbackuppolicy_info_module.html