Endpoint Resolution - Resolve

Service:

Workload Development

API Version:

v1

Resolve an endpoint for a given service called by Microsoft Fabric
Resolves the endpoint for a given service called by Microsoft Fabric based on the tenant's region and workspace region. Fabric provides a set of context properties and returns the appropriate service endpoint URL and its time-to-live (TTL).

The Endpoint Resolution API is crucial for services that require dynamic endpoint determination based on operational context. This allows for optimized routing and regional compliance.

To resolve an endpoint, Fabric will send a POST request with the required context properties in the request body. The response will contain the resolved URL and its TTL, which indicates how long the URL is considered valid.

For a sample implementation and usage examples, please refer to the Endpoint Resolution Sample Code.

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

Request Header

Name	Required	Type	Description
ActivityId	True	string	A unique ID for correlating the request with your system when a user interacts with your workload.
RequestId	True	string	A globally unique ID that helps Fabric correlate your request with our logs. Provide this ID when reporting an issue.
Authorization	True	string	A dual token authorization header that allows the workload to validate the request origin, provide user context, and call other services. This header has the following format: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".

Request Body

Name	Required	Type	Description
context	True	EndpointResolutionContextProperty[]	Array of context properties for endpoint resolution.

Responses

Name	Type	Description
200 OK	EndpointResolutionResponse	Endpoint resolution response
Other Status Codes	ErrorResponse	For error conditions the workload should return an appropriate HTTP error status code (4xx, 5xx) with detailed error information in the response body.

Definitions

Name	Description
EndpointResolutionContextProperty	Defines a context property used in endpoint resolution. This property must be specified in the workload manifest to ensure correct endpoint determination by Fabric.
EndpointResolutionContextPropertyName	The name of the property for endpoint resolution context.
EndpointResolutionRequest
EndpointResolutionResponse
ErrorExtendedInformation	The extended error information.
ErrorResponse	The error response.
ErrorSource	The source of the error.
NameValuePair	A name-value pair.

EndpointResolutionContextProperty

Defines a context property used in endpoint resolution. This property must be specified in the workload manifest to ensure correct endpoint determination by Fabric.

Name	Type	Description
name	EndpointResolutionContextPropertyName	The name of the context property.
value	string	The value of the context property.

EndpointResolutionContextPropertyName

The name of the property for endpoint resolution context.

Name	Type	Description
EndpointName	string
TenantId	string
TenantRegion	string
WorkspaceRegion	string

EndpointResolutionRequest

Name	Type	Description
context	EndpointResolutionContextProperty[]	Array of context properties for endpoint resolution.

EndpointResolutionResponse

Name	Type	Description
ttlInMinutes	integer	Time to live in minutes for the resolved URL.
url	string	The resolved URL of the service.

ErrorExtendedInformation

The extended error information.

Name	Type	Description
additionalParameters	NameValuePair[]	A list of additional parameters specific to the error.
errorCode	string	The error code.
message	string	The error message.
messageParameters	string[]	A list of parameters for formatting a localized message.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	The error code.
isPermanent	boolean	Indicates whether the error is permanent or the operation can be retried.
message	string	The error message.
messageParameters	string[]	A list of parameters for formatting a localized message.
moreDetails	ErrorExtendedInformation[]	A list of additional error details.
source	ErrorSource	The error source.

ErrorSource

The source of the error.

Name	Type	Description
External	string
System	string
User	string

NameValuePair

A name-value pair.

Name	Type	Description
name	string	The name.
value	string	The value.