Модуль azure.azcollection.azure_rm_servicebussaspolicy — Управление политикой SAS Azure Service Bus

Примечание

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

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_servicebussaspolicy.

Новая функция в azure.azcollection 0.1.2

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

Обзор

Создание, обновление или удаление политики SAS Azure Service Bus.

Требования

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

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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"`
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"`

regenerate_primary_key boolean	Перегенерировать первичный ключ политики SAS. Варианты: `false` ← (по умолчанию) `true`
regenerate_secondary_key boolean	Перегенерировать вторичный ключ политики SAS. Варианты: `false` ← (по умолчанию) `true`
resource_group string / обязательно	Имя группы ресурсов.
rights string	Права доступа политики SAS. Требуется при создании. Варианты: `"manage"` `"listen"` `"send"` `"listen_send"`
secret string	Секрет Azure-клиента. Используется при аутентификации с помощью сервисного принципала.
state string	Установить состояние маршрута. Используйте `present` для создания или обновления и `absent` для удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id string	Ваш идентификатор подписки Azure.
tenant string	Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала.
thumbprint string добавлен в azure.azcollection 1.14.0	Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью сервисного принципала. Требуется, если определён x509_certificate_path.
topic string	Имя темы обмена сообщениями. Нельзя установить `queue` когда это поле установлено.
x509_certificate_path 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 и пароль или установите 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 a namespace
  azure_rm_servicebussaspolicy:
      name: deadbeef
      queue: qux
      namespace: bar
      resource_group: myResourceGroup
      rights: send

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
id строка	Текущее состояние политики SAS. Возвращено: Успешно Пример: `"/subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/ namespaces/nsb57dc95979/topics/topicb57dc95979/authorizationRules/testpolicy"`
keys сложное	Словарь ключей политики SAS. Возвращено: Успешно
key_name строка	Имя политики SAS. Возвращено: Успешно Пример: `"testpolicy"`
primary_connection_string строка	Первичная строка подключения. Возвращено: Успешно Пример: `"Endpoint=sb://nsb57dc95979.servicebus.windows.net/;SharedAccessKeyName=testpolicy; SharedAccessKey=xxxxxxxxxxxxxxxxxxxxxxxxxxxx"`
primary_key строка	Первичный ключ. Возвращено: Успешно Пример: `"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"`
secondary_connection_string строка	Вторичная строка подключения. Возвращено: Успешно Пример: `"Endpoint=sb://nsb57dc95979.servicebus.windows.net/;SharedAccessKeyName=testpolicy; SharedAccessKey=xxxxxxxxxxxxxxxxxxxxxxxxx"`
secondary_key строка	Вторичный ключ. Возвращено: Успешно Пример: `"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"`
name строка	Имя политики SAS. Возвращено: Успешно Пример: `"testpolicy"`
rights строка	Права политики SAS. Возвращено: Успешно Пример: `"manage"`
type строка	Тип политики SAS. Возвращено: Успешно Пример: `"Microsoft.ServiceBus/Namespaces/Topics/AuthorizationRules"`

Авторы

Yuwei Zhou (@yuwzho)

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

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