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

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"

append_tags

boolean

Определяет, будет ли поле tags каноническим или только дополнять существующие теги.

В каноническом режиме все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

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

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

extended_location_name

string

Имя расширенного расположения.

Обязательно, если kind=AzureArc.

extended_location_type

string

Тип расширенного расположения.

Обязательно, если kind=AzureArc.

Варианты:

• "customlocation"

identity

dictionary

Удостоверение сервера.

type

string

Тип управляемого удостоверения

Варианты:

• "UserAssigned"
• "SystemAssigned" ← (по умолчанию)
• "SystemAssigned UserAssigned"
• "None"

user_assigned_identities

list / элементы=string

Назначенное пользователем управляемое удостоверение

inbound_ip_rules

list / элементы=dictionary

Список правил для входящих IP-адресов

По умолчанию: []

action

string

Действие, выполняемое при совпадении или несовпадении с IpMask.

Варианты:

• "Allow"
• "Deny"

ipmask

string

IP-адрес в нотации CIDR, например 10.0.0.0/8

input_mapping_default_values

list / элементы=dictionary

Если для input_schema указано значение CustomEventSchema, этот параметр позволяет задать сопоставления входных данных на основе значений по умолчанию. Используйте этот параметр, если в пользовательской схеме отсутствует поле, соответствующее одному из трех полей, поддерживаемых этим параметром.

mapping_key

string

Имя параметра

Варианты:

• "subject"
• "eventtype"
• "dataversion"

mapping_value

string

Значение по умолчанию для параметра, если оно не указано в публикуемом событии.

input_mapping_fields

list / элементы=dictionary

Если для input_schema указано значение CustomEventSchema, этот параметр задает сопоставления входных данных на основе имен полей.

mapping_key

string

Имя параметра

Варианты:

• "id"
• "topic"
• "eventtime"
• "subject"
• "eventtype"
• "dataversion"

mapping_value

string

Соответствующее значение должно указывать имя поля в пользовательской входной схеме. Если сопоставление для «id» или «eventtime» не задано, Event Grid автоматически создаст значения по умолчанию для этих двух полей.

input_schema

string

Схема, в которой входящие события будут публиковаться в этой теме или домене. Если для этого параметра указано значение CustomEventSchema, необходимо также задать значения как минимум для одного из параметров: input_mapping_default_values или input_mapping_fields.

Варианты:

• "CloudEventSchemaV1_0"
• "CustomEventSchema"
• "EventGridSchema" ← (по умолчанию)

kind

string

Тип ресурса темы.

Варианты:

• "Azure" ← (по умолчанию)
• "AzureArc"

location

string

Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.

log_mode

string

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

log_path

string

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

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

profile

string

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

public_network_access

string

Определяет, разрешен ли трафик через общедоступную сеть.

Варианты:

• "enabled" ← (по умолчанию)
• "disabled"

regenerate_keys

list / элементы=string

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

Варианты:

• "key1"
• "key2"

resource_group

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

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

secret

string

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

state

string

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

Варианты:

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

subscription_id

string

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

tags

dictionary

Словарь пар «строка:строка», назначаемых объекту в качестве метаданных.

Теги метаданных объекта будут обновлены с учетом всех предоставленных значений.

Чтобы удалить теги, задайте для параметра append_tags значение false.

В настоящее время зоны DNS Azure и службы Traffic Manager также не допускают использование пробелов в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.

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, используемому для создания субъекта-службы.

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

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

changed

boolean

Был ли изменён ресурс.

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

Пример: true

eventgrid_topic

complex

Тема Event Grid.

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

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"

input_schema_mapping

string

Настраиваемое сопоставление схемы входных данных

Возвращается: если включено

Пример: "\"data_version\": {\n  \"default_value\": \"1.0\"\n},\n\"event_time\": {},\n\"event_type\": {\n  \"source_field\": \"myEventTypeField\"\n},\n\"id\": {},\n\"input_schema_mapping_type\": \"Json\",\n\"subject\": {\n  \"default_value\": \"DefaultSubject\"\n},\n\"topic\": {\n  \"source_field\": \"myTopicField\"\n}\n"

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

string

Указывает, включена ли диагностика загрузки.

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

Пример: "Enabled"

type

string

Тип Event Grid

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

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