Endpoint Resolution - Resolve

Service:

Workload Development

Version d'API:

v1

Résoudre un point de terminaison pour un service donné appelé par Microsoft Fabric
Résout le point de terminaison d’un service donné appelé par Microsoft Fabric en fonction de la région et de l’espace de travail du locataire. Fabric fournit un ensemble de propriétés de contexte et retourne l’URL de point de terminaison de service appropriée et sa durée de vie (TTL).

L’API Résolution de point de terminaison est essentielle pour les services qui nécessitent une détermination de point de terminaison dynamique en fonction du contexte opérationnel. Cela permet d’optimiser le routage et la conformité régionale.

Pour résoudre un point de terminaison, Fabric envoie une requête POST avec les propriétés de contexte requises dans le corps de la requête. La réponse contient l’URL résolue et sa durée de vie, qui indique la durée pendant laquelle l’URL est considérée comme valide.

Pour obtenir des exemples d’implémentation et d’utilisation, reportez-vous à l’exemple de code de résolution de point de terminaison .

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

En-tête de la demande

Nom	Obligatoire	Type	Description
ActivityId	True	string	ID unique pour la corrélation de la requête avec votre système lorsqu’un utilisateur interagit avec votre charge de travail.
RequestId	True	string	ID global unique qui aide Fabric à mettre en corrélation votre demande avec nos journaux d’activité. Fournissez cet ID lors de la création d’un problème.
Authorization	True	string	En-tête d’autorisation double jeton qui permet à la charge de travail de valider l’origine de la requête, de fournir un contexte utilisateur et d’appeler d’autres services. Cet en-tête a le format suivant : SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".

Corps de la demande

Nom	Obligatoire	Type	Description
context	True	EndpointResolutionContextProperty[]	Tableau de propriétés de contexte pour la résolution de point de terminaison.

Réponses

Nom	Type	Description
200 OK	EndpointResolutionResponse	Réponse de résolution de point de terminaison
Other Status Codes	ErrorResponse	Pour les conditions d’erreur, la charge de travail doit retourner un code d’état d’erreur HTTP approprié (4xx, 5xx) avec des informations d’erreur détaillées dans le corps de la réponse.

Définitions

Nom	Description
EndpointResolutionContextProperty	Définit une propriété de contexte utilisée dans la résolution de point de terminaison. Cette propriété doit être spécifiée dans le manifeste de charge de travail pour garantir la détermination correcte du point de terminaison par Fabric.
EndpointResolutionContextPropertyName	Nom de la propriété pour le contexte de résolution de point de terminaison.
EndpointResolutionRequest
EndpointResolutionResponse
ErrorExtendedInformation	Informations d’erreur étendues.
ErrorResponse	Réponse d’erreur.
ErrorSource	Source de l’erreur.
NameValuePair	Paire nom-valeur.

EndpointResolutionContextProperty

Object

Définit une propriété de contexte utilisée dans la résolution de point de terminaison. Cette propriété doit être spécifiée dans le manifeste de charge de travail pour garantir la détermination correcte du point de terminaison par Fabric.

Nom	Type	Description
name	EndpointResolutionContextPropertyName	Nom de la propriété de contexte.
value	string	Valeur de la propriété de contexte.

EndpointResolutionContextPropertyName

Énumération

Nom de la propriété pour le contexte de résolution de point de terminaison.

Valeur	Description
EndpointName
TenantRegion
WorkspaceRegion
TenantId

EndpointResolutionRequest

Object

Nom	Type	Description
context	EndpointResolutionContextProperty[]	Tableau de propriétés de contexte pour la résolution de point de terminaison.

EndpointResolutionResponse

Object

Nom	Type	Description
ttlInMinutes	integer (int32)	Durée de vie en minutes pour l’URL résolue.
url	string	URL résolue du service.

ErrorExtendedInformation

Object

Informations d’erreur étendues.

Nom	Type	Description
additionalParameters	NameValuePair[]	Liste des paramètres supplémentaires spécifiques à l’erreur.
errorCode	string	Code d’erreur.
message	string	Message d’erreur.
messageParameters	string[]	Liste des paramètres de mise en forme d’un message localisé.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Code d’erreur.
isPermanent	boolean	Indique si l’erreur est permanente ou si l’opération peut être retentée.
message	string	Message d’erreur.
messageParameters	string[]	Liste des paramètres de mise en forme d’un message localisé.
moreDetails	ErrorExtendedInformation[]	Liste des détails d’erreur supplémentaires.
source	ErrorSource	Source d’erreur.

ErrorSource

Énumération

Source de l’erreur.

Valeur	Description
System
User
External

NameValuePair

Object

Paire nom-valeur.

Nom	Type	Description
name	string	Nom.
value	string	Valeur.