Модуль azure.azcollection.azure_rm_containerregistrywebhook — Управление экземпляром веб-хука.
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости, см. Требования для подробностей.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_containerregistrywebhook.
Новая функция в azure.azcollection 0.1.2
Описание
- Создание, обновление и удаление экземпляра веб-хука.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, выполняющем модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
actions list / elements=string | Список действий, которые запускают вебхук для отправки уведомлений. |
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. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлено через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Также может быть установлено через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
custom_headers dictionary | Пользовательские заголовки, которые будут добавлены к уведомлениям вебхука. |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате крайне важно убедиться, что настроенный узел является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
location string | Расположение ресурса. Если не указано, по умолчанию будет использоваться расположение из группы ресурсов. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
registry_name string / required | Имя реестра контейнеров. |
resource_group строка / обязательно | Название группы ресурсов, к которой принадлежит реестр контейнеров. |
scope строка | Область хранилищ, где может быть инициировано событие. Например, «foo:*» означает события для всех тегов в хранилище «foo». «foo:bar» означает события только для «foo:bar». «foo» эквивалентно «foo:latest». Пустая строка означает все события. |
secret строка | Секретный ключ клиента Azure. Используется при аутентификации с помощью службы-принципала. |
service_uri строка | URI службы веб-хука для отправки уведомлений. |
state строка | Устанавливает состояние репликации реестра контейнеров. Используйте Варианты:
|
status строка | Статус веб-хука на момент вызова операции. Варианты:
|
subscription_id строка | Ваш идентификатор подписки Azure. |
tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с помощью службы-принципала. |
thumbprint строка добавлен в azure.azcollection 1.14.0 | Отпечаток цифрового ключа закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью службы-принципала. Требуется, если определён x509_certificate_path. |
webhook_name строка / обязательно | Имя веб-хука. |
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 и пароль или установите 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 (or update) Webhook
azure_rm_containerregistrywebhook:
resource_group: myResourceGroup
registry_name: myRegistry
webhook_name: myWebhook
location: eastus
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
id строка | Идентификатор ресурса. Возвращается: всегда Пример: |
status строка | Статус веб-хука на момент вызова операции. Возможные значения: «enabled», «disabled» Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_containerregistrywebhook_module.html