Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_notificationhub — Управление центрами уведомлений

Примечание

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

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

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

Для использования в плейбуке укажите: azure.azcollection.azure_rm_notificationhub.

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

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

Описание

  • Создание, обновление и удаление экземпляра центра уведомлений.

Требования

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

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

Параметры

Параметр

Комментарии

ad_user

строка

Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала.

adfs_authority_url

строка

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

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

api_profile

строка

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

Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

append_tags

логическое значение

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

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

Варианты:

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

auth_source

строка

добавлено в 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

строка

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

Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

строка

Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала или управляемой идентичности (msi).

Также может быть задан через переменную среды AZURE_CLIENT_ID.

cloud_environment

строка

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

Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки доступа для обнаружения метаданных (необходим для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

логическое значение

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

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

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

Варианты:

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

location

строка

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

log_mode

строка

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

log_path

строка

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

name

строка

Уникальное имя центра уведомлений.

namespace_name

строка / обязательно

Имя пространства имен, в котором нужно создать центр уведомлений.

password

строка

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала.

profile

строка

Профиль безопасности, находящийся в файле ~/.azure/credentials.
END_OF_DOCUMENT_MARKER

resource_group

строка / обязательно

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

secret

строка

Секретный ключ Azure. Используется при аутентификации с помощью сервисного принципала.

sku

строка

Имя SKU.

См. https://azure.microsoft.com/ru-ru/pricing/details/notification-hubs/.

Варианты:

  • "free" ← (по умолчанию)
  • "basic"
  • "standard"

state

строка

Установить состояние центра уведомлений.

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

Варианты:

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

subscription_id

строка

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

tags

словарь

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

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

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

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

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

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

tenant

строка

Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала.

thumbprint

строка

добавлено в 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 Notification Hub"
  azure_rm_notificationhub:
    resource_group: testgroupans
    location: eastus
    namespace_name: myNamespace
    name: myhub
    tags:
      - a: b
    sku: free

- name: Delete Notification Hub
  azure_rm_notificationhub:
    resource_group: testgroupans
    name: myNamespace
    state: absent

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

- name: Delete Notification Hub Namespace
  azure_rm_notificationhub:
    resource_group: testgroupans
    namespace_name: myNamespace
    state: absent

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

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

Ключ

Описание

state

словарь

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

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

Пример: {"additional_properties": {}, "critical": false, "data_center": null, "enabled": true, "location": "eastus2", "metric_id": null, "name": "testnaedd3d22d3w", "namespace_type": "NotificationHub", "provisioning_state": "Succeeded", "region": null, "scale_unit": null, "service_bus_endpoint": "https://testnaedd3d22d3w.servicebus.windows.net:443/", "sku": {"name": "Free"}, "tags": {"a": "b"}, "type": "Microsoft.NotificationHubs/namespaces"}

Авторы

  • Praveen Ghuge (@praveenghuge)
  • Karl Dasan (@karldas30)

Справочные ссылки по коллекциям

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходные коды)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API