次の方法で共有

Job Router Administration Operations - Upsert Queue

  • リファレンス
サービス:
Communication
API バージョン:
2023-11-01

キューを作成または更新します。

PATCH {endpoint}/routing/queues/{queueId}?api-version=2023-11-01

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

通信リソースの URI
queueId
 path True

string

キューの ID。
api-version
 query True

string

この操作に使用する API バージョン。

要求ヘッダー

Media Types: "application/merge-patch+json"

名前 必須 型 説明
If-Match

string

要求は、エンティティがこの文字列と一致する場合にのみ続行する必要があります。
If-Unmodified-Since

string

date-time-rfc7231

要求は、エンティティがこの時刻より後に変更されなかった場合にのみ続行する必要があります。

要求本文

Media Types: "application/merge-patch+json"

名前 型 説明
distributionPolicyId

string

ジョブをワーカーに配布する方法を決定する配布ポリシーの ID。
exceptionPolicyId

string

さまざまなジョブ エスカレーション ルールを決定する例外ポリシーの ID。
labels

ルール エンジンが決定を下すために使用する属性を識別するキーと値のペアのセット。 値はプリミティブ値 (数値、文字列、ブール値) である必要があります。
name

string

このキューのフレンドリ名。

応答

名前 型 説明
200 OK

RouterQueue

要求は成功しました。

ヘッダー

  • ETag: string
  • Last-Modified: string
201 Created

RouterQueue

要求が成功し、結果として新しいリソースが作成されました。

ヘッダー

  • ETag: string
  • Last-Modified: string
Other Status Codes

Azure.Core.Foundations.ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

AadOauth2Auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前 説明
https://communication.azure.com/.default

例

Creates a queue
Updates a queue

Creates a queue

要求のサンプル

PATCH https://contoso.westus.communications.azure.com/routing/queues/QueueId?api-version=2023-11-01

{
  "distributionPolicyId": "MainDistributionPolicy",
  "name": "Main",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy"
}

応答のサンプル

状態コード:
200 
{
  "id": "246d5a06-c04a-4b6b-8a34-02bbd9fdad68",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}
状態コード:
201 
{
  "id": "246d5a06-c04a-4b6b-8a34-02bbd9fdad68",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}

Updates a queue

要求のサンプル

PATCH https://contoso.westus.communications.azure.com/routing/queues/MainQueue?api-version=2023-11-01

{
  "distributionPolicyId": "MainDistributionPolicy",
  "name": "Main"
}

応答のサンプル

状態コード:
200 
{
  "id": "MainQueue",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}
状態コード:
201 
{
  "id": "MainQueue",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}

定義

名前 説明
Azure.Core.Foundations.Error

エラー オブジェクト。
Azure.Core.Foundations.ErrorResponse

エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueue

ルーティングするジョブを格納できるキュー。
RouterQueueCreateOrUpdate

ルーティングするジョブを格納できるキュー。

Azure.Core.Foundations.Error

エラー オブジェクト。

名前 型 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。
details

Azure.Core.Foundations.Error[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror

Azure.Core.Foundations.InnerError

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message

string

エラーの人間が判読できる表現。
target

string

エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

エラーの詳細を含む応答。

名前 型 説明
error

Azure.Core.Foundations.Error

エラー オブジェクト。

Azure.Core.Foundations.InnerError

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

名前 型 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。
innererror

Azure.Core.Foundations.InnerError

内部エラー。

RouterQueue

ルーティングするジョブを格納できるキュー。

名前 型 説明
distributionPolicyId

string

ジョブをワーカーに配布する方法を決定する配布ポリシーの ID。
etag

string

このリソースのエンティティ タグ。
exceptionPolicyId

string

さまざまなジョブ エスカレーション ルールを決定する例外ポリシーの ID。
id

string

キューの ID。
labels

ルール エンジンが決定を下すために使用する属性を識別するキーと値のペアのセット。 値はプリミティブ値 (数値、文字列、ブール値) である必要があります。
name

string

このキューのフレンドリ名。

RouterQueueCreateOrUpdate

ルーティングするジョブを格納できるキュー。

名前 型 説明
distributionPolicyId

string

ジョブをワーカーに配布する方法を決定する配布ポリシーの ID。
exceptionPolicyId

string

さまざまなジョブ エスカレーション ルールを決定する例外ポリシーの ID。
labels

ルール エンジンが決定を下すために使用する属性を識別するキーと値のペアのセット。 値はプリミティブ値 (数値、文字列、ブール値) である必要があります。
name

string

このキューのフレンドリ名。