Job Router Administration - List Distribution Policies

Referencia

Szolgáltatás:: Communication

API-verzió:: 2022-07-18-preview

Lekéri a meglévő terjesztési szabályzatokat.

GET {endpoint}/routing/distributionPolicies?api-version=2022-07-18-preview

Opcionális paraméterekkel:

GET {endpoint}/routing/distributionPolicies?maxpagesize={maxpagesize}&api-version=2022-07-18-preview

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	Az Azure Communication-erőforrás végpontja.
api-version	query	True	string	A meghívandó API verziója.
maxpagesize	query		integer (int32)	Maximális oldalméret.

Válaszok

Name	Típus	Description
200 OK	DistributionPolicyCollection	Siker
Other Status Codes	CommunicationErrorResponse	Hiba

Példák

Get Distribution policies with pagination (max page size)

Mintakérelem

HTTP

GET https://contoso.westus.communications.azure.com/routing/distributionPolicies?maxpagesize=2&api-version=2022-07-18-preview

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "distributionPolicy": {
        "id": "SecondaryDistributionPolicy",
        "name": "Secondary",
        "offerExpiresAfterSeconds": 300,
        "mode": {
          "kind": "round-robin",
          "minConcurrentOffers": 1,
          "maxConcurrentOffers": 2,
          "bypassSelectors": false
        }
      },
      "etag": "etag"
    },
    {
      "distributionPolicy": {
        "id": "MainDistributionPolicy",
        "name": "Main",
        "offerExpiresAfterSeconds": 300,
        "mode": {
          "kind": "longest-idle",
          "minConcurrentOffers": 1,
          "maxConcurrentOffers": 5,
          "bypassSelectors": false
        }
      },
      "etag": "etag"
    }
  ],
  "nextLink": "null"
}

Definíciók

Name	Description
BestWorkerMode	A feladatok a rendelkezésre álló legerősebb képességekkel vannak elosztva a feldolgozó között.
DirectMapRouterRule	Olyan szabály, amely ugyanazokat a címkéket adja vissza, mint a bemeneti címkék.
DistributionPolicy	A feladatok munkavállalóknak való elosztását szabályozó szabályzat
DistributionPolicyCollection	Terjesztési szabályzatok lapozott gyűjteménye.
DistributionPolicyItem	A DistributionPolicy lapozott példánya
ExpressionRouterRule	Beágyazott kifejezési szabályokat tartalmazó szabály.
ExpressionRouterRuleLanguage	A kifejezés nyelvének fordítása és végrehajtása
FunctionRouterRule	Egy HTTP-aktivált Azure-függvényhez kötést biztosító szabály.
FunctionRouterRuleCredential	Az Azure-függvényszabály eléréséhez használt hitelesítő adatok
LongestIdleMode	A feladatok a leghosszabb ideig tétlen feldolgozóhoz lesznek irányítva.
Oauth2ClientCredential	A Contoso engedélyezési kiszolgálójának OAuth2.0 hitelesítő adatai. Hivatkozás: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
RoundRobinMode	A feladatok el vannak osztva a dolgozók között, kezdve azzal a feldolgozóval, aki az utolsó munkavégző után kap egy feladatot.
ScoringRuleOptions	Beágyazza azokat a beállításokat, amelyek paraméterként átadhatók a pontozási szabályhoz a BestWorkerMode használatával
ScoringRuleParameterSelector	(Nem kötelező) Azon további paraméterek listája a feladatból, amelyeket a hasznos adat részeként küldünk el a pontozási szabálynak. Ha nincs beállítva, a rendszer alapértelmezés szerint hozzáadja a feladat címkéit (a hasznos adatokban `job`) és a feladat munkavégző választóit (a hasznos adatokban `selectors`) alapértelmezés szerint hozzáadja a pontozási szabály hasznos adataihoz. Megjegyzés: A munkavégző címkék mindig pontozási hasznos adatokkal lesznek elküldve.
StaticRouterRule	Statikus szabályokat tartalmazó szabály, amely mindig ugyanazt az eredményt adja vissza, a bemenettől függetlenül.
WebhookRouterRule	Egy külső webkiszolgálóhoz kötést biztosító szabály.

BestWorkerMode

Objektum

A feladatok a rendelkezésre álló legerősebb képességekkel vannak elosztva a feldolgozó között.

