Sdílet prostřednictvím


Job Router Administration Operations - Upsert Distribution Policy

Vytvoří nebo aktualizuje zásady distribuce.

PATCH {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

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Media Types: "application/merge-patch+json"

Name Vyžadováno Typ Description
If-Match

string

Požadavek by měl pokračovat pouze v případě, že entita odpovídá tomuto řetězci.

If-Unmodified-Since

string

date-time-rfc7231

Požadavek by měl pokračovat pouze v případě, že po této době nebyla entita změněna.

Text požadavku

Media Types: "application/merge-patch+json"

Name Typ Description
mode DistributionModeCreateOrUpdate:

Režim řízení konkrétní metody distribuce

name

string

Popisný název této zásady

offerExpiresAfterSeconds

number

Počet sekund, po jejichž uplynutí vyprší platnost všech nabídek vytvořených v rámci této zásady.

Odpovědi

Name Typ Description
200 OK

DistributionPolicy

Požadavek byl úspěšný.

Hlavičky

  • ETag: string
  • Last-Modified: string
201 Created

DistributionPolicy

Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

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

Creates a Distribution policy
Updates a distribution policy

Creates a Distribution policy

Ukázkový požadavek

PATCH https://contoso.westus.communications.azure.com/routing/distributionPolicies/d9033d56-659c-437a-b5b7-4f3b14301dd4?api-version=2023-11-01

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

Ukázková odpověď

{
  "id": "d9033d56-659c-437a-b5b7-4f3b14301dd4",
  "name": "Main",
  "offerExpiresAfterSeconds": 300,
  "mode": {
    "kind": "longestIdle",
    "minConcurrentOffers": 1,
    "maxConcurrentOffers": 5,
    "bypassSelectors": false
  },
  "etag": "etag"
}
{
  "id": "d9033d56-659c-437a-b5b7-4f3b14301dd4",
  "name": "Main",
  "offerExpiresAfterSeconds": 300,
  "mode": {
    "kind": "longestIdle",
    "minConcurrentOffers": 1,
    "maxConcurrentOffers": 5,
    "bypassSelectors": false
  },
  "etag": "etag"
}

Updates a distribution policy

Ukázkový požadavek

PATCH https://contoso.westus.communications.azure.com/routing/distributionPolicies/d9033d56-659c-437a-b5b7-4f3b14301dd4?api-version=2023-11-01

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

Ukázková odpověď

{
  "id": "d9033d56-659c-437a-b5b7-4f3b14301dd4",
  "name": "Main",
  "offerExpiresAfterSeconds": 300,
  "mode": {
    "kind": "longestIdle",
    "minConcurrentOffers": 1,
    "maxConcurrentOffers": 5,
    "bypassSelectors": false
  },
  "etag": "etag"
}
{
  "id": "d9033d56-659c-437a-b5b7-4f3b14301dd4",
  "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.

BestWorkerModeCreateOrUpdate

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

DirectMapRouterRule

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

DirectMapRouterRuleCreateOrUpdate

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

DistributionPolicyCreateOrUpdate

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

ExpressionRouterRule

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

ExpressionRouterRuleCreateOrUpdate

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

FunctionRouterRuleCreateOrUpdate

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ý.

LongestIdleModeCreateOrUpdate

Ú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.

RoundRobinModeCreateOrUpdate

Ú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.

StaticRouterRuleCreateOrUpdate

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.

WebhookRouterRuleCreateOrUpdate

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

Azure.Core.Foundations.Error

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

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

Name Typ Description
error

Azure.Core.Foundations.Error

Objekt chyby.

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.

Name Typ Description
code

string

Jedna ze serverově definovaných kódů chyb.

innererror

Azure.Core.Foundations.InnerError

Vnitřní chyba.

BestWorkerMode

Ú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

1

Určuje maximální počet aktivních souběžných nabídek, které může mít úloha.

minConcurrentOffers

integer

1

Určuje minimální požadovaný počet aktivních souběžných nabídek, které může mít úloha.

scoringRule RouterRule:

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.

BestWorkerModeCreateOrUpdate

Ú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

1

Určuje maximální počet aktivních souběžných nabídek, které může mít úloha.

minConcurrentOffers

integer

1

Určuje minimální požadovaný počet aktivních souběžných nabídek, které může mít úloha.

scoringRule RouterRuleCreateOrUpdate:

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

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

Name Typ Description
kind string:

directMap

Typ diskriminující popis podtypu RouterRule

DirectMapRouterRuleCreateOrUpdate

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

Name Typ Description
kind string:

directMap

Typ diskriminující popis podtypu RouterRule

DistributionModeKind

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

Name Typ Description
bestWorker

string

Diskriminující hodnota pro BestWorkerMode.

longestIdle

string

Diskriminující hodnota pro LongestIdleMode.

roundRobin

string

Diskriminační hodnota pro RoundRobinMode.

DistributionPolicy

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:

Režim řízení konkrétní metody distribuce

name

string

Popisný název této zásady

offerExpiresAfterSeconds

number

Počet sekund, po jejichž uplynutí vyprší platnost všech nabídek vytvořených v rámci této zásady.

DistributionPolicyCreateOrUpdate

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

Name Typ Description
mode DistributionModeCreateOrUpdate:

Režim řízení konkrétní metody distribuce

name

string

Popisný název této zásady

offerExpiresAfterSeconds

number

Počet sekund, po jejichž uplynutí vyprší platnost všech nabídek vytvořených v rámci této zásady.

ExpressionRouterRule

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í.

ExpressionRouterRuleCreateOrUpdate

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

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

Name Typ Description
powerFx

string

PowerFx

FunctionRouterRule

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

Adresa URL pro funkci Azure Functions

kind string:

function

Typ diskriminující popis podtypu RouterRule

FunctionRouterRuleCreateOrUpdate

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

Adresa URL pro funkci Azure Functions

kind string:

function

Typ diskriminující popis podtypu RouterRule

FunctionRouterRuleCredential

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

Ú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

1

Určuje maximální počet aktivních souběžných nabídek, které může mít úloha.

minConcurrentOffers

integer

1

Určuje minimální požadovaný počet aktivních souběžných nabídek, které může mít úloha.

LongestIdleModeCreateOrUpdate

Ú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

1

Určuje maximální počet aktivních souběžných nabídek, které může mít úloha.

minConcurrentOffers

integer

1

Určuje minimální požadovaný počet aktivních souběžných nabídek, které může mít úloha.

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/

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

Ú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

1

Určuje maximální počet aktivních souběžných nabídek, které může mít úloha.

minConcurrentOffers

integer

1

Určuje minimální požadovaný počet aktivních souběžných nabídek, které může mít úloha.

RoundRobinModeCreateOrUpdate

Ú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

1

Určuje maximální počet aktivních souběžných nabídek, které může mít úloha.

minConcurrentOffers

integer

1

Určuje minimální požadovaný počet aktivních souběžných nabídek, které může mít úloha.

RouterRuleKind

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

Name Typ Description
directMap

string

Diskriminující hodnota pro DirectMapRouterRule.

expression

string

Diskriminující hodnota pro ExpressionRouterRule.

function

string

Diskriminující hodnota pro FunctionRouterRule.

static

string

Diskriminující hodnota pro StaticRouterRule.

webhook

string

Diskriminující hodnota pro WebhookRouterRule.

ScoringRuleOptions

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

Name Typ Default value Description
batchSize

integer

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 workerodeš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

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

Name Typ Description
jobLabels

string

Parametr pro přidání popisků úloh do datové části bodování Vlastnost je odeslána jako job.

workerSelectors

string

Parametr pro přidání selektorů pracovního procesu z úlohy do datové části bodování Vlastnost je odeslána jako selectors.

StaticRouterRule

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.

StaticRouterRuleCreateOrUpdate

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

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

Name Typ Description
authorizationServerUri

string

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

Identifikátor URI webového serveru společnosti Contoso.

WebhookRouterRuleCreateOrUpdate

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

Name Typ Description
authorizationServerUri

string

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

Identifikátor URI webového serveru společnosti Contoso.