PublishToAzureServiceBus@1 - Publier sur Azure Service Bus tâche v1

  • Article

Utilisez cette tâche pour envoyer un message à Azure Service Bus à l’aide d’une connexion de service (aucun agent n’est requis).

Utilisez cette tâche pour envoyer un message à Azure Service Bus à l’aide d’une connexion de service (aucun agent requis).

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.

Entrées

azureSubscription - connexion de service Azure Service Bus
Alias d’entrée : connectedServiceName. string. Obligatoire.

Spécifie une connexion de service Azure Service Bus.


messageBody - Corps du message
string.

Spécifie le JSON messageBody.


sessionId - Session Id
string.

Spécifie l’ID de session avec lequel le message est publié. Pour les files d’attente basées sur une session, la publication échoue si aucune valeur n’est spécifiée. Pour les files d’attente non basées sur une session, il n’est pas nécessaire de spécifier une valeur.


signPayload - Signer le message
boolean. Valeur par défaut : false.

Si la valeur trueest , un certificat privé est ajouté au message.


certificateString - Variable de certificat
string. Nécessaire lorsque signPayload = true.

Spécifie la variable secrète qui contient le contenu du certificat. Il peut également s’agir d’un certificat stocké dans un coffre de clés Azure lié à un groupe de variables utilisé par le pipeline de mise en production.


signatureKey - Clé de propriété signature
string. facultatif. Utilisez quand signPayload = true. Valeur par défaut : signature.

Dans Propriétés du message, spécifie la clé où se trouve la signature. S’il reste vide, la valeur par défaut est signature.


waitForCompletion - Attendre l’achèvement de la tâche
boolean. Valeur par défaut : false.

Si la valeur est true, cette tâche attend l’événement TaskCompleted pour le délai d’expiration de la tâche spécifié.


useDataContractSerializer - Utilisez le sérialiseur de contrat de données .NET.
boolean. Valeur par défaut : true.

Définissez useDataContractSerializer sur false si vous souhaitez transmettre votre message sous la forme d’un flux au lieu d’un objet.


Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

Utilisez cette tâche dans un travail sans agent d’un pipeline de mise en production pour envoyer un message à un Azure Service Bus à l’aide d’une connexion de service (sans utiliser d’agent).

Notes

Peut uniquement être utilisé dans un travail sans agent d’un pipeline de mise en production.

Où une tâche doit-elle signaler l’achèvement ?

Pour signaler l’achèvement, le service externe doit publier (POST) les données d’achèvement sur le point de terminaison REST du pipeline suivant.

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

Pour plus d’informations, consultez cette application en ligne de commande simple.

En outre, une bibliothèque d’assistance C# est disponible pour activer la journalisation dynamique et la gestion de la tâche status pour les tâches sans agent. En savoir plus sur les tâches http asynchrones sans agent.

Configuration requise

Condition requise Description
Types de pipelines YAML, build classique, version classique
S’exécute sur Serveur
Demandes None
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande Quelconque
Variables paramétrables Quelconque
Version de l’agent Toutes les versions d’agent prises en charge.
Catégorie de la tâche Utilitaire