你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 minLength: 1	用于此操作的 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 (double)	在此策略下创建的任何产品/服务都将过期的秒数。

响应

名称	类型	说明
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

名称

类型

说明

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
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 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	包含有关错误的更具体信息的对象。根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
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

Object

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

BestWorkerMode

Object

作业分发给具有最强大能力的辅助角色。

名称	类型	默认值	说明
bypassSelectors	boolean	False	如果设置为 true，则路由器会将工作器与作业匹配，即使它们与标签选择器不匹配。警告：如果将此变量设置为 true，可能会获取不符合其匹配作业条件的辅助角色。此标志更适用于临时使用。默认情况下，设置为 false。
kind	string: bestWorker		描述 DistributionMode 子类型的类型鉴别器。
maxConcurrentOffers	integer (int32)	1	控制作业可以拥有的活动并发产品/服务的最大数量。
minConcurrentOffers	integer (int32)	1	控制作业可以拥有的最小所需活动并发产品/服务数。
scoringRule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule		在计算分数以确定最佳辅助角色时，定义要使用的评分规则。如果未设置，将使用使用工作器标签匹配的作业标签数的默认评分公式，以及工作器标签匹配的标签选择器数以及/或超过使用逻辑函数（https://en.wikipedia.org/wiki/Logistic_function）。
scoringRuleOptions	ScoringRuleOptions		用于配置“scoringRule”的选项。如果未设置，则使用默认值。

BestWorkerModeCreateOrUpdate

Object

作业分发给具有最强大能力的辅助角色。

名称	类型	默认值	说明
bypassSelectors	boolean	False	如果设置为 true，则路由器会将工作器与作业匹配，即使它们与标签选择器不匹配。警告：如果将此变量设置为 true，可能会获取不符合其匹配作业条件的辅助角色。此标志更适用于临时使用。默认情况下，设置为 false。
kind	string: bestWorker		描述 DistributionMode 子类型的类型鉴别器。
maxConcurrentOffers	integer (int32)	1	控制作业可以拥有的活动并发产品/服务的最大数量。
minConcurrentOffers	integer (int32)	1	控制作业可以拥有的最小所需活动并发产品/服务数。
scoringRule	RouterRuleCreateOrUpdate: DirectMapRouterRuleCreateOrUpdate ExpressionRouterRuleCreateOrUpdate FunctionRouterRuleCreateOrUpdate StaticRouterRuleCreateOrUpdate WebhookRouterRuleCreateOrUpdate		在计算分数以确定最佳辅助角色时，定义要使用的评分规则。如果未设置，将使用使用工作器标签匹配的作业标签数的默认评分公式，以及工作器标签匹配的标签选择器数以及/或超过使用逻辑函数（https://en.wikipedia.org/wiki/Logistic_function）。
scoringRuleOptions	ScoringRuleOptions		用于配置“scoringRule”的选项。如果未设置，则使用默认值。

DirectMapRouterRule

Object

返回与输入标签相同的标签的规则。

名称	类型	说明
kind	string: directMap	描述 RouterRule 子类型的类型鉴别器

DirectMapRouterRuleCreateOrUpdate

Object

返回与输入标签相同的标签的规则。

名称	类型	说明
kind	string: directMap	描述 RouterRule 子类型的类型鉴别器

DistributionModeKind

枚举

支持的分发模式类型的鉴别器。

值	说明
bestWorker	BestWorkerMode 的鉴别器值。
longestIdle	LongestIdleMode 的鉴别器值。
roundRobin	RoundRobinMode 的鉴别器值。

DistributionPolicy

Object

控制作业如何分发给辅助角色的策略

名称	类型	说明
etag	string	此资源的实体标记。
id	string	分发策略的 ID。
mode	DistributionMode: BestWorkerMode LongestIdleMode RoundRobinMode	控制特定分发方法的模式。
name	string	此策略的友好名称。
offerExpiresAfterSeconds	number (double)	在此策略下创建的任何产品/服务都将过期的秒数。

DistributionPolicyCreateOrUpdate

Object

控制作业如何分发给辅助角色的策略

名称	类型	说明
mode	DistributionModeCreateOrUpdate: BestWorkerModeCreateOrUpdate LongestIdleModeCreateOrUpdate RoundRobinModeCreateOrUpdate	控制特定分发方法的模式。
name	string	此策略的友好名称。
offerExpiresAfterSeconds	number (double)	在此策略下创建的任何产品/服务都将过期的秒数。

ExpressionRouterRule

Object

提供内联表达式规则的规则。

名称	类型	说明
expression	string	要计算的表达式。应包含包含计算值的 return 语句。
kind	string: expression	描述 RouterRule 子类型的类型鉴别器
language	ExpressionRouterRuleLanguage	要编译到和执行的表达式语言。

