Job Router Administration Operations - Get Classification Policy

Referência

Serviço:: Communication

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

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

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
classificationPolicyId	path	True	string	ID de uma política de classificaçã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	ClassificationPolicy	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

ClassificationPolicy

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

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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"
}

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.
ClassificationPolicy	Um contêiner para as regras que regem como os trabalhos são classificados.
ConditionalQueueSelectorAttachment	Descreve um conjunto de seletores de fila que serão anexados se a condição determinada for resolvida como true.
ConditionalWorkerSelectorAttachment	Descreve um conjunto de seletores de trabalho que serão anexados se a condição determinada for resolvida como true.
DirectMapRouterRule	Uma regra que retorna os mesmos rótulos que os rótulos de entrada.
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.
LabelOperator	Descreve as operações com suporte em valores de rótulo.
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/
PassThroughQueueSelectorAttachment	Anexa um seletor de fila em que o valor é passado do rótulo de um trabalho com a mesma chave.
PassThroughWorkerSelectorAttachment	Anexa um seletor de trabalho em que o valor é passado do rótulo de um trabalho com a mesma chave.
QueueSelectorAttachmentKind	Discriminadores para tipos de anexo de seletor de fila com suporte.
QueueWeightedAllocation	Contém o percentual de peso e os seletores de fila a serem aplicados se selecionados para distribuições ponderadas.
RouterQueueSelector	Descreve uma condição que deve ser atendida em relação a um conjunto de rótulos para seleção de fila.
RouterRuleKind	Discriminadores para tipos de regra de roteador com suporte.
RouterWorkerSelector	Descreve uma condição que deve ser atendida em relação a um conjunto de rótulos para seleção de trabalho.
RouterWorkerSelectorStatus	Descreve o status de um seletor de trabalho.
RuleEngineQueueSelectorAttachment	Anexa seletores de fila a um trabalho quando o RouterRule é resolvido.
RuleEngineWorkerSelectorAttachment	Anexa seletores de trabalho a um trabalho quando um RouterRule é resolvido.
StaticQueueSelectorAttachment	Descreve um seletor de fila que será anexado a um trabalho.
StaticRouterRule	Uma regra que fornece regras estáticas que sempre retornam o mesmo resultado, independentemente da entrada.
StaticWorkerSelectorAttachment	Descreve um seletor de trabalho que será anexado a um trabalho.
WebhookRouterRule	Uma regra que fornece uma associação a um servidor Web externo.
WeightedAllocationQueueSelectorAttachment	Descreve vários conjuntos de seletores de fila, dos quais um será selecionado e anexado de acordo com uma ponderação.
WeightedAllocationWorkerSelectorAttachment	Descreve vários conjuntos de seletores de trabalho, dos quais um será selecionado e anexado de acordo com uma ponderação.
WorkerSelectorAttachmentKind	Discriminadores para tipos de anexo de seletor de trabalho com suporte.
WorkerWeightedAllocation	Contém o percentual de peso e os seletores de trabalho a serem aplicados se selecionados para distribuições ponderadas.

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.

ClassificationPolicy

Um contêiner para as regras que regem como os trabalhos são classificados.

Nome	Tipo	Description
etag	string	A marca de entidade para esse recurso.
fallbackQueueId	string	ID de uma fila de fallback para selecionar se os anexos do seletor de fila não encontrarem uma correspondência.
id	string	ID de uma política de classificação.
name	string	Nome amigável desta política.
prioritizationRule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	Uma regra para determinar uma pontuação de prioridade para um trabalho.
queueSelectorAttachments	QueueSelectorAttachment[]: ConditionalQueueSelectorAttachment[] PassThroughQueueSelectorAttachment[] RuleEngineQueueSelectorAttachment[] StaticQueueSelectorAttachment[] WeightedAllocationQueueSelectorAttachment[]	Anexos do seletor de fila usados para resolver uma fila para um trabalho.
workerSelectorAttachments	WorkerSelectorAttachment[]: ConditionalWorkerSelectorAttachment[] PassThroughWorkerSelectorAttachment[] RuleEngineWorkerSelectorAttachment[] StaticWorkerSelectorAttachment[] WeightedAllocationWorkerSelectorAttachment[]	Anexos do seletor de trabalho usados para anexar seletores de trabalho a um trabalho.

