Модуль azure.azcollection.azure_rm_servicebus_info — получение сведений о 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; в противном случае будет использоваться подписка Azure 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

Ограничить результаты указанным Service Bus.

namespace

string

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

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

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

Обязательный параметр при type=namespace.

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.

resource_group

string

Ограничить результаты указанной группой ресурсов.

secret

string

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

show_sas_policies

boolean

Определяет, отображать ли политики SAS.

Не поддерживается при type=subscription.

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

Возможные значения:

• false
• true

subscription_id

string

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

tags

list / элементы=string

Ограничить результаты, указав список тегов. Задавайте теги в формате «ключ» или «ключ:значение».

tenant

string

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

thumbprint

string

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

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

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

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

topic

string

Имя раздела.

Обязательный параметр при type=subscription.

type

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

Тип ресурса.

Возможные значения:

• "namespace"
• "queue"
• "topic"
• "subscription"

x509_certificate_path

path

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

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

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

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

servicebuses

complex

Список словарей servicebus.

Возвращается: всегда

accessed_at

string

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

Возвращается: всегда

Пример: "2019-01-25 02:46:55.543953+00:00"

auto_delete_on_idle_in_seconds

integer

Интервал простоя timespan в формате ISO 8061, по истечении которого очередь или тема автоматически удаляется.

Минимальная длительность составляет 5 минут.

Возвращается: всегда

Пример: true

count_details

complex

Сведения о количестве сообщений.

Возвращается: всегда

active_message_count

integer

Количество активных сообщений в queue, topic или subscription.

Возвращается: всегда

Пример: 0

dead_letter_message_count

integer

Количество сообщений, перемещённых в очередь недоставленных сообщений.

Возвращается: всегда

Пример: 0

scheduled_message_count

integer

Количество запланированных сообщений.

Возвращается: всегда

Пример: 0

transfer_dead_letter_message_count

integer

Количество сообщений, перемещённых в очереди недоставленных сообщений.

Возвращается: всегда

Пример: 0

transfer_message_count

integer

Количество сообщений, перенаправленных в другую queue, topic или subscription.

Возвращается: всегда

Пример: 0

created_at

string

Точное время создания сообщения.

Возвращается: всегда

Пример: "2019-01-25 02:46:55.543953+00:00"

dead_lettering_on_filter_evaluation_exceptions

integer

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

Возвращается: всегда

Пример: 0

dead_lettering_on_message_expiration

integer

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

Возвращается: всегда

Пример: 0

default_message_time_to_live_seconds

integer

Значение времени жизни сообщения по умолчанию, timespan в формате ISO 8061.

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

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

Возвращается: всегда

Пример: 0

duplicate_detection_time_in_seconds

integer

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

Возвращается: всегда

Пример: 600

enable_batched_operations

boolean

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

Возвращается: всегда

Пример: true

enable_express

boolean

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

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

Возвращается: всегда

Пример: true

enable_partitioning

boolean

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

Возвращается: всегда

Пример: true

forward_dead_lettered_messages_to

string

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

Возвращается: всегда

Пример: "corge"

forward_to

string

Имя queue или topic, куда перенаправляются сообщения.

Возвращается: всегда

Пример: "quux"

id

string

Идентификатор ресурса.

Возвращается: всегда

Пример: "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/foo/providers/Microsoft.ServiceBus/ namespaces/bar/topics/baz/subscriptions/qux"

location

string

Географическое расположение ресурса.

Возвращается: всегда

Пример: "eastus"

lock_duration_in_seconds

integer

Длительность блокировки при просмотре с блокировкой, timespan в формате ISO 8601.

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

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

Возвращается: всегда

Пример: 60

max_delivery_count

integer

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

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

Возвращается: всегда

Пример: 10

max_size_in_mb

integer

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

Возвращается: всегда

Пример: 5120

message_count

integer

Количество сообщений.

Возвращается: всегда

Пример: 10

metric_id

string

Идентификатор метрик Azure Insights для пространства имён.

Возвращается: всегда

Пример: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX:bar"

name

string

Имя ресурса.

Возвращается: всегда

Пример: "qux"

namespace

string

Имя namespace для queue или topic, subscription.

Возвращается: всегда

Пример: "bar"

private_endpoint_connections

list / elements=string

Свойства PrivateEndpointConnection.

Возвращается: всегда

Пример: [{"id": "/subscriptions/xxxxxx/resourceGroups/myRG/providers/Microsoft.ServiceBus/namespaces/fredVM/privateEndpointConnections/xxxxxxxx", "name": "xxxxxx", "private_endpoint": {"id": "/subscriptions/xxxxx/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/fredprivateendpoint"}, "private_link_service_connection_state": {"description": "Auto-Approved", "status": "Approved"}, "provisioning_state": "Succeeded", "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections"}]

provisioning_state

string

Состояние подготовки пространства имён.

Возвращается: всегда

Пример: "Succeeded"

requires_duplicate_detection

boolean

Значение, указывающее, требуется ли для этого queue или topic обнаружение дубликатов.

Возвращается: всегда

Пример: true

requires_session

boolean

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

Возвращается: всегда

Пример: true

sas_policies

dictionary

Словарь политик SAS.

Возвращается только при установленном параметре show_sas_policy.

Возвращается: всегда

Пример: {"testpolicy1": {"id": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/ foo/providers/Microsoft.ServiceBus/namespaces/bar/queues/qux/authorizationRules/testpolicy1", "keys": {"key_name": "testpolicy1", "primary_connection_string": "Endpoint=sb://bar.servicebus.windows.net/; SharedAccessKeyName=testpolicy1;SharedAccessKey=XXXXXXXXXXXXXXXXX;EntityPath=qux", "primary_key": "XXXXXXXXXXXXXXXXX", "secondary_connection_string": "Endpoint=sb://bar.servicebus.windows.net/; SharedAccessKeyName=testpolicy1;SharedAccessKey=XXXXXXXXXXXXXXX;EntityPath=qux", "secondary_key": "XXXXXXXXXXXXXXX"}, "name": "testpolicy1", "rights": "listen_send", "type": "Microsoft.ServiceBus/Namespaces/Queues/AuthorizationRules"}}

service_bus_endpoint

string

Конечная точка для выполнения операций Service Bus.

Возвращается: всегда

Пример: "https://bar.servicebus.windows.net:443/"

size_in_bytes

integer

Размер queue или topic в байтах.

Возвращается: всегда

Пример: 0

sku

string

Свойства SKU пространства имён.

Возвращается: всегда

Пример: "Standard"

status

string

Состояние сущности обмена сообщениями.

Возвращается: всегда

Пример: "active"

subscription_count

integer

Количество подписок для темы.

Возвращается: всегда

Пример: 1

support_ordering

boolean

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

Возвращается: всегда

Пример: true

tags

dictionary

Теги ресурса.

Возвращается: всегда

Пример: {"env": "sandbox"}

topic

string

Имя темы для подписки.

Возвращается: всегда

Пример: "baz"

type

string

Тип ресурса.

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

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

Тема и подписки обеспечивают связь «один ко многим» между издателями и подписчиками.

Возвращается: всегда

Пример: "Microsoft.ServiceBus/Namespaces/Topics"

updated_at

string

Точное время обновления сообщения.

Возвращается: всегда

Пример: "2019-01-25 02:46:55.543953+00:00"