Job Router Administration Operations - Get Classification Policy

Referencia

Servicio:: Communication

Versión de la API:: 2023-11-01

Recupera una directiva de clasificación existente por identificador.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
classificationPolicyId	path	True	string	Identificador de una directiva de clasificación.
endpoint	path	True	string	Uri del recurso de comunicación
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	ClassificationPolicy	La solicitud se ha realizado correctamente. Encabezados ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

ClassificationPolicy

La solicitud se ha realizado correctamente.

Encabezados

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

AadOauth2Auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Ejemplos

Retrieves an existing classification policy by Id

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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"
}

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ClassificationPolicy	Contenedor de las reglas que rigen cómo se clasifican los trabajos.
ConditionalQueueSelectorAttachment	Describe un conjunto de selectores de cola que se adjuntarán si la condición dada se resuelve en true.
ConditionalWorkerSelectorAttachment	Describe un conjunto de selectores de trabajo que se adjuntarán si la condición dada se resuelve en true.
DirectMapRouterRule	Regla que devuelve las mismas etiquetas que las etiquetas de entrada.
ExpressionRouterRule	Regla que proporciona reglas de expresión insertadas.
ExpressionRouterRuleLanguage	Lenguajes de expresiones disponibles que se pueden configurar.
FunctionRouterRule	Una regla que proporciona un enlace a una función de Azure desencadenada por HTTP.
FunctionRouterRuleCredential	Credenciales usadas para acceder a la regla de funciones de Azure.
LabelOperator	Describe las operaciones admitidas en los valores de etiqueta.
OAuth2WebhookClientCredential	Credenciales de OAuth2.0 usadas en el servidor de autorización de Contoso. Referencia: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
PassThroughQueueSelectorAttachment	Asocia un selector de cola donde el valor se pasa desde la etiqueta de un trabajo con la misma clave.
PassThroughWorkerSelectorAttachment	Asocia un selector de trabajo donde el valor se pasa desde la etiqueta de un trabajo con la misma clave.
QueueSelectorAttachmentKind	Discriminadores para los tipos de datos adjuntos del selector de cola admitidos.
QueueWeightedAllocation	Contiene el porcentaje de peso y los selectores de cola que se van a aplicar si se seleccionan para distribuciones ponderadas.
RouterQueueSelector	Describe una condición que se debe cumplir con un conjunto de etiquetas para la selección de cola.
RouterRuleKind	Discriminadores para tipos de reglas de enrutador compatibles.
RouterWorkerSelector	Describe una condición que se debe cumplir con un conjunto de etiquetas para la selección de trabajo.
RouterWorkerSelectorStatus	Describe el estado de un selector de trabajo.
RuleEngineQueueSelectorAttachment	Asocia selectores de cola a un trabajo cuando se resuelve routerRule.
RuleEngineWorkerSelectorAttachment	Asocia selectores de trabajo a un trabajo cuando se resuelve un RouterRule.
StaticQueueSelectorAttachment	Describe un selector de colas que se asociará a un trabajo.
StaticRouterRule	Regla que proporciona reglas estáticas que siempre devuelven el mismo resultado, independientemente de la entrada.
StaticWorkerSelectorAttachment	Describe un selector de trabajo que se asociará a un trabajo.
WebhookRouterRule	Una regla que proporciona un enlace a un servidor web externo.
WeightedAllocationQueueSelectorAttachment	Describe varios conjuntos de selectores de cola, de los cuales se seleccionará y se asociará según una ponderación.
WeightedAllocationWorkerSelectorAttachment	Describe varios conjuntos de selectores de trabajo, de los cuales se seleccionará y se asociará según una ponderación.
WorkerSelectorAttachmentKind	Discriminadores para los tipos de datos adjuntos del selector de trabajo admitidos.
WorkerWeightedAllocation	Contiene el porcentaje de peso y los selectores de trabajo que se van a aplicar si se seleccionan para distribuciones ponderadas.

Azure.Core.Foundations.Error

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

ClassificationPolicy

Contenedor de las reglas que rigen cómo se clasifican los trabajos.

