Endpoint Resolution - Resolve

Servizio:

Workload Development

Versione API:

v1

Risolvere un endpoint per un determinato servizio chiamato da Microsoft Fabric
Risolve l'endpoint per un determinato servizio chiamato da Microsoft Fabric in base all'area geografica e all'area dell'area di lavoro del tenant. Fabric fornisce un set di proprietà di contesto e restituisce l'URL dell'endpoint di servizio appropriato e la durata (TTL).

L'API di risoluzione degli endpoint è fondamentale per i servizi che richiedono la determinazione dinamica degli endpoint in base al contesto operativo. In questo modo è possibile ottimizzare il routing e la conformità a livello di area.

Per risolvere un endpoint, Fabric invierà una richiesta POST con le proprietà di contesto necessarie nel corpo della richiesta. La risposta conterrà l'URL risolto e il relativo TTL, che indica per quanto tempo l'URL è considerato valido.

Per esempi di implementazione e utilizzo di esempio, vedere il codice di esempio di risoluzione degli endpoint .

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

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
ActivityId	True	string	ID univoco per correlare la richiesta con il sistema quando un utente interagisce con il carico di lavoro.
RequestId	True	string	ID univoco globale che consente a Fabric di correlare la richiesta con i log. Specificare questo ID quando si segnala un problema.
Authorization	True	string	Intestazione di autorizzazione del token doppio che consente al carico di lavoro di convalidare l'origine della richiesta, fornire il contesto utente e chiamare altri servizi. Questa intestazione ha il formato seguente: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
context	True	EndpointResolutionContextProperty[]	Matrice di proprietà di contesto per la risoluzione degli endpoint.

Risposte

Nome	Tipo	Descrizione
200 OK	EndpointResolutionResponse	Risposta alla risoluzione degli endpoint
Other Status Codes	ErrorResponse	Per le condizioni di errore, il carico di lavoro deve restituire un codice di stato di errore HTTP appropriato (4xx, 5xx) con informazioni dettagliate sull'errore nel corpo della risposta.

Definizioni

Nome	Descrizione
EndpointResolutionContextProperty	Definisce una proprietà di contesto utilizzata nella risoluzione degli endpoint. Questa proprietà deve essere specificata nel manifesto del carico di lavoro per garantire la corretta determinazione dell'endpoint da parte di Fabric.
EndpointResolutionContextPropertyName	Nome della proprietà per il contesto di risoluzione dell'endpoint.
EndpointResolutionRequest
EndpointResolutionResponse
ErrorExtendedInformation	Informazioni estese sull'errore.
ErrorResponse	Risposta di errore.
ErrorSource	Origine dell'errore.
NameValuePair	Coppia nome-valore.

EndpointResolutionContextProperty

Object

Definisce una proprietà di contesto utilizzata nella risoluzione degli endpoint. Questa proprietà deve essere specificata nel manifesto del carico di lavoro per garantire la corretta determinazione dell'endpoint da parte di Fabric.

Nome	Tipo	Descrizione
name	EndpointResolutionContextPropertyName	Nome della proprietà di contesto.
value	string	Valore della proprietà di contesto.

EndpointResolutionContextPropertyName

Enumerazione

Nome della proprietà per il contesto di risoluzione dell'endpoint.

Valore	Descrizione
EndpointName
TenantRegion
WorkspaceRegion
TenantId

EndpointResolutionRequest

Object

Nome	Tipo	Descrizione
context	EndpointResolutionContextProperty[]	Matrice di proprietà di contesto per la risoluzione degli endpoint.

EndpointResolutionResponse

Object

Nome	Tipo	Descrizione
ttlInMinutes	integer (int32)	Tempo di durata in minuti per l'URL risolto.
url	string	URL risolto del servizio.

ErrorExtendedInformation

Object

Informazioni estese sull'errore.

Nome	Tipo	Descrizione
additionalParameters	NameValuePair[]	Elenco di parametri aggiuntivi specifici dell'errore.
errorCode	string	Codice di errore.
message	string	Messaggio di errore.
messageParameters	string[]	Elenco di parametri per la formattazione di un messaggio localizzato.

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Codice di errore.
isPermanent	boolean	Indica se l'errore è permanente o se l'operazione può essere ritentata.
message	string	Messaggio di errore.
messageParameters	string[]	Elenco di parametri per la formattazione di un messaggio localizzato.
moreDetails	ErrorExtendedInformation[]	Elenco di dettagli aggiuntivi sull'errore.
source	ErrorSource	Origine dell'errore.

ErrorSource

Enumerazione

Origine dell'errore.

Valore	Descrizione
System
User
External

NameValuePair

Object

Coppia nome-valore.

Nome	Tipo	Descrizione
name	string	Nome.
value	string	Valore.