PublishToAzureServiceBus@1 — публикация в задаче Служебная шина Azure версии 1

Статья
06/11/2024

Эта задача предназначена для отправки сообщения Служебная шина Azure с помощью подключения к службе (агент не требуется).

Используйте эту задачу для отправки сообщения Служебная шина Azure с помощью подключения к службе (агент не требуется).

Синтаксис

# Publish To Azure Service Bus v1
# Sends a message to Azure Service Bus using a service connection (no agent is required).
- task: PublishToAzureServiceBus@1
  inputs:
    azureSubscription: # string. Alias: connectedServiceName. Required. Azure Service Bus service connection. 
    #messageBody: # string. Message body. 
    #waitForCompletion: false # boolean. Wait for task completion. Default: false.
    #useDataContractSerializer: true # boolean. Use .NET data contract serializer. Default: true.
  # Advanced
    #sessionId: # string. Session Id. 
    #signPayload: false # boolean. Sign the Message. Default: false.
    #certificateString: # string. Required when signPayload = true. Certificate Variable. 
    #signatureKey: 'signature' # string. Optional. Use when signPayload = true. Signature Property Key. Default: signature.

# Publish To Azure Service Bus v1
# Sends a message to Azure Service Bus using a service connection (no agent is required).
- task: PublishToAzureServiceBus@1
  inputs:
    azureSubscription: # string. Alias: connectedServiceName. Required. Azure Service Bus service connection. 
    #messageBody: # string. Message body. 
    #waitForCompletion: false # boolean. Wait for task completion. Default: false.
  # Advanced
    #sessionId: # string. Session Id. 
    #signPayload: false # boolean. Sign the Message. Default: false.
    #certificateString: # string. Required when signPayload = true. Certificate Variable. 
    #signatureKey: 'signature' # string. Optional. Use when signPayload = true. Signature Property Key. Default: signature.

# Publish To Azure Service Bus v1
# Sends a message to azure service bus using a service connection (no agent required).
- task: PublishToAzureServiceBus@1
  inputs:
    azureSubscription: # string. Alias: connectedServiceName. Required. Azure Service Bus service connection. 
    #messageBody: # string. Message body. 
    #waitForCompletion: false # boolean. Wait for task completion. Default: false.
  # Signing Properties
    #signPayload: false # boolean. Sign the Message. Default: false.
    #certificateString: # string. Required when signPayload = true. Certificate Variable. 
    #signatureKey: 'signature' # string. Optional. Use when signPayload = true. Signature Property Key. Default: signature.

Входные данные

azureSubscription - Подключение службы Служебная шина Azure
Входной псевдоним: connectedServiceName. string. Обязательный.

Указывает подключение службы Служебная шина Azure.

messageBody - Текст сообщения
string.

Указывает JSON messageBody.

sessionId - Идентификатор сеанса
string.

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

signPayload - Подпись сообщения
boolean. Значение по умолчанию: false.

Если задано значение true, в сообщение будет добавлен закрытый сертификат.

certificateString - Переменная сертификата
string. Требуется при .signPayload = true

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

signatureKey - Ключ свойства Signature
string. Необязательный элемент. Используйте при signPayload = true. Значение по умолчанию: signature.

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

waitForCompletion - Ожидание завершения задачи
boolean. Значение по умолчанию: false.

Если задано значение true, эта задача будет ожидать события TaskCompleted для указанного времени ожидания задачи.

useDataContractSerializer - Используйте сериализатор контракта данных .NET.
boolean. Значение по умолчанию: true.

Задайте значение useDataContractSerializer , false если вы хотите передать сообщение в виде потока, а не объекта.

Параметры управления задачами

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

Выходные переменные

Нет.

Remarks

Используйте эту задачу в задании конвейера выпуска без агента для отправки сообщения Служебная шина Azure с помощью подключения к службе (без использования агента).

Примечание

Может использоваться только в задании без агента конвейера выпуска.

Где задача должна сигнализировать о завершении?

Чтобы сообщить о завершении, внешняя служба должна получить данные о завершении POST в следующую конечную точку REST конвейеров.

{planUri}/{projectId}/_apis/distributedtask/hubs/{hubName}/plans/{planId}/events?api-version=2.0-preview.1

**Request Body**
 { "name": "TaskCompleted", "taskId": "taskInstanceId", "jobId": "jobId", "result": "succeeded" }

Дополнительные сведения см. в этом простом приложении cmdline .

Кроме того, доступна вспомогающая библиотека C# для включения динамического ведения журнала и управления состоянием задач без агента. Дополнительные сведения о задачах async HTTP без агента.

Требования

Требование	Описание
Типы конвейеров	YAML, классическая сборка, классический выпуск
Выполняется в	Сервер
Требования	None
Capabilities	Эта задача не удовлетворяет требованиям для последующих задач в задании.
Ограничения команд	Любой
Устанавливаемые переменные	Любой
Версия агента	Все поддерживаемые версии агента.
Категория задач	Служебная программа

Поделиться через