Job Router Administration Operations - Get Classification Policy

Reference

Služba:: Communication

Verze rozhraní API:: 2023-11-01

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

GET {endpoint}/routing/classificationPolicies/{classificationPolicyId}?api-version=2023-11-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
classificationPolicyId	path	True	string	ID zásady klasifikace.
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	ClassificationPolicy	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

ClassificationPolicy

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 classification policy by Id

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "id": "MainClassificationPolicy",
  "name": "Main",
  "fallbackQueueId": "MainQueue",
  "queueSelectorAttachments": [
    {
      "kind": "conditional",
      "condition": {
        "kind": "expression",
        "language": "powerFx",
        "expression": "1 = 1"
      },
      "queueSelectors": [
        {
          "key": "foo",
          "labelOperator": "equal",
          "value": "bar"
        }
      ]
    }
  ],
  "prioritizationRule": {
    "kind": "static",
    "value": "2"
  },
  "workerSelectorAttachments": [
    {
      "kind": "passThrough",
      "key": "language",
      "labelOperator": "equal"
    }
  ],
  "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.
ClassificationPolicy	Kontejner pravidel, která určují způsob klasifikace úloh.
ConditionalQueueSelectorAttachment	Popisuje sadu selektorů fronty, které budou připojeny, pokud se daná podmínka přeloží na true.
ConditionalWorkerSelectorAttachment	Popisuje sadu selektorů pracovních procesů, které budou připojeny, pokud se daná podmínka přeloží na true.
DirectMapRouterRule	Pravidlo, které vrátí stejné popisky jako vstupní popisky.
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.
LabelOperator	Popisuje podporované operace s hodnotami popisků.
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/
PassThroughQueueSelectorAttachment	Připojí selektor fronty, ve kterém se hodnota předává z popisku úlohy se stejným klíčem.
PassThroughWorkerSelectorAttachment	Připojí selektor pracovního procesu, ve kterém se hodnota předává z popisku úlohy se stejným klíčem.
QueueSelectorAttachmentKind	Diskriminátor pro podporované typy příloh selektoru fronty.
QueueWeightedAllocation	Obsahuje procento hmotnosti a selektory fronty, které se mají použít, pokud jsou vybrány pro vážené distribuce.
RouterQueueSelector	Popisuje podmínku, která musí být splněna u sady popisků pro výběr fronty.
RouterRuleKind	Diskriminátor podporovaných typů pravidel směrovače.
RouterWorkerSelector	Popisuje podmínku, která musí být splněna u sady popisků pro výběr pracovního procesu.
RouterWorkerSelectorStatus	Popisuje stav selektoru pracovního procesu.
RuleEngineQueueSelectorAttachment	Při vyřešení pravidla směrovače připojí selektory fronty k úloze.
RuleEngineWorkerSelectorAttachment	Připojí selektory pracovních procesů k úloze při vyřešení pravidla směrovače.
StaticQueueSelectorAttachment	Popisuje selektor fronty, který bude připojen k úloze.
StaticRouterRule	Pravidlo poskytující statická pravidla, která vždy vrací stejný výsledek bez ohledu na vstup.
StaticWorkerSelectorAttachment	Popisuje selektor pracovního procesu, který bude připojen k úloze.
WebhookRouterRule	Pravidlo poskytující vazbu na externí webový server.
WeightedAllocationQueueSelectorAttachment	Popisuje více sad selektorů fronty, z nichž jeden bude vybrán a připojen podle váhy.
WeightedAllocationWorkerSelectorAttachment	Popisuje více sad selektorů pracovního procesu, z nichž jeden bude vybrán a připojen podle váhy.
WorkerSelectorAttachmentKind	Diskriminátor pro podporované typy příloh selektoru pracovních procesů.
WorkerWeightedAllocation	Obsahuje procento hmotnosti a selektory pracovních procesů, které se mají použít, pokud jsou vybrány pro vážené rozdělení.

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.

ClassificationPolicy

Objekt

Kontejner pravidel, která určují způsob klasifikace úloh.

Name	Typ	Description
etag	string	Značka entity pro tento prostředek.
fallbackQueueId	string	ID záložní fronty, která se má vybrat, pokud přílohy selektoru fronty nenajde shodu.
id	string	ID zásady klasifikace.
name	string	Popisný název této zásady
prioritizationRule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	Pravidlo, které určí skóre priority pro úlohu.
queueSelectorAttachments	QueueSelectorAttachment[]: ConditionalQueueSelectorAttachment[] PassThroughQueueSelectorAttachment[] RuleEngineQueueSelectorAttachment[] StaticQueueSelectorAttachment[] WeightedAllocationQueueSelectorAttachment[]	Přílohy selektoru fronty používané k překladu fronty pro úlohu
workerSelectorAttachments	WorkerSelectorAttachment[]: ConditionalWorkerSelectorAttachment[] PassThroughWorkerSelectorAttachment[] RuleEngineWorkerSelectorAttachment[] StaticWorkerSelectorAttachment[] WeightedAllocationWorkerSelectorAttachment[]	Přílohy selektoru pracovních procesů používané k připojení selektorů pracovních procesů k úloze

