Job Router Administration Operations - Get Distribution Policy

Odwołanie

Usługa:: Communication

Wersja interfejsu API:: 2023-11-01

Pobiera istniejące zasady dystrybucji według identyfikatora.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
distributionPolicyId	path	True	string	Identyfikator zasad dystrybucji.
endpoint	path	True	string	Identyfikator URI zasobu komunikacji
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DistributionPolicy	Żądanie zakończyło się pomyślnie. Nagłówki ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

DistributionPolicy

Żądanie zakończyło się pomyślnie.

Nagłówki

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

AadOauth2Auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://communication.azure.com/.default

Przykłady

Retrieves an existing distribution policy by Id

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
BestWorkerMode	Zadania są dystrybuowane do procesu roboczego z najsilniejszymi dostępnymi możliwościami.
DirectMapRouterRule	Reguła zwracająca te same etykiety co etykiety wejściowe.
DistributionModeKind	Dyskryminujące typy obsługiwanych trybów dystrybucji.
DistributionPolicy	Zasady dotyczące sposobu dystrybuowania miejsc pracy do pracowników
ExpressionRouterRule	Reguła dostarczająca reguły wyrażeń wbudowanych.
ExpressionRouterRuleLanguage	Dostępne języki wyrażeń, które można skonfigurować.
FunctionRouterRule	Reguła zapewniająca powiązanie z funkcją platformy Azure wyzwalaną przez protokół HTTP.
FunctionRouterRuleCredential	Poświadczenia używane do uzyskiwania dostępu do reguły funkcji platformy Azure.
LongestIdleMode	Zadania są kierowane do pracownika, który był najdłużej bezczynny.
OAuth2WebhookClientCredential	Poświadczenia OAuth2.0 używane do serwera autoryzacji firmy Contoso. Dokumentacja: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
RoundRobinMode	Zadania są dystrybuowane w celu pracowników, począwszy od procesu roboczego, który jest po ostatnim pracowniku, aby otrzymać zadanie.
RouterRuleKind	Dyskryminujące dla obsługiwanych typów reguł routera.
ScoringRuleOptions	Hermetyzuje wszystkie opcje, które można przekazać jako parametry reguły oceniania za pomocą funkcji BestWorkerMode.
ScoringRuleParameterSelector	Obsługiwane parametry dla procesów roboczych oceniania używanych w trybie BestWorkerMode.
StaticRouterRule	Reguła zapewniająca reguły statyczne, które zawsze zwracają ten sam wynik, niezależnie od danych wejściowych.
WebhookRouterRule	Reguła zapewniająca powiązanie z zewnętrznym serwerem internetowym.

Azure.Core.Foundations.Error

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

BestWorkerMode

Zadania są dystrybuowane do procesu roboczego z najsilniejszymi dostępnymi możliwościami.

