Compartir a través de

Job Router Administration Operations - Upsert Queue

  • Referencia
Servicio:
Communication
Versión de la API:
2023-11-01

Crea o actualiza una cola.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string

Uri del recurso de comunicación
queueId
 path True

string

Identificador de una cola.
api-version
 query True

string

Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

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

Nombre Requerido Tipo Description
If-Match

string

La solicitud solo debe continuar si una entidad coincide con esta cadena.
If-Unmodified-Since

string

date-time-rfc7231

La solicitud solo debe continuar si la entidad no se modificó después de este tiempo.

Cuerpo de la solicitud

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

Nombre Tipo Description
distributionPolicyId

string

Identificador de una directiva de distribución que determinará cómo se distribuye un trabajo a los trabajos.
exceptionPolicyId

string

Identificador de una directiva de excepción que determina varias reglas de escalado de trabajos.
labels

Conjunto de pares clave-valor que identifican los atributos usados por los motores de reglas para tomar decisiones. Los valores deben ser valores primitivos: número, cadena, booleano.
name

string

Nombre descriptivo de esta cola.

Respuestas

Nombre Tipo Description
200 OK

RouterQueue

La solicitud se ha realizado correctamente.

Encabezados

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

RouterQueue

La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Encabezados

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

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

AadOauth2Auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

Nombre Description
https://communication.azure.com/.default

Ejemplos

Creates a queue
Updates a queue

Creates a queue

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
200 
{
  "id": "246d5a06-c04a-4b6b-8a34-02bbd9fdad68",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}
status code:
201 
{
  "id": "246d5a06-c04a-4b6b-8a34-02bbd9fdad68",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}

Updates a queue

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
200 
{
  "id": "MainQueue",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}
status code:
201 
{
  "id": "MainQueue",
  "name": "Main",
  "distributionPolicyId": "MainDistributionPolicy",
  "labels": {},
  "exceptionPolicyId": "MainExceptionPolicy",
  "etag": "etag"
}

Definiciones

Nombre Description
Azure.Core.Foundations.Error

Objeto de error.
Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueue

Una cola que puede contener trabajos que se van a enrutar.
RouterQueueCreateOrUpdate

Una cola que puede contener trabajos que se van a enrutar.

Azure.Core.Foundations.Error

Objeto de error.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.
details

Azure.Core.Foundations.Error[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica que el objeto actual sobre el error.
message

string

Representación legible del error.
target

string

Destino del error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Nombre Tipo Description
error

Azure.Core.Foundations.Error

Objeto de error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.
innererror

Azure.Core.Foundations.InnerError

Error interno.

RouterQueue

Una cola que puede contener trabajos que se van a enrutar.

Nombre Tipo Description
distributionPolicyId

string

Identificador de una directiva de distribución que determinará cómo se distribuye un trabajo a los trabajos.
etag

string

Etiqueta de entidad para este recurso.
exceptionPolicyId

string

Identificador de una directiva de excepción que determina varias reglas de escalado de trabajos.
id

string

Identificador de una cola.
labels

Conjunto de pares clave-valor que identifican los atributos usados por los motores de reglas para tomar decisiones. Los valores deben ser valores primitivos: número, cadena, booleano.
name

string

Nombre descriptivo de esta cola.

RouterQueueCreateOrUpdate

Una cola que puede contener trabajos que se van a enrutar.

Nombre Tipo Description
distributionPolicyId

string

Identificador de una directiva de distribución que determinará cómo se distribuye un trabajo a los trabajos.
exceptionPolicyId

string

Identificador de una directiva de excepción que determina varias reglas de escalado de trabajos.
labels

Conjunto de pares clave-valor que identifican los atributos usados por los motores de reglas para tomar decisiones. Los valores deben ser valores primitivos: número, cadena, booleano.
name

string

Nombre descriptivo de esta cola.