Модуль azure.azcollection.azure_rm_eventgrid_topic_subscription — управление подписками на темы Event Grid

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра сертификации Azure AD. Используйте при аутентификации по имени пользователя и паролю, если у вас есть собственный центр сертификации ADFS.

advanced_filter

list / elements=string

Расширенный фильтр позволяет фильтровать события на основе определенного свойства события.

KEY[.INNERKEY] FILTEROPERATOR VALUE [VALUE …]

Примеры

data.Color StringIn Blue Red Orange Yellow

data.Color StringNotIn Blue Red Orange Yellow

subject StringContains Blue Red

subject StringNotContains Blue Red

subject StringBeginsWith Blue Red

subject StringNotBeginsWith Blue Red

subject StringEndsWith img png jpg

subject StringNotEndsWith img png jpg

data.property1 NumberIn 5 10 20

data.property1 NumberInRange 5,10 20,30 40,50

data.property2 NumberNotIn 100 200 300

data.property2 NumberNotInRange 100,110 200,210 300,310

data.property3 NumberLessThan 100

data.property2 NumberLessThanOrEquals 100

data.property3 NumberGreaterThan 100

data.property2 NumberGreaterThanOrEquals 100

data.property3 BoolEquals true

data.property3 IsNullOrUndefined

data.property3 IsNotNull

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"

azure_active_directory_application_id_or_uri

string

Идентификатор или URI приложения Azure Active Directory, используемые для получения токена доступа, который будет включен в запросы доставки в качестве токена предъявителя. Применимо только для конечной точки типа webhook.

azure_active_directory_tenant_id

string

Идентификатор арендатора Azure Active Directory, используемый для получения токена доступа, который будет включен в запросы доставки в качестве токена предъявителя. Применимо только для конечной точки типа webhook.

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"

deadletter_endpoint

string

Идентификатор ресурса Azure для целевого контейнера больших двоичных объектов Azure Storage, в который EventGrid должен помещать недоставляемые события для этой подписки на события.

delivery_attribute_mapping

list / elements=string

Добавляет сопоставление атрибутов доставки для передачи дополнительной информации в заголовках HTTP при доставке событий. Этот атрибут допустим для всех типов целевых точек, кроме StorageQueue.

Формат: attribute-name attribute-type attribute-value [attribute-is-secret]

somename dynamic somevalue true

somename2 static somevalue

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра сертификации будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляров включает получение метаданных центра сертификации с https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации отключается. Поэтому крайне важно убедиться, что настроенный узел центра сертификации является действительным и заслуживающим доверия.

Задается в профиле файла учетных данных или с помощью переменной среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

• false ← (по умолчанию)
• true

enable_advanced_filtering_on_arrays

boolean

Разрешает применять расширенные фильтры к массиву значений вместо ожидания одного значения.

Варианты:

• false
• true

endpoint

string

Конечная точка, в которую EventGrid должен доставлять события, соответствующие этой подписке на события. Для конечной точки типа webhook укажите соответствующий URL-адрес webhook. Для других типов конечных точек укажите идентификатор ресурса Azure этой конечной точки. Перед выполнением любой команды Event Grid предполагается, что целевая конечная точка уже создана и доступна для использования.

endpoint_type

string

Тип целевой конечной точки.

Варианты:

• "azurefunction"
• "eventhub"
• "hybridconnection"
• "servicebusqueue"
• "servicebustopic"
• "storagequeue"
• "webhook" ← (по умолчанию)

event_delivery_schema

string

Схема, в которой должны доставляться события для этой подписки на события. По умолчанию события доставляются в той же схеме, в которой они публикуются (на основе входной схемы соответствующей темы).

Варианты:

• "CloudEventSchemaV1_0"
• "CustomInputSchema"
• "EventGridSchema"

event_ttl

integer

Время жизни события (в минутах). Должно быть числом от 1 до 1440.

По умолчанию: 1440

expiration_date

string

Дата или дата и время (в формате UTC, например ‘2018-11-30T11:59:59+00:00’ или ‘2018-11-30’), после которых срок действия подписки на события истечет. По умолчанию срок действия подписки на события не истекает.

included_event_types

list / elements=string

