Delen via

Job Router Administration Operations - Get Distribution Policy

  • Referentie
Service:
Communication
API-versie:
2023-11-01

Hiermee haalt u een bestaand distributiebeleid op id.

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

URI-parameters

Name In Vereist Type Description
distributionPolicyId
 path True

string

Id van een distributiebeleid.
endpoint
 path True

string

URI van uw communicatieresource
api-version
 query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name Type Description
200 OK

DistributionPolicy

De aanvraag is voltooid.

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

Retrieves an existing distribution policy by Id

Voorbeeldaanvraag

GET https://contoso.westus.communications.azure.com/routing/distributionPolicies/MainDistributionPolicy?api-version=2023-11-01

Voorbeeldrespons

Statuscode:
200 
{
  "id": "MainDistributionPolicy",
  "name": "Main",
  "offerExpiresAfterSeconds": 300,
  "mode": {
    "kind": "longestIdle",
    "minConcurrentOffers": 1,
    "maxConcurrentOffers": 5,
    "bypassSelectors": false
  },
  "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.
BestWorkerMode

Taken worden gedistribueerd naar de werkrol met de sterkste mogelijkheden die beschikbaar zijn.
DirectMapRouterRule

Een regel die dezelfde labels retourneert als de invoerlabels.
DistributionModeKind

Discriminators voor ondersteunde distributiemodustypen.
DistributionPolicy

Beleid voor de verdeling van taken naar werknemers
ExpressionRouterRule

Een regel die regels voor inline-expressies opgeeft.
ExpressionRouterRuleLanguage

Beschikbare expressietalen die kunnen worden geconfigureerd.
FunctionRouterRule

Een regel die een binding aan een door HTTP geactiveerde Azure-functie levert.
FunctionRouterRuleCredential

Referenties die worden gebruikt voor toegang tot de Azure-functieregel.
LongestIdleMode

Taken worden doorgestuurd naar de werknemer die het langst inactief is geweest.
OAuth2WebhookClientCredential

OAuth2.0-referenties die worden gebruikt voor de autorisatieserver van Contoso. Naslaginformatie: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
RoundRobinMode

Taken worden gedistribueerd voor werknemers, te beginnen met de werkrol die na de laatste werkrol is om een taak te ontvangen.
RouterRuleKind

Discriminators voor ondersteunde routerregeltypen.
ScoringRuleOptions

Bevat alle opties die kunnen worden doorgegeven als parameters voor scoreregel met BestWorkerMode.
ScoringRuleParameterSelector

Ondersteunde parameters voor scoremedewerkers die worden gebruikt met BestWorkerMode.
StaticRouterRule

Een regel die statische regels levert die altijd hetzelfde resultaat retourneren, ongeacht invoer.
WebhookRouterRule

Een regel die een binding aan een externe webserver levert.

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.

BestWorkerMode

Taken worden gedistribueerd naar de werkrol met de sterkste mogelijkheden die beschikbaar zijn.

Name Type Default value Description
bypassSelectors

boolean

False

Als deze optie is ingesteld op waar, wordt de router vergeleken met taken, zelfs als deze niet overeenkomen met labelkiezers. Waarschuwing: mogelijk krijgt u werknemers die niet zijn gekwalificeerd voor een taak waarmee ze overeenkomen als u deze variabele instelt op waar. Deze vlag is meer bedoeld voor tijdelijk gebruik. Standaard ingesteld op false.
kind string:

bestWorker

Het typediscriminator dat een subtype DistributionMode beschrijft.
maxConcurrentOffers

integer

1

Bepaalt het maximum aantal actieve gelijktijdige aanbiedingen dat een taak kan hebben.
minConcurrentOffers

integer

1

Bepaalt het minimum aantal actieve gelijktijdige aanbiedingen dat een taak kan hebben.
scoringRule RouterRule:

Definieer een scoreregel die moet worden gebruikt bij het berekenen van een score om de beste werkrol te bepalen. Als deze niet is ingesteld, gebruikt u een standaardscoreformule die gebruikmaakt van het aantal joblabels dat de werkrollabels overeenkomen, evenals het aantal labelkiezers dat de werkrollabels overeenkomen en/of overschrijdt met behulp van een logistieke functie (https://en.wikipedia.org/wiki/Logistic_function).
scoringRuleOptions

ScoringRuleOptions

Opties voor het configureren van scoringRule. Als deze niet is ingesteld, worden standaardwaarden gebruikt.

DirectMapRouterRule

Een regel die dezelfde labels retourneert als de invoerlabels.

Name Type Description
kind string:

directMap

Het typediscriminatie dat een subtype RouterRule beschrijft

DistributionModeKind

Discriminators voor ondersteunde distributiemodustypen.

Name Type Description
bestWorker

string

Discriminatorwaarde voor BestWorkerMode.
longestIdle

string

Discriminatorwaarde voor LongestIdleMode.
roundRobin

string

Discriminatorwaarde voor RoundRobinMode.

DistributionPolicy

Beleid voor de verdeling van taken naar werknemers

Name Type Description
etag

string

De entiteitstag voor deze resource.
id

string

Id van een distributiebeleid.
mode DistributionMode:

Modus voor de specifieke distributiemethode.
name

string

Beschrijvende naam van dit beleid.
offerExpiresAfterSeconds

number

Het aantal seconden waarna alle aanbiedingen die zijn gemaakt onder dit beleid, verlopen zijn.

ExpressionRouterRule

Een regel die regels voor inline-expressies opgeeft.

Name Type Description
expression

string

Een expressie die moet worden geëvalueerd. Moet een retourinstructie met berekende waarden bevatten.
kind string:

expression

Het typediscriminatie dat een subtype RouterRule beschrijft
language

ExpressionRouterRuleLanguage

De expressietaal die moet worden gecompileerd en uitgevoerd.

ExpressionRouterRuleLanguage

Beschikbare expressietalen die kunnen worden geconfigureerd.

Name Type Description
powerFx

string

PowerFx

FunctionRouterRule

Een regel die een binding aan een door HTTP geactiveerde Azure-functie levert.

Name Type Description
credential

FunctionRouterRuleCredential

Referenties die worden gebruikt voor toegang tot de Azure-functieregel.
functionUri

string

URL voor Azure Function.
kind string:

function

Het typediscriminatie dat een subtype RouterRule beschrijft

FunctionRouterRuleCredential

Referenties die worden gebruikt voor toegang tot de Azure-functieregel.

Name Type Description
appKey

string

Toegang tot de sleutel die is gericht op een Azure Function-app. Met deze sleutel verleent u toegang tot alle functies in de app.
clientId

string

Client-id, wanneer AppKey is opgegeven in de context van de Azure-functie, is dit meestal de naam van de sleutel.
functionKey

string

Toegang tot de sleutel die is gericht op een bepaalde functie.

LongestIdleMode

Taken worden doorgestuurd naar de werknemer die het langst inactief is geweest.

Name Type Default value Description
bypassSelectors

boolean

False

Als deze optie is ingesteld op waar, wordt de router vergeleken met taken, zelfs als deze niet overeenkomen met labelkiezers. Waarschuwing: mogelijk krijgt u werknemers die niet zijn gekwalificeerd voor een taak waarmee ze overeenkomen als u deze variabele instelt op waar. Deze vlag is meer bedoeld voor tijdelijk gebruik. Standaard ingesteld op false.
kind string:

longestIdle

Het typediscriminator dat een subtype DistributionMode beschrijft.
maxConcurrentOffers

integer

1

Bepaalt het maximum aantal actieve gelijktijdige aanbiedingen dat een taak kan hebben.
minConcurrentOffers

integer

1

Bepaalt het minimum aantal actieve gelijktijdige aanbiedingen dat een taak kan hebben.

OAuth2WebhookClientCredential

OAuth2.0-referenties die worden gebruikt voor de autorisatieserver van Contoso. Naslaginformatie: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/

Name Type Description
clientId

string

ClientId voor contoso-autorisatieserver.
clientSecret

string

Clientgeheim voor Contoso Authorization-server.

RoundRobinMode

Taken worden gedistribueerd voor werknemers, te beginnen met de werkrol die na de laatste werkrol is om een taak te ontvangen.

Name Type Default value Description
bypassSelectors

boolean

False

Als deze optie is ingesteld op waar, wordt de router vergeleken met taken, zelfs als deze niet overeenkomen met labelkiezers. Waarschuwing: mogelijk krijgt u werknemers die niet zijn gekwalificeerd voor een taak waarmee ze overeenkomen als u deze variabele instelt op waar. Deze vlag is meer bedoeld voor tijdelijk gebruik. Standaard ingesteld op false.
kind string:

roundRobin

Het typediscriminator dat een subtype DistributionMode beschrijft.
maxConcurrentOffers

integer

1

Bepaalt het maximum aantal actieve gelijktijdige aanbiedingen dat een taak kan hebben.
minConcurrentOffers

integer

1

Bepaalt het minimum aantal actieve gelijktijdige aanbiedingen dat een taak kan hebben.

RouterRuleKind

Discriminators voor ondersteunde routerregeltypen.

Name Type Description
directMap

string

Discriminatorwaarde voor DirectMapRouterRule.
expression

string

Discriminatorwaarde voor ExpressionRouterRule.
function

string

Discriminatorwaarde voor FunctionRouterRule.
static

string

Discriminatorwaarde voor StaticRouterRule.
webhook

string

Discriminatorwaarde voor WebhookRouterRule.

ScoringRuleOptions

Bevat alle opties die kunnen worden doorgegeven als parameters voor scoreregel met BestWorkerMode.

Name Type Default value Description
batchSize

integer

20

Stel de batchgrootte in wanneer 'isBatchScoringEnabled' is ingesteld op true. De standaardwaarde is 20 als deze niet is geconfigureerd.
descendingOrder

boolean

True

Als dit onwaar is, sorteert u scores op oplopende volgorde. Standaard ingesteld op true.
isBatchScoringEnabled

boolean

False

Als deze optie is ingesteld op true, scoret u werkrollen in batches en wordt de parameternaam van de werkrollabels verzonden als workers. Standaard wordt ingesteld op false en wordt de parameternaam voor de werkrollabels verzonden als worker. Opmerking: als deze optie is ingeschakeld, gebruikt u batchSize om de batchgrootte in te stellen.
scoringParameters

ScoringRuleParameterSelector[]

[ "jobLabels", "workerSelectors" ]

Lijst met extra parameters van een taak die wordt verzonden als onderdeel van de nettolading naar scoreregel. Als deze niet is ingesteld, worden de labels van een taak (verzonden in de nettolading als job) en de werkrolkiezers van een taak (verzonden in de nettolading als selectors) standaard toegevoegd aan de nettolading van de scoreregel. Opmerking: Werklabels worden altijd verzonden met scorenpayload.

ScoringRuleParameterSelector

Ondersteunde parameters voor scoremedewerkers die worden gebruikt met BestWorkerMode.

Name Type Description
jobLabels

string

Parameter voor het toevoegen van taaklabels aan scoren nettolading. De eigenschap wordt verzonden als job.
workerSelectors

string

Parameter voor het toevoegen van werkrolkiezers uit een taak om nettolading te scoren. De eigenschap wordt verzonden als selectors.

StaticRouterRule

Een regel die statische regels levert die altijd hetzelfde resultaat retourneren, ongeacht invoer.

Name Type Description
kind string:

static

Het typediscriminatie dat een subtype RouterRule beschrijft
value

De statische waarde die deze regel altijd retourneert. Waarden moeten primitieve waarden zijn: getal, tekenreeks, booleaanse waarde.

WebhookRouterRule

Een regel die een binding aan een externe webserver levert.

Name Type Description
authorizationServerUri

string

URI voor autorisatieserver.
clientCredential

OAuth2WebhookClientCredential

OAuth2.0-referenties die worden gebruikt voor de autorisatieserver van Contoso. Naslaginformatie: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
kind string:

webhook

Het typediscriminatie dat een subtype RouterRule beschrijft
webhookUri

string

Uri voor de webserver van Contoso.