通过

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

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

一组键/值对，用于标识规则引擎用于做出决策的属性。 值必须是基元值 - number、string、boolean 类型的值。
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
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 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一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
RouterQueue

可以包含要路由的作业的队列。
RouterQueueCreateOrUpdate

可以包含要路由的作业的队列。

Azure.Core.Foundations.Error

错误对象。

名称 类型 说明
code

string

服务器定义的错误代码集之一。
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一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称 类型 说明
code

string

服务器定义的错误代码集之一。
innererror

Azure.Core.Foundations.InnerError

内部错误。

RouterQueue

可以包含要路由的作业的队列。

名称 类型 说明
distributionPolicyId

string

分配策略的 ID，用于确定作业如何分发给辅助角色。
etag

string

此资源的实体标记。
exceptionPolicyId

string

确定各种作业升级规则的异常策略的 ID。
id

string

队列的 ID。
labels

一组键/值对，用于标识规则引擎用于做出决策的属性。 值必须是基元值 - number、string、boolean 类型的值。
name

string

此队列的友好名称。

RouterQueueCreateOrUpdate

可以包含要路由的作业的队列。

名称 类型 说明
distributionPolicyId

string

分配策略的 ID，用于确定作业如何分发给辅助角色。
exceptionPolicyId

string

确定各种作业升级规则的异常策略的 ID。
labels

一组键/值对，用于标识规则引擎用于做出决策的属性。 值必须是基元值 - number、string、boolean 类型的值。
name

string

此队列的友好名称。