Job Router Administration Operations - Get Distribution Policy

Riferimento

Servizio:: Communication

Versione API:: 2023-11-01

Recupera un criterio di distribuzione esistente in base all'ID.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
distributionPolicyId	path	True	string	ID di un criterio di distribuzione.
endpoint	path	True	string	URI della risorsa di comunicazione
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	DistributionPolicy	La richiesta ha avuto esito positivo. Intestazioni ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

DistributionPolicy

La richiesta ha avuto esito positivo.

Intestazioni

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Sicurezza

AadOauth2Auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome	Descrizione
https://communication.azure.com/.default

Esempio

Retrieves an existing distribution policy by Id

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

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

Definizioni

Nome	Descrizione
Azure.Core.Foundations.Error	Oggetto error.
Azure.Core.Foundations.ErrorResponse	Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
BestWorkerMode	I processi vengono distribuiti al lavoratore con le capacità più forti disponibili.
DirectMapRouterRule	Regola che restituisce le stesse etichette delle etichette di input.
DistributionModeKind	Discriminanti per i tipi di modalità di distribuzione supportati.
DistributionPolicy	Criteri che regolano il modo in cui i processi vengono distribuiti ai lavoratori
ExpressionRouterRule	Regola che fornisce regole di espressione inline.
ExpressionRouterRuleLanguage	Linguaggi di espressione disponibili che possono essere configurati.
FunctionRouterRule	Regola che fornisce un'associazione a una funzione di Azure attivata da HTTP.
FunctionRouterRuleCredential	Credenziali usate per accedere alla regola della funzione di Azure.
LongestIdleMode	I processi vengono indirizzati al lavoratore che è rimasto inattiva più a lungo.
OAuth2WebhookClientCredential	Credenziali OAuth2.0 usate per il server di autorizzazione di Contoso. Riferimento: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
RoundRobinMode	I processi vengono distribuiti per i ruoli di lavoro, a partire dal ruolo di lavoro successivo all'ultimo lavoratore per ricevere un processo.
RouterRuleKind	Discriminanti per i tipi di regola router supportati.
ScoringRuleOptions	Incapsula tutte le opzioni che possono essere passate come parametri per la regola di assegnazione dei punteggi con BestWorkerMode.
ScoringRuleParameterSelector	Parametri supportati per i ruoli di lavoro con punteggio usati con BestWorkerMode.
StaticRouterRule	Regola che fornisce regole statiche che restituiscono sempre lo stesso risultato, indipendentemente dall'input.
WebhookRouterRule	Regola che fornisce un'associazione a un server Web esterno.

Azure.Core.Foundations.Error

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Azure.Core.Foundations.Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	Azure.Core.Foundations.InnerError	Errore interno.

BestWorkerMode

I processi vengono distribuiti al lavoratore con le capacità più forti disponibili.