Nazwa	Typ	Domyślna wartość	Opis
bypassSelectors	boolean	False	Jeśli ustawiono wartość true, router będzie pasować do zadań roboczych, nawet jeśli nie pasują do selektorów etykiet. Ostrzeżenie: Jeśli ustawisz tę zmienną na wartość true, możesz uzyskać pracowników, które nie są kwalifikowane do pracy, z którą są dopasowywane. Ta flaga jest przeznaczona bardziej do tymczasowego użycia. Domyślnie ustawiono wartość false.
kind	string: bestWorker		Dyskryminujący typ opisujący podtyp funkcji DistributionMode.
maxConcurrentOffers	integer	1	Zarządza maksymalną liczbą aktywnych równoczesnych ofert, które może mieć zadanie.
minConcurrentOffers	integer	1	Określa minimalną żądaną liczbę aktywnych równoczesnych ofert, które może mieć zadanie.
scoringRule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule		Zdefiniuj regułę oceniania do użycia podczas obliczania wyniku w celu określenia najlepszego procesu roboczego. Jeśli nie zostanie ustawiona, użyje domyślnej formuły oceniania, która używa etykiet zadań pasujących do etykiet procesów roboczych, a także liczby selektorów etykiet, które są zgodne z etykietami procesów roboczych i/lub przekraczają użycie funkcji logistycznej (https://en.wikipedia.org/wiki/Logistic_function).
scoringRuleOptions	ScoringRuleOptions		Opcje konfigurowania "scoringRule". Jeśli nie zostanie ustawiona, zostaną użyte wartości domyślne.

DirectMapRouterRule

Reguła zwracająca te same etykiety co etykiety wejściowe.

Nazwa	Typ	Opis
kind	string: directMap	Dyskryminujący typ opisujący podtyp RouterRule

DistributionModeKind

Dyskryminujące typy obsługiwanych trybów dystrybucji.

Nazwa	Typ	Opis
bestWorker	string	Wartość dyskryminująca dla elementu BestWorkerMode.
longestIdle	string	Wartość dyskryminująca dla elementu LongestIdleMode.
roundRobin	string	Wartość dyskryminująca dla elementu RoundRobinMode.

DistributionPolicy

Zasady dotyczące sposobu dystrybuowania miejsc pracy do pracowników

Nazwa	Typ	Opis
etag	string	Tag jednostki dla tego zasobu.
id	string	Identyfikator zasad dystrybucji.
mode	DistributionMode: BestWorkerMode LongestIdleMode RoundRobinMode	Tryb zarządzający określoną metodą dystrybucji.
name	string	Przyjazna nazwa tych zasad.
offerExpiresAfterSeconds	number	Liczba sekund, po których wszystkie oferty utworzone w ramach tych zasad wygasły.

ExpressionRouterRule

Reguła dostarczająca reguły wyrażeń wbudowanych.

Nazwa	Typ	Opis
expression	string	Wyrażenie do obliczenia. Powinna zawierać instrukcję return z wartościami obliczeniowymi.
kind	string: expression	Dyskryminujący typ opisujący podtyp RouterRule
language	ExpressionRouterRuleLanguage	Język wyrażeń do skompilowania i wykonania.

ExpressionRouterRuleLanguage

Dostępne języki wyrażeń, które można skonfigurować.

Nazwa	Typ	Opis
powerFx	string	PowerFx

FunctionRouterRule

Reguła zapewniająca powiązanie z funkcją platformy Azure wyzwalaną przez protokół HTTP.

Nazwa	Typ	Opis
credential	FunctionRouterRuleCredential	Poświadczenia używane do uzyskiwania dostępu do reguły funkcji platformy Azure.
functionUri	string	Adres URL funkcji platformy Azure.
kind	string: function	Dyskryminujący typ opisujący podtyp RouterRule

FunctionRouterRuleCredential

Poświadczenia używane do uzyskiwania dostępu do reguły funkcji platformy Azure.

Nazwa	Typ	Opis
appKey	string	Dostęp do klucza ograniczonego do aplikacji funkcji platformy Azure. Ten klucz udziela dostępu do wszystkich funkcji w aplikacji.
clientId	string	Identyfikator klienta, gdy wartość AppKey jest podana w kontekście funkcji platformy Azure, jest to zwykle nazwa klucza.
functionKey	string	Klucz dostępu o określonym zakresie do określonej funkcji.

LongestIdleMode

Zadania są kierowane do pracownika, który był najdłużej bezczynny.

Nazwa	Typ	Domyślna wartość	Opis
bypassSelectors	boolean	False	Jeśli ustawiono wartość true, router będzie pasować do zadań roboczych, nawet jeśli nie pasują do selektorów etykiet. Ostrzeżenie: Jeśli ustawisz tę zmienną na wartość true, możesz uzyskać pracowników, które nie są kwalifikowane do pracy, z którą są dopasowywane. Ta flaga jest przeznaczona bardziej do tymczasowego użycia. Domyślnie ustawiono wartość false.
kind	string: longestIdle		Dyskryminujący typ opisujący podtyp funkcji DistributionMode.
maxConcurrentOffers	integer	1	Zarządza maksymalną liczbą aktywnych równoczesnych ofert, które może mieć zadanie.
minConcurrentOffers	integer	1	Określa minimalną żądaną liczbę aktywnych równoczesnych ofert, które może mieć zadanie.

OAuth2WebhookClientCredential

Poświadczenia OAuth2.0 używane do serwera autoryzacji firmy Contoso. Dokumentacja: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/

Nazwa	Typ	Opis
clientId	string	ClientId dla serwera autoryzacji Contoso.
clientSecret	string	Wpis tajny klienta dla serwera autoryzacji Contoso.

RoundRobinMode

Zadania są dystrybuowane w celu pracowników, począwszy od procesu roboczego, który jest po ostatnim pracowniku, aby otrzymać zadanie.

Nazwa	Typ	Domyślna wartość	Opis
bypassSelectors	boolean	False	Jeśli ustawiono wartość true, router będzie pasować do zadań roboczych, nawet jeśli nie pasują do selektorów etykiet. Ostrzeżenie: Jeśli ustawisz tę zmienną na wartość true, możesz uzyskać pracowników, które nie są kwalifikowane do pracy, z którą są dopasowywane. Ta flaga jest przeznaczona bardziej do tymczasowego użycia. Domyślnie ustawiono wartość false.
kind	string: roundRobin		Dyskryminujący typ opisujący podtyp funkcji DistributionMode.
maxConcurrentOffers	integer	1	Zarządza maksymalną liczbą aktywnych równoczesnych ofert, które może mieć zadanie.
minConcurrentOffers	integer	1	Określa minimalną żądaną liczbę aktywnych równoczesnych ofert, które może mieć zadanie.

RouterRuleKind

Dyskryminujące dla obsługiwanych typów reguł routera.

Nazwa	Typ	Opis
directMap	string	Dyskryminująca wartość directMapRouterRule.
expression	string	Dyskryminująca wartość expressionRouterRule.
function	string	Wartość dyskryminująca dla functionRouterRule.
static	string	Wartość dyskryminująca dla staticRouterRule.
webhook	string	Wartość dyskryminująca dla elementu WebhookRouterRule.

ScoringRuleOptions

Hermetyzuje wszystkie opcje, które można przekazać jako parametry reguły oceniania za pomocą funkcji BestWorkerMode.

Nazwa	Typ	Domyślna wartość	Opis
batchSize	integer	20	Ustaw rozmiar partii, gdy parametr "isBatchScoringEnabled" ma wartość true. Wartość domyślna to 20, jeśli nie została skonfigurowana.
descendingOrder	boolean	True	Jeśli wartość false, posortuje wyniki według kolejności rosnącej. Domyślnie ustaw wartość true.
isBatchScoringEnabled	boolean	False	Jeśli ustawiono wartość true, będzie oceniać procesy robocze w partiach, a nazwa parametru etykiet procesu roboczego zostanie wysłana jako `workers`. Domyślnie ustawiono wartość false, a nazwa parametru etykiet procesu roboczego zostanie wysłana jako `worker`. Uwaga: w przypadku włączenia użyj polecenia "batchSize", aby ustawić rozmiar partii.
scoringParameters	ScoringRuleParameterSelector[]	[ "jobLabels", "workerSelectors" ]	Lista dodatkowych parametrów z zadania, które zostaną wysłane jako część ładunku do reguły oceniania. Jeśli nie zostanie ustawiona, etykiety zadania (wysyłane w ładunku jako `job`) i selektory procesów roboczych zadania (wysyłane w ładunku jako `selectors`) są domyślnie dodawane do ładunku reguły oceniania. Uwaga: etykiety procesów roboczych są zawsze wysyłane z ładunkiem oceniania.

ScoringRuleParameterSelector

Obsługiwane parametry dla procesów roboczych oceniania używanych w trybie BestWorkerMode.

Nazwa	Typ	Opis
jobLabels	string	Parametr umożliwiający dodanie etykiet zadań do ładunku oceniania. Właściwość jest wysyłana jako `job`.
workerSelectors	string	Parametr służący do dodawania selektorów procesów roboczych z zadania do oceniania ładunku. Właściwość jest wysyłana jako `selectors`.

StaticRouterRule

Reguła zapewniająca reguły statyczne, które zawsze zwracają ten sam wynik, niezależnie od danych wejściowych.

Nazwa	Typ	Opis
kind	string: static	Dyskryminujący typ opisujący podtyp RouterRule
value		Wartość statyczna, która jest zawsze zwracana przez tę regułę. Wartości muszą być wartościami pierwotnymi — liczba, ciąg, wartość logiczna.

WebhookRouterRule

Reguła zapewniająca powiązanie z zewnętrznym serwerem internetowym.

Nazwa	Typ	Opis
authorizationServerUri	string	Identyfikator URI serwera autoryzacji.
clientCredential	OAuth2WebhookClientCredential	Poświadczenia OAuth2.0 używane do serwera autoryzacji firmy Contoso. Dokumentacja: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
kind	string: webhook	Dyskryminujący typ opisujący podtyp RouterRule
webhookUri	string	Identyfikator URI dla serwera internetowego firmy Contoso.

Udostępnij za pośrednictwem

Job Router Administration Operations - Get Distribution Policy

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

AadOauth2Auth

Zakresy

Przykłady

Retrieves an existing distribution policy by Id

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

BestWorkerMode

DirectMapRouterRule

DistributionModeKind

DistributionPolicy

ExpressionRouterRule

ExpressionRouterRuleLanguage

FunctionRouterRule

FunctionRouterRuleCredential

LongestIdleMode

OAuth2WebhookClientCredential

RoundRobinMode

RouterRuleKind

ScoringRuleOptions

ScoringRuleParameterSelector

StaticRouterRule

WebhookRouterRule

Dodatkowe zasoby