Job Router Administration Operations - Upsert Classification Policy
分類ポリシーを作成または更新します。
PATCH {endpoint}/routing/classificationPolicies/{classificationPolicyId}?api-version=2023-11-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
classification
|
path | True |
string |
分類ポリシーの ID。 |
endpoint
|
path | True |
string |
通信リソースの URI |
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"
名前 | 型 | 説明 |
---|---|---|
fallbackQueueId |
string |
キュー セレクターの添付ファイルで一致するものが見つからないかどうかを選択するフォールバック キューの ID。 |
name |
string |
このポリシーのフレンドリ名。 |
prioritizationRule | RouterRuleCreateOrUpdate: |
ジョブの優先度スコアを決定するルール。 |
queueSelectorAttachments | QueueSelectorAttachment[]: |
ジョブのキューを解決するために使用されるキュー セレクターの添付ファイル。 |
workerSelectorAttachments | WorkerSelectorAttachment[]: |
ワーカー セレクターをジョブにアタッチするために使用されるワーカー セレクターの添付ファイル。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は成功しました。 ヘッダー
|
|
201 Created |
要求が成功し、結果として新しいリソースが作成されました。 ヘッダー
|
|
Other Status Codes |
予期しないエラー応答。 ヘッダー 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 Classification Policy |
Updates a Classification Policy |
Creates a Classification Policy
要求のサンプル
PATCH https://contoso.westus.communications.azure.com/routing/classificationPolicies/90eb00c4-234e-4df7-a231-ef7895518384?api-version=2023-11-01
{
"name": "Main",
"fallbackQueueId": "MainQueue",
"queueSelectorAttachments": [
{
"kind": "conditional",
"condition": {
"kind": "expression",
"language": "powerFx",
"expression": "1 = 1"
},
"queueSelectors": [
{
"key": "foo",
"labelOperator": "equal",
"value": "bar"
}
]
}
],
"prioritizationRule": {
"kind": "static",
"value": "2"
}
}
応答のサンプル
{
"id": "90eb00c4-234e-4df7-a231-ef7895518384",
"name": "Main",
"fallbackQueueId": "MainQueue",
"queueSelectorAttachments": [
{
"kind": "conditional",
"condition": {
"kind": "expression",
"language": "powerFx",
"expression": "1 = 1"
},
"queueSelectors": [
{
"key": "foo",
"labelOperator": "equal",
"value": "bar"
}
]
}
],
"prioritizationRule": {
"kind": "static",
"value": "2"
},
"workerSelectorAttachments": [],
"etag": "etag"
}
{
"id": "90eb00c4-234e-4df7-a231-ef7895518384",
"name": "Main",
"fallbackQueueId": "MainQueue",
"queueSelectorAttachments": [
{
"kind": "conditional",
"condition": {
"kind": "expression",
"language": "powerFx",
"expression": "1 = 1"
},
"queueSelectors": [
{
"key": "foo",
"labelOperator": "equal",
"value": "bar"
}
]
}
],
"prioritizationRule": {
"kind": "static",
"value": "2"
},
"workerSelectorAttachments": [],
"etag": "etag"
}
Updates a Classification Policy
要求のサンプル
PATCH https://contoso.westus.communications.azure.com/routing/classificationPolicies/90eb00c4-234e-4df7-a231-ef7895518384?api-version=2023-11-01
{
"name": "MainUpdate"
}
応答のサンプル
{
"id": "90eb00c4-234e-4df7-a231-ef7895518384",
"name": "MainUpdate",
"fallbackQueueId": "MainQueue",
"queueSelectorAttachments": [
{
"kind": "conditional",
"condition": {
"kind": "expression",
"language": "powerFx",
"expression": "1 = 1"
},
"queueSelectors": [
{
"key": "foo",
"labelOperator": "equal",
"value": "bar"
}
]
}
],
"prioritizationRule": {
"kind": "static",
"value": "2"
},
"workerSelectorAttachments": [],
"etag": "etag"
}
{
"id": "90eb00c4-234e-4df7-a231-ef7895518384",
"name": "MainUpdate",
"fallbackQueueId": "MainQueue",
"queueSelectorAttachments": [
{
"kind": "conditional",
"condition": {
"kind": "expression",
"language": "powerFx",
"expression": "1 = 1"
},
"queueSelectors": [
{
"key": "foo",
"labelOperator": "equal",
"value": "bar"
}
]
}
],
"prioritizationRule": {
"kind": "static",
"value": "2"
},
"workerSelectorAttachments": [],
"etag": "etag"
}
定義
名前 | 説明 |
---|---|
Azure. |
エラー オブジェクト。 |
Azure. |
エラーの詳細を含む応答。 |
Azure. |
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Classification |
ジョブの分類方法を管理するルールのコンテナー。 |
Classification |
ジョブの分類方法を管理するルールのコンテナー。 |
Conditional |
指定された条件が true に解決された場合にアタッチされるキュー セレクターのセットについて説明します。 |
Conditional |
指定された条件が true に解決された場合にアタッチされるワーカー セレクターのセットについて説明します。 |
Direct |
入力ラベルと同じラベルを返すルール。 |
Direct |
入力ラベルと同じラベルを返すルール。 |
Expression |
インライン式ルールを提供するルール。 |
Expression |
インライン式ルールを提供するルール。 |
Expression |
構成できる使用可能な式言語。 |
Function |
HTTP によってトリガーされる Azure 関数へのバインドを提供する規則。 |
Function |
HTTP によってトリガーされる Azure 関数へのバインドを提供する規則。 |
Function |
Azure 関数ルールへのアクセスに使用される資格情報。 |
Label |
ラベル値に対してサポートされている操作について説明します。 |
OAuth2Webhook |
Contoso の承認サーバーに使用される OAuth2.0 資格情報。 リファレンス: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/ |
Pass |
同じキーを持つジョブのラベルから値が渡されるキュー セレクターをアタッチします。 |
Pass |
同じキーを持つジョブのラベルから値が渡されるワーカー セレクターをアタッチします。 |
Queue |
サポートされているキュー セレクターの添付ファイルの種類の識別子。 |
Queue |
重み付けディストリビューションに対して選択されている場合に適用される重みの割合とキュー セレクターが含まれます。 |
Router |
キューを選択するために一連のラベルに対して満たす必要がある条件について説明します。 |
Router |
サポートされているルーター 規則の種類の判別子。 |
Router |
worker 選択のラベルのセットに対して満たす必要がある条件について説明します。 |
Router |
ワーカー セレクターの状態について説明します。 |
Rule |
RouterRule が解決されたときに、キュー セレクターをジョブにアタッチします。 |
Rule |
RouterRule が解決されたときに、ワーカー セレクターをジョブにアタッチします。 |
Static |
ジョブにアタッチされるキュー セレクターについて説明します。 |
Static |
入力に関係なく、常に同じ結果を返す静的ルールを提供するルール。 |
Static |
入力に関係なく、常に同じ結果を返す静的ルールを提供するルール。 |
Static |
ジョブにアタッチされるワーカー セレクターについて説明します。 |
Webhook |
外部 Web サーバーへのバインドを提供する規則。 |
Webhook |
外部 Web サーバーへのバインドを提供する規則。 |
Weighted |
複数のキュー セレクターのセットについて説明します。その中の 1 つが選択され、重み付けに従ってアタッチされます。 |
Weighted |
ワーカー セレクターの複数のセットについて説明します。そのうちの 1 つが選択され、重み付けに従ってアタッチされます。 |
Worker |
サポートされているワーカー セレクターの添付ファイルの種類の識別子。 |
Worker |
加重分布に対して選択されている場合に適用される重みの割合とワーカー セレクターが含まれます。 |
Azure.Core.Foundations.Error
エラー オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
details |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
|
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
|
message |
string |
エラーの人間が判読できる表現。 |
target |
string |
エラーのターゲット。 |
Azure.Core.Foundations.ErrorResponse
エラーの詳細を含む応答。
名前 | 型 | 説明 |
---|---|---|
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 |
内部エラー。 |
ClassificationPolicy
ジョブの分類方法を管理するルールのコンテナー。
名前 | 型 | 説明 |
---|---|---|
etag |
string |
このリソースのエンティティ タグ。 |
fallbackQueueId |
string |
キュー セレクターの添付ファイルで一致するものが見つからないかどうかを選択するフォールバック キューの ID。 |
id |
string |
分類ポリシーの ID。 |
name |
string |
このポリシーのフレンドリ名。 |
prioritizationRule | RouterRule: |
ジョブの優先度スコアを決定するルール。 |
queueSelectorAttachments | QueueSelectorAttachment[]: |
ジョブのキューを解決するために使用されるキュー セレクターの添付ファイル。 |
workerSelectorAttachments | WorkerSelectorAttachment[]: |
ワーカー セレクターをジョブにアタッチするために使用されるワーカー セレクターの添付ファイル。 |
ClassificationPolicyCreateOrUpdate
ジョブの分類方法を管理するルールのコンテナー。
名前 | 型 | 説明 |
---|---|---|
fallbackQueueId |
string |
キュー セレクターの添付ファイルで一致するものが見つからないかどうかを選択するフォールバック キューの ID。 |
name |
string |
このポリシーのフレンドリ名。 |
prioritizationRule | RouterRuleCreateOrUpdate: |
ジョブの優先度スコアを決定するルール。 |
queueSelectorAttachments | QueueSelectorAttachment[]: |
ジョブのキューを解決するために使用されるキュー セレクターの添付ファイル。 |
workerSelectorAttachments | WorkerSelectorAttachment[]: |
ワーカー セレクターをジョブにアタッチするために使用されるワーカー セレクターの添付ファイル。 |
ConditionalQueueSelectorAttachment
指定された条件が true に解決された場合にアタッチされるキュー セレクターのセットについて説明します。
名前 | 型 | 説明 |
---|---|---|
condition | RouterRule: |
キュー セレクターをアタッチするために true にする必要がある条件。 |
kind |
string:
conditional |
QueueSelectorAttachment のサブタイプを記述する型識別子。 |
queueSelectors |
アタッチするキュー セレクター。 |
ConditionalWorkerSelectorAttachment
指定された条件が true に解決された場合にアタッチされるワーカー セレクターのセットについて説明します。
名前 | 型 | 説明 |
---|---|---|
condition | RouterRule: |
ワーカー セレクターをアタッチするために true にする必要がある条件。 |
kind |
string:
conditional |
WorkerSelectorAttachment のサブタイプを記述する型識別子。 |
workerSelectors |
アタッチするワーカー セレクター。 |
DirectMapRouterRule
入力ラベルと同じラベルを返すルール。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
direct |
RouterRule のサブタイプを記述する型識別子 |
DirectMapRouterRuleCreateOrUpdate
入力ラベルと同じラベルを返すルール。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
direct |
RouterRule のサブタイプを記述する型識別子 |
ExpressionRouterRule
インライン式ルールを提供するルール。
名前 | 型 | 説明 |
---|---|---|
expression |
string |
評価する式。 計算値を持つ return ステートメントを含める必要があります。 |
kind |
string:
expression |
RouterRule のサブタイプを記述する型識別子 |
language |
コンパイルして実行する式言語。 |
ExpressionRouterRuleCreateOrUpdate
インライン式ルールを提供するルール。
名前 | 型 | 説明 |
---|---|---|
expression |
string |
評価する式。 計算値を持つ return ステートメントを含める必要があります。 |
kind |
string:
expression |
RouterRule のサブタイプを記述する型識別子 |
language |
コンパイルして実行する式言語。 |
ExpressionRouterRuleLanguage
構成できる使用可能な式言語。
名前 | 型 | 説明 |
---|---|---|
powerFx |
string |
PowerFx |
FunctionRouterRule
HTTP によってトリガーされる Azure 関数へのバインドを提供する規則。
名前 | 型 | 説明 |
---|---|---|
credential |
Azure 関数ルールへのアクセスに使用される資格情報。 |
|
functionUri |
string |
Azure 関数の URL。 |
kind |
string:
function |
RouterRule のサブタイプを記述する型識別子 |
FunctionRouterRuleCreateOrUpdate
HTTP によってトリガーされる Azure 関数へのバインドを提供する規則。
名前 | 型 | 説明 |
---|---|---|
credential |
Azure 関数ルールへのアクセスに使用される資格情報。 |
|
functionUri |
string |
Azure 関数の URL。 |
kind |
string:
function |
RouterRule のサブタイプを記述する型識別子 |
FunctionRouterRuleCredential
Azure 関数ルールへのアクセスに使用される資格情報。
名前 | 型 | 説明 |
---|---|---|
appKey |
string |
Azure 関数アプリをスコープとしたアクセス キー。 このキーは、アプリのすべての関数へのアクセスを許可します。 |
clientId |
string |
クライアント ID。AppKey が Azure 関数のコンテキストで指定されている場合、これは通常、キーの名前です。 |
functionKey |
string |
特定の関数をスコープとするアクセス キー。 |
LabelOperator
ラベル値に対してサポートされている操作について説明します。
名前 | 型 | 説明 |
---|---|---|
equal |
string |
等しい。 |
greaterThan |
string |
より大きい。 |
greaterThanOrEqual |
string |
以上。 |
lessThan |
string |
未満。 |
lessThanOrEqual |
string |
以下。 |
notEqual |
string |
等しくない。 |
OAuth2WebhookClientCredential
Contoso の承認サーバーに使用される OAuth2.0 資格情報。 リファレンス: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
名前 | 型 | 説明 |
---|---|---|
clientId |
string |
Contoso Authorization サーバーの ClientId。 |
clientSecret |
string |
Contoso Authorization サーバーのクライアント シークレット。 |
PassThroughQueueSelectorAttachment
同じキーを持つジョブのラベルから値が渡されるキュー セレクターをアタッチします。
名前 | 型 | 説明 |
---|---|---|
key |
string |
クエリの対象となるラベル キー。 |
kind |
string:
pass |
QueueSelectorAttachment のサブタイプを記述する型識別子。 |
labelOperator |
ラベルの値とパススルー値の比較方法について説明します。 |
PassThroughWorkerSelectorAttachment
同じキーを持つジョブのラベルから値が渡されるワーカー セレクターをアタッチします。
名前 | 型 | 説明 |
---|---|---|
expiresAfterSeconds |
number |
添付ラベル セレクターが有効な時間 (秒単位) について説明します。 |
key |
string |
クエリの対象となるラベル キー。 |
kind |
string:
pass |
WorkerSelectorAttachment のサブタイプを記述する型識別子。 |
labelOperator |
ラベルの値とパススルー値の比較方法について説明します。 |
QueueSelectorAttachmentKind
サポートされているキュー セレクターの添付ファイルの種類の識別子。
名前 | 型 | 説明 |
---|---|---|
conditional |
string |
ConditionalQueueSelectorAttachment の識別子の値。 |
passThrough |
string |
PassThroughQueueSelectorAttachment の識別子の値。 |
ruleEngine |
string |
RuleEngineQueueSelectorAttachment の識別子の値。 |
static |
string |
StaticQueueSelectorAttachment の識別子の値。 |
weightedAllocation |
string |
WeightedAllocationQueueSelectorAttachment の識別子の値。 |
QueueWeightedAllocation
重み付けディストリビューションに対して選択されている場合に適用される重みの割合とキュー セレクターが含まれます。
名前 | 型 | 説明 |
---|---|---|
queueSelectors |
この割り当てが選択されている場合に適用されるキュー セレクターのコレクション。 |
|
weight |
number |
この重量の割合は、1の分数として表される。 |
RouterQueueSelector
キューを選択するために一連のラベルに対して満たす必要がある条件について説明します。
名前 | 型 | 説明 |
---|---|---|
key |
string |
クエリの対象となるラベル キー。 |
labelOperator |
ラベルセレクターで定義されている値とラベルの値を比較する方法について説明します。 |
|
value |
実際のラベル値と特定の演算子と比較する値。 値はプリミティブ値 (数値、文字列、ブール値) である必要があります。 |
RouterRuleKind
サポートされているルーター 規則の種類の判別子。
名前 | 型 | 説明 |
---|---|---|
directMap |
string |
DirectMapRouterRule の識別子の値。 |
expression |
string |
ExpressionRouterRule の識別子の値。 |
function |
string |
FunctionRouterRule の識別子の値。 |
static |
string |
StaticRouterRule の識別子の値。 |
webhook |
string |
WebhookRouterRule の識別子の値。 |
RouterWorkerSelector
worker 選択のラベルのセットに対して満たす必要がある条件について説明します。
名前 | 型 | 説明 |
---|---|---|
expedite |
boolean |
このセレクターがアクティブである限り、ジョブをキューの先頭にプッシュします。 |
expiresAfterSeconds |
number |
このラベル セレクターが有効な時間 (秒単位) について説明します。 |
expiresAt |
string |
このワーカー セレクターが UTC で期限切れになる時刻。 |
key |
string |
クエリの対象となるラベル キー。 |
labelOperator |
ラベルの値とワーカー セレクターで定義されている値の比較方法について説明します。 |
|
status |
ワーカー セレクターの状態。 |
|
value |
実際のラベル値と特定の演算子と比較する値。 値はプリミティブ値 (数値、文字列、ブール値) である必要があります。 |
RouterWorkerSelectorStatus
ワーカー セレクターの状態について説明します。
名前 | 型 | 説明 |
---|---|---|
active |
string |
ワーカー セレクターは有効です。 |
expired |
string |
ワーカー セレクターが無効です。 |
RuleEngineQueueSelectorAttachment
RouterRule が解決されたときに、キュー セレクターをジョブにアタッチします。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
rule |
QueueSelectorAttachment のサブタイプを記述する型識別子。 |
rule | RouterRule: |
アタッチするキュー セレクターのコレクションを解決する RouterRule。 |
RuleEngineWorkerSelectorAttachment
RouterRule が解決されたときに、ワーカー セレクターをジョブにアタッチします。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
rule |
WorkerSelectorAttachment のサブタイプを記述する型識別子。 |
rule | RouterRule: |
アタッチするワーカー セレクターのコレクションを解決する RouterRule。 |
StaticQueueSelectorAttachment
ジョブにアタッチされるキュー セレクターについて説明します。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
static |
QueueSelectorAttachment のサブタイプを記述する型識別子。 |
queueSelector |
アタッチするキュー セレクター。 |
StaticRouterRule
入力に関係なく、常に同じ結果を返す静的ルールを提供するルール。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
static |
RouterRule のサブタイプを記述する型識別子 |
value |
このルールが常に返す静的な値。 値はプリミティブ値 (数値、文字列、ブール値) である必要があります。 |
StaticRouterRuleCreateOrUpdate
入力に関係なく、常に同じ結果を返す静的ルールを提供するルール。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
static |
RouterRule のサブタイプを記述する型識別子 |
value |
このルールが常に返す静的な値。 値はプリミティブ値 (数値、文字列、ブール値) である必要があります。 |
StaticWorkerSelectorAttachment
ジョブにアタッチされるワーカー セレクターについて説明します。
名前 | 型 | 説明 |
---|---|---|
kind |
string:
static |
WorkerSelectorAttachment のサブタイプを記述する型識別子。 |
workerSelector |
アタッチするワーカー セレクター。 |
WebhookRouterRule
外部 Web サーバーへのバインドを提供する規則。
名前 | 型 | 説明 |
---|---|---|
authorizationServerUri |
string |
承認サーバーの URI。 |
clientCredential |
Contoso の承認サーバーに使用される OAuth2.0 資格情報。 リファレンス: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/ |
|
kind |
string:
webhook |
RouterRule のサブタイプを記述する型識別子 |
webhookUri |
string |
Contoso の Web サーバーの URI。 |
WebhookRouterRuleCreateOrUpdate
外部 Web サーバーへのバインドを提供する規則。
名前 | 型 | 説明 |
---|---|---|
authorizationServerUri |
string |
承認サーバーの URI。 |
clientCredential |
Contoso の承認サーバーに使用される OAuth2.0 資格情報。 リファレンス: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/ |
|
kind |
string:
webhook |
RouterRule のサブタイプを記述する型識別子 |
webhookUri |
string |
Contoso の Web サーバーの URI。 |
WeightedAllocationQueueSelectorAttachment
複数のキュー セレクターのセットについて説明します。その中の 1 つが選択され、重み付けに従ってアタッチされます。
名前 | 型 | 説明 |
---|---|---|
allocations |
パーセンテージベースの重み付け割り当てのコレクション。 |
|
kind |
string:
weighted |
QueueSelectorAttachment のサブタイプを記述する型識別子。 |
WeightedAllocationWorkerSelectorAttachment
ワーカー セレクターの複数のセットについて説明します。そのうちの 1 つが選択され、重み付けに従ってアタッチされます。
名前 | 型 | 説明 |
---|---|---|
allocations |
パーセンテージベースの重み付け割り当てのコレクション。 |
|
kind |
string:
weighted |
WorkerSelectorAttachment のサブタイプを記述する型識別子。 |
WorkerSelectorAttachmentKind
サポートされているワーカー セレクターの添付ファイルの種類の識別子。
名前 | 型 | 説明 |
---|---|---|
conditional |
string |
ConditionalWorkerSelectorAttachment の識別子の値。 |
passThrough |
string |
PassThroughWorkerSelectorAttachment の識別子の値。 |
ruleEngine |
string |
RuleEngineWorkerSelectorAttachment の識別子の値。 |
static |
string |
StaticWorkerSelectorAttachment の識別子の値。 |
weightedAllocation |
string |
WeightedAllocationWorkerSelectorAttachment の識別子の値。 |
WorkerWeightedAllocation
加重分布に対して選択されている場合に適用される重みの割合とワーカー セレクターが含まれます。
名前 | 型 | 説明 |
---|---|---|
weight |
number |
この重量の割合は、1の分数として表される。 |
workerSelectors |
この割り当てが選択されている場合に適用されるワーカー セレクターのコレクション。 |