Nombre	Tipo	Description
etag	string	Etiqueta de entidad para este recurso.
fallbackQueueId	string	Identificador de una cola de reserva para seleccionar si los datos adjuntos del selector de cola no encuentran ninguna coincidencia.
id	string	Identificador de una directiva de clasificación.
name	string	Nombre descriptivo de esta directiva.
prioritizationRule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	Regla para determinar una puntuación de prioridad para un trabajo.
queueSelectorAttachments	QueueSelectorAttachment[]: ConditionalQueueSelectorAttachment[] PassThroughQueueSelectorAttachment[] RuleEngineQueueSelectorAttachment[] StaticQueueSelectorAttachment[] WeightedAllocationQueueSelectorAttachment[]	Datos adjuntos del selector de cola que se usan para resolver una cola para un trabajo.
workerSelectorAttachments	WorkerSelectorAttachment[]: ConditionalWorkerSelectorAttachment[] PassThroughWorkerSelectorAttachment[] RuleEngineWorkerSelectorAttachment[] StaticWorkerSelectorAttachment[] WeightedAllocationWorkerSelectorAttachment[]	Datos adjuntos del selector de trabajo usados para adjuntar selectores de trabajo a un trabajo.

ConditionalQueueSelectorAttachment

Describe un conjunto de selectores de cola que se adjuntarán si la condición dada se resuelve en true.

Nombre	Tipo	Description
condition	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	Condición que debe ser true para que los selectores de cola se conecten.
kind	string: conditional	El discriminador de tipos que describe un subtipo de QueueSelectorAttachment.
queueSelectors	RouterQueueSelector[]	Selectores de cola que se van a adjuntar.

ConditionalWorkerSelectorAttachment

Describe un conjunto de selectores de trabajo que se adjuntarán si la condición dada se resuelve en true.

Nombre	Tipo	Description
condition	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	Condición que debe ser true para que se conecten los selectores de trabajo.
kind	string: conditional	El discriminador de tipo que describe un subtipo de WorkerSelectorAttachment.
workerSelectors	RouterWorkerSelector[]	Selectores de trabajo que se van a adjuntar.

DirectMapRouterRule

Regla que devuelve las mismas etiquetas que las etiquetas de entrada.

Nombre	Tipo	Description
kind	string: directMap	El discriminador de tipos que describe un subtipo de RouterRule

ExpressionRouterRule

Regla que proporciona reglas de expresión insertadas.

Nombre	Tipo	Description
expression	string	Expresión que se va a evaluar. Debe contener la instrucción return con valores calculados.
kind	string: expression	El discriminador de tipos que describe un subtipo de RouterRule
language	ExpressionRouterRuleLanguage	Lenguaje de expresión que se va a compilar y ejecutar.

ExpressionRouterRuleLanguage

Lenguajes de expresiones disponibles que se pueden configurar.

Nombre	Tipo	Description
powerFx	string	PowerFx

FunctionRouterRule

Una regla que proporciona un enlace a una función de Azure desencadenada por HTTP.

Nombre	Tipo	Description
credential	FunctionRouterRuleCredential	Credenciales usadas para acceder a la regla de funciones de Azure.
functionUri	string	Dirección URL de La función de Azure.
kind	string: function	El discriminador de tipos que describe un subtipo de RouterRule

FunctionRouterRuleCredential

Credenciales usadas para acceder a la regla de funciones de Azure.

Nombre	Tipo	Description
appKey	string	Clave de acceso con ámbito a una aplicación de funciones de Azure. Esta clave concede acceso a todas las funciones de la aplicación.
clientId	string	Identificador de cliente, cuando se proporciona AppKey en el contexto de la función de Azure, suele ser el nombre de la clave.
functionKey	string	Clave de acceso con ámbito a una función determinada.

LabelOperator

Describe las operaciones admitidas en los valores de etiqueta.

Nombre	Tipo	Description
equal	string	Igual.
greaterThan	string	Mayor que.
greaterThanOrEqual	string	Mayor o igual que.
lessThan	string	Menos que.
lessThanOrEqual	string	Menor o igual que.
notEqual	string	No es igual.

OAuth2WebhookClientCredential

Credenciales de OAuth2.0 usadas en el servidor de autorización de Contoso. Referencia: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/

Nombre	Tipo	Description
clientId	string	ClientId para el servidor de autorización de Contoso.
clientSecret	string	Secreto de cliente para el servidor de autorización de Contoso.

