PublishToAzureServiceBus@1 - Publicar na tarefa Azure Service Bus v1

Artigo
06/11/2024

Utilize esta tarefa para enviar uma mensagem para Azure Service Bus através de uma ligação de serviço (não é necessário nenhum agente).

Syntax

# 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.

Entradas

azureSubscription - Azure Service Bus ligação de serviço
Alias de entrada: connectedServiceName. string. Obrigatório.

Especifica uma ligação de serviço Azure Service Bus.

messageBody - Corpo da mensagem
string.

Especifica o JSON messageBody.

sessionId - ID da Sessão
string.

Especifica o ID da sessão com o qual a mensagem é publicada. Para filas baseadas em sessões, a publicação falha se não for especificado um valor. Para filas não baseadas em sessões, não é necessário especificar um valor.

signPayload - Assinar a Mensagem
boolean. Valor predefinido: false.

Se estiver definido como true, será adicionado um certificado privado à mensagem.

certificateString - Variável de Certificado
string. Necessário quando signPayload = true.

Especifica a variável de segredo que contém o conteúdo do certificado. Também pode ser um certificado armazenado num cofre de chaves do Azure que está ligado a um grupo de variáveis utilizado pelo pipeline de versão.

signatureKey - Chave de Propriedade de Assinatura
string. Opcional. Utilize quando signPayload = true. Valor predefinido: signature.

Em Propriedades da Mensagem, especifica a chave onde está a assinatura. Se ficar vazio, o valor predefinido é signature.

waitForCompletion - Aguardar a conclusão da tarefa
boolean. Valor predefinido: false.

Se estiver definida como true, esta tarefa aguardará pelo evento TaskCompleted para o tempo limite da tarefa especificado.

useDataContractSerializer - Utilize o serializador de contratos de dados .NET.
boolean. Valor predefinido: true.

Defina useDataContractSerializer como false se pretendesse transmitir a sua mensagem como um fluxo em vez de um objeto.

Opções de controlo de tarefas

Todas as tarefas têm opções de controlo para além das entradas de tarefas. Para obter mais informações, veja Opções de controlo e propriedades de tarefas comuns.

Variáveis de saída

Nenhum.

Observações

Utilize esta tarefa numa tarefa sem agente de um pipeline de versão para enviar uma mensagem para um Azure Service Bus através de uma ligação de serviço (sem utilizar um agente).

Nota

Só pode ser utilizado numa tarefa sem agente de um pipeline de versão.

Onde deve ser concluída a conclusão de um sinal de tarefa?

Para assinalar a conclusão, o serviço externo deve publicar os dados de conclusão para o ponto final REST dos pipelines seguintes.

{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" }

Veja esta aplicação de cmdline simples para obter detalhes.

Além disso, está disponível uma biblioteca auxiliar de C# para ativar o registo em direto e gerir o estado da tarefa para tarefas sem agente. Saiba mais sobre as tarefas assíncronas de HTTP sem agente.

Requisitos

Requisito	Description
Tipos de pipeline	YAML, Compilação clássica, Versão clássica
É executado em	Servidor
Exigências	Nenhuma
Capacidades	Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa.
Restrições de comandos	Qualquer
Variáveis de definição	Qualquer
Versão do agente	Todas as versões de agente suportadas.
Categoria da tarefa	Utilitário

Partilhar via