ExpressionRouterRuleCreateOrUpdate

Object

提供内联表达式规则的规则。

名称	类型	说明
expression	string	要计算的表达式。应包含包含计算值的 return 语句。
kind	string: expression	描述 RouterRule 子类型的类型鉴别器
language	ExpressionRouterRuleLanguage	要编译到和执行的表达式语言。

ExpressionRouterRuleLanguage

枚举

可配置的可用表达式语言。

值	说明
powerFx	PowerFx

FunctionRouterRule

Object

提供对 HTTP 触发的 Azure 函数的绑定的规则。

名称	类型	说明
credential	FunctionRouterRuleCredential	用于访问 Azure 函数规则的凭据。
functionUri	string (uri)	Azure 函数的 URL。
kind	string: function	描述 RouterRule 子类型的类型鉴别器

FunctionRouterRuleCreateOrUpdate

Object

提供对 HTTP 触发的 Azure 函数的绑定的规则。

名称	类型	说明
credential	FunctionRouterRuleCredential	用于访问 Azure 函数规则的凭据。
functionUri	string (uri)	Azure 函数的 URL。
kind	string: function	描述 RouterRule 子类型的类型鉴别器

FunctionRouterRuleCredential

Object

用于访问 Azure 函数规则的凭据。

名称	类型	说明
appKey	string	访问作用域为 Azure 函数应用的密钥。此密钥授予对应用下的所有函数的访问权限。
clientId	string	客户端 ID，在 Azure 函数的上下文中提供 AppKey 时，这通常是密钥的名称。
functionKey	string	访问范围限定为特定函数的密钥。

LongestIdleMode

Object

作业将定向到空闲时间最长的辅助角色。

名称	类型	默认值	说明
bypassSelectors	boolean	False	如果设置为 true，则路由器会将工作器与作业匹配，即使它们与标签选择器不匹配。警告：如果将此变量设置为 true，可能会获取不符合其匹配作业条件的辅助角色。此标志更适用于临时使用。默认情况下，设置为 false。
kind	string: longestIdle		描述 DistributionMode 子类型的类型鉴别器。
maxConcurrentOffers	integer (int32)	1	控制作业可以拥有的活动并发产品/服务的最大数量。
minConcurrentOffers	integer (int32)	1	控制作业可以拥有的最小所需活动并发产品/服务数。

LongestIdleModeCreateOrUpdate

Object

作业将定向到空闲时间最长的辅助角色。

名称	类型	默认值	说明
bypassSelectors	boolean	False	如果设置为 true，则路由器会将工作器与作业匹配，即使它们与标签选择器不匹配。警告：如果将此变量设置为 true，可能会获取不符合其匹配作业条件的辅助角色。此标志更适用于临时使用。默认情况下，设置为 false。
kind	string: longestIdle		描述 DistributionMode 子类型的类型鉴别器。
maxConcurrentOffers	integer (int32)	1	控制作业可以拥有的活动并发产品/服务的最大数量。
minConcurrentOffers	integer (int32)	1	控制作业可以拥有的最小所需活动并发产品/服务数。

OAuth2WebhookClientCredential

Object

用于 Contoso 授权服务器的 OAuth2.0 凭据。参考：https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/

名称	类型	说明
clientId	string	Contoso 授权服务器的 ClientId。
clientSecret	string	Contoso 授权服务器的客户端密码。

RoundRobinMode

Object

作业分发给辅助角色，从最后一个工作线程之后开始接收作业的工作器开始。

名称	类型	默认值	说明
bypassSelectors	boolean	False	如果设置为 true，则路由器会将工作器与作业匹配，即使它们与标签选择器不匹配。警告：如果将此变量设置为 true，可能会获取不符合其匹配作业条件的辅助角色。此标志更适用于临时使用。默认情况下，设置为 false。
kind	string: roundRobin		描述 DistributionMode 子类型的类型鉴别器。
maxConcurrentOffers	integer (int32)	1	控制作业可以拥有的活动并发产品/服务的最大数量。
minConcurrentOffers	integer (int32)	1	控制作业可以拥有的最小所需活动并发产品/服务数。

RoundRobinModeCreateOrUpdate

Object

作业分发给辅助角色，从最后一个工作线程之后开始接收作业的工作器开始。

名称	类型	默认值	说明
bypassSelectors	boolean	False	如果设置为 true，则路由器会将工作器与作业匹配，即使它们与标签选择器不匹配。警告：如果将此变量设置为 true，可能会获取不符合其匹配作业条件的辅助角色。此标志更适用于临时使用。默认情况下，设置为 false。
kind	string: roundRobin		描述 DistributionMode 子类型的类型鉴别器。
maxConcurrentOffers	integer (int32)	1	控制作业可以拥有的活动并发产品/服务的最大数量。
minConcurrentOffers	integer (int32)	1	控制作业可以拥有的最小所需活动并发产品/服务数。

