Модуль azure.azcollection.azure_rm_eventgrid_topic_info – список тем Event Grid

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: azure.azcollection.azure_rm_eventgrid_topic_info.

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

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

Краткое описание

Список тем Event Grid.

Требования

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

python >= 2.7
На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
Все пакеты Python, перечисленные в requirements.txt коллекции, должны быть установлены на узле, выполняющем модули azure.azcollection, с помощью pip
Полные инструкции по установке можно найти здесь: https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
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"`
disable_instance_discovery boolean добавлено в 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	Родительский аргумент.
name string	Укажите имя темы Event Grid.
odata_query string	Запрос для фильтрации результатов поиска с использованием синтаксиса OData.
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.
resource_group string	Имя группы ресурсов, по которой нужно ограничить поиск тем. Если не указано, поиск выполняется по всей подписке.
secret string	Секрет клиента Azure. Используется для аутентификации с помощью субъекта-службы.
subscription_id string	Идентификатор вашей подписки Azure.
tags list / элементы=string	Ограничьте результаты, передав список тегов. Формат тегов: «ключ» или «ключ:значение».
tenant string	Идентификатор клиента Azure. Используется для аутентификации с помощью субъекта-службы.
thumbprint string добавлено в azure.azcollection 1.14.0	Отпечаток закрытого ключа, указанного в x509_certificate_path. Используется для аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path.
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: Get info on a Topic
  azure.azcollection.azure_rm_eventgrid_topic_info:
    resource_group: rg1
    odata_query: "contains(name, 'PATTERN')"

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

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

Ключ	Описание
changed boolean	Изменён ли ресурс. Возвращается: всегда Пример: `true`
eventgrid_topics complex	Список топиков Eventgrid. Возвращается: всегда
data_residency_boundary string	Граница резидентности данных Возвращается: всегда Пример: `"WithinGeopair"`
disable_local_auth boolean	Отключена ли локальная аутентификация Возвращается: всегда Пример: `false`
endpoint string	Конечная точка REST API для отправки событий Возвращается: всегда Пример: `"https://myTopic-20070.westus3-1.eventgrid.azure.net/api/events"`
id string	Идентификатор ресурса. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.EventGrid/topics/myTopic"`
inbound_ip_rules complex	Правила сетевого доступа Возвращается: если включено
action string	Действие: разрешить или запретить Возвращается: всегда Пример: `"Allow"`
ip_mask string	Сеть, к которой применяется правило, в нотации CIDR. Возвращается: всегда Пример: `"10.0.0.0/8"`
input_schema string	Схема входных данных, назначенная этому топику Возвращается: всегда Пример: `"EventGridSchema"`
location string	Расположение ресурса. Возвращается: всегда Пример: `"westus3"`
metric_resource_id string	Идентификатор ресурса метрики. Возвращается: всегда Пример: `"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"`
minimum_tls_version_allowed string	Минимально допустимая версия TLS Возвращается: всегда Пример: `"1.0"`
name string	Имя ресурса. Возвращается: всегда Пример: `"myTopic"`
provisioning_state string	Состояние подготовки. Возвращается: всегда Пример: `"Succeeded"`
public_network_access boolean	Указывает, включена ли диагностика загрузки. Возвращается: всегда Пример: `true`
topic_keys complex	Ключи общего доступа к топику Возвращается: всегда
key1 string	Ключ общего доступа 1 Возвращается: всегда Пример: `"FYKuIOq0xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxZEGV3gr"`
key2 string	Ключ общего доступа 2 Возвращается: всегда Пример: `"D8QRdfVrxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxZEGdMMc"`
type string	Тип Eventgrid Возвращается: всегда Пример: `"Microsoft.EventGrid/topics"`

Авторы

Bill Peck (@p3ck)

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

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