Job Router Administration Operations - Get Distribution Policy

Reference

Služba:: Communication

Verze rozhraní API:: 2023-11-01

Načte existující distribuční zásadu podle ID.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
distributionPolicyId	path	True	string	ID zásady distribuce.
endpoint	path	True	string	Identifikátor URI vašeho komunikačního prostředku
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	DistributionPolicy	Požadavek byl úspěšný. Hlavičky ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

DistributionPolicy

Požadavek byl úspěšný.

Hlavičky

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

AadOauth2Auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

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

Příklady

Retrieves an existing distribution policy by Id

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
BestWorkerMode	Úlohy se distribuují pracovnímu procesu s nejsilnějšími dostupnými schopnostmi.
DirectMapRouterRule	Pravidlo, které vrátí stejné popisky jako vstupní popisky.
DistributionModeKind	Diskriminátor podporovaných typů distribučního režimu.
DistributionPolicy	Zásady, kterými se řídí způsob distribuce úloh pracovníkům
ExpressionRouterRule	Pravidlo poskytující pravidla vložených výrazů.
ExpressionRouterRuleLanguage	Dostupné jazyky výrazů, které lze konfigurovat.
FunctionRouterRule	Pravidlo poskytující vazbu na funkci Azure aktivovanou protokolem HTTP
FunctionRouterRuleCredential	Přihlašovací údaje používané pro přístup k pravidlu funkce Azure.
LongestIdleMode	Úlohy se směrují na pracovníka, který byl nejdéle nečinný.
OAuth2WebhookClientCredential	Přihlašovací údaje OAuth2.0 používané k autorizačnímu serveru společnosti Contoso. Referenční informace: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
RoundRobinMode	Úlohy se distribuují pracovníkům, počínaje pracovníkem, který je po posledním pracovním procesu, aby získal úlohu.
RouterRuleKind	Diskriminátor podporovaných typů pravidel směrovače.
ScoringRuleOptions	Zapouzdřuje všechny možnosti, které lze předat jako parametry pro bodovací pravidlo pomocí BestWorkerMode.
ScoringRuleParameterSelector	Podporované parametry pro hodnoticí pracovní procesy používané s BestWorkerMode.
StaticRouterRule	Pravidlo poskytující statická pravidla, která vždy vrací stejný výsledek bez ohledu na vstup.
WebhookRouterRule	Pravidlo poskytující vazbu na externí webový server.

Azure.Core.Foundations.Error

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

BestWorkerMode

Objekt

Úlohy se distribuují pracovnímu procesu s nejsilnějšími dostupnými schopnostmi.