Nome	Tipo	Valore predefinito	Descrizione
bypassSelectors	boolean	False	Se impostato su true, il router corrisponderà ai ruoli di lavoro ai processi anche se non corrispondono ai selettori di etichetta. Avviso: è possibile che i ruoli di lavoro non qualificati per un processo corrispondano a se si imposta questa variabile su true. Questo flag è destinato all'utilizzo temporaneo. Per impostazione predefinita, impostare su false.
kind	string: bestWorker		Il discriminante del tipo che descrive un sottotipo di DistributionMode.
maxConcurrentOffers	integer	1	Determina il numero massimo di offerte simultanee attive che un processo può avere.
minConcurrentOffers	integer	1	Regola il numero minimo desiderato di offerte simultanee attive che un processo può avere.
scoringRule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule		Definire una regola di assegnazione dei punteggi da usare quando si calcola un punteggio per determinare il ruolo di lavoro migliore. Se non impostato, userà una formula di assegnazione dei punteggi predefinita che usa il numero di etichette di processo corrispondenti alle etichette di lavoro, nonché il numero di selettori di etichetta corrispondenti alle etichette di lavoro e/o superano usando una funzione logistica (https://en.wikipedia.org/wiki/Logistic_function).
scoringRuleOptions	ScoringRuleOptions		Opzioni per configurare 'scoringRule'. Se non è impostato, vengono usati i valori predefiniti.

DirectMapRouterRule

Regola che restituisce le stesse etichette delle etichette di input.

Nome	Tipo	Descrizione
kind	string: directMap	Il discriminante del tipo che descrive un sottotipo di RouterRule

DistributionModeKind

Discriminanti per i tipi di modalità di distribuzione supportati.

Nome	Tipo	Descrizione
bestWorker	string	Valore discriminatorio per BestWorkerMode.
longestIdle	string	Valore discriminatorio per LongestIdleMode.
roundRobin	string	Valore discriminatorio per RoundRobinMode.

DistributionPolicy

Criteri che regolano il modo in cui i processi vengono distribuiti ai lavoratori

Nome	Tipo	Descrizione
etag	string	Tag di entità per questa risorsa.
id	string	ID di un criterio di distribuzione.
mode	DistributionMode: BestWorkerMode LongestIdleMode RoundRobinMode	Modalità che regola il metodo di distribuzione specifico.
name	string	Nome descrittivo di questo criterio.
offerExpiresAfterSeconds	number	Numero di secondi dopo il quale tutte le offerte create in base a questo criterio verranno scadute.

ExpressionRouterRule

Regola che fornisce regole di espressione inline.

Nome	Tipo	Descrizione
expression	string	Espressione da valutare. Deve contenere un'istruzione return con valori calcolati.
kind	string: expression	Il discriminante del tipo che descrive un sottotipo di RouterRule
language	ExpressionRouterRuleLanguage	Linguaggio delle espressioni da compilare ed eseguire.

ExpressionRouterRuleLanguage

Linguaggi di espressione disponibili che possono essere configurati.

Nome	Tipo	Descrizione
powerFx	string	PowerFx

FunctionRouterRule

Regola che fornisce un'associazione a una funzione di Azure attivata da HTTP.

Nome	Tipo	Descrizione
credential	FunctionRouterRuleCredential	Credenziali usate per accedere alla regola della funzione di Azure.
functionUri	string	URL per la funzione di Azure.
kind	string: function	Il discriminante del tipo che descrive un sottotipo di RouterRule

FunctionRouterRuleCredential

Credenziali usate per accedere alla regola della funzione di Azure.

Nome	Tipo	Descrizione
appKey	string	Chiave di accesso con ambito a un'app per le funzioni di Azure. Questa chiave concede l'accesso a tutte le funzioni nell'app.
clientId	string	ID client, quando AppKey viene fornito Nel contesto della funzione di Azure, questo è in genere il nome della chiave.
functionKey	string	Chiave di accesso con ambito a una funzione specifica.

LongestIdleMode

I processi vengono indirizzati al lavoratore che è rimasto inattiva più a lungo.

Nome	Tipo	Valore predefinito	Descrizione
bypassSelectors	boolean	False	Se impostato su true, il router corrisponderà ai ruoli di lavoro ai processi anche se non corrispondono ai selettori di etichetta. Avviso: è possibile che i ruoli di lavoro non qualificati per un processo corrispondano a se si imposta questa variabile su true. Questo flag è destinato all'utilizzo temporaneo. Per impostazione predefinita, impostare su false.
kind	string: longestIdle		Il discriminante del tipo che descrive un sottotipo di DistributionMode.
maxConcurrentOffers	integer	1	Determina il numero massimo di offerte simultanee attive che un processo può avere.
minConcurrentOffers	integer	1	Regola il numero minimo desiderato di offerte simultanee attive che un processo può avere.

OAuth2WebhookClientCredential

Credenziali OAuth2.0 usate per il server di autorizzazione di Contoso. Riferimento: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/

Nome	Tipo	Descrizione
clientId	string	ClientId per il server di autorizzazione Contoso.
clientSecret	string	Segreto client per il server di autorizzazione Contoso.

RoundRobinMode

I processi vengono distribuiti per i ruoli di lavoro, a partire dal ruolo di lavoro successivo all'ultimo lavoratore per ricevere un processo.

Nome	Tipo	Valore predefinito	Descrizione
bypassSelectors	boolean	False	Se impostato su true, il router corrisponderà ai ruoli di lavoro ai processi anche se non corrispondono ai selettori di etichetta. Avviso: è possibile che i ruoli di lavoro non qualificati per un processo corrispondano a se si imposta questa variabile su true. Questo flag è destinato all'utilizzo temporaneo. Per impostazione predefinita, impostare su false.
kind	string: roundRobin		Il discriminante del tipo che descrive un sottotipo di DistributionMode.
maxConcurrentOffers	integer	1	Determina il numero massimo di offerte simultanee attive che un processo può avere.
minConcurrentOffers	integer	1	Regola il numero minimo desiderato di offerte simultanee attive che un processo può avere.

RouterRuleKind

Discriminanti per i tipi di regola router supportati.

Nome	Tipo	Descrizione
directMap	string	Valore discriminatorio per DirectMapRouterRule.
expression	string	Valore discriminatorio per ExpressionRouterRule.
function	string	Valore discriminatorio per FunctionRouterRule.
static	string	Valore discriminatorio per StaticRouterRule.
webhook	string	Valore discriminatorio per WebhookRouterRule.

ScoringRuleOptions

Incapsula tutte le opzioni che possono essere passate come parametri per la regola di assegnazione dei punteggi con BestWorkerMode.

Nome	Tipo	Valore predefinito	Descrizione
batchSize	integer	20	Impostare le dimensioni del batch quando 'isBatchScoringEnabled' è impostato su true. Il valore predefinito è 20 se non è configurato.
descendingOrder	boolean	True	Se false, ordina i punteggi in base all'ordine crescente. Per impostazione predefinita, impostare su true.
isBatchScoringEnabled	boolean	False	Se impostato su true, assegna un punteggio ai ruoli di lavoro in batch e il nome del parametro delle etichette di lavoro verrà inviato come `workers`. Per impostazione predefinita, impostare su false e il nome del parametro per le etichette di lavoro verrà inviato come `worker`. Nota: se abilitata, usare 'batchSize' per impostare le dimensioni del batch.
scoringParameters	ScoringRuleParameterSelector[]	[ "jobLabels", "workerSelectors" ]	Elenco di parametri aggiuntivi da un processo che verrà inviato come parte del payload alla regola di assegnazione dei punteggi. Se non è impostata, le etichette di un processo (inviate nel payload come `job`) e i selettori di lavoro di un processo (inviati nel payload come `selectors`) vengono aggiunti al payload della regola di assegnazione dei punteggi per impostazione predefinita. Nota: le etichette del ruolo di lavoro vengono sempre inviate con il payload di assegnazione dei punteggi.

ScoringRuleParameterSelector

Parametri supportati per i ruoli di lavoro con punteggio usati con BestWorkerMode.

Nome	Tipo	Descrizione
jobLabels	string	Parametro per aggiungere etichette di processo al payload di assegnazione dei punteggi. La proprietà viene inviata come `job`.
workerSelectors	string	Parametro per aggiungere selettori di lavoro da un processo al payload di assegnazione dei punteggi. La proprietà viene inviata come `selectors`.

StaticRouterRule

Regola che fornisce regole statiche che restituiscono sempre lo stesso risultato, indipendentemente dall'input.

Nome	Tipo	Descrizione
kind	string: static	Il discriminante del tipo che descrive un sottotipo di RouterRule
value		Il valore statico restituito da questa regola. I valori devono essere valori primitivi: numero, stringa, booleano.

WebhookRouterRule

Regola che fornisce un'associazione a un server Web esterno.

Nome	Tipo	Descrizione
authorizationServerUri	string	URI per il server di autorizzazione.
clientCredential	OAuth2WebhookClientCredential	Credenziali OAuth2.0 usate per il server di autorizzazione di Contoso. Riferimento: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
kind	string: webhook	Il discriminante del tipo che descrive un sottotipo di RouterRule
webhookUri	string	Uri per il server Web di Contoso.

Condividi tramite

Job Router Administration Operations - Get Distribution Policy

Parametri dell'URI

Risposte

Sicurezza

AadOauth2Auth

Ambiti

Esempio

Retrieves an existing distribution policy by Id

Esempio di richiesta

Risposta di esempio

Definizioni

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

Risorse aggiuntive