Compartir a través de

Job Router Administration Operations - Upsert Distribution Policy

  • Referencia
Servicio:
Communication
Versión de la API:
2023-11-01

Crea o actualiza una directiva de distribución.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
distributionPolicyId
 path True

string

Identificador de una directiva de distribució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.

Encabezado de la solicitud

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

Nombre Requerido Tipo Description
If-Match

string

La solicitud solo debe continuar si una entidad coincide con esta cadena.
If-Unmodified-Since

string

date-time-rfc7231

La solicitud solo debe continuar si la entidad no se modificó después de este tiempo.

Cuerpo de la solicitud

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

Nombre Tipo Description
mode DistributionModeCreateOrUpdate:

Modo que rige el método de distribución específico.
name

string

Nombre descriptivo de esta directiva.
offerExpiresAfterSeconds

number

Número de segundos después de los cuales las ofertas creadas en esta directiva expirarán.

Respuestas

Nombre Tipo Description
200 OK

DistributionPolicy

La solicitud se ha realizado correctamente.

Encabezados

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

DistributionPolicy

La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

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

Creates a Distribution policy
Updates a distribution policy

Creates a Distribution policy

Solicitud de ejemplo

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"
}

Respuesta de muestra

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

Solicitud de ejemplo

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"
}

Respuesta de muestra

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

Los trabajos se distribuyen al trabajo con las capacidades más fuertes disponibles.
BestWorkerModeCreateOrUpdate

Los trabajos se distribuyen al trabajo con las capacidades más fuertes disponibles.
DirectMapRouterRule

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

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

Discriminadores para los tipos de modo de distribución admitidos.
DistributionPolicy

Directiva que rige cómo se distribuyen los trabajos a los trabajadores
DistributionPolicyCreateOrUpdate

Directiva que rige cómo se distribuyen los trabajos a los trabajadores
ExpressionRouterRule

Regla que proporciona reglas de expresión insertadas.
ExpressionRouterRuleCreateOrUpdate

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

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

Los trabajos se dirigen al trabajador que ha estado inactivo más tiempo.
LongestIdleModeCreateOrUpdate

Los trabajos se dirigen al trabajador que ha estado inactivo más tiempo.
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/
RoundRobinMode

Los trabajos se distribuyen para los trabajos, empezando por el trabajo que es después del último trabajo para recibir un trabajo.
RoundRobinModeCreateOrUpdate

Los trabajos se distribuyen para los trabajos, empezando por el trabajo que es después del último trabajo para recibir un trabajo.
RouterRuleKind

Discriminadores para tipos de reglas de enrutador compatibles.
ScoringRuleOptions

Encapsula todas las opciones que se pueden pasar como parámetros para la regla de puntuación con BestWorkerMode.
ScoringRuleParameterSelector

Parámetros admitidos para los trabajadores de puntuación usados con BestWorkerMode.
StaticRouterRule

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

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

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

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

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.

BestWorkerMode

Los trabajos se distribuyen al trabajo con las capacidades más fuertes disponibles.

Nombre Tipo Valor predeterminado Description
bypassSelectors

boolean

False

Si se establece en true, el enrutador coincidirá con los trabajos incluso si no coinciden con los selectores de etiquetas. Advertencia: puede obtener trabajos que no estén calificados para un trabajo con el que coincidan si establece esta variable en true. Esta marca está pensada para un uso temporal. De forma predeterminada, establezca en false.
kind string:

bestWorker

El discriminador de tipos que describe un subtipo de DistributionMode.
maxConcurrentOffers

integer

1

Controla el número máximo de ofertas simultáneas activas que puede tener un trabajo.
minConcurrentOffers

integer

1

Controla el número mínimo deseado de ofertas simultáneas activas que puede tener un trabajo.
scoringRule RouterRule:

