Freigeben über

Job Router Administration Operations - Get Distribution Policy

  • Referenz
Dienst:
Communication
API-Version:
2023-11-01

Ruft eine vorhandene Verteilungsrichtlinie nach ID ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
distributionPolicyId
 path True

string

ID einer Verteilungsrichtlinie.
endpoint
 path True

string

URI Ihrer Kommunikationsressource
api-version
 query True

string

Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

DistributionPolicy

Die Anforderung ist erfolgreich.

Header

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

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

AadOauth2Auth

Der Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

Retrieves an existing distribution policy by Id

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "MainDistributionPolicy",
  "name": "Main",
  "offerExpiresAfterSeconds": 300,
  "mode": {
    "kind": "longestIdle",
    "minConcurrentOffers": 1,
    "maxConcurrentOffers": 5,
    "bypassSelectors": false
  },
  "etag": "etag"
}

Definitionen

Name Beschreibung
Azure.Core.Foundations.Error

Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
BestWorkerMode

Arbeitsplätze werden an den Arbeiter mit den stärksten verfügbaren Fähigkeiten verteilt.
DirectMapRouterRule

Eine Regel, die dieselben Bezeichnungen wie die Eingabebezeichnungen zurückgibt.
DistributionModeKind

Diskriminatoren für unterstützte Verteilungsmodustypen.
DistributionPolicy

Richtlinie für die Verteilung von Aufträgen an Arbeitnehmer
ExpressionRouterRule

Eine Regel, die Inlineausdrucksregeln bereitstellt.
ExpressionRouterRuleLanguage

Verfügbare Ausdruckssprachen, die konfiguriert werden können.
FunctionRouterRule

Eine Regel, die eine Bindung an eine vom HTTP ausgelöste Azure-Funktion bereitstellt.
FunctionRouterRuleCredential

Anmeldeinformationen, die für den Zugriff auf die Azure-Funktionsregel verwendet werden.
LongestIdleMode

Arbeitsplätze werden an den Arbeitnehmer geleitet, der längst im Leerlauf war.
OAuth2WebhookClientCredential

OAuth2.0-Anmeldeinformationen, die für den Autorisierungsserver von Contoso verwendet werden. Referenz: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
RoundRobinMode

Arbeitsplätze werden an Die Arbeitnehmer verteilt, beginnend mit dem Arbeitnehmer, der nach dem letzten Arbeitnehmer einen Arbeitsplatz erhält.
RouterRuleKind

Diskriminatoren für unterstützte Routerregeltypen.
ScoringRuleOptions

Kapselt alle Optionen, die als Parameter für die Bewertungsregel mit BestWorkerMode übergeben werden können.
ScoringRuleParameterSelector

Unterstützte Parameter für die Bewertung von Workern, die mit BestWorkerMode verwendet werden.
StaticRouterRule

Eine Regel, die statische Regeln bereitstellt, die unabhängig von der Eingabe immer dasselbe Ergebnis zurückgeben.
WebhookRouterRule

Eine Regel, die eine Bindung an einen externen Webserver bereitstellt.

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.
details

Azure.Core.Foundations.Error[]

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message

string

Eine lesbare Darstellung des Fehlers.
target

string

Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name Typ Beschreibung
error

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.
innererror

Azure.Core.Foundations.InnerError

Innerer Fehler.

BestWorkerMode

Arbeitsplätze werden an den Arbeiter mit den stärksten verfügbaren Fähigkeiten verteilt.

Name Typ Standardwert Beschreibung
bypassSelectors

boolean

False

Wenn dieser Wert auf "true" festgelegt ist, stimmen Router Mitarbeiter an Aufträge ab, auch wenn sie nicht mit Bezeichnungsmarkierern übereinstimmen. Warnung: Möglicherweise erhalten Sie Mitarbeiter, die nicht für einen Auftrag qualifiziert sind, dem sie entsprechen, wenn Sie diese Variable auf "true" festlegen. Dieses Flag ist für die temporäre Verwendung vorgesehen. Standardmäßig auf "false" festgelegt.
kind string:

bestWorker

Der Typdiskriminator, der einen Untertyp von DistributionMode beschreibt.
maxConcurrentOffers

integer

1

Steuert die maximale Anzahl aktiver gleichzeitiger Angebote, die ein Auftrag haben kann.
minConcurrentOffers

integer

1

Steuert die mindest gewünschte Anzahl aktiver gleichzeitiger Angebote, über die ein Auftrag verfügen kann.
scoringRule RouterRule:

