Модуль azure.azcollection.azure_rm_servicebus_info – Получение фактов о службе 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"

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"

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

log_mode

string

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

log_path

string

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

name

string

Ограничение результатов для определенного servicebus.

namespace

string

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

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

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

Требуется, когда type=namespace.

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 / elements=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

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

Минимальная продолжительность составляет 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

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

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

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

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

Пример: 0

duplicate_detection_time_in_seconds

integer

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

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

Пример: 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

Продолжительность времени ожидания в формате 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

Имя пространства имен 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

Тип ресурса.

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

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

Тема и подписки обеспечивают 1:n отношения между издателями и подписчиками.

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

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

updated_at

string

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

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

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