Job Router Administration Operations - Upsert Distribution Policy

サービス:

Communication

API バージョン:

2023-11-01

配布ポリシーを作成または更新します。

PATCH {endpoint}/routing/distributionPolicies/{distributionPolicyId}?api-version=2023-11-01

URI パラメーター

名前	/	必須	型	説明
distributionPolicyId	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"

名前	型	説明
mode	DistributionModeCreateOrUpdate: BestWorkerModeCreateOrUpdate LongestIdleModeCreateOrUpdate RoundRobinModeCreateOrUpdate	特定の配布方法を管理するモード。
name	string	このポリシーのフレンドリ名。
offerExpiresAfterSeconds	number	このポリシーで作成されたオファーの有効期限が切れる秒数。

応答

名前	型	説明
200 OK	DistributionPolicy	要求は成功しました。 ヘッダー ETag: string Last-Modified: string
201 Created	DistributionPolicy	要求が成功し、結果として新しいリソースが作成されました。 ヘッダー 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 Distribution policy

Updates a distribution policy

Creates a Distribution policy

要求のサンプル

HTTP

PATCH https://contoso.westus.communications.azure.com/routing/distributionPolicies/d9033d56-659c-437a-b5b7-4f3b14301dd4?api-version=2023-11-01

{
  "mode": {
    "kind": "longestIdle",
    "minConcurrentOffers": 1,
    "maxConcurrentOffers": 5,
    "bypassSelectors": false
  },
  "offerExpiresAfterSeconds": 300,
  "name": "Main"
}

応答のサンプル

状態コード:

200

{
  "id": "d9033d56-659c-437a-b5b7-4f3b14301dd4",
  "name": "Main",
  "offerExpiresAfterSeconds": 300,
  "mode": {
    "kind": "longestIdle",
    "minConcurrentOffers": 1,
    "maxConcurrentOffers": 5,
    "bypassSelectors": false
  },
  "etag": "etag"
}

状態コード:

201

{
  "id": "d9033d56-659c-437a-b5b7-4f3b14301dd4",
  "name": "Main",
  "offerExpiresAfterSeconds": 300,
  "mode": {
    "kind": "longestIdle",
    "minConcurrentOffers": 1,
    "maxConcurrentOffers": 5,
    "bypassSelectors": false
  },
  "etag": "etag"
}

Updates a distribution policy

要求のサンプル

HTTP

PATCH https://contoso.westus.communications.azure.com/routing/distributionPolicies/d9033d56-659c-437a-b5b7-4f3b14301dd4?api-version=2023-11-01

{
  "mode": {
    "kind": "longestIdle",
    "minConcurrentOffers": 1,
    "maxConcurrentOffers": 5,
    "bypassSelectors": false
  },
  "offerExpiresAfterSeconds": 300,
  "name": "Main"
}

応答のサンプル

状態コード:

200

{
  "id": "d9033d56-659c-437a-b5b7-4f3b14301dd4",
  "name": "Main",
  "offerExpiresAfterSeconds": 300,
  "mode": {
    "kind": "longestIdle",
    "minConcurrentOffers": 1,
    "maxConcurrentOffers": 5,
    "bypassSelectors": false
  },
  "etag": "etag"
}

状態コード:

201

