Модуль azure.azcollection.azure_rm_backuppolicy — Управление политикой резервного копирования Azure

Примечание

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

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

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

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

Новое в azure.azcollection 1.4.0

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

Обзор

Создание и удаление экземпляра политики резервного копирования 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 added in azure.azcollection 0.0.1	URL-адрес узла Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и имеет собственный узел ADFS.
api_profile string added in azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. Default: `"latest"`
auth_source string added in 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` могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию. При установке в `msi`, хост-машина должна быть ресурсом Azure с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
backup_management_type string	Определяет тип ресурса, к которому будет применена политика. Варианты: `"AzureIaasVM"`
cert_validation_mode string added in 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 added in azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. Default: `"AzureCloud"`
daily_retention_count integer	Количество дней для хранения резервных копий. Не применяется к еженедельной частоте.
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя извлечение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в True, проверка узла отключается. В результате важно убедиться, что настроенный узел узла действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
instant_recovery_snapshot_retention integer	Сколько дней хранить моментальные снимки для мгновенного восстановления.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string / required	Имя политики резервного копирования.
password string	Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group строка / обязательно	Имя группы ресурсов, в которой находится хранилище.
schedule_days список / элементы=строка	Список дней для выполнения расписания. Не применяется к ежедневной частоте.
schedule_run_frequency строка	Частота выполнения политики. Варианты: `"Daily"` `"Weekly"`
schedule_run_time целое число	Час для запуска резервного копирования. Допустимые значения находятся в пределах 24-часового формата (0-23).
schedule_weekly_frequency целое число	Количество недель между резервными копиями. Резервное копирование каждые schedule_weekly_frequency недель. Azure по умолчанию будет выполнять резервное копирование еженедельно, если этот параметр не указан. Не применяется к ежедневной частоте.
secret строка	Секрет Azure-клиента. Используйте при аутентификации с помощью Служебного принципа.
state строка	Утверждение состояния политики резервного копирования. Используйте `present` для создания или обновления политики резервного копирования и `absent` для ее удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id строка	Ваш идентификатор подписки Azure.
tenant строка	Идентификатор Azure-аренды. Используйте при аутентификации с помощью Служебного принципа.
thumbprint строка добавлено в azure.azcollection 1.14.0	Отпечаток цифрового сертификата закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью Служебного принципа. Необходимо, если определен x509_certificate_path.
time_zone строка	Часовой пояс для применения schedule_run_time. По умолчанию: `"UTC"`
vault_name строка / обязательно	Имя хранилища Recovery Services Vault, к которому принадлежит политика.
weekly_retention_count целое число	Количество недель для хранения резервных копий.
x509_certificate_path путь добавлено в azure.azcollection 1.14.0	Путь к X509-сертификату, используемому для создания служебного принципа в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используйте при аутентификации с помощью Служебного принципа.

Примечания

Примечание

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

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

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

Ключ	Описание
id строка	Идентификатор указанной резервной копии. Возвращаемое значение: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/Vault_Name/backupPolicies/Policy_Name"`
location строка	Расположение резервной копии. Возвращаемое значение: всегда Пример: `"eastus"`
name строка	Имя резервной копии. Возвращаемое значение: всегда Пример: `"DefaultPolicy"`
type строка	Тип резервной копии. Возвращаемое значение: всегда Пример: `"Microsoft.RecoveryServices/vaults/backupPolicies"`

Авторы

Кол Неубауэр(@coleneubauer)

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

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