ConditionalQueueSelectorAttachment

Objekt

Popisuje sadu selektorů fronty, které budou připojeny, pokud se daná podmínka přeloží na true.

Name	Typ	Description
condition	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	Podmínka, která musí být pravdivá pro selektory fronty, které se mají připojit.
kind	string: conditional	Typ diskriminující popis dílčího typu QueueSelectorAttachment.
queueSelectors	RouterQueueSelector[]	Selektory fronty, které se mají připojit.

ConditionalWorkerSelectorAttachment

Objekt

Popisuje sadu selektorů pracovních procesů, které budou připojeny, pokud se daná podmínka přeloží na true.

Name	Typ	Description
condition	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	Podmínka, která musí být pravdivá pro selektory pracovního procesu, které mají být připojeny.
kind	string: conditional	Typ diskriminující popis dílčího typu WorkerSelectorAttachment.
workerSelectors	RouterWorkerSelector[]	Selektory pracovních procesů, které se mají připojit.

DirectMapRouterRule

Objekt

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

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

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.

LabelOperator

Výčet

Popisuje podporované operace s hodnotami popisků.

Hodnota	Description
equal	Rovný.
greaterThan	Větší než.
greaterThanOrEqual	Větší než nebo rovno.
lessThan	Méně než.
lessThanOrEqual	Menší než nebo rovno.
notEqual	Nerovná se.

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.

PassThroughQueueSelectorAttachment

Objekt

Připojí selektor fronty, ve kterém se hodnota předává z popisku úlohy se stejným klíčem.

Name	Typ	Description
key	string	Klíč popisku pro dotazování.
kind	string: passThrough	Typ diskriminující popis dílčího typu QueueSelectorAttachment.
labelOperator	LabelOperator	Popisuje, jak se hodnota popisku porovnává s předávanou hodnotou.

PassThroughWorkerSelectorAttachment

Objekt

Připojí selektor pracovního procesu, ve kterém se hodnota předává z popisku úlohy se stejným klíčem.

Name	Typ	Description
expiresAfterSeconds	number (double)	Popisuje, jak dlouho je připojený selektor popisků platný v sekundách.
key	string	Klíč popisku pro dotazování.
kind	string: passThrough	Typ diskriminující popis dílčího typu WorkerSelectorAttachment.
labelOperator	LabelOperator	Popisuje, jak se hodnota popisku porovnává s předávanou hodnotou.

QueueSelectorAttachmentKind

Výčet

Diskriminátor pro podporované typy příloh selektoru fronty.

Hodnota	Description
conditional	Diskriminující hodnota pro ConditionalQueueSelectorAttachment.
passThrough	Diskriminující hodnota pro PassThroughQueueSelectorAttachment.
ruleEngine	Diskriminující hodnota pro RuleEngineQueueSelectorAttachment.
static	Diskriminující hodnota pro StaticQueueSelectorAttachment.
weightedAllocation	Diskriminační hodnota pro WeightedAllocationQueueSelectorAttachment.

QueueWeightedAllocation

Objekt

Obsahuje procento hmotnosti a selektory fronty, které se mají použít, pokud jsou vybrány pro vážené distribuce.

Name	Typ	Description
queueSelectors	RouterQueueSelector[]	Kolekce selektorů fronty, které se použijí, pokud je toto přidělení vybráno.
weight	number (double)	Procento této hmotnosti vyjádřené zlomkem 1.

RouterQueueSelector

Objekt

Popisuje podmínku, která musí být splněna u sady popisků pro výběr fronty.

Name	Typ	Description
key	string	Klíč popisku pro dotazování.
labelOperator	LabelOperator	Popisuje, jak se hodnota popisku porovnává s hodnotou definovanou v selektoru popisků.
value		Hodnota, která se má porovnat se skutečnou hodnotou popisku s daným operátorem. Hodnoty musí být primitivní hodnoty – číslo, řetězec, logická hodnota.

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.

RouterWorkerSelector

Objekt

Popisuje podmínku, která musí být splněna u sady popisků pro výběr pracovního procesu.

Name	Typ	Description
expedite	boolean	Nasdílí úlohu do fronty, pokud je tento selektor aktivní.
expiresAfterSeconds	number (double)	Popisuje, jak dlouho je tento selektor popisků platný v sekundách.
expiresAt	string (date-time)	Čas vypršení platnosti tohoto selektoru pracovního procesu ve standardu UTC.
key	string	Klíč popisku pro dotazování.
labelOperator	LabelOperator	Popisuje, jak se hodnota popisku porovnává s hodnotou definovanou v selektoru pracovního procesu.
status	RouterWorkerSelectorStatus	Stav selektoru pracovního procesu
value		Hodnota, která se má porovnat se skutečnou hodnotou popisku s daným operátorem. Hodnoty musí být primitivní hodnoty – číslo, řetězec, logická hodnota.