Definieren Sie eine zu verwendende Bewertungsregel, wenn Sie eine Bewertung berechnen, um den besten Worker zu ermitteln. Wenn sie nicht festgelegt ist, wird eine Standardbewertungsformel verwendet, die die Anzahl der Arbeitsbezeichnungen verwendet, die von den Arbeitsbezeichnungen übereinstimmen, sowie die Anzahl der Bezeichnungsmarkierer, die die Arbeitsbezeichnungen übereinstimmen und/oder die Verwendung einer Logistikfunktion überschreiten (https://en.wikipedia.org/wiki/Logistic_function).
scoringRuleOptions

ScoringRuleOptions

Optionen zum Konfigurieren von "scoringRule". Wenn nicht festgelegt, werden Standardwerte verwendet.

DirectMapRouterRule

Eine Regel, die dieselben Bezeichnungen wie die Eingabebezeichnungen zurückgibt.

Name Typ Beschreibung
kind string:

directMap

Der Typdiskriminator, der einen Untertyp von RouterRule beschreibt

DistributionModeKind

Diskriminatoren für unterstützte Verteilungsmodustypen.

Name Typ Beschreibung
bestWorker

string

Diskriminatorwert für BestWorkerMode.
longestIdle

string

Diskriminatorwert für LongestIdleMode.
roundRobin

string

Diskriminatorwert für RoundRobinMode.

DistributionPolicy

Richtlinie für die Verteilung von Aufträgen an Arbeitnehmer

Name Typ Beschreibung
etag

string

Das Entitätstag für diese Ressource.
id

string

ID einer Verteilungsrichtlinie.
mode DistributionMode:

Modus für die spezifische Verteilungsmethode.
name

string

Anzeigename dieser Richtlinie.
offerExpiresAfterSeconds

number

Die Anzahl der Sekunden, nach denen alle unter dieser Richtlinie erstellten Angebote abgelaufen sind.

ExpressionRouterRule

Eine Regel, die Inlineausdrucksregeln bereitstellt.

Name Typ Beschreibung
expression

string

Ein ausdruck, der ausgewertet werden soll. Sollte eine Rückgabe-Anweisung mit berechneten Werten enthalten.
kind string:

expression

Der Typdiskriminator, der einen Untertyp von RouterRule beschreibt
language

ExpressionRouterRuleLanguage

Die Ausdruckssprache zum Kompilieren und Ausführen.

ExpressionRouterRuleLanguage

Verfügbare Ausdruckssprachen, die konfiguriert werden können.

Name Typ Beschreibung
powerFx

string

PowerFx

FunctionRouterRule

Eine Regel, die eine Bindung an eine vom HTTP ausgelöste Azure-Funktion bereitstellt.

Name Typ Beschreibung
credential

FunctionRouterRuleCredential

Anmeldeinformationen, die für den Zugriff auf die Azure-Funktionsregel verwendet werden.
functionUri

string

URL für Azure-Funktion.
kind string:

function

Der Typdiskriminator, der einen Untertyp von RouterRule beschreibt

FunctionRouterRuleCredential

Anmeldeinformationen, die für den Zugriff auf die Azure-Funktionsregel verwendet werden.

Name Typ Beschreibung
appKey

string

Zugriffstastenbereich für eine Azure-Funktions-App. Dieser Schlüssel gewährt Zugriff auf alle Funktionen unter der App.
clientId

string

Client-ID, wenn AppKey im Kontext der Azure-Funktion bereitgestellt wird, ist dies in der Regel der Name des Schlüssels.
functionKey

string

Zugriffstastenbereich für eine bestimmte Funktion.

LongestIdleMode

Arbeitsplätze werden an den Arbeitnehmer geleitet, der längst im Leerlauf war.

Name Typ Standardwert Beschreibung
bypassSelectors

boolean

False

Wenn dieser Wert auf "true" festgelegt ist, stimmen Router Mitarbeiter an Aufträge ab, auch wenn sie nicht mit Bezeichnungsmarkierern übereinstimmen. Warnung: Möglicherweise erhalten Sie Mitarbeiter, die nicht für einen Auftrag qualifiziert sind, dem sie entsprechen, wenn Sie diese Variable auf "true" festlegen. Dieses Flag ist für die temporäre Verwendung vorgesehen. Standardmäßig auf "false" festgelegt.
kind string:

longestIdle

Der Typdiskriminator, der einen Untertyp von DistributionMode beschreibt.
maxConcurrentOffers

integer

1

Steuert die maximale Anzahl aktiver gleichzeitiger Angebote, die ein Auftrag haben kann.
minConcurrentOffers

integer

1

Steuert die mindest gewünschte Anzahl aktiver gleichzeitiger Angebote, über die ein Auftrag verfügen kann.

OAuth2WebhookClientCredential

OAuth2.0-Anmeldeinformationen, die für den Autorisierungsserver von Contoso verwendet werden. Referenz: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/

Name Typ Beschreibung
clientId

string

ClientId für Contoso-Autorisierungsserver.
clientSecret

string

Geheimer Clientschlüssel für den Contoso-Autorisierungsserver.

RoundRobinMode

Arbeitsplätze werden an Die Arbeitnehmer verteilt, beginnend mit dem Arbeitnehmer, der nach dem letzten Arbeitnehmer einen Arbeitsplatz erhält.

Name Typ Standardwert Beschreibung
bypassSelectors

boolean

False

Wenn dieser Wert auf "true" festgelegt ist, stimmen Router Mitarbeiter an Aufträge ab, auch wenn sie nicht mit Bezeichnungsmarkierern übereinstimmen. Warnung: Möglicherweise erhalten Sie Mitarbeiter, die nicht für einen Auftrag qualifiziert sind, dem sie entsprechen, wenn Sie diese Variable auf "true" festlegen. Dieses Flag ist für die temporäre Verwendung vorgesehen. Standardmäßig auf "false" festgelegt.
kind string:

roundRobin

Der Typdiskriminator, der einen Untertyp von DistributionMode beschreibt.
maxConcurrentOffers

integer

1

Steuert die maximale Anzahl aktiver gleichzeitiger Angebote, die ein Auftrag haben kann.
minConcurrentOffers

integer

1

Steuert die mindest gewünschte Anzahl aktiver gleichzeitiger Angebote, über die ein Auftrag verfügen kann.

RouterRuleKind

Diskriminatoren für unterstützte Routerregeltypen.

Name Typ Beschreibung
directMap

string

Diskriminatorwert für DirectMapRouterRule.
expression

string

Diskriminatorwert für ExpressionRouterRule.
function

string

Diskriminatorwert für FunctionRouterRule.
static

string

Diskriminatorwert für StaticRouterRule.
webhook

string

Diskriminatorwert für WebhookRouterRule.

ScoringRuleOptions

Kapselt alle Optionen, die als Parameter für die Bewertungsregel mit BestWorkerMode übergeben werden können.

Name Typ Standardwert Beschreibung
batchSize

integer

20

Legen Sie die Batchgröße fest, wenn "isBatchScoringEnabled" auf "true" festgelegt ist. Wird standardmäßig auf 20 festgelegt, wenn dies nicht konfiguriert ist.
descendingOrder

boolean

True

Wenn "false" ist, werden die Bewertungen nach aufsteigender Reihenfolge sortiert. Legen Sie standardmäßig auf "true" fest.
isBatchScoringEnabled

boolean

False

Wenn dieser Wert auf "true" festgelegt ist, werden Mitarbeiter in Batches bewertet, und der Parametername der Arbeitsbezeichnungen wird als workersgesendet. Legen Sie standardmäßig auf "false" fest, und der Parametername für die Arbeitsbezeichnungen wird als workergesendet. Hinweis: Wenn diese Option aktiviert ist, verwenden Sie "batchSize", um die Batchgröße festzulegen.
scoringParameters

ScoringRuleParameterSelector[]

[ "jobLabels", "workerSelectors" ]

Liste der zusätzlichen Parameter aus einem Auftrag, der als Teil der Nutzlast an die Bewertungsregel gesendet wird. Wenn nicht festgelegt, werden die Beschriftungen eines Auftrags (in der Nutzlast als job) und die Arbeitsauswahlen eines Auftrags (die als selectorsgesendet werden) der Nutzlast der Bewertungsregel standardmäßig hinzugefügt. Hinweis: Arbeitsbezeichnungen werden immer mit der Bewertungsnutzlast gesendet.

ScoringRuleParameterSelector

Unterstützte Parameter für die Bewertung von Workern, die mit BestWorkerMode verwendet werden.

Name Typ Beschreibung
jobLabels

string

Parameter zum Hinzufügen von Auftragsbezeichnungen zur Bewertungsnutzlast. Die Eigenschaft wird als jobgesendet.
workerSelectors

string

Parameter zum Hinzufügen von Workerselektoren aus einem Auftrag zur Bewertung der Nutzlast. Die Eigenschaft wird als selectorsgesendet.

StaticRouterRule

Eine Regel, die statische Regeln bereitstellt, die unabhängig von der Eingabe immer dasselbe Ergebnis zurückgeben.

Name Typ Beschreibung
kind string:

static

Der Typdiskriminator, der einen Untertyp von RouterRule beschreibt
value

Der statische Wert, den diese Regel immer zurückgibt. Werte müssen primitive Werte sein – Zahl, Zeichenfolge, boolescher Wert.

WebhookRouterRule

Eine Regel, die eine Bindung an einen externen Webserver bereitstellt.

Name Typ Beschreibung
authorizationServerUri

string

URI für Autorisierungsserver.
clientCredential

OAuth2WebhookClientCredential

OAuth2.0-Anmeldeinformationen, die für den Autorisierungsserver von Contoso verwendet werden. Referenz: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
kind string:

webhook

Der Typdiskriminator, der einen Untertyp von RouterRule beschreibt
webhookUri

string

URI für den Webserver von Contoso.