{
  "id": "d9033d56-659c-437a-b5b7-4f3b14301dd4",
  "name": "Main",
  "offerExpiresAfterSeconds": 300,
  "mode": {
    "kind": "longestIdle",
    "minConcurrentOffers": 1,
    "maxConcurrentOffers": 5,
    "bypassSelectors": false
  },
  "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.
BestWorkerMode	ジョブは、使用可能な最も強力な能力を持つワーカーに配布されます。
BestWorkerModeCreateOrUpdate	ジョブは、使用可能な最も強力な能力を持つワーカーに配布されます。
DirectMapRouterRule	入力ラベルと同じラベルを返すルール。
DirectMapRouterRuleCreateOrUpdate	入力ラベルと同じラベルを返すルール。
DistributionModeKind	サポートされている配布モードの種類の判別子。
DistributionPolicy	ジョブをワーカーに配布する方法を管理するポリシー
DistributionPolicyCreateOrUpdate	ジョブをワーカーに配布する方法を管理するポリシー
ExpressionRouterRule	インライン式ルールを提供するルール。
ExpressionRouterRuleCreateOrUpdate	インライン式ルールを提供するルール。
ExpressionRouterRuleLanguage	構成できる使用可能な式言語。
FunctionRouterRule	HTTP によってトリガーされる Azure 関数へのバインドを提供する規則。
FunctionRouterRuleCreateOrUpdate	HTTP によってトリガーされる Azure 関数へのバインドを提供する規則。
FunctionRouterRuleCredential	Azure 関数ルールへのアクセスに使用される資格情報。
LongestIdleMode	ジョブは、アイドル時間が最も長いワーカーに送信されます。
LongestIdleModeCreateOrUpdate	ジョブは、アイドル時間が最も長いワーカーに送信されます。
OAuth2WebhookClientCredential	Contoso の承認サーバーに使用される OAuth2.0 資格情報。 リファレンス: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
RoundRobinMode	ジョブは、ジョブを受け取る最後のワーカーの後のワーカーから開始して、ワーカーに配布されます。
RoundRobinModeCreateOrUpdate	ジョブは、ジョブを受け取る最後のワーカーの後のワーカーから開始して、ワーカーに配布されます。
RouterRuleKind	サポートされているルーター 規則の種類の判別子。
ScoringRuleOptions	BestWorkerMode を使用してスコアリング ルールのパラメーターとして渡すことができるすべてのオプションをカプセル化します。
ScoringRuleParameterSelector	BestWorkerMode で使用されるスコアリング ワーカーでサポートされているパラメーター。
StaticRouterRule	入力に関係なく、常に同じ結果を返す静的ルールを提供するルール。
StaticRouterRuleCreateOrUpdate	入力に関係なく、常に同じ結果を返す静的ルールを提供するルール。
WebhookRouterRule	外部 Web サーバーへのバインドを提供する規則。
WebhookRouterRuleCreateOrUpdate	外部 Web サーバーへのバインドを提供する規則。

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	内部エラー。

BestWorkerMode

ジョブは、使用可能な最も強力な能力を持つワーカーに配布されます。

名前	型	規定値	説明
bypassSelectors	boolean	False	true に設定すると、ルーターはラベル セレクターと一致しない場合でも、ワーカーをジョブと照合します。 警告: この変数を true に設定すると、一致するジョブに対して修飾されていないワーカーが取得される場合があります。 このフラグは、より一時的な使用を目的としています。 既定では、false に設定します。
kind	string: bestWorker		DistributionMode のサブタイプを記述する型識別子。
maxConcurrentOffers	integer	1	ジョブに含めることができるアクティブな同時実行オファーの最大数を制御します。
minConcurrentOffers	integer	1	ジョブに含めることができるアクティブな同時実行オファーの最小数を制御します。
scoringRule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule		スコアを計算して最適なワーカーを決定するときに、使用するスコアリング ルールを定義します。 設定されていない場合は、worker ラベルが一致するジョブ ラベルの数と、ワーカー ラベルが一致するラベル セレクターの数、またはロジスティック関数 (https://en.wikipedia.org/wiki/Logistic_function) を使用した超過の数を使用する既定のスコアリング式を使用します。
scoringRuleOptions	ScoringRuleOptions		'scoringRule' を構成するためのオプション。 設定しない場合は、既定値が使用されます。

BestWorkerModeCreateOrUpdate

ジョブは、使用可能な最も強力な能力を持つワーカーに配布されます。

名前	型	規定値	説明
bypassSelectors	boolean	False	true に設定すると、ルーターはラベル セレクターと一致しない場合でも、ワーカーをジョブと照合します。 警告: この変数を true に設定すると、一致するジョブに対して修飾されていないワーカーが取得される場合があります。 このフラグは、より一時的な使用を目的としています。 既定では、false に設定します。
kind	string: bestWorker		DistributionMode のサブタイプを記述する型識別子。
maxConcurrentOffers	integer	1	ジョブに含めることができるアクティブな同時実行オファーの最大数を制御します。
minConcurrentOffers	integer	1	ジョブに含めることができるアクティブな同時実行オファーの最小数を制御します。
scoringRule	RouterRuleCreateOrUpdate: DirectMapRouterRuleCreateOrUpdate ExpressionRouterRuleCreateOrUpdate FunctionRouterRuleCreateOrUpdate StaticRouterRuleCreateOrUpdate WebhookRouterRuleCreateOrUpdate		スコアを計算して最適なワーカーを決定するときに、使用するスコアリング ルールを定義します。 設定されていない場合は、worker ラベルが一致するジョブ ラベルの数と、ワーカー ラベルが一致するラベル セレクターの数、またはロジスティック関数 (https://en.wikipedia.org/wiki/Logistic_function) を使用した超過の数を使用する既定のスコアリング式を使用します。
scoringRuleOptions	ScoringRuleOptions		'scoringRule' を構成するためのオプション。 設定しない場合は、既定値が使用されます。

DirectMapRouterRule

入力ラベルと同じラベルを返すルール。

名前	型	説明
kind	string: directMap	RouterRule のサブタイプを記述する型識別子

DirectMapRouterRuleCreateOrUpdate

入力ラベルと同じラベルを返すルール。

名前	型	説明
kind	string: directMap	RouterRule のサブタイプを記述する型識別子

DistributionModeKind

サポートされている配布モードの種類の判別子。

名前	型	説明
bestWorker	string	BestWorkerMode の識別子の値。
longestIdle	string	LongestIdleMode の識別子の値。
roundRobin	string	RoundRobinMode の識別子の値。

DistributionPolicy

ジョブをワーカーに配布する方法を管理するポリシー

名前	型	説明
etag	string	このリソースのエンティティ タグ。
id	string	配布ポリシーの ID。
mode	DistributionMode: BestWorkerMode LongestIdleMode RoundRobinMode	特定の配布方法を管理するモード。
name	string	このポリシーのフレンドリ名。
offerExpiresAfterSeconds	number	このポリシーで作成されたオファーの有効期限が切れる秒数。

DistributionPolicyCreateOrUpdate

ジョブをワーカーに配布する方法を管理するポリシー

名前	型	説明
mode	DistributionModeCreateOrUpdate: BestWorkerModeCreateOrUpdate LongestIdleModeCreateOrUpdate RoundRobinModeCreateOrUpdate	特定の配布方法を管理するモード。
name	string	このポリシーのフレンドリ名。
offerExpiresAfterSeconds	number	このポリシーで作成されたオファーの有効期限が切れる秒数。

ExpressionRouterRule

インライン式ルールを提供するルール。

名前	型	説明
expression	string	評価する式。 計算値を持つ return ステートメントを含める必要があります。
kind	string: expression	RouterRule のサブタイプを記述する型識別子
language	ExpressionRouterRuleLanguage	コンパイルして実行する式言語。

ExpressionRouterRuleCreateOrUpdate

インライン式ルールを提供するルール。

名前	型	説明
expression	string	評価する式。 計算値を持つ return ステートメントを含める必要があります。
kind	string: expression	RouterRule のサブタイプを記述する型識別子
language	ExpressionRouterRuleLanguage	コンパイルして実行する式言語。

ExpressionRouterRuleLanguage

構成できる使用可能な式言語。

名前	型	説明
powerFx	string	PowerFx

FunctionRouterRule

HTTP によってトリガーされる Azure 関数へのバインドを提供する規則。

名前	型	説明
credential	FunctionRouterRuleCredential	Azure 関数ルールへのアクセスに使用される資格情報。
functionUri	string	Azure 関数の URL。
kind	string: function	RouterRule のサブタイプを記述する型識別子

FunctionRouterRuleCreateOrUpdate

HTTP によってトリガーされる Azure 関数へのバインドを提供する規則。

名前	型	説明
credential	FunctionRouterRuleCredential	Azure 関数ルールへのアクセスに使用される資格情報。
functionUri	string	Azure 関数の URL。
kind	string: function	RouterRule のサブタイプを記述する型識別子

FunctionRouterRuleCredential

Azure 関数ルールへのアクセスに使用される資格情報。

名前	型	説明
appKey	string	Azure 関数アプリをスコープとしたアクセス キー。 このキーは、アプリのすべての関数へのアクセスを許可します。
clientId	string	クライアント ID。AppKey が Azure 関数のコンテキストで指定されている場合、これは通常、キーの名前です。
functionKey	string	特定の関数をスコープとするアクセス キー。

LongestIdleMode

ジョブは、アイドル時間が最も長いワーカーに送信されます。

名前	型	規定値	説明
bypassSelectors	boolean	False	true に設定すると、ルーターはラベル セレクターと一致しない場合でも、ワーカーをジョブと照合します。 警告: この変数を true に設定すると、一致するジョブに対して修飾されていないワーカーが取得される場合があります。 このフラグは、より一時的な使用を目的としています。 既定では、false に設定します。
kind	string: longestIdle		DistributionMode のサブタイプを記述する型識別子。
maxConcurrentOffers	integer	1	ジョブに含めることができるアクティブな同時実行オファーの最大数を制御します。
minConcurrentOffers	integer	1	ジョブに含めることができるアクティブな同時実行オファーの最小数を制御します。

LongestIdleModeCreateOrUpdate

ジョブは、アイドル時間が最も長いワーカーに送信されます。

名前	型	規定値	説明
bypassSelectors	boolean	False	true に設定すると、ルーターはラベル セレクターと一致しない場合でも、ワーカーをジョブと照合します。 警告: この変数を true に設定すると、一致するジョブに対して修飾されていないワーカーが取得される場合があります。 このフラグは、より一時的な使用を目的としています。 既定では、false に設定します。
kind	string: longestIdle		DistributionMode のサブタイプを記述する型識別子。
maxConcurrentOffers	integer	1	ジョブに含めることができるアクティブな同時実行オファーの最大数を制御します。
minConcurrentOffers	integer	1	ジョブに含めることができるアクティブな同時実行オファーの最小数を制御します。

OAuth2WebhookClientCredential

Contoso の承認サーバーに使用される OAuth2.0 資格情報。 リファレンス: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/

名前	型	説明
clientId	string	Contoso Authorization サーバーの ClientId。
clientSecret	string	Contoso Authorization サーバーのクライアント シークレット。

RoundRobinMode

ジョブは、ジョブを受け取る最後のワーカーの後のワーカーから開始して、ワーカーに配布されます。

名前	型	規定値	説明
bypassSelectors	boolean	False	true に設定すると、ルーターはラベル セレクターと一致しない場合でも、ワーカーをジョブと照合します。 警告: この変数を true に設定すると、一致するジョブに対して修飾されていないワーカーが取得される場合があります。 このフラグは、より一時的な使用を目的としています。 既定では、false に設定します。
kind	string: roundRobin		DistributionMode のサブタイプを記述する型識別子。
maxConcurrentOffers	integer	1	ジョブに含めることができるアクティブな同時実行オファーの最大数を制御します。
minConcurrentOffers	integer	1	ジョブに含めることができるアクティブな同時実行オファーの最小数を制御します。

RoundRobinModeCreateOrUpdate

ジョブは、ジョブを受け取る最後のワーカーの後のワーカーから開始して、ワーカーに配布されます。

名前	型	規定値	説明
bypassSelectors	boolean	False	true に設定すると、ルーターはラベル セレクターと一致しない場合でも、ワーカーをジョブと照合します。 警告: この変数を true に設定すると、一致するジョブに対して修飾されていないワーカーが取得される場合があります。 このフラグは、より一時的な使用を目的としています。 既定では、false に設定します。
kind	string: roundRobin		DistributionMode のサブタイプを記述する型識別子。
maxConcurrentOffers	integer	1	ジョブに含めることができるアクティブな同時実行オファーの最大数を制御します。
minConcurrentOffers	integer	1	ジョブに含めることができるアクティブな同時実行オファーの最小数を制御します。

RouterRuleKind

サポートされているルーター 規則の種類の判別子。

名前	型	説明
directMap	string	DirectMapRouterRule の識別子の値。
expression	string	ExpressionRouterRule の識別子の値。
function	string	FunctionRouterRule の識別子の値。
static	string	StaticRouterRule の識別子の値。
webhook	string	WebhookRouterRule の識別子の値。

ScoringRuleOptions

BestWorkerMode を使用してスコアリング ルールのパラメーターとして渡すことができるすべてのオプションをカプセル化します。

名前	型	規定値	説明
batchSize	integer	20	'isBatchScoringEnabled' が true に設定されている場合は、バッチ サイズを設定します。 構成されていない場合、既定値は 20 です。
descendingOrder	boolean	True	false の場合、スコアは昇順で並べ替えられます。 既定では、true に設定します。
isBatchScoringEnabled	boolean	False	true に設定すると、ワーカーがバッチでスコア付けされ、worker ラベルのパラメーター名が workersとして送信されます。 既定では、false に設定すると、worker ラベルのパラメーター名が workerとして送信されます。 注: 有効になっている場合は、'batchSize' を使用してバッチ サイズを設定します。
scoringParameters	ScoringRuleParameterSelector[]	[ "jobLabels", "workerSelectors" ]	ペイロードの一部としてスコアリング ルールに送信されるジョブからの追加パラメーターの一覧。 設定されていない場合、ジョブのラベル (jobとしてペイロードで送信) とジョブのワーカー セレクター (selectorsとしてペイロードで送信) が、既定でスコアリング ルールのペイロードに追加されます。 注: Worker ラベルは常にスコアリング ペイロードと共に送信されます。

ScoringRuleParameterSelector

BestWorkerMode で使用されるスコアリング ワーカーでサポートされているパラメーター。

名前	型	説明
jobLabels	string	スコアリング ペイロードにジョブ ラベルを追加するパラメーター。 プロパティは、jobとして送信されます。
workerSelectors	string	ジョブからスコアリング ペイロードにワーカー セレクターを追加するパラメーター。 プロパティは、selectorsとして送信されます。

StaticRouterRule

入力に関係なく、常に同じ結果を返す静的ルールを提供するルール。

名前	型	説明
kind	string: static	RouterRule のサブタイプを記述する型識別子
value		このルールが常に返す静的な値。 値はプリミティブ値 (数値、文字列、ブール値) である必要があります。

StaticRouterRuleCreateOrUpdate

入力に関係なく、常に同じ結果を返す静的ルールを提供するルール。

名前	型	説明
kind	string: static	RouterRule のサブタイプを記述する型識別子
value		このルールが常に返す静的な値。 値はプリミティブ値 (数値、文字列、ブール値) である必要があります。

WebhookRouterRule

外部 Web サーバーへのバインドを提供する規則。

名前	型	説明
authorizationServerUri	string	承認サーバーの URI。
clientCredential	OAuth2WebhookClientCredential	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	OAuth2WebhookClientCredential	Contoso の承認サーバーに使用される OAuth2.0 資格情報。 リファレンス: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
kind	string: webhook	RouterRule のサブタイプを記述する型識別子
webhookUri	string	Contoso の Web サーバーの URI。