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

ad_user

string

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

adfs_authority_url

string

added in azure.azcollection 0.0.1

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

api_profile

string

added in azure.azcollection 0.0.1

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

Default: "latest"

auth_source

string

added in 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

added in 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

added in azure.azcollection 0.0.1

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

Default: "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

added in 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

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

Choices:

• 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

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

Сообщение автоматически переводится в категорию «Мертвая буква» после этого числа доставок.

name

string / required

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

namespace

string / required

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

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

В одном пространстве имен может находиться несколько подписок и тем, а пространства имен часто служат контейнерами приложений.

password

string

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

profile

string

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

requires_session

boolean

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

Choices:

• false
• true

resource_group

string / required

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

secret

string

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

state

string

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

Choices:

• "absent"
• "present" ← (default)

status

string

Статус объекта.

Choices:

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

subscription_id

string

Ваш идентификатор подписки Azure.

tenant

string

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

thumbprint

string

added in azure.azcollection 1.14.0

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

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

Требуется, если определен x509_certificate_path.

topic

string / required

Имя темы, на которую подписана подписка.

x509_certificate_path

path

added in azure.azcollection 1.14.0

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

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

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