Модуль azure.azcollection.azure_rm_containerregistrywebhook_info – Получение фактов о веб-хуке.

Примечание

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

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

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

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

Добавлена в azure.azcollection 0.1.2

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

Обзор

Получение фактов о веб-хуке.

Требования

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

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"`
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"`
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`
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
password string	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
registry_name string / required	Имя реестра контейнеров.
resource_group string / required	Имя группы ресурсов, к которой принадлежит реестр контейнеров.
secret string	Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности.
subscription_id string	Ваш идентификатор подписки Azure.

tenant string	Идентификатор Azure-тенанта. Используется при аутентификации с помощью принципала службы.
thumbprint string added in azure.azcollection 1.14.0	Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью принципала службы. Обязательно, если определён параметр x509_certificate_path.
webhook_name string / обязательно	Имя вебхука.
x509_certificate_path path added in 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: Get instance of Webhook
  azure_rm_containerregistrywebhook_info:
    resource_group: resource_group_name
    registry_name: registry_name
    webhook_name: webhook_name

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

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

Ключ	Описание
webhooks сложный	Список результатов в виде словарей, где ключ — имя вебхука, а значения — данные для этого вебхука. Возвращается: всегда
webhook_name сложный	Ключ — имя сервера, к которому относятся значения. Возвращается: успех
actions строка	Список действий, которые вызывают вебхук для отправки уведомлений. Возвращается: всегда Пример: `"[\n'push'\n]"`
id строка	Идентификатор ресурса. Возвращается: всегда Пример: `"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registr ies/myRegistry/webhooks/myWebhook"`
location строка	Расположение ресурса. Его нельзя изменить после создания ресурса. Возвращается: всегда Пример: `"westus"`
name строка	Имя ресурса. Возвращается: всегда Пример: `"myWebhook"`
scope строка	Область репозиториев, где может быть вызвано событие. Например, ‘foo:’ означает события для всех тегов в репозитории ‘foo’. ‘foo:bar’ означает события только для ‘foo:bar’. ‘foo’ эквивалентно ‘foo:latest’. Пустая строка означает все события. Возвращается:* всегда Пример: `"myRepository"`
status строка	Статус вебхука в момент вызова операции. Возможные значения: ‘enabled’, ‘disabled’ Возвращается: всегда Пример: `"enabled"`
type строка	Тип ресурса. Возвращается: всегда Пример: `"Microsoft.ContainerRegistry/registries/webhooks"`

Авторы

Zim Kalinowski (@zikalino)

Ссылки на сборку

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