Список типов событий (например, Microsoft.Storage.BlobCreated и Microsoft.Storage.BlobDeleted). Чтобы подписаться на все типы событий по умолчанию, не указывайте значение этого аргумента. Для тем Event Grid типы событий задаются пользователем. Для событий Azure, например Storage Accounts, IoT Hub и т. д., типы событий можно получить с помощью этой команды CLI: ‘az eventgrid topic-type list-event-types’.

labels

list / elements=string

Список меток, связанных с этой подпиской на события.

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

max_delivery_attempts

integer

Максимальное количество попыток доставки. Должно быть числом от 1 до 30.

По умолчанию: 30

max_events_per_batch

integer

Максимальное количество событий в пакете. Должно быть числом от 1 до 5000.

name

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, а не субъекта-службы.

preferred_batch_size_in_kilobytes

integer

Предпочтительный размер пакета в килобайтах. Должен быть числом от 1 до 1024.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

resource_group

string / обязательный

Имя группы ресурсов, в которой находится или будет создана тема.

secret

string

Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

state

string

Состояние подписки на события темы Eventgrid. Используйте present для создания или обновления и absent для удаления.

Варианты:

• "absent"
• "present" ← (по умолчанию)

storage_queue_msg_ttl

integer

Время жизни сообщения в очереди хранилища в секундах.

subject_begins_with

string

Необязательная строка для фильтрации событий подписки по префиксу. Подстановочные знаки не поддерживаются.

subject_case_sensitive

boolean

Указывает, следует ли сравнивать поля темы с учетом регистра. Если флаг задан, используется значение True.

Варианты:

• false
• true

subject_ends_with

string

Необязательная строка для фильтрации событий подписки по суффиксу. Подстановочные знаки не поддерживаются.

subscription_id

string

Идентификатор вашей подписки Azure.

tenant

string

Идентификатор арендатора Azure. Используйте при аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью субъекта-службы.

Обязателен, если задан параметр x509_certificate_path.

topic_name

string / обязательный

Имя темы.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат необходимо добавить после закрытого ключа.

Используйте при аутентификации с помощью субъекта-службы.

changed

boolean

Изменился ли ресурс.

Возвращается: всегда

Пример: true

eventgrid_subscriptions

complex

Список подписок Eventgrid.

Возвращается: всегда

destination

complex

Сведения о назначении

Возвращается: всегда

endpoint_base_url

string

Базовый URL конечной точки

Возвращается: всегда

Пример: "https://event-grid-site-xxxxx20070.azurewebsites.net/api/updates"

endpoint_type

string

Тип конечной точки

Возвращается: всегда

Пример: "WebHook"

max_events_per_batch

integer

Количество событий в пакете

Возвращается: всегда

Пример: 1

preferred_batch_size_in_kilobytes

integer

Предпочтительный размер пакета в килобайтах

Возвращается: всегда

Пример: 64

event_delivery_schema

string

Тип схемы Eventgrid

Возвращается: всегда

Пример: "EventGridSchema"

filter

complex

Параметры фильтрации событий, публикуемых в конечную точку

Возвращается: всегда

subject_begins_with

string

Фильтровать по началу темы, соответствующему этому значению

Возвращается: всегда

subject_ends_with

string

Фильтровать по окончанию темы, соответствующему этому значению

Возвращается: всегда

id

string

Идентификатор подписки Eventgrid

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.EventGrid/topics/topic-xxxxx20070/providers/Microsoft.EventGrid/eventSubscriptions/subscription-xxxxx20070"

name

string

Имя подписки Eventgrid

Возвращается: всегда

Пример: "subscription-xxxxx20070"

provisioning_state

string

Состояние подготовки этой подписки Eventgrid

Возвращается: всегда

Пример: "Succeeded"

retry_policy

complex

Политика повторных попыток для этой подписки Eventgrid

Возвращается: всегда

event_time_to_live_in_minutes

integer

Время жизни события в минутах

Возвращается: всегда

Пример: 1440

max_delivery_attempts

integer

Максимальное количество попыток доставки в конечную точку

Возвращается: всегда

Пример: 30

topic

string

Идентификатор исходного ресурса, на который оформлена подписка Eventgrid

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/microsoft.eventgrid/topics/topic-xxxxx20070"

type

string

Тип подписки Eventgrid

Возвращается: всегда

Пример: "Microsoft.EventGrid/eventSubscriptions"