ConditionalQueueSelectorAttachment

Descreve um conjunto de seletores de fila que serão anexados se a condição determinada for resolvida como true.

Nome	Tipo	Description
condition	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	A condição que deve ser verdadeira para que os seletores de fila sejam anexados.
kind	string: conditional	O tipo discriminatório que descreve um subtipo de QueueSelectorAttachment.
queueSelectors	RouterQueueSelector[]	Os seletores de fila a serem anexados.

ConditionalWorkerSelectorAttachment

Descreve um conjunto de seletores de trabalho que serão anexados se a condição determinada for resolvida como true.

Nome	Tipo	Description
condition	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	A condição que deve ser verdadeira para que os seletores de trabalho sejam anexados.
kind	string: conditional	O tipo discriminatório que descreve um subtipo de WorkerSelectorAttachment.
workerSelectors	RouterWorkerSelector[]	Os seletores de trabalho a serem anexados.

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

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.

LabelOperator

Descreve as operações com suporte em valores de rótulo.

Nome	Tipo	Description
equal	string	Igual.
greaterThan	string	Maior que.
greaterThanOrEqual	string	Maior ou igual.
lessThan	string	Menor que.
lessThanOrEqual	string	Menor ou igual.
notEqual	string	Não é igual.

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.

PassThroughQueueSelectorAttachment

Anexa um seletor de fila em que o valor é passado do rótulo de um trabalho com a mesma chave.

Nome	Tipo	Description
key	string	A chave de rótulo com a qual consultar.
kind	string: passThrough	O tipo discriminatório que descreve um subtipo de QueueSelectorAttachment.
labelOperator	LabelOperator	Descreve como o valor do rótulo é comparado ao valor passado.

PassThroughWorkerSelectorAttachment

Anexa um seletor de trabalho em que o valor é passado do rótulo de um trabalho com a mesma chave.

Nome	Tipo	Description
expiresAfterSeconds	number	Descreve por quanto tempo o seletor de rótulo anexado é válido em segundos.
key	string	A chave de rótulo com a qual consultar.
kind	string: passThrough	O tipo discriminatório que descreve um subtipo de WorkerSelectorAttachment.
labelOperator	LabelOperator	Descreve como o valor do rótulo é comparado ao valor passado.

QueueSelectorAttachmentKind

Discriminadores para tipos de anexo de seletor de fila com suporte.

Nome	Tipo	Description
conditional	string	Valor discriminatório para ConditionalQueueSelectorAttachment.
passThrough	string	Valor discriminatório para PassThroughQueueSelectorAttachment.
ruleEngine	string	Valor discriminatório para RuleEngineQueueSelectorAttachment.
static	string	Valor discriminatório para StaticQueueSelectorAttachment.
weightedAllocation	string	Valor discriminatório para WeightedAllocationQueueSelectorAttachment.

QueueWeightedAllocation

Contém o percentual de peso e os seletores de fila a serem aplicados se selecionados para distribuições ponderadas.

Nome	Tipo	Description
queueSelectors	RouterQueueSelector[]	Uma coleção de seletores de fila que serão aplicados se essa alocação for selecionada.
weight	number	O percentual desse peso, expresso como uma fração de 1.

RouterQueueSelector

Descreve uma condição que deve ser atendida em relação a um conjunto de rótulos para seleção de fila.

Nome	Tipo	Description
key	string	A chave de rótulo com a qual consultar.
labelOperator	LabelOperator	Descreve como o valor do rótulo é comparado ao valor definido no seletor de rótulo.
value		O valor a ser comparado com o valor real do rótulo com o operador fornecido. Os valores devem ser valores primitivos - número, cadeia de caracteres, booliano.

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.

RouterWorkerSelector

Descreve uma condição que deve ser atendida em relação a um conjunto de rótulos para seleção de trabalho.

