Job Router Administration Operations - Upsert Queue

Service:

Communication

API-versie:

2023-11-01

Hiermee maakt of werkt u een wachtrij bij.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	URI van uw communicatieresource
queueId	path	True	string	Id van een wachtrij.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
If-Match		string	De aanvraag mag alleen worden voortgezet als een entiteit overeenkomt met deze tekenreeks.
If-Unmodified-Since		string date-time-rfc7231	De aanvraag moet alleen worden voortgezet als de entiteit na deze tijd niet is gewijzigd.

Aanvraagbody

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

Name	Type	Description
distributionPolicyId	string	Id van een distributiebeleid waarmee wordt bepaald hoe een taak wordt gedistribueerd naar werkrollen.
exceptionPolicyId	string	Id van een uitzonderingsbeleid dat verschillende escalatieregels voor taken bepaalt.
labels		Een set sleutel-waardeparen die kenmerken identificeren die door de regelengines worden gebruikt om beslissingen te nemen. Waarden moeten primitieve waarden zijn: getal, tekenreeks, booleaanse waarde.
name	string	Beschrijvende naam van deze wachtrij.

Antwoorden

Name	Type	Description
200 OK	RouterQueue	De aanvraag is voltooid. Kopteksten ETag: string Last-Modified: string
201 Created	RouterQueue	De aanvraag is geslaagd en er is een nieuwe resource gemaakt. Kopteksten ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

AadOauth2Auth

De Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

Creates a queue

Updates a queue

Creates a queue

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:

200

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

Statuscode:

201

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

Updates a queue

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:

200

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

Statuscode:

201

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

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterQueue	Een wachtrij die taken kan bevatten die moeten worden gerouteerd.
RouterQueueCreateOrUpdate	Een wachtrij die taken kan bevatten die moeten worden gerouteerd.

Azure.Core.Foundations.Error

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

RouterQueue

Een wachtrij die taken kan bevatten die moeten worden gerouteerd.

Name	Type	Description
distributionPolicyId	string	Id van een distributiebeleid waarmee wordt bepaald hoe een taak wordt gedistribueerd naar werkrollen.
etag	string	De entiteitstag voor deze resource.
exceptionPolicyId	string	Id van een uitzonderingsbeleid dat verschillende escalatieregels voor taken bepaalt.
id	string	Id van een wachtrij.
labels		Een set sleutel-waardeparen die kenmerken identificeren die door de regelengines worden gebruikt om beslissingen te nemen. Waarden moeten primitieve waarden zijn: getal, tekenreeks, booleaanse waarde.
name	string	Beschrijvende naam van deze wachtrij.

RouterQueueCreateOrUpdate

Een wachtrij die taken kan bevatten die moeten worden gerouteerd.

Name	Type	Description
distributionPolicyId	string	Id van een distributiebeleid waarmee wordt bepaald hoe een taak wordt gedistribueerd naar werkrollen.
exceptionPolicyId	string	Id van een uitzonderingsbeleid dat verschillende escalatieregels voor taken bepaalt.
labels		Een set sleutel-waardeparen die kenmerken identificeren die door de regelengines worden gebruikt om beslissingen te nemen. Waarden moeten primitieve waarden zijn: getal, tekenreeks, booleaanse waarde.
name	string	Beschrijvende naam van deze wachtrij.