модуль azure.azcollection.azure_rm_servicebusqueue — управление очередью 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_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

enable_express

boolean

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

Экспресс-топик или очередь временно хранит сообщение в памяти перед записью в постоянное хранилище.

Варианты:

• false
• true

enable_partitioning

boolean

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

Варианты:

• false
• true

forward_dead_lettered_messages_to

string

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

forward_to

string

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

lock_duration_in_seconds

integer

Длительность блокировки при просмотре сообщения (peek-lock).

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

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

log_mode

string

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

log_path

string

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

max_delivery_count

integer

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

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

max_message_size_in_kb

integer

Максимальный размер полезной нагрузки сообщения (в КБ), который может принять очередь.

В настоящее время это свойство используется только в Premium; значение по умолчанию — 1024.

max_size_in_mb

integer

Максимальный размер очереди в мегабайтах, то есть объём памяти, выделенной для очереди.

name

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

Имя очереди.

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_duplicate_detection

boolean

Указывает, требуется ли для этой очереди или топика обнаружение дубликатов.

Варианты:

• false
• true

requires_session

boolean

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

Варианты:

• false
• true

resource_group

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

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

secret

string

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

state

string

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

Варианты:

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

status

string

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

Варианты:

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

subscription_id

string

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

tenant

string

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

thumbprint

string

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

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

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

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

x509_certificate_path

path

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

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

Сертификат должен быть добавлен к закрытому ключу.

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

id

string

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

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

Пример: "/subscriptions/xxx...xxx/resourceGroups/v-xisuRG/providers/Microsoft.ServiceBus/namespaces/nsb57dc9561/queues/queueb57dc9561"