Job Router Administration Operations - Get Distribution Policy

Referência

Serviço:: Communication

Versão da API:: 2023-11-01

Recupera uma política de distribuição existente por Id.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
distributionPolicyId	path	True	string	ID de uma política de distribuição.
endpoint	path	True	string	Uri do seu recurso de comunicação
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	DistributionPolicy	A solicitação foi bem-sucedida. Cabeçalhos ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

DistributionPolicy

A solicitação foi bem-sucedida.

Cabeçalhos

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

AadOauth2Auth

O fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Exemplos

Retrieves an existing distribution policy by Id

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

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

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
BestWorkerMode	Os trabalhos são distribuídos para o trabalhador com as habilidades mais fortes disponíveis.
DirectMapRouterRule	Uma regra que retorna os mesmos rótulos que os rótulos de entrada.
DistributionModeKind	Discriminadores para tipos de modo de distribuição com suporte.
DistributionPolicy	Política que rege como os trabalhos são distribuídos aos trabalhadores
ExpressionRouterRule	Uma regra que fornece regras de expressão embutidas.
ExpressionRouterRuleLanguage	Idiomas de expressão disponíveis que podem ser configurados.
FunctionRouterRule	Uma regra que fornece uma associação a uma função do Azure disparada por HTTP.
FunctionRouterRuleCredential	Credenciais usadas para acessar a regra de função do Azure.
LongestIdleMode	Os trabalhos são direcionados ao trabalhador que está ocioso há mais tempo.
OAuth2WebhookClientCredential	Credenciais OAuth2.0 usadas para o servidor de Autorização da Contoso. Referência: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
RoundRobinMode	Os trabalhos são distribuídos para os trabalhadores, começando pelo trabalhador que está após o último trabalho a receber um trabalho.
RouterRuleKind	Discriminadores para tipos de regra de roteador com suporte.
ScoringRuleOptions	Encapsula todas as opções que podem ser passadas como parâmetros para a regra de pontuação com BestWorkerMode.
ScoringRuleParameterSelector	Parâmetros com suporte para pontuar trabalhos usados com BestWorkerMode.
StaticRouterRule	Uma regra que fornece regras estáticas que sempre retornam o mesmo resultado, independentemente da entrada.
WebhookRouterRule	Uma regra que fornece uma associação a um servidor Web externo.

Azure.Core.Foundations.Error

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

BestWorkerMode

Os trabalhos são distribuídos para o trabalhador com as habilidades mais fortes disponíveis.

