Модуль azure.azcollection.azure_rm_servicebustopic — управление 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"

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

log_mode

string

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

log_path

string

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

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

resource_group

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

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

secret

string

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

state

string

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

Варианты:

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

status

string

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

Варианты:

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

subscription_id

string

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

support_ordering

boolean

Определяет, поддерживает ли раздел упорядочивание.

Варианты:

• false
• true

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/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/nsb57dc95979/topics/topicb57dc95979"