azure.azcollection.azure_rm_containerregistrywebhook — Управление экземпляром веб-хука.

Примечание

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

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

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

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

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

Обзор

Создание, обновление и удаление экземпляра веб-хука.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
actions список / элементы=строка		Список действий, которые запускают веб-хук для отправки уведомлений.
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.
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.
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`.
custom_headers строка		Дополнительные заголовки, которые будут добавлены к уведомлениям веб-хука.
... (остальные строки таблицы)	...	...

Примечания

Примечание

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

См. также

Войти в систему с помощью Azure CLI: Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: Create (or update) Webhook
  azure_rm_containerregistrywebhook:
    resource_group: myResourceGroup
    registry_name: myRegistry
    webhook_name: myWebhook
    location: eastus

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

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

Ключ	Возвращаемое значение	Описание
id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/w ebhooks/myWebhook
status строка	всегда	Статус веб-хука на момент вызова операции. Возможные значения: 'enabled', 'disabled' Пример: enabled

Авторы

Zim Kalinowski (@zikalino)

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