Name	Typ	Default value	Description
bypassSelectors	boolean	False	Pokud je nastavená hodnota true, bude směrovač odpovídat pracovním procesům i v případě, že neodpovídají selektorům popisků. Upozornění: Pokud tuto proměnnou nastavíte na hodnotu true, můžete získat pracovníky, kteří nejsou kvalifikovaní pro úlohu. Tento příznak je určený pro dočasné použití. Ve výchozím nastavení je nastavená hodnota false.
kind	string: bestWorker		Typ diskriminující popis dílčího typu DistributionMode.
maxConcurrentOffers	integer (int32)	1	Určuje maximální počet aktivních souběžných nabídek, které může mít úloha.
minConcurrentOffers	integer (int32)	1	Určuje minimální požadovaný počet aktivních souběžných nabídek, které může mít úloha.
scoringRule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule		Při výpočtu skóre pro určení nejlepšího pracovního procesu definujte pravidlo bodování, které se má použít. Pokud není nastavená hodnota, použije se výchozí bodovací vzorec, který používá počet popisků úloh, které se popisky pracovního procesu shodují, a také počet selektorů popisků, které se budou shodovat s popisky pracovního procesu nebo které překračují pomocí logistické funkce (https://en.wikipedia.org/wiki/Logistic_function).
scoringRuleOptions	ScoringRuleOptions		Možnosti konfigurace hodnoticího pravidla Pokud není nastavená, použijí se výchozí hodnoty.

DirectMapRouterRule

Objekt

Pravidlo, které vrátí stejné popisky jako vstupní popisky.

Name	Typ	Description
kind	string: directMap	Typ diskriminující popis podtypu RouterRule

DistributionModeKind

Výčet

Diskriminátor podporovaných typů distribučního režimu.

Hodnota	Description
bestWorker	Diskriminující hodnota pro BestWorkerMode.
longestIdle	Diskriminující hodnota pro LongestIdleMode.
roundRobin	Diskriminační hodnota pro RoundRobinMode.

DistributionPolicy

Objekt

Zásady, kterými se řídí způsob distribuce úloh pracovníkům

Name	Typ	Description
etag	string	Značka entity pro tento prostředek.
id	string	ID zásady distribuce.
mode	DistributionMode: BestWorkerMode LongestIdleMode RoundRobinMode	Režim řízení konkrétní metody distribuce
name	string	Popisný název této zásady
offerExpiresAfterSeconds	number (double)	Počet sekund, po jejichž uplynutí vyprší platnost všech nabídek vytvořených v rámci této zásady.

ExpressionRouterRule

Objekt

Pravidlo poskytující pravidla vložených výrazů.

Name	Typ	Description
expression	string	Výraz, který se má vyhodnotit. Měl by obsahovat návratový příkaz s počítanými hodnotami.
kind	string: expression	Typ diskriminující popis podtypu RouterRule
language	ExpressionRouterRuleLanguage	Jazyk výrazu pro kompilaci a spuštění.

ExpressionRouterRuleLanguage

Výčet

Dostupné jazyky výrazů, které lze konfigurovat.

Hodnota	Description
powerFx	PowerFx

FunctionRouterRule

Objekt

Pravidlo poskytující vazbu na funkci Azure aktivovanou protokolem HTTP

Name	Typ	Description
credential	FunctionRouterRuleCredential	Přihlašovací údaje používané pro přístup k pravidlu funkce Azure.
functionUri	string (uri)	Adresa URL pro funkci Azure Functions
kind	string: function	Typ diskriminující popis podtypu RouterRule

FunctionRouterRuleCredential

Objekt

Přihlašovací údaje používané pro přístup k pravidlu funkce Azure.

Name	Typ	Description
appKey	string	Přístupový klíč vymezený na aplikaci Funkcí Azure. Tento klíč uděluje přístup ke všem funkcím v aplikaci.
clientId	string	ID klienta, pokud je appKey zadaný v kontextu funkce Azure, je to obvykle název klíče.
functionKey	string	Přístupový klíč vymezený na konkrétní funkci.

LongestIdleMode

Objekt

Úlohy se směrují na pracovníka, který byl nejdéle nečinný.

Name	Typ	Default value	Description
bypassSelectors	boolean	False	Pokud je nastavená hodnota true, bude směrovač odpovídat pracovním procesům i v případě, že neodpovídají selektorům popisků. Upozornění: Pokud tuto proměnnou nastavíte na hodnotu true, můžete získat pracovníky, kteří nejsou kvalifikovaní pro úlohu. Tento příznak je určený pro dočasné použití. Ve výchozím nastavení je nastavená hodnota false.
kind	string: longestIdle		Typ diskriminující popis dílčího typu DistributionMode.
maxConcurrentOffers	integer (int32)	1	Určuje maximální počet aktivních souběžných nabídek, které může mít úloha.
minConcurrentOffers	integer (int32)	1	Určuje minimální požadovaný počet aktivních souběžných nabídek, které může mít úloha.

OAuth2WebhookClientCredential

Objekt

Přihlašovací údaje OAuth2.0 používané k autorizačnímu serveru společnosti Contoso. Referenční informace: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/

Name	Typ	Description
clientId	string	ClientId pro autorizační server Společnosti Contoso.
clientSecret	string	Tajný klíč klienta pro autorizační server Společnosti Contoso.

RoundRobinMode

Objekt

Úlohy se distribuují pracovníkům, počínaje pracovníkem, který je po posledním pracovním procesu, aby získal úlohu.

Name	Typ	Default value	Description
bypassSelectors	boolean	False	Pokud je nastavená hodnota true, bude směrovač odpovídat pracovním procesům i v případě, že neodpovídají selektorům popisků. Upozornění: Pokud tuto proměnnou nastavíte na hodnotu true, můžete získat pracovníky, kteří nejsou kvalifikovaní pro úlohu. Tento příznak je určený pro dočasné použití. Ve výchozím nastavení je nastavená hodnota false.
kind	string: roundRobin		Typ diskriminující popis dílčího typu DistributionMode.
maxConcurrentOffers	integer (int32)	1	Určuje maximální počet aktivních souběžných nabídek, které může mít úloha.
minConcurrentOffers	integer (int32)	1	Určuje minimální požadovaný počet aktivních souběžných nabídek, které může mít úloha.

RouterRuleKind

Výčet

Diskriminátor podporovaných typů pravidel směrovače.

Hodnota	Description
directMap	Diskriminující hodnota pro DirectMapRouterRule.
expression	Diskriminující hodnota pro ExpressionRouterRule.
function	Diskriminující hodnota pro FunctionRouterRule.
static	Diskriminující hodnota pro StaticRouterRule.
webhook	Diskriminující hodnota pro WebhookRouterRule.

ScoringRuleOptions

Objekt

Zapouzdřuje všechny možnosti, které lze předat jako parametry pro bodovací pravidlo pomocí BestWorkerMode.

Name	Typ	Default value	Description
batchSize	integer (int32)	20	Nastavte velikost dávky, pokud je hodnota isBatchScoringEnabled nastavená na hodnotu true. Výchozí hodnota je 20, pokud není nakonfigurovaná.
descendingOrder	boolean	True	Pokud je false, seřadí skóre vzestupně. Ve výchozím nastavení je nastavená hodnota true.
isBatchScoringEnabled	boolean	False	Pokud je nastavena hodnota true, bude skóre pracovních procesů v dávkách a název parametru popisků pracovních procesů se odešle jako `workers`. Ve výchozím nastavení se jako `worker`odešle název parametru pro popisky pracovního procesu. Poznámka: Pokud je tato možnost povolená, použijte batchSize k nastavení velikosti dávky.
scoringParameters	ScoringRuleParameterSelector[]	[ "jobLabels", "workerSelectors" ]	Seznam dalších parametrů z úlohy, která se odešle jako součást datové části do pravidla bodování Pokud není nastavená, popisky úlohy (odeslané v datové části jako `job`) a selektory pracovních procesů úlohy (odesílané do datové části jako `selectors`) se ve výchozím nastavení přidají do datové části pravidla bodování. Poznámka: Popisky pracovních procesů se vždy posílají s datovou částí bodování.

ScoringRuleParameterSelector

Výčet

Podporované parametry pro hodnoticí pracovní procesy používané s BestWorkerMode.

Hodnota	Description
jobLabels	Parametr pro přidání popisků úloh do datové části bodování Vlastnost je odeslána jako `job`.
workerSelectors	Parametr pro přidání selektorů pracovního procesu z úlohy do datové části bodování Vlastnost je odeslána jako `selectors`.

StaticRouterRule

Objekt

Pravidlo poskytující statická pravidla, která vždy vrací stejný výsledek bez ohledu na vstup.

Name	Typ	Description
kind	string: static	Typ diskriminující popis podtypu RouterRule
value		Statická hodnota, kterou toto pravidlo vždy vrátí. Hodnoty musí být primitivní hodnoty – číslo, řetězec, logická hodnota.

WebhookRouterRule

Objekt

Pravidlo poskytující vazbu na externí webový server.

Name	Typ	Description
authorizationServerUri	string (uri)	Identifikátor URI pro autorizační server
clientCredential	OAuth2WebhookClientCredential	Přihlašovací údaje OAuth2.0 používané k autorizačnímu serveru společnosti Contoso. Referenční informace: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
kind	string: webhook	Typ diskriminující popis podtypu RouterRule
webhookUri	string (uri)	Identifikátor URI webového serveru společnosti Contoso.

Sdílet prostřednictvím

Job Router Administration Operations - Get Distribution Policy

Parametry identifikátoru URI

Odpovědi

Zabezpečení

AadOauth2Auth

Rozsahy

Příklady

Retrieves an existing distribution policy by Id

Ukázkový požadavek

Ukázková odpověď

Definice

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

Další materiály