Модуль azure.azcollection.azure_rm_eventhub – Управление Event Hub

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: azure.azcollection.azure_rm_eventhub.

Новое в azure.azcollection 1.6.0

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

Описание

Создание, обновление и удаление экземпляров Event Hub.

Требования

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

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"`
append_tags boolean	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices: `false` `true` ← (default)
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. Choices: `"auto"` ← (default) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Choices: `"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`. Choices: `false` ← (default) `true`
location string	Расположение ресурса. Если не установлено, по умолчанию будет использоваться расположение из группы ресурсов.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
message_retention_in_days integer	Количество дней для хранения событий для этого концентратора событий.
name string	Уникальное имя концентратора событий.
namespace_name string / required	Имя пространства имен, в котором необходимо создать концентратор событий.
partition_count integer	Количество разделов, созданных для концентратора событий. Диапазон от 1 до 32.

пароль строка	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала.
профиль строка	Профиль безопасности, найденный в файле ~/.azure/credentials.
группа_ресурсов строка / обязательно	Имя группы ресурсов, к которой принадлежит ресурс.
секрет строка	Секретный ключ клиента Azure. Используется при аутентификации с помощью службы-принципала.
sku строка	Имя SKU. См. https://azure.microsoft.com/ru-ru/pricing/details/event-hubs/. Варианты: `"Basic"` ← (по умолчанию) `"Standard"`
состояние строка	Утверждение состояния узла Event Hub. Используйте `present` для создания или обновления узла Event Hub и `absent` для его удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
статус строка	Перечисляет возможные значения статуса узла Event Hub. Варианты: `"Active"` ← (по умолчанию) `"Disabled"` `"Restoring"` `"SendDisabled"` `"ReceiveDisabled"` `"Creating"` `"Deleting"` `"Renaming"` `"Unknown"`
идентификатор_подписки строка	Ваш идентификатор подписки Azure.
теги словарь	Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false. В настоящее время Azure DNS zones и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах.
арендатор строка	Идентификатор аренды Azure. Используется при аутентификации с помощью службы-принципала.
отпечаток_пальца строка добавлено в azure.azcollection 1.14.0	Отпечаток пальца закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью службы-принципала. Требуется, если определен x509_certificate_path.
x509_certificate_path путь добавлено в 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: "Create Event Hub"
  azure_rm_eventhub:
    resource_group: testgroupans
    location: eastus
    namespace_name: myNamespace
    name: myhub
    tags:
      - a: b
    sku: free

- name: Delete Event Hub
  azure_rm_eventhub:
    resource_group: testgroupans
    name: myNamespace
    state: absent

- name: "Create Event Hub Namespace"
  azure_rm_eventhub:
    resource_group: testgroupans
    location: eastus
    namespace_name: myNamespace
    tags:
      a: b
    sku: free

- name: Delete Event Hub Namespace
  azure_rm_eventhub:
    resource_group: testgroupans
    namespace_name: myNamespace
    state: absent

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

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

Ключ	Описание
состояние словарь	Текущее состояние пространства имен Event Hub или Event Hub. Возвращается: всегда Пример: {"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"}

Ключ

Описание

состояние

словарь

Текущее состояние пространства имен Event Hub или Event Hub.

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

Пример: {"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"}

Авторы

Praveen Ghuge (@praveenghuge)
Karl Dasan (@karldas30)
Saurabh Malpani(@saurabh3796)

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

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