PublishToAzureServiceBus@1 - Tarefa Publicar no Barramento de Serviço do Azure v1
Use esta tarefa para enviar uma mensagem para Barramento de Serviço do Azure usando uma conexão de serviço (nenhum agente é necessário).
Use esta tarefa para enviar uma mensagem para Barramento de Serviço do Azure usando uma conexão de serviço (nenhum agente necessário).
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
- conexão de serviço Barramento de Serviço do Azure
Alias de entrada: connectedServiceName
. string
. Obrigatórios.
Especifica uma conexão de serviço Barramento de Serviço do Azure.
messageBody
- Corpo da mensagem
string
.
Especifica o JSON messageBody
.
sessionId
- ID da sessão
string
.
Especifica a ID da sessão com a qual a mensagem é publicada. Para filas baseadas em sessão, a publicação falhará se um valor não for especificado. Para filas não baseadas em sessão, um valor não precisa ser especificado.
signPayload
- Assinar a Mensagem
boolean
. Valor padrão: false
.
Se definido como true
, um certificado privado será adicionado à mensagem.
certificateString
- Variável de certificado
string
. Obrigatório quando signPayload = true
.
Especifica a variável secreta que contém o conteúdo do certificado. Também pode ser um certificado armazenado em um cofre de chaves do Azure vinculado a um grupo de variáveis usado pelo pipeline de lançamento.
signatureKey
- Chave de propriedade signature
string
. Opcional. Use quando signPayload = true
. Valor padrão: signature
.
Em Propriedades da Mensagem, especifica a chave em que a assinatura está. Se deixado vazio, o valor padrão será signature
.
waitForCompletion
- Aguardar a conclusão da tarefa
boolean
. Valor padrão: false
.
Se definido como true
, essa tarefa aguardará o evento TaskCompleted para o tempo limite da tarefa especificado.
useDataContractSerializer
- Use o serializador de contrato de dados .NET.
boolean
. Valor padrão: true
.
Defina useDataContractSerializer
como false
se você quiser passar sua mensagem como um fluxo em vez de um objeto .
Opções de controle da tarefa
Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.
Variáveis de saída
Nenhum.
Comentários
Use essa tarefa em um trabalho sem agente de um pipeline de lançamento para enviar uma mensagem a um Barramento de Serviço do Azure usando uma conexão de serviço (sem usar um agente).
Observação
Só pode ser usado em um trabalho sem agente de um pipeline de lançamento.
Onde uma tarefa deve sinalizar a conclusão?
Para sinalizar a conclusão, o serviço externo deve fazer POST dos dados de conclusão para o ponto de extremidade REST de pipelines a seguir.
{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" }
Confira este aplicativo cmdline simples para obter detalhes.
Além disso, uma biblioteca auxiliar do C# está disponível para habilitar o registro em log dinâmico e gerenciar a tarefa status para tarefas sem agente. Saiba mais sobre tarefas sem agente HTTP assíncronas.
Requisitos
Requisito | Descrição |
---|---|
Tipos de pipeline | YAML, build clássico, versão clássica |
É executado em | Servidor |
Demandas | Nenhum |
Funcionalidades | Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho. |
Restrições de comando | Qualquer |
Variáveis configuráveis | Qualquer |
Versão do agente | Todas as versões do agente com suporte. |
Categoria da tarefa | Utilitário |