Nome	Tipo	Valor padrão	Description
bypassSelectors	boolean	False	Se definido como true, o roteador corresponderá os trabalhadores aos trabalhos, mesmo que eles não correspondam aos seletores de rótulo. Aviso: você pode obter trabalhadores que não estão qualificados para um trabalho com o qual eles são correspondidos se você definir essa variável como true. Esse sinalizador destina-se mais ao uso temporário. Por padrão, defina como false.
kind	string: bestWorker		O tipo discriminatório que descreve um subtipo de DistributionMode.
maxConcurrentOffers	integer	1	Controla o número máximo de ofertas simultâneas ativas que um trabalho pode ter.
minConcurrentOffers	integer	1	Rege o número mínimo desejado de ofertas simultâneas ativas que um trabalho pode ter.
scoringRule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule		Defina uma regra de pontuação a ser usada ao calcular uma pontuação para determinar o melhor trabalho. Se não estiver definido, usará uma fórmula de pontuação padrão que usa o número de rótulos de trabalho que os rótulos de trabalho correspondem, bem como o número de seletores de rótulo que os rótulos de trabalho correspondem e/ou excedem usando uma função logística (https://en.wikipedia.org/wiki/Logistic_function).
scoringRuleOptions	ScoringRuleOptions		Opções para configurar 'scoreRule'. Se não for definido, os valores padrão serão usados.

DirectMapRouterRule

Uma regra que retorna os mesmos rótulos que os rótulos de entrada.

Nome	Tipo	Description
kind	string: directMap	O tipo discriminatório que descreve um subtipo de RouterRule

DistributionModeKind

Discriminadores para tipos de modo de distribuição com suporte.

Nome	Tipo	Description
bestWorker	string	Valor discriminatório para BestWorkerMode.
longestIdle	string	Valor discriminatório para LongestIdleMode.
roundRobin	string	Valor discriminatório para RoundRobinMode.

DistributionPolicy

Política que rege como os trabalhos são distribuídos aos trabalhadores

Nome	Tipo	Description
etag	string	A marca de entidade para esse recurso.
id	string	ID de uma política de distribuição.
mode	DistributionMode: BestWorkerMode LongestIdleMode RoundRobinMode	Modo que rege o método de distribuição específico.
name	string	Nome amigável desta política.
offerExpiresAfterSeconds	number	O número de segundos após o qual todas as ofertas criadas sob essa política expirarão.

ExpressionRouterRule

Uma regra que fornece regras de expressão embutidas.

Nome	Tipo	Description
expression	string	Uma expressão a ser avaliada. Deve conter a instrução return com valores calculados.
kind	string: expression	O tipo discriminatório que descreve um subtipo de RouterRule
language	ExpressionRouterRuleLanguage	A linguagem de expressão a ser compilada e executada.

ExpressionRouterRuleLanguage

Idiomas de expressão disponíveis que podem ser configurados.

Nome	Tipo	Description
powerFx	string	PowerFx

FunctionRouterRule

Uma regra que fornece uma associação a uma função do Azure disparada por HTTP.

Nome	Tipo	Description
credential	FunctionRouterRuleCredential	Credenciais usadas para acessar a regra de função do Azure.
functionUri	string	URL para a Função do Azure.
kind	string: function	O tipo discriminatório que descreve um subtipo de RouterRule

FunctionRouterRuleCredential

Credenciais usadas para acessar a regra de função do Azure.

Nome	Tipo	Description
appKey	string	Chave de acesso com escopo para um aplicativo de funções do Azure. Essa chave concede acesso a todas as funções no aplicativo.
clientId	string	ID do cliente, quando AppKey é fornecido no contexto da função do Azure, geralmente esse é o nome da chave.
functionKey	string	Chave de acesso com escopo para uma função específica.

LongestIdleMode

Os trabalhos são direcionados ao trabalhador que está ocioso há mais tempo.

Nome	Tipo	Valor padrão	Description
bypassSelectors	boolean	False	Se definido como true, o roteador corresponderá os trabalhadores aos trabalhos, mesmo que eles não correspondam aos seletores de rótulo. Aviso: você pode obter trabalhadores que não estão qualificados para um trabalho com o qual eles são correspondidos se você definir essa variável como true. Esse sinalizador destina-se mais ao uso temporário. Por padrão, defina como false.
kind	string: longestIdle		O tipo discriminatório que descreve um subtipo de DistributionMode.
maxConcurrentOffers	integer	1	Controla o número máximo de ofertas simultâneas ativas que um trabalho pode ter.
minConcurrentOffers	integer	1	Rege o número mínimo desejado de ofertas simultâneas ativas que um trabalho pode ter.

OAuth2WebhookClientCredential

Credenciais OAuth2.0 usadas para o servidor de Autorização da Contoso. Referência: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/

Nome	Tipo	Description
clientId	string	ClientId para o servidor de autorização da Contoso.
clientSecret	string	Segredo do cliente para o servidor de Autorização da Contoso.

RoundRobinMode

Os trabalhos são distribuídos para os trabalhadores, começando pelo trabalhador que está após o último trabalho a receber um trabalho.

Nome	Tipo	Valor padrão	Description
bypassSelectors	boolean	False	Se definido como true, o roteador corresponderá os trabalhadores aos trabalhos, mesmo que eles não correspondam aos seletores de rótulo. Aviso: você pode obter trabalhadores que não estão qualificados para um trabalho com o qual eles são correspondidos se você definir essa variável como true. Esse sinalizador destina-se mais ao uso temporário. Por padrão, defina como false.
kind	string: roundRobin		O tipo discriminatório que descreve um subtipo de DistributionMode.
maxConcurrentOffers	integer	1	Controla o número máximo de ofertas simultâneas ativas que um trabalho pode ter.
minConcurrentOffers	integer	1	Rege o número mínimo desejado de ofertas simultâneas ativas que um trabalho pode ter.

RouterRuleKind

Discriminadores para tipos de regra de roteador com suporte.

Nome	Tipo	Description
directMap	string	Valor discriminatório para DirectMapRouterRule.
expression	string	Valor discriminatório para ExpressionRouterRule.
function	string	Valor discriminatório para FunctionRouterRule.
static	string	Valor discriminatório para StaticRouterRule.
webhook	string	Valor discriminatório para WebhookRouterRule.

ScoringRuleOptions

Encapsula todas as opções que podem ser passadas como parâmetros para a regra de pontuação com BestWorkerMode.

Nome	Tipo	Valor padrão	Description
batchSize	integer	20	Defina o tamanho do lote quando 'isBatchScoringEnabled' for definido como true. O padrão é 20 se não estiver configurado.
descendingOrder	boolean	True	Se false, classificará as pontuações por ordem crescente. Por padrão, defina como true.
isBatchScoringEnabled	boolean	False	Se definido como true, pontuará os trabalhos em lotes e o nome do parâmetro dos rótulos de trabalho será enviado como `workers`. Por padrão, defina como false e o nome do parâmetro para os rótulos de trabalho será enviado como `worker`. Observação: se habilitado, use 'batchSize' para definir o tamanho do lote.
scoringParameters	ScoringRuleParameterSelector[]	[ "jobLabels", "workerSelectors" ]	Lista de parâmetros extras de um trabalho que será enviado como parte do conteúdo para a regra de pontuação. Se não for definido, os rótulos de um trabalho (enviados na carga como `job`) e os seletores de trabalho de um trabalho (enviados no conteúdo como `selectors`) serão adicionados ao conteúdo da regra de pontuação por padrão. Observação: os rótulos de trabalho são sempre enviados com carga de pontuação.

ScoringRuleParameterSelector

Parâmetros com suporte para pontuar trabalhos usados com BestWorkerMode.

Nome	Tipo	Description
jobLabels	string	Parâmetro para adicionar rótulos de trabalho ao conteúdo de pontuação. A propriedade é enviada como `job`.
workerSelectors	string	Parâmetro para adicionar seletores de trabalho de um trabalho à carga de pontuação. A propriedade é enviada como `selectors`.

StaticRouterRule

Uma regra que fornece regras estáticas que sempre retornam o mesmo resultado, independentemente da entrada.

Nome	Tipo	Description
kind	string: static	O tipo discriminatório que descreve um subtipo de RouterRule
value		O valor estático que essa regra sempre retorna. Os valores devem ser valores primitivos - número, cadeia de caracteres, booliano.

WebhookRouterRule

Uma regra que fornece uma associação a um servidor Web externo.

Nome	Tipo	Description
authorizationServerUri	string	Uri para Servidor de Autorização.
clientCredential	OAuth2WebhookClientCredential	Credenciais OAuth2.0 usadas para o servidor de Autorização da Contoso. Referência: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
kind	string: webhook	O tipo discriminatório que descreve um subtipo de RouterRule
webhookUri	string	Uri para o Servidor Web da Contoso.

Compartilhar via

Job Router Administration Operations - Get Distribution Policy

Parâmetros de URI

Respostas

Segurança

AadOauth2Auth

Escopos

Exemplos

Retrieves an existing distribution policy by Id

Solicitação de exemplo

Resposta de exemplo

Definições

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

Recursos adicionais