Defina una regla de puntuación que se va a usar al calcular una puntuación para determinar el mejor trabajo. Si no se establece, usará una fórmula de puntuación predeterminada que use el número de etiquetas de trabajo que coinciden las etiquetas de trabajo, así como el número de selectores de etiquetas que coinciden las etiquetas de trabajo o que superen mediante una función logística (https://en.wikipedia.org/wiki/Logistic_function).
scoringRuleOptions

ScoringRuleOptions

Opciones para configurar "scoringRule". Si no se establece, se usan los valores predeterminados.

BestWorkerModeCreateOrUpdate

Los trabajos se distribuyen al trabajo con las capacidades más fuertes disponibles.

Nombre Tipo Valor predeterminado Description
bypassSelectors

boolean

False

Si se establece en true, el enrutador coincidirá con los trabajos incluso si no coinciden con los selectores de etiquetas. Advertencia: puede obtener trabajos que no estén calificados para un trabajo con el que coincidan si establece esta variable en true. Esta marca está pensada para un uso temporal. De forma predeterminada, establezca en false.
kind string:

bestWorker

El discriminador de tipos que describe un subtipo de DistributionMode.
maxConcurrentOffers

integer

1

Controla el número máximo de ofertas simultáneas activas que puede tener un trabajo.
minConcurrentOffers

integer

1

Controla el número mínimo deseado de ofertas simultáneas activas que puede tener un trabajo.
scoringRule RouterRuleCreateOrUpdate:

Defina una regla de puntuación que se va a usar al calcular una puntuación para determinar el mejor trabajo. Si no se establece, usará una fórmula de puntuación predeterminada que use el número de etiquetas de trabajo que coinciden las etiquetas de trabajo, así como el número de selectores de etiquetas que coinciden las etiquetas de trabajo o que superen mediante una función logística (https://en.wikipedia.org/wiki/Logistic_function).
scoringRuleOptions

ScoringRuleOptions

Opciones para configurar "scoringRule". Si no se establece, se usan los valores predeterminados.

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

DirectMapRouterRuleCreateOrUpdate

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

DistributionModeKind

Discriminadores para los tipos de modo de distribución admitidos.

Nombre Tipo Description
bestWorker

string

Valor discriminador para BestWorkerMode.
longestIdle

string

Valor discriminador de LongIdleMode.
roundRobin

string

Valor discriminador para RoundRobinMode.

DistributionPolicy

Directiva que rige cómo se distribuyen los trabajos a los trabajadores

Nombre Tipo Description
etag

string

Etiqueta de entidad para este recurso.
id

string

Identificador de una directiva de distribución.
mode DistributionMode:

Modo que rige el método de distribución específico.
name

string

Nombre descriptivo de esta directiva.
offerExpiresAfterSeconds

number

Número de segundos después de los cuales las ofertas creadas en esta directiva expirarán.

DistributionPolicyCreateOrUpdate

Directiva que rige cómo se distribuyen los trabajos a los trabajadores

Nombre Tipo Description
mode DistributionModeCreateOrUpdate:

Modo que rige el método de distribución específico.
name

string

Nombre descriptivo de esta directiva.
offerExpiresAfterSeconds

number

Número de segundos después de los cuales las ofertas creadas en esta directiva expirarán.

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.

ExpressionRouterRuleCreateOrUpdate

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

FunctionRouterRuleCreateOrUpdate

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.

LongestIdleMode

Los trabajos se dirigen al trabajador que ha estado inactivo más tiempo.

Nombre Tipo Valor predeterminado Description
bypassSelectors

boolean

False

Si se establece en true, el enrutador coincidirá con los trabajos incluso si no coinciden con los selectores de etiquetas. Advertencia: puede obtener trabajos que no estén calificados para un trabajo con el que coincidan si establece esta variable en true. Esta marca está pensada para un uso temporal. De forma predeterminada, establezca en false.
kind string:

longestIdle

El discriminador de tipos que describe un subtipo de DistributionMode.
maxConcurrentOffers

integer

1

Controla el número máximo de ofertas simultáneas activas que puede tener un trabajo.
minConcurrentOffers

integer

1

Controla el número mínimo deseado de ofertas simultáneas activas que puede tener un trabajo.

LongestIdleModeCreateOrUpdate

Los trabajos se dirigen al trabajador que ha estado inactivo más tiempo.

Nombre Tipo Valor predeterminado Description
bypassSelectors

boolean

False

Si se establece en true, el enrutador coincidirá con los trabajos incluso si no coinciden con los selectores de etiquetas. Advertencia: puede obtener trabajos que no estén calificados para un trabajo con el que coincidan si establece esta variable en true. Esta marca está pensada para un uso temporal. De forma predeterminada, establezca en false.
kind string:

longestIdle

El discriminador de tipos que describe un subtipo de DistributionMode.
maxConcurrentOffers

integer

1

Controla el número máximo de ofertas simultáneas activas que puede tener un trabajo.
minConcurrentOffers

integer

1

Controla el número mínimo deseado de ofertas simultáneas activas que puede tener un trabajo.

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.

RoundRobinMode

Los trabajos se distribuyen para los trabajos, empezando por el trabajo que es después del último trabajo para recibir un trabajo.

Nombre Tipo Valor predeterminado Description
bypassSelectors

boolean

False

Si se establece en true, el enrutador coincidirá con los trabajos incluso si no coinciden con los selectores de etiquetas. Advertencia: puede obtener trabajos que no estén calificados para un trabajo con el que coincidan si establece esta variable en true. Esta marca está pensada para un uso temporal. De forma predeterminada, establezca en false.
kind string:

roundRobin

El discriminador de tipos que describe un subtipo de DistributionMode.
maxConcurrentOffers

integer

1

Controla el número máximo de ofertas simultáneas activas que puede tener un trabajo.
minConcurrentOffers

integer

1

Controla el número mínimo deseado de ofertas simultáneas activas que puede tener un trabajo.

RoundRobinModeCreateOrUpdate

Los trabajos se distribuyen para los trabajos, empezando por el trabajo que es después del último trabajo para recibir un trabajo.

Nombre Tipo Valor predeterminado Description
bypassSelectors

boolean

False

Si se establece en true, el enrutador coincidirá con los trabajos incluso si no coinciden con los selectores de etiquetas. Advertencia: puede obtener trabajos que no estén calificados para un trabajo con el que coincidan si establece esta variable en true. Esta marca está pensada para un uso temporal. De forma predeterminada, establezca en false.
kind string:

roundRobin

El discriminador de tipos que describe un subtipo de DistributionMode.
maxConcurrentOffers

integer

1

Controla el número máximo de ofertas simultáneas activas que puede tener un trabajo.
minConcurrentOffers

integer

1

Controla el número mínimo deseado de ofertas simultáneas activas que puede tener un trabajo.

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.

ScoringRuleOptions

Encapsula todas las opciones que se pueden pasar como parámetros para la regla de puntuación con BestWorkerMode.

Nombre Tipo Valor predeterminado Description
batchSize

integer

20

Establezca el tamaño del lote cuando "isBatchScoringEnabled" esté establecido en true. El valor predeterminado es 20 si no está configurado.
descendingOrder

boolean

True

Si es false, ordenará las puntuaciones por orden ascendente. De forma predeterminada, establezca en true.
isBatchScoringEnabled

boolean

False

Si se establece en true, puntuará los trabajos en lotes y el nombre del parámetro de las etiquetas de trabajo se enviará como workers. De forma predeterminada, se establece en false y el nombre del parámetro de las etiquetas de trabajo se enviará como worker. Nota: Si está habilitada, use "batchSize" para establecer el tamaño del lote.
scoringParameters

ScoringRuleParameterSelector[]

[ "jobLabels", "workerSelectors" ]

Lista de parámetros adicionales de un trabajo que se enviará como parte de la carga a la regla de puntuación. Si no se establece, las etiquetas de un trabajo (enviadas en la carga como job) y los selectores de trabajo de un trabajo (enviados en la carga como selectors) se agregan a la carga de la regla de puntuación de forma predeterminada. Nota: Las etiquetas de trabajo siempre se envían con la carga de puntuación.

ScoringRuleParameterSelector

Parámetros admitidos para los trabajadores de puntuación usados con BestWorkerMode.

Nombre Tipo Description
jobLabels

string

Parámetro para agregar etiquetas de trabajo a la carga de puntuación. La propiedad se envía como job.
workerSelectors

string

Parámetro para agregar selectores de trabajo de un trabajo a la carga de puntuación. La propiedad se envía como selectors.

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.

StaticRouterRuleCreateOrUpdate

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.

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.

WebhookRouterRuleCreateOrUpdate

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.