Nome	Tipo	Description
expedite	boolean	Envia um trabalho para a frente da fila enquanto esse seletor estiver ativo.
expiresAfterSeconds	number	Descreve por quanto tempo esse seletor de rótulo é válido em segundos.
expiresAt	string	O momento em que esse seletor de trabalho expira em UTC.
key	string	A chave de rótulo com a qual consultar.
labelOperator	LabelOperator	Descreve como o valor do rótulo é comparado ao valor definido no seletor de trabalho.
status	RouterWorkerSelectorStatus	Status do seletor de trabalho.
value		O valor a ser comparado com o valor real do rótulo com o operador fornecido. Os valores devem ser valores primitivos - número, cadeia de caracteres, booliano.

RouterWorkerSelectorStatus

Descreve o status de um seletor de trabalho.

Nome	Tipo	Description
active	string	O seletor de trabalho é válido.
expired	string	O seletor de trabalho não é válido.

RuleEngineQueueSelectorAttachment

Anexa seletores de fila a um trabalho quando o RouterRule é resolvido.

Nome	Tipo	Description
kind	string: ruleEngine	O tipo discriminatório que descreve um subtipo de QueueSelectorAttachment.
rule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	Um RouterRule que resolve uma coleção de seletores de fila a serem anexados.

RuleEngineWorkerSelectorAttachment

Anexa seletores de trabalho a um trabalho quando um RouterRule é resolvido.

Nome	Tipo	Description
kind	string: ruleEngine	O tipo discriminatório que descreve um subtipo de WorkerSelectorAttachment.
rule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	Um RouterRule que resolve uma coleção de seletores de trabalho a serem anexados.

StaticQueueSelectorAttachment

Descreve um seletor de fila que será anexado a um trabalho.

Nome	Tipo	Description
kind	string: static	O tipo discriminatório que descreve um subtipo de QueueSelectorAttachment.
queueSelector	RouterQueueSelector	O seletor de fila a ser anexado.

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.

StaticWorkerSelectorAttachment

Descreve um seletor de trabalho que será anexado a um trabalho.

Nome	Tipo	Description
kind	string: static	O tipo discriminatório que descreve um subtipo de WorkerSelectorAttachment.
workerSelector	RouterWorkerSelector	O seletor de trabalho a ser anexado.

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.

WeightedAllocationQueueSelectorAttachment

Descreve vários conjuntos de seletores de fila, dos quais um será selecionado e anexado de acordo com uma ponderação.

Nome	Tipo	Description
allocations	QueueWeightedAllocation[]	Uma coleção de alocações ponderadas baseadas em porcentagem.
kind	string: weightedAllocation	O tipo discriminatório que descreve um subtipo de QueueSelectorAttachment.

WeightedAllocationWorkerSelectorAttachment

Descreve vários conjuntos de seletores de trabalho, dos quais um será selecionado e anexado de acordo com uma ponderação.

Nome	Tipo	Description
allocations	WorkerWeightedAllocation[]	Uma coleção de alocações ponderadas baseadas em porcentagem.
kind	string: weightedAllocation	O tipo discriminatório que descreve um subtipo de WorkerSelectorAttachment.

WorkerSelectorAttachmentKind

Discriminadores para tipos de anexo de seletor de trabalho com suporte.

Nome	Tipo	Description
conditional	string	Valor discriminatório para ConditionalWorkerSelectorAttachment.
passThrough	string	Valor discriminatório para PassThroughWorkerSelectorAttachment.
ruleEngine	string	Valor discriminatório para RuleEngineWorkerSelectorAttachment.
static	string	Valor discriminatório para StaticWorkerSelectorAttachment.
weightedAllocation	string	Valor discriminatório para WeightedAllocationWorkerSelectorAttachment.

WorkerWeightedAllocation

Contém o percentual de peso e os seletores de trabalho a serem aplicados se selecionados para distribuições ponderadas.

Nome	Tipo	Description
weight	number	O percentual desse peso, expresso como uma fração de 1.
workerSelectors	RouterWorkerSelector[]	Uma coleção de seletores de trabalho que serão aplicados se essa alocação for selecionada.

Compartilhar via

Job Router Administration Operations - Get Classification Policy

Parâmetros de URI

Respostas

Segurança

AadOauth2Auth

Escopos

Exemplos

Retrieves an existing classification policy by Id

Solicitação de exemplo

Resposta de exemplo

Definições

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

Recursos adicionais