PassThroughQueueSelectorAttachment

Asocia un selector de cola donde el valor se pasa desde la etiqueta de un trabajo con la misma clave.

Nombre	Tipo	Description
key	string	Clave de etiqueta en la que se va a consultar.
kind	string: passThrough	El discriminador de tipos que describe un subtipo de QueueSelectorAttachment.
labelOperator	LabelOperator	Describe cómo se compara el valor de la etiqueta con el valor que pasa.

PassThroughWorkerSelectorAttachment

Asocia un selector de trabajo donde el valor se pasa desde la etiqueta de un trabajo con la misma clave.

Nombre	Tipo	Description
expiresAfterSeconds	number	Describe cuánto tiempo es válido el selector de etiquetas adjuntas en segundos.
key	string	Clave de etiqueta en la que se va a consultar.
kind	string: passThrough	El discriminador de tipo que describe un subtipo de WorkerSelectorAttachment.
labelOperator	LabelOperator	Describe cómo se compara el valor de la etiqueta con el valor que pasa.

QueueSelectorAttachmentKind

Discriminadores para los tipos de datos adjuntos del selector de cola admitidos.

Nombre	Tipo	Description
conditional	string	Valor discriminador de ConditionalQueueSelectorAttachment.
passThrough	string	Valor discriminador de PassThroughQueueSelectorAttachment.
ruleEngine	string	Valor discriminador de RuleEngineQueueSelectorAttachment.
static	string	Valor discriminador de StaticQueueSelectorAttachment.
weightedAllocation	string	Valor discriminador de WeightedAllocationQueueSelectorAttachment.

QueueWeightedAllocation

Contiene el porcentaje de peso y los selectores de cola que se van a aplicar si se seleccionan para distribuciones ponderadas.

Nombre	Tipo	Description
queueSelectors	RouterQueueSelector[]	Colección de selectores de cola que se aplicarán si se selecciona esta asignación.
weight	number	Porcentaje de este peso, expresado como una fracción de 1.

RouterQueueSelector

Describe una condición que se debe cumplir con un conjunto de etiquetas para la selección de cola.

Nombre	Tipo	Description
key	string	Clave de etiqueta en la que se va a consultar.
labelOperator	LabelOperator	Describe cómo se compara el valor de la etiqueta con el valor definido en el selector de etiquetas.
value		Valor que se va a comparar con el valor de etiqueta real con el operador especificado. Los valores deben ser valores primitivos: número, cadena, booleano.

RouterRuleKind

Discriminadores para tipos de reglas de enrutador compatibles.

Nombre	Tipo	Description
directMap	string	Valor discriminador para DirectMapRouterRule.
expression	string	Valor discriminador para ExpressionRouterRule.
function	string	Valor discriminador de FunctionRouterRule.
static	string	Valor discriminador para StaticRouterRule.
webhook	string	Valor discriminador de WebhookRouterRule.

RouterWorkerSelector

Describe una condición que se debe cumplir con un conjunto de etiquetas para la selección de trabajo.

Nombre	Tipo	Description
expedite	boolean	Inserta un trabajo en la parte delantera de la cola siempre que este selector esté activo.
expiresAfterSeconds	number	Describe cuánto tiempo es válido este selector de etiquetas en segundos.
expiresAt	string	Hora a la que expira este selector de trabajo en UTC.
key	string	Clave de etiqueta en la que se va a consultar.
labelOperator	LabelOperator	Describe cómo se compara el valor de la etiqueta con el valor definido en el selector de trabajo.
status	RouterWorkerSelectorStatus	Estado del selector de trabajo.
value		Valor que se va a comparar con el valor de etiqueta real con el operador especificado. Los valores deben ser valores primitivos: número, cadena, booleano.

RouterWorkerSelectorStatus

Describe el estado de un selector de trabajo.

Nombre	Tipo	Description
active	string	El selector de trabajo es válido.
expired	string	El selector de trabajo no es válido.

RuleEngineQueueSelectorAttachment

Asocia selectores de cola a un trabajo cuando se resuelve routerRule.

