Модуль azure.azcollection.azure_rm_containerregistrywebhook – управление экземпляром веб-перехватчика.

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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 добавлено в azure.azcollection 0.0.1	URL-адрес центра сертификации Azure AD. Используйте при аутентификации по имени пользователя и паролю с собственным центром сертификации ADFS.
api_profile string добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
auth_source string добавлено в 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"`
cert_validation_mode string добавлено в 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 добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США: имя среды (как определено в Azure Python SDK, например `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также можно задать через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
custom_headers dictionary	Пользовательские заголовки, которые будут добавлены к уведомлениям веб-перехватчика.
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Значение true полностью отключает обнаружение экземпляра и проверку центра сертификации. Эта функция предназначена для сценариев, в которых невозможно получить доступ к конечной точке метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных центра сертификации с адреса https://login.microsoft.com/ для проверки центра сертификации. Если установить значение True, проверка центра сертификации отключается. Поэтому необходимо убедиться, что настроенный хост центра сертификации является действительным и заслуживающим доверия. Задается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
location string	Расположение ресурса. Если не задано, по умолчанию используется расположение группы ресурсов.
log_mode string	Аргумент родительского объекта.
log_path string	Аргумент родительского объекта.
oidc_token string добавлено в azure.azcollection 3.17.0	Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации рабочей нагрузки по удостоверению. Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC. Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды `AZURE_FEDERATED_TOKEN`.
oidc_token_file_path path добавлено в azure.azcollection 3.17.0	Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации рабочей нагрузки по удостоверению. Файл должен содержать только исходный токен. Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной среды `AZURE_FEDERATED_TOKEN_FILE`.
password string	Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.
profile string	Профиль безопасности из файла ~/.azure/credentials.
registry_name string / обязательный	Имя реестра контейнеров.
resource_group string / обязательный	Имя группы ресурсов, к которой относится реестр контейнеров.
scope string	Область репозиториев, в которой может срабатывать событие. Например, «foo:*» означает события для всех тегов в репозитории «foo». «foo:bar» означает события только для «foo:bar». «foo» эквивалентно «foo:latest». Пустое значение означает все события.
secret string	Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
service_uri string	URI службы, на который веб-перехватчик отправляет уведомления.
state string	Задает требуемое состояние репликации реестра контейнеров. Используйте `present` для создания или обновления репликации реестра контейнеров и `absent` для ее удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
status string	Состояние веб-перехватчика на момент вызова операции. Варианты: `"enabled"` `"disabled"`
subscription_id string	Идентификатор вашей подписки Azure.
tenant string	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
thumbprint string добавлено в azure.azcollection 1.14.0	Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path.
webhook_name string / обязательный	Имя веб-перехватчика.
x509_certificate_path path добавлено в azure.azcollection 1.14.0	Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат необходимо добавить к закрытому ключу. Используйте при аутентификации с помощью субъекта-службы.

Примечания

Примечание

Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль из ~/.azure/credentials или войти в систему перед выполнением задач или плейбука с помощью az login.
Аутентификация также возможна с помощью субъекта-службы или пользователя Active Directory.
Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
Для аутентификации с помощью субъекта-службы передайте 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 (or update) Webhook
  azure_rm_containerregistrywebhook:
    resource_group: myResourceGroup
    registry_name: myRegistry
    webhook_name: myWebhook
    location: eastus
    service_uri: http://test123.com
    scope: test123
    custom_headers:
      Key: Value1
    actions:
      - push

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

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

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

Авторы

Zim Kalinowski (@zikalino)

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

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