Name	Típus	Description
bypassSelectors	boolean	(Nem kötelező) Ha igaz értékre van állítva, akkor az útválasztó akkor is megfelel a dolgozóknak a feladatoknak, ha nem egyeznek a címkeválasztókkal. Figyelmeztetés: Előfordulhat, hogy a változó igaz értékre állításakor olyan dolgozókat is lekérhet, akik nem rendelkeznek a megfelelő feladattal. Ez a jelző inkább ideiglenes használatra szolgál. Alapértelmezés szerint false (hamis) értékre van állítva.
kind	string	A BestWorkerMode-t leíró típuskriminatív
maxConcurrentOffers	integer (int32)	Az aktív egyidejű ajánlatok maximális számát szabályozza.
minConcurrentOffers	integer (int32)	Az aktív egyidejű ajánlatok minimálisan kívánt számát szabályozza.
scoringRule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	Az alábbi típusok egyikének szabálya: StaticRule: Olyan statikus szabályokat biztosító szabály, amely a bemenettől függetlenül mindig ugyanazt az eredményt adja vissza. DirectMapRule: Olyan szabály, amely ugyanazokat a címkéket adja vissza, mint a bemeneti címkék. ExpressionRule: Beágyazott kifejezési szabályokat biztosító szabály. AzureFunctionRule: Egy HTTP-aktivált Azure-függvényhez kötést biztosító szabály. WebhookRule: Az OAuth2.0 hitelesítési protokollt követő webkiszolgálóhoz kötést biztosító szabály.
scoringRuleOptions	ScoringRuleOptions	Beágyazza azokat a beállításokat, amelyek paraméterként átadhatók a pontozási szabályhoz a BestWorkerMode használatával

DirectMapRouterRule

Objektum

Olyan szabály, amely ugyanazokat a címkéket adja vissza, mint a bemeneti címkék.

Name	Típus	Description
kind	string	A DirectMapRouterRule-t leíró típuskriminatív

DistributionPolicy

Objektum

A feladatok munkavállalóknak való elosztását szabályozó szabályzat

Name	Típus	Description
id	string	A szabályzat egyedi azonosítója.
mode	DistributionMode: BestWorkerMode LongestIdleMode RoundRobinMode	Absztrakciós alaposztály terjesztési mód meghatározásához
name	string	A szabályzat olvasható neve.
offerExpiresAfterSeconds	number (double)	Az a másodperc, amely után a szabályzatban létrehozott ajánlatok lejárnak.

DistributionPolicyCollection

Objektum

Terjesztési szabályzatok lapozott gyűjteménye.

Name	Típus	Description
nextLink	string
value	DistributionPolicyItem[]	A DistributionPolicy lapozott példánya

DistributionPolicyItem

Objektum

A DistributionPolicy lapozott példánya

Name	Típus	Description
distributionPolicy	DistributionPolicy	A feladatok munkavállalóknak való elosztását szabályozó szabályzat
etag	string	(Nem kötelező) Az egyidejűségi jogkivonat.

ExpressionRouterRule

Objektum

Beágyazott kifejezési szabályokat tartalmazó szabály.

Name	Típus	Description
expression	string minLength: 0 maxLength: 500	A kiértékelendő kifejezést tartalmazó sztring. Számított értékekkel rendelkező visszatérési utasítást kell tartalmaznia.
kind	string	A ExpressionRouterRule-t leíró típuskriminatív
language	ExpressionRouterRuleLanguage	A kifejezés nyelvének fordítása és végrehajtása

ExpressionRouterRuleLanguage

Enumerálás

A kifejezés nyelvének fordítása és végrehajtása

Érték	Description
powerFx

FunctionRouterRule

Objektum

Egy HTTP-aktivált Azure-függvényhez kötést biztosító szabály.

Name	Típus	Description
credential	FunctionRouterRuleCredential	Az Azure-függvényszabály eléréséhez használt hitelesítő adatok
functionUri	string (uri)	Az Azure-függvény URL-címe
kind	string	A FunctionRouterRule-t leíró típuskriminatív

FunctionRouterRuleCredential

Objektum

Az Azure-függvényszabály eléréséhez használt hitelesítő adatok

Name	Típus	Description
appKey	string minLength: 0 maxLength: 500	(Nem kötelező) Hozzáférési kulcs hatóköre egy Azure-függvényalkalmazáshoz. Ez a kulcs hozzáférést biztosít az alkalmazás összes függvényéhez.
clientId	string minLength: 0 maxLength: 500	(Nem kötelező) Ügyfélazonosító, ha az AppKey az Azure-függvény kontextusában van megadva, általában ez a kulcs neve
functionKey	string minLength: 0 maxLength: 500	(Nem kötelező) Hozzáférési kulcs hatóköre egy adott függvényhez

LongestIdleMode

Objektum

A feladatok a leghosszabb ideig tétlen feldolgozóhoz lesznek irányítva.

Name	Típus	Description
bypassSelectors	boolean	(Nem kötelező) Ha igaz értékre van állítva, akkor az útválasztó akkor is megfelel a dolgozóknak a feladatoknak, ha nem egyeznek a címkeválasztókkal. Figyelmeztetés: Előfordulhat, hogy a változó igaz értékre állításakor olyan dolgozókat is lekérhet, akik nem rendelkeznek a megfelelő feladattal. Ez a jelző inkább ideiglenes használatra szolgál. Alapértelmezés szerint false (hamis) értékre van állítva.
kind	string	A LongestIdleMode típuskriminatív leírása
maxConcurrentOffers	integer (int32)	Az aktív egyidejű ajánlatok maximális számát szabályozza.
minConcurrentOffers	integer (int32)	Az aktív egyidejű ajánlatok minimálisan kívánt számát szabályozza.

Oauth2ClientCredential

Objektum

A Contoso engedélyezési kiszolgálójának OAuth2.0 hitelesítő adatai. Hivatkozás: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/