Nombre	Tipo	Description
kind	string: ruleEngine	El discriminador de tipos que describe un subtipo de QueueSelectorAttachment.
rule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	RouterRule que resuelve una colección de selectores de cola que se van a adjuntar.

RuleEngineWorkerSelectorAttachment

Asocia selectores de trabajo a un trabajo cuando se resuelve un RouterRule.

Nombre	Tipo	Description
kind	string: ruleEngine	El discriminador de tipo que describe un subtipo de WorkerSelectorAttachment.
rule	RouterRule: DirectMapRouterRule ExpressionRouterRule FunctionRouterRule StaticRouterRule WebhookRouterRule	RouterRule que resuelve una colección de selectores de trabajo que se van a adjuntar.

StaticQueueSelectorAttachment

Describe un selector de colas que se asociará a un trabajo.

Nombre	Tipo	Description
kind	string: static	El discriminador de tipos que describe un subtipo de QueueSelectorAttachment.
queueSelector	RouterQueueSelector	Selector de cola que se va a adjuntar.

StaticRouterRule

Regla que proporciona reglas estáticas que siempre devuelven el mismo resultado, independientemente de la entrada.

Nombre	Tipo	Description
kind	string: static	El discriminador de tipos que describe un subtipo de RouterRule
value		El valor estático que esta regla siempre devuelve. Los valores deben ser valores primitivos: número, cadena, booleano.

StaticWorkerSelectorAttachment

Describe un selector de trabajo que se asociará a un trabajo.

Nombre	Tipo	Description
kind	string: static	El discriminador de tipo que describe un subtipo de WorkerSelectorAttachment.
workerSelector	RouterWorkerSelector	Selector de trabajo que se va a adjuntar.

WebhookRouterRule

Una regla que proporciona un enlace a un servidor web externo.

Nombre	Tipo	Description
authorizationServerUri	string	Uri para el servidor de autorización.
clientCredential	OAuth2WebhookClientCredential	Credenciales de OAuth2.0 usadas en el servidor de autorización de Contoso. Referencia: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/
kind	string: webhook	El discriminador de tipos que describe un subtipo de RouterRule
webhookUri	string	Uri para el servidor web de Contoso.

WeightedAllocationQueueSelectorAttachment

Describe varios conjuntos de selectores de cola, de los cuales se seleccionará y se asociará según una ponderación.

Nombre	Tipo	Description
allocations	QueueWeightedAllocation[]	Colección de asignaciones ponderadas basadas en porcentajes.
kind	string: weightedAllocation	El discriminador de tipos que describe un subtipo de QueueSelectorAttachment.

WeightedAllocationWorkerSelectorAttachment

Describe varios conjuntos de selectores de trabajo, de los cuales se seleccionará y se asociará según una ponderación.

Nombre	Tipo	Description
allocations	WorkerWeightedAllocation[]	Colección de asignaciones ponderadas basadas en porcentajes.
kind	string: weightedAllocation	El discriminador de tipo que describe un subtipo de WorkerSelectorAttachment.

WorkerSelectorAttachmentKind

Discriminadores para los tipos de datos adjuntos del selector de trabajo admitidos.

Nombre	Tipo	Description
conditional	string	Valor discriminador para ConditionalWorkerSelectorAttachment.
passThrough	string	Valor discriminador para PassThroughWorkerSelectorAttachment.
ruleEngine	string	Valor discriminador para RuleEngineWorkerSelectorAttachment.
static	string	Valor discriminador para StaticWorkerSelectorAttachment.
weightedAllocation	string	Valor discriminador de WeightedAllocationWorkerSelectorAttachment.

WorkerWeightedAllocation

Contiene el porcentaje de peso y los selectores de trabajo que se van a aplicar si se seleccionan para distribuciones ponderadas.

Nombre	Tipo	Description
weight	number	Porcentaje de este peso, expresado como una fracción de 1.
workerSelectors	RouterWorkerSelector[]	Colección de selectores de trabajo que se aplicarán si se selecciona esta asignación.

Compartir a través de

Job Router Administration Operations - Get Classification Policy

Parámetros de identificador URI

Respuestas

Seguridad

AadOauth2Auth

Ámbitos

Ejemplos

Retrieves an existing classification policy by Id

Solicitud de ejemplo

Respuesta de muestra

Definiciones

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 adicionales