Freigeben über

Endpoint Resolution - Resolve

Dienst:
Workload Development
API-Version:
v1

Auflösen eines Endpunkts für einen bestimmten Dienst, der von Microsoft Fabric aufgerufen wird
Löst den Endpunkt für einen von Microsoft Fabric aufgerufenen Dienst basierend auf der Region und Arbeitsbereichsregion des Mandanten auf. Fabric stellt eine Reihe von Kontexteigenschaften bereit und gibt die entsprechende Dienstendpunkt-URL und deren Time-to-Live (TTL) zurück.

Die Endpunktauflösungs-API ist für Dienste von entscheidender Bedeutung, die eine dynamische Endpunktermittlung basierend auf dem betrieblichen Kontext erfordern. Dies ermöglicht eine optimierte Routing- und regionale Compliance.

Um einen Endpunkt aufzulösen, sendet Fabric eine POST-Anforderung mit den erforderlichen Kontexteigenschaften im Anforderungstext. Die Antwort enthält die aufgelöste URL und die zugehörige TTL, die angibt, wie lange die URL als gültig betrachtet wird.

Eine Beispielimplementierung und Verwendungsbeispiele finden Sie im Endpunktauflösungsbeispielcode.

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

Anforderungsheader

Name Erforderlich Typ Beschreibung
ActivityId True

string (uuid)

Eine eindeutige ID zum Korrelieren der Anforderung mit Ihrem System, wenn ein Benutzer mit Ihrer Workload interagiert.
RequestId True

string (uuid)

Eine global eindeutige ID, die Fabric dabei hilft, Ihre Anforderung mit unseren Protokollen zu korrelieren. Geben Sie diese ID an, wenn ein Problem gemeldet wird.
Authorization True

string

Ein Dual-Token-Autorisierungsheader, der es der Workload ermöglicht, den Anforderungsursprung zu überprüfen, Den Benutzerkontext bereitzustellen und andere Dienste aufzurufen. Diese Kopfzeile hat das folgende Format: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".

Anforderungstext

Name Erforderlich Typ Beschreibung
context True

EndpointResolutionContextProperty[]

Array von Kontexteigenschaften für die Endpunktauflösung.

Antworten

Name Typ Beschreibung
200 OK

EndpointResolutionResponse

Endpunktauflösungsantwort.
Other Status Codes

ErrorResponse

Bei Fehlerbedingungen sollte die Workload einen entsprechenden HTTP-Fehlerstatuscode (4xx, 5xx) mit detaillierten Fehlerinformationen im Antworttext zurückgeben.

Beispiele

Resolve endpoint example

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
EndpointResolutionContextProperty

Definiert eine Kontexteigenschaft, die in der Endpunktauflösung verwendet wird. Diese Eigenschaft muss im Workloadmanifest angegeben werden, um die korrekte Endpunktbestimmung durch Fabric sicherzustellen.
EndpointResolutionContextPropertyName

Der Name der Eigenschaft für den Endpunktauflösungskontext.
EndpointResolutionRequest
EndpointResolutionResponse
ErrorExtendedInformation

Die erweiterten Fehlerinformationen.
ErrorResponse

Die Fehlerantwort.
ErrorSource

Die Ursache des Fehlers.
NameValuePair

Ein Name-Wert-Paar.

EndpointResolutionContextProperty

Objekt

Definiert eine Kontexteigenschaft, die in der Endpunktauflösung verwendet wird. Diese Eigenschaft muss im Workloadmanifest angegeben werden, um die korrekte Endpunktbestimmung durch Fabric sicherzustellen.

Name Typ Beschreibung
name

EndpointResolutionContextPropertyName

Der Name der Eigenschaft für den Endpunktauflösungskontext.
value

string

Der Wert der Kontexteigenschaft.

EndpointResolutionContextPropertyName

Enumeration

Der Name der Eigenschaft für den Endpunktauflösungskontext.

Wert Beschreibung
EndpointName

Der Endpunktname.
TenantRegion

Die Mandantenregion.
WorkspaceRegion

Der Arbeitsbereichsbereich.
TenantId

Die Mandanten-ID.

EndpointResolutionRequest

Objekt
Name Typ Beschreibung
context

EndpointResolutionContextProperty[]

Array von Kontexteigenschaften für die Endpunktauflösung.

EndpointResolutionResponse

Objekt
Name Typ Beschreibung
ttlInMinutes

integer (int32)

Zeit für die aufgelöste URL in Minuten zu leben.
url

string

Die aufgelöste URL des Diensts.

ErrorExtendedInformation

Objekt

Die erweiterten Fehlerinformationen.

Name Typ Beschreibung
additionalParameters

NameValuePair[]

Eine Liste mit zusätzlichen Parametern, die für den Fehler spezifisch sind.
errorCode

string

Der Fehlercode.
message

string

Die Fehlermeldung.
messageParameters

string[]

Eine Liste der Parameter zum Formatieren einer lokalisierten Nachricht.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Der Fehlercode.
isPermanent

boolean

Gibt an, ob der Fehler dauerhaft ist oder der Vorgang wiederholt werden kann.
message

string

Die Fehlermeldung.
messageParameters

string[]

Eine Liste der Parameter zum Formatieren einer lokalisierten Nachricht.
moreDetails

ErrorExtendedInformation[]

Eine Liste mit zusätzlichen Fehlerdetails.
source

ErrorSource

Die Ursache des Fehlers.

ErrorSource

Enumeration

Die Ursache des Fehlers.

Wert Beschreibung
System

Der Fehler stammt aus dem System.
User

Der Fehler stammt von der Benutzereingabe.
External

Der Fehler stammt aus einer externen Quelle.

NameValuePair

Objekt

Ein Name-Wert-Paar.

Name Typ Beschreibung
name

string

Der Name.
value

string

Der -Wert.