PublishToAzureServiceBus@1 - v1 タスクに発行Azure Service Bus
このタスクを使用して、サービス接続を使用してAzure Service Busにメッセージを送信します (エージェントは必要ありません)。
このタスクを使用して、サービス接続を使用してAzure Service Busにメッセージを送信します (エージェントは必要ありません)。
構文
# 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 Service Bus サービス接続
入力エイリアス: connectedServiceName
。 string
. 必須です。
Azure Service Bus サービス接続を指定します。
messageBody
- メッセージ本文
string
.
JSON を指定します messageBody
。
sessionId
- セッション ID
string
.
メッセージをパブリッシュするセッション ID を指定します。 セッション ベースのキューの場合、値が指定されていない場合、発行は失敗します。 セッション ベース以外のキューの場合、値を指定する必要はありません。
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
。
オブジェクトではなくストリームとしてメッセージを渡す場合は、 を にfalse
設定useDataContractSerializer
します。
タスク制御オプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。
出力変数
[なし] :
解説
リリース パイプラインのエージェントレス ジョブでこのタスクを使用して、(エージェントを使用せずに) サービス接続を使用してAzure Service Busにメッセージを送信します。
注意
リリース パイプラインの エージェントレス ジョブ でのみ使用できます。
タスクは完了をどこで通知する必要がありますか?
完了を通知するには、外部サービスで完了データを次のパイプライン REST エンドポイントに POST する必要があります。
{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# ヘルパー ライブラリを使用して、エージェントレス タスクのライブ ログ記録とタスク状態の管理を可能にします。 非同期 HTTP エージェントレス タスクの詳細については、こちらを参照してください。
要件
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
実行日 | サーバー |
確認要求 | なし |
Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | Any |
設定可能な変数 | Any |
エージェントのバージョン | サポートされているすべてのエージェント バージョン。 |
タスクのカテゴリ | ユーティリティ |