Модуль azure.azcollection.azure_rm_eventhub — управление концентратором событий

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; в противном случае используется подписка Azure 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

identity

dictionary

Удостоверение объекта

type

string

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

Варианты:

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

user_assigned_identities

dictionary

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

По умолчанию: {}

append

boolean

Следует ли добавить список удостоверений к текущим удостоверениям (true) или заменить текущие удостоверения (false)

Варианты:

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

id

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

Список идентификаторов назначенных пользователем удостоверений, связанных с объектом

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

location

string

Расположение ресурса. Если не задано, по умолчанию используется расположение группы ресурсов.

log_mode

string

Аргумент родительского объекта.

log_path

string

Аргумент родительского объекта.

message_retention_in_days

integer

Количество дней хранения событий для этого концентратора событий.

name

string

Уникальное имя концентратора событий.

namespace_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.

partition_count

integer

Количество разделов, создаваемых для концентратора событий.

Диапазон: от 1 до 32.

password

string

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

profile

string

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

resource_group

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

Имя группы ресурсов, к которой относится ресурс.

secret

string

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

sku

string

Название SKU.

См. https://azure.microsoft.com/en-in/pricing/details/event-hubs/.

Варианты:

• "Basic" ← (по умолчанию)
• "Standard"

state

string

Проверка состояния концентратора событий.

Используйте present для создания или обновления концентратора событий и absent для его удаления.

Варианты:

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

status

string

Перечисляет возможные значения состояния концентратора событий.

Варианты:

• "Active" ← (по умолчанию)
• "Disabled"
• "Restoring"
• "SendDisabled"
• "ReceiveDisabled"
• "Creating"
• "Deleting"
• "Renaming"
• "Unknown"

subscription_id

string

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

tags

dictionary

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

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

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

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

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

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

state

dictionary

Текущее состояние пространства имен концентратора событий или самого концентратора событий.

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

Пример: {"additional_properties": {"location": "East US"}, "created_at": "2021-04-29T10:05:20.377Z", "critical": false, "enabled": true, "message_retention_in_days": 7, "metric_id": null, "name": "testnaedd3d22d3w", "namespace_type": "eventHub", "partition_count": 4, "partition_ids": ["0", "1", "2", "3"], "region": null, "scale_unit": null, "service_bus_endpoint": "https://testnaedd3d22d3w.servicebus.windows.net:443/", "sku": "Basic", "status": "Active", "tags": {"a": "b"}, "type": "Microsoft.eventHubs/namespaces", "updated_at": "2021-04-29T10:05:24.000Z"}