RouterWorkerSelectorStatus

Výčet

Popisuje stav selektoru pracovního procesu.

Hodnota	Description
active	Selektor pracovního procesu je platný.
expired	Selektor pracovního procesu není platný.

RuleEngineQueueSelectorAttachment

Objekt

Při vyřešení pravidla směrovače připojí selektory fronty k úloze.

Name	Typ	Description
kind	string: ruleEngine	Typ diskriminující popis dílčího typu QueueSelectorAttachment.
rule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	RouterRule, která řeší kolekci selektorů fronty, které se mají připojit.

RuleEngineWorkerSelectorAttachment

Objekt

Připojí selektory pracovních procesů k úloze při vyřešení pravidla směrovače.

Name	Typ	Description
kind	string: ruleEngine	Typ diskriminující popis dílčího typu WorkerSelectorAttachment.
rule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	RouterRule, která řeší kolekci selektorů pracovních procesů, které se mají připojit.

StaticQueueSelectorAttachment

Objekt

Popisuje selektor fronty, který bude připojen k úloze.

Name	Typ	Description
kind	string: static	Typ diskriminující popis dílčího typu QueueSelectorAttachment.
queueSelector	RouterQueueSelector	Selektor fronty, který se má připojit.

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.

StaticWorkerSelectorAttachment

Objekt

Popisuje selektor pracovního procesu, který bude připojen k úloze.

Name	Typ	Description
kind	string: static	Typ diskriminující popis dílčího typu WorkerSelectorAttachment.
workerSelector	RouterWorkerSelector	Selektor pracovního procesu, který se má připojit.

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.

WeightedAllocationQueueSelectorAttachment

Objekt

Popisuje více sad selektorů fronty, z nichž jeden bude vybrán a připojen podle váhy.

Name	Typ	Description
allocations	QueueWeightedAllocation[]	Kolekce vážených přidělení založených na procentech.
kind	string: weightedAllocation	Typ diskriminující popis dílčího typu QueueSelectorAttachment.

WeightedAllocationWorkerSelectorAttachment

Objekt

Popisuje více sad selektorů pracovního procesu, z nichž jeden bude vybrán a připojen podle váhy.

Name	Typ	Description
allocations	WorkerWeightedAllocation[]	Kolekce vážených přidělení založených na procentech.
kind	string: weightedAllocation	Typ diskriminující popis dílčího typu WorkerSelectorAttachment.

WorkerSelectorAttachmentKind

Výčet

Diskriminátor pro podporované typy příloh selektoru pracovních procesů.

Hodnota	Description
conditional	Diskriminující hodnota pro ConditionalWorkerSelectorAttachment.
passThrough	Diskriminující hodnota pro PassThroughWorkerSelectorAttachment.
ruleEngine	Diskriminující hodnota pro RuleEngineWorkerSelectorAttachment.
static	Diskriminující hodnota pro StaticWorkerSelectorAttachment.
weightedAllocation	Diskriminační hodnota pro WeightedAllocationWorkerSelectorAttachment.

WorkerWeightedAllocation

Objekt

Obsahuje procento hmotnosti a selektory pracovních procesů, které se mají použít, pokud jsou vybrány pro vážené rozdělení.

Name	Typ	Description
weight	number (double)	Procento této hmotnosti vyjádřené zlomkem 1.
workerSelectors	RouterWorkerSelector[]	Kolekce selektorů pracovních procesů, které se použijí, pokud je toto přidělení vybráno.

Sdílet prostřednictvím

Job Router Administration Operations - Get Classification Policy

Parametry identifikátoru URI

Odpovědi

Zabezpečení

AadOauth2Auth

Rozsahy

Příklady

Retrieves an existing classification policy by Id

Ukázkový požadavek

Ukázková odpověď

Definice

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

ClassificationPolicy

ConditionalQueueSelectorAttachment

ConditionalWorkerSelectorAttachment

DirectMapRouterRule

ExpressionRouterRule

ExpressionRouterRuleLanguage

FunctionRouterRule

FunctionRouterRuleCredential

LabelOperator

OAuth2WebhookClientCredential

PassThroughQueueSelectorAttachment

PassThroughWorkerSelectorAttachment

QueueSelectorAttachmentKind

QueueWeightedAllocation

RouterQueueSelector

RouterRuleKind

RouterWorkerSelector

RouterWorkerSelectorStatus

RuleEngineQueueSelectorAttachment

RuleEngineWorkerSelectorAttachment

StaticQueueSelectorAttachment

StaticRouterRule

StaticWorkerSelectorAttachment

WebhookRouterRule

WeightedAllocationQueueSelectorAttachment

WeightedAllocationWorkerSelectorAttachment

WorkerSelectorAttachmentKind

WorkerWeightedAllocation

Další materiály