Name	Típus	Description
clientId	string minLength: 0 maxLength: 500	A Contoso engedélyezési kiszolgáló ügyfélazonosítója.
clientSecret	string minLength: 0 maxLength: 500	A Contoso engedélyezési kiszolgáló ügyfélkódja.

RoundRobinMode

Objektum

A feladatok el vannak osztva a dolgozók között, kezdve azzal a feldolgozóval, aki az utolsó munkavégző után kap egy feladatot.

Name	Típus	Description
bypassSelectors	boolean	(Nem kötelező) Ha igaz értékre van állítva, akkor az útválasztó akkor is megfelel a dolgozóknak a feladatoknak, ha nem egyeznek a címkeválasztókkal. Figyelmeztetés: Előfordulhat, hogy a változó igaz értékre állításakor olyan dolgozókat is lekérhet, akik nem rendelkeznek a megfelelő feladattal. Ez a jelző inkább ideiglenes használatra szolgál. Alapértelmezés szerint false (hamis) értékre van állítva.
kind	string	A RoundRobinMode-t leíró típuskriminatív
maxConcurrentOffers	integer (int32)	Az aktív egyidejű ajánlatok maximális számát szabályozza.
minConcurrentOffers	integer (int32)	Az aktív egyidejű ajánlatok minimálisan kívánt számát szabályozza.

ScoringRuleOptions

Objektum

Beágyazza azokat a beállításokat, amelyek paraméterként átadhatók a pontozási szabályhoz a BestWorkerMode használatával

Name	Típus	Description
allowScoringBatchOfWorkers	boolean	(Nem kötelező) Ha igaz értékre van állítva, akkor a kötegekben lévő feldolgozók pontszámot kapnak, és a feldolgozócímkék paraméterneve `workers`lesz elküldve. Alapértelmezés szerint hamis értékre van állítva, és a munkavégző címkék paraméterneve `worker`lesz elküldve. Megjegyzés: Ha engedélyezve van, a BatchSize használatával állítsa be a köteg méretét.
batchSize	integer (int32)	(Nem kötelező) Állítsa be a köteg méretét, ha az AllowScoringBatchOfWorkers értéke igaz. Alapértelmezés szerint 20, ha nincs konfigurálva.
descendingOrder	boolean	(Nem kötelező) Ha hamis, a pontszámokat növekvő sorrend szerint rendezi. Alapértelmezés szerint igaz értékre van állítva.
scoringParameters	ScoringRuleParameterSelector[]	(Nem kötelező) Azon további paraméterek listája a feladatból, amelyeket a hasznos adat részeként küldünk el a pontozási szabálynak. Ha nincs beállítva, a rendszer alapértelmezés szerint hozzáadja a feladat címkéit (a hasznos adatokban `job`) és a feladat munkavégző választóit (a hasznos adatokban `selectors`) alapértelmezés szerint hozzáadja a pontozási szabály hasznos adataihoz. Megjegyzés: A munkavégző címkék mindig pontozási hasznos adatokkal lesznek elküldve.

ScoringRuleParameterSelector

Enumerálás

(Nem kötelező) Azon további paraméterek listája a feladatból, amelyeket a hasznos adat részeként küldünk el a pontozási szabálynak. Ha nincs beállítva, a rendszer alapértelmezés szerint hozzáadja a feladat címkéit (a hasznos adatokban job) és a feladat munkavégző választóit (a hasznos adatokban selectors) alapértelmezés szerint hozzáadja a pontozási szabály hasznos adataihoz. Megjegyzés: A munkavégző címkék mindig pontozási hasznos adatokkal lesznek elküldve.

Érték	Description
jobLabels
workerSelectors

StaticRouterRule

Objektum

Statikus szabályokat tartalmazó szabály, amely mindig ugyanazt az eredményt adja vissza, a bemenettől függetlenül.

Name	Típus	Description
kind	string	A StaticRouterRule-t leíró típuskriminatív
value	object	A szabály által visszaadott statikus érték.

WebhookRouterRule

Objektum

Egy külső webkiszolgálóhoz kötést biztosító szabály.

Name	Típus	Description
authorizationServerUri	string (uri)	Uri az engedélyezési kiszolgálóhoz.
clientCredential	Oauth2ClientCredential	A Contoso engedélyezési kiszolgálójának OAuth2.0 hitelesítő adatai. Hivatkozás: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
kind	string	A WebhookRouterRule-t leíró típuskriminatív
webhookUri	string (uri)	Uri a Contoso webkiszolgálóján.

Megosztás a következőn keresztül:

Job Router Administration - List Distribution Policies

URI-paraméterek

Válaszok

Példák

Get Distribution policies with pagination (max page size)

Mintakérelem

Mintaválasz

Definíciók

BestWorkerMode

DirectMapRouterRule

DistributionPolicy

DistributionPolicyCollection

DistributionPolicyItem

ExpressionRouterRule

ExpressionRouterRuleLanguage

FunctionRouterRule

FunctionRouterRuleCredential

LongestIdleMode

Oauth2ClientCredential

RoundRobinMode

ScoringRuleOptions

ScoringRuleParameterSelector

StaticRouterRule

WebhookRouterRule