Endpoint Resolution - Resolve

Servicio:: Workload Development

Versión de la API:: v1

Resolución de un punto de conexión para un servicio determinado llamado por Microsoft Fabric
Resuelve el punto de conexión de un servicio determinado llamado por Microsoft Fabric en función de la región y la región del área de trabajo del inquilino. Fabric proporciona un conjunto de propiedades de contexto y devuelve la dirección URL del punto de conexión de servicio adecuada y su período de vida (TTL).

La API de resolución de puntos de conexión es fundamental para los servicios que requieren la determinación de puntos de conexión dinámicos en función del contexto operativo. Esto permite el enrutamiento optimizado y el cumplimiento regional.

Para resolver un punto de conexión, Fabric enviará una solicitud POST con las propiedades de contexto necesarias en el cuerpo de la solicitud. La respuesta contendrá la dirección URL resuelta y su TTL, que indica cuánto tiempo se considera válida la dirección URL.

Para obtener ejemplos de implementación y uso de ejemplo, consulte el código de ejemplo de resolución de puntos de conexión.

POST https://be.myWorkload.contoso.com/workload-api-path-placeholder/resolve-api-path-placeholder

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
ActivityId	True	string (uuid)	Un identificador único para correlacionar la solicitud con el sistema cuando un usuario interactúa con la carga de trabajo.
RequestId	True	string (uuid)	Un identificador único global que ayuda a Fabric a correlacionar su solicitud con nuestros registros. Proporcione este identificador al notificar un problema.
Authorization	True	string	Encabezado de autorización de token dual que permite a la carga de trabajo validar el origen de la solicitud, proporcionar contexto de usuario y llamar a otros servicios. Este encabezado tiene el siguiente formato: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
context	True	EndpointResolutionContextProperty[]	Matriz de propiedades de contexto para la resolución de puntos de conexión.

Respuestas

Nombre	Tipo	Description
200 OK	EndpointResolutionResponse	Respuesta de resolución de puntos de conexión.
Other Status Codes	ErrorResponse	Para las condiciones de error, la carga de trabajo debe devolver un código de estado de error HTTP adecuado (4xx, 5xx) con información detallada del error en el cuerpo de la respuesta.

Ejemplos

Resolve endpoint example

Solicitud de ejemplo

HTTP

POST https://be.myWorkload.contoso.com/workload-api-path-placeholder/resolve-api-path-placeholder

{
  "context": [
    {
      "name": "EndpointName",
      "value": "Workload"
    },
    {
      "name": "TenantRegion",
      "value": "West Central US"
    },
    {
      "name": "WorkspaceRegion",
      "value": "West Central US"
    }
  ]
}

Respuesta de muestra

status code:: 200

{
  "url": "https://my-service-name-resolved.example.com",
  "ttlInMinutes": 60
}

Definiciones

Nombre	Description
EndpointResolutionContextProperty	Define una propiedad de contexto usada en la resolución de puntos de conexión. Esta propiedad debe especificarse en el manifiesto de carga de trabajo para garantizar la determinación correcta del punto de conexión mediante Fabric.
EndpointResolutionContextPropertyName	Nombre de la propiedad para el contexto de resolución de puntos de conexión.
EndpointResolutionRequest
EndpointResolutionResponse
ErrorExtendedInformation	Información de error extendida.
ErrorResponse	Respuesta de error.
ErrorSource	Origen del error.
NameValuePair	Par nombre-valor.

EndpointResolutionContextProperty

Objeto

Define una propiedad de contexto usada en la resolución de puntos de conexión. Esta propiedad debe especificarse en el manifiesto de carga de trabajo para garantizar la determinación correcta del punto de conexión mediante Fabric.

Nombre	Tipo	Description
name	EndpointResolutionContextPropertyName	Nombre de la propiedad para el contexto de resolución de puntos de conexión.
value	string	Valor de la propiedad de contexto.

EndpointResolutionContextPropertyName

Enumeración

Nombre de la propiedad para el contexto de resolución de puntos de conexión.

Valor	Description
EndpointName	Nombre del punto de conexión.
TenantRegion	Región del inquilino.
WorkspaceRegion	Región del área de trabajo.
TenantId	Identificador del inquilino.

EndpointResolutionRequest

Objeto

Nombre	Tipo	Description
context	EndpointResolutionContextProperty[]	Matriz de propiedades de contexto para la resolución de puntos de conexión.

EndpointResolutionResponse

Objeto

Nombre	Tipo	Description
ttlInMinutes	integer (int32)	Período de vida en minutos para la dirección URL resuelta.
url	string	Dirección URL resuelta del servicio.

ErrorExtendedInformation

Objeto

Información de error extendida.

Nombre	Tipo	Description
additionalParameters	NameValuePair[]	Lista de parámetros adicionales específicos del error.
errorCode	string	Código de error.
message	string	El mensaje de error.
messageParameters	string[]	Lista de parámetros para dar formato a un mensaje localizado.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Código de error.
isPermanent	boolean	Indica si el error es permanente o se puede reintentar la operación.
message	string	El mensaje de error.
messageParameters	string[]	Lista de parámetros para dar formato a un mensaje localizado.
moreDetails	ErrorExtendedInformation[]	Una lista de detalles de error adicionales.
source	ErrorSource	Origen del error.

ErrorSource

Enumeración

Origen del error.

Valor	Description
System	El error se originó en el sistema.
User	El error se originó en la entrada del usuario.
External	El error se originó en un origen externo.

NameValuePair

Objeto

Par nombre-valor.

Nombre	Tipo	Description
name	string	Nombre.
value	string	Valor de tipo .