RouterRuleKind

枚举

支持的路由器规则类型的鉴别器。

值	说明
directMap	DirectMapRouterRule 的鉴别器值。
expression	ExpressionRouterRule 的鉴别器值。
function	FunctionRouterRule 的鉴别器值。
static	StaticRouterRule 的鉴别器值。
webhook	WebhookRouterRule 的鉴别器值。

ScoringRuleOptions

Object

封装所有可以使用 BestWorkerMode 作为评分规则的参数传递的选项。

名称	类型	默认值	说明
batchSize	integer (int32)	20	将“isBatchScoringEnabled”设置为 true 时设置批大小。如果未配置，则默认为 20。
descendingOrder	boolean	True	如果为 false，将按升序对分数进行排序。默认情况下，设置为 true。
isBatchScoringEnabled	boolean	False	如果设置为 true，将分批对辅助角色进行评分，并将辅助角色标签的参数名称作为 `workers`发送。默认情况下，设置为 false，辅助角色标签的参数名称将作为 `worker`发送。注意：如果启用，请使用“batchSize”设置批大小。
scoringParameters	ScoringRuleParameterSelector[]	[ "jobLabels", "workerSelectors" ]	将作为有效负载的一部分发送到评分规则的作业的额外参数列表。如果未设置，作业的标签（作为 `job`在有效负载中发送）和作业的工作器选择器（以 `selectors`形式发送）默认添加到评分规则的有效负载中。注意：始终使用评分有效负载发送辅助角色标签。

ScoringRuleParameterSelector

枚举

用于对 BestWorkerMode 使用的评分辅助角色的支持参数。

值	说明
jobLabels	用于将作业标签添加到评分有效负载的参数。属性作为 `job`发送。
workerSelectors	用于将作业中的辅助角色选择器添加到评分有效负载的参数。属性作为 `selectors`发送。

StaticRouterRule

Object

提供始终返回相同结果的静态规则的规则，而不考虑输入。

名称	类型	说明
kind	string: static	描述 RouterRule 子类型的类型鉴别器
value		此规则始终返回的静态值。值必须是基元值 - number、string、boolean 类型的值。

StaticRouterRuleCreateOrUpdate

Object

提供始终返回相同结果的静态规则的规则，而不考虑输入。

名称	类型	说明
kind	string: static	描述 RouterRule 子类型的类型鉴别器
value		此规则始终返回的静态值。值必须是基元值 - number、string、boolean 类型的值。

WebhookRouterRule

Object

提供对外部 Web 服务器的绑定的规则。

名称	类型	说明
authorizationServerUri	string (uri)	授权服务器的 URI。
clientCredential	OAuth2WebhookClientCredential	用于 Contoso 授权服务器的 OAuth2.0 凭据。参考：https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
kind	string: webhook	描述 RouterRule 子类型的类型鉴别器
webhookUri	string (uri)	Contoso 的 Web 服务器的 URI。

WebhookRouterRuleCreateOrUpdate

Object

提供对外部 Web 服务器的绑定的规则。

名称	类型	说明
authorizationServerUri	string (uri)	授权服务器的 URI。
clientCredential	OAuth2WebhookClientCredential	用于 Contoso 授权服务器的 OAuth2.0 凭据。参考：https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
kind	string: webhook	描述 RouterRule 子类型的类型鉴别器
webhookUri	string (uri)	Contoso 的 Web 服务器的 URI。

通过

Job Router Administration Operations - Upsert Distribution Policy

URI 参数

请求头

请求正文

响应

安全性

AadOauth2Auth

作用域

示例

Creates a Distribution policy

示例请求

示例响应

Updates a distribution policy

示例请求

示例响应

定义

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

BestWorkerMode

BestWorkerModeCreateOrUpdate

DirectMapRouterRule

DirectMapRouterRuleCreateOrUpdate

DistributionModeKind

DistributionPolicy

DistributionPolicyCreateOrUpdate

ExpressionRouterRule

ExpressionRouterRuleCreateOrUpdate

ExpressionRouterRuleLanguage

FunctionRouterRule

FunctionRouterRuleCreateOrUpdate

FunctionRouterRuleCredential

LongestIdleMode

LongestIdleModeCreateOrUpdate

OAuth2WebhookClientCredential

RoundRobinMode

RoundRobinModeCreateOrUpdate

RouterRuleKind

ScoringRuleOptions

ScoringRuleParameterSelector

StaticRouterRule

StaticRouterRuleCreateOrUpdate

WebhookRouterRule

WebhookRouterRuleCreateOrUpdate