Модуль azure.azcollection.azure_rm_servicebustopicsubscription — управление подпиской Azure Service Bus

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"

auto_delete_on_idle_in_seconds

integer

Период бездействия, по истечении которого подписка автоматически удаляется.

Минимальная продолжительность — 5 минут.

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"

dead_lettering_on_filter_evaluation_exceptions

boolean

Значение, указывающее, поддерживает ли подписка помещение сообщений в очередь недоставленных сообщений при исключениях во время вычисления фильтра.

Варианты:

• false
• true

dead_lettering_on_message_expiration

boolean

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

Варианты:

• false
• true

default_message_time_to_live_seconds

integer

Значение времени жизни сообщения по умолчанию.

Это период, по истечении которого сообщение становится недействительным, отсчитываемый с момента отправки сообщения в Service Bus.

Это значение по умолчанию используется, если параметр TimeToLive не задан для самого сообщения.

disable_instance_discovery

boolean

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

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

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

Варианты:

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

duplicate_detection_time_in_seconds

integer

Структура TimeSpan, определяющая продолжительность хранения истории обнаружения дубликатов.

enable_batched_operations

boolean

Значение, указывающее, включены ли пакетные операции на стороне сервера.

Варианты:

• false
• true

forward_dead_lettered_messages_to

string

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

forward_to

string

Имя очереди или раздела, в который следует перенаправлять сообщения для подписки.

lock_duration_in_seconds

integer

Продолжительность блокировки при просмотре с блокировкой.

Период, в течение которого сообщение заблокировано для других получателей.

Максимальное значение LockDuration — 5 минут.

log_mode

string

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

log_path

string

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

max_delivery_count

integer

Максимальное количество доставок.

После указанного количества доставок сообщение автоматически помещается в очередь недоставленных сообщений.

name

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

Имя подписки Service Bus.

namespace

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

Имя пространства имен Service Bus.

Пространство имен служит контейнером для всех компонентов обмена сообщениями.

В одном пространстве имен могут находиться несколько подписок и разделов; пространства имен часто используются как контейнеры приложений.

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.

requires_session

boolean

Значение, указывающее, поддерживает ли подписка работу с сеансами.

Варианты:

• false
• true

resource_group

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

Имя группы ресурсов.

secret

string

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

state

string

Задайте требуемое состояние подписки Service Bus. Используйте present для создания или обновления и absent для удаления.

Варианты:

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

status

string

Состояние сущности.

Варианты:

• "active"
• "disabled"
• "send_disabled"
• "receive_disabled"

subscription_id

string

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

tenant

string

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

thumbprint

string

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

Отпечаток закрытого ключа, указанного в x509_certificate_path.

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

Обязателен, если задан x509_certificate_path.

topic

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

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

x509_certificate_path

path

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

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

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

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

id

string

Текущее состояние подписки.

Возвращается: при успехе

Пример: "/subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/ namespaces/nsb57dc95979/topics/topicb57dc95979/subscriptions/subsb57dc95979"