Spec-Zone.ru › Ansible 2.11

azure.azcollection.azure_rm_vmbackuppolicy – Создание или удаление политики резервного копирования ВМ Azure

Примечание

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

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

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

Введено в версии 1.1.0: коллекции azure.azcollection

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

Описание

  • Создание или удаление политики резервного копирования ВМ 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
логическое значение
    Варианты:
  • нет
  • да ←
Управляет тем, является ли поле тегов каноническим или просто добавляет к существующим тегам.
При каноническом виде любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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.
count
целое число
По умолчанию:
1
Количество типов периодов. Период хранения определяется путем подсчета типа периода Count раз.
months
список / элементы=строка
По умолчанию:
["Январь"]
Список месяцев года для политики годового хранения.
name
строка / обязательно
Имя политики.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile
строка
Профиль безопасности, находящийся в файле ~/.azure/credentials.
resource_group
строка / обязательно
Имя группы ресурсов.
secret
строка
Секрет клиента Azure. Используется при аутентификации с принципалом службы.
state
строка
    Варианты:
  • наличие ←
  • отсутствие
Утверждение состояния элемента защиты.
Используйте present для создания политики резервного копирования.
Используйте absent для удаления политики резервного копирования.
subscription_id
строка
Ваш идентификатор подписки Azure.
tags
словарь
Словарь пар "строка:строка" для назначения метаданных объекту.
Метаданные теги объекта будут обновлены с любыми предоставленными значениями.
Для удаления тегов установите параметр append_tags в значение false.
tenant
строка
Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
time
строка
По умолчанию:
"12:00"
Временные параметры политики резервного копирования в UTC.
vault_name
строка / обязательно
Имя хранилища Recovery Service.
weekdays
список / элементы=строка
По умолчанию:
["Понедельник"]
Список дней недели.
weeks
список / элементы=строка
По умолчанию:
["Первая"]
Список недель месяца.

Примечания

Примечание

  • Для аутентификации с 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: Create VM Backup Policy
  azure_rm_backvmuppolicy:
     name: 'myBackupPolicy'
     vault_name: 'myVault'
     resource_group: 'myResourceGroup'
     time: '18:00'
     weekdays: ['Monday', 'Thursday', 'Friday']
     weeks: ['First', 'Fourth']
     months: ['February', 'November']
     count: 4
     state: present
- name: Delete VM Backup Policy
  azure_rm_backvmuppolicy:
     name: 'myBackupPolicy'
     vault_name: 'myVault'
     resource_group: 'myResourceGroup'
     state: absent

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

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

Ключ Возвращаемое значение Описание
response
complex
всегда
Информация о текущем состоянии политики резервного копирования.
id
string
всегда
Идентификатор ресурса.

Пример:
/subscriptions/xxxxxxx/resourceGroups/resourcegroup_name/ providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myBackup
name
string
всегда
Имя политики резервного копирования.

Пример:
myBackup
properties
dictionary
всегда
Свойства политики резервного копирования.

Пример:
{'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
string
всегда
Тип ресурса.

Пример:
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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API