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

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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

Параметры

Параметр	Комментарии
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"`
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`
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string / обязательный	Имя политики SAS.
namespace string / обязательный	Управление политикой SAS для пространства имен без заданных `queue` или `topic`. Управление политикой SAS для очереди или раздела в этом пространстве имен.
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.
queue string	Тип очереди сообщений. Если это поле задано, нельзя задать `topc`.
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.
Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
Для аутентификации с помощью субъекта-службы передайте 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 a namespace
  azure_rm_servicebussaspolicy:
      name: deadbeef
      queue: qux
      namespace: bar
      resource_group: myResourceGroup
      rights: send

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

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

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

Авторы

Yuwei Zhou (@yuwzho)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_servicebussaspolicy_module.html