Endpoint Resolution - Resolve

Service:: Workload Development

API-versie:: v1

Een eindpunt voor een bepaalde service oplossen die wordt aangeroepen door Microsoft Fabric
Hiermee wordt het eindpunt voor een bepaalde service opgelost die wordt aangeroepen door Microsoft Fabric op basis van de regio en werkruimteregio van de tenant. Fabric biedt een set contexteigenschappen en retourneert de juiste SERVICE-eindpunt-URL en de time-to-live (TTL).

De Eindpuntomzettings-API is van cruciaal belang voor services waarvoor dynamische eindpuntbepaling is vereist op basis van operationele context. Dit maakt geoptimaliseerde routering en regionale naleving mogelijk.

Fabric verzendt een POST-aanvraag met de vereiste contexteigenschappen in de aanvraagbody om een eindpunt op te lossen. Het antwoord bevat de opgeloste URL en de bijbehorende TTL, die aangeeft hoe lang de URL als geldig wordt beschouwd.

Raadpleeg de voorbeeldcode voor eindpuntomzetting voor een voorbeeld van implementatie en gebruik.

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

Aanvraagkoptekst

Name	Vereist	Type	Description
ActivityId	True	string (uuid)	Een unieke id voor het correleren van de aanvraag met uw systeem wanneer een gebruiker interactie heeft met uw workload.
RequestId	True	string (uuid)	Een wereldwijd unieke id waarmee Fabric uw aanvraag correleert met onze logboeken. Geef deze id op bij het melden van een probleem.
Authorization	True	string	Een dubbele tokenautorisatieheader waarmee de workload de oorsprong van de aanvraag kan valideren, gebruikerscontext kan bieden en andere services kan aanroepen. Deze header heeft de volgende indeling: `SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token"`.

Aanvraagbody

Name	Vereist	Type	Description
context	True	EndpointResolutionContextProperty[]	Matrix met contexteigenschappen voor eindpuntresolutie.

Antwoorden

Name	Type	Description
200 OK	EndpointResolutionResponse	Antwoord op eindpuntomzetting.
Other Status Codes	ErrorResponse	Voor foutvoorwaarden moet de workload een geschikte HTTP-foutcode (4xx, 5xx) retourneren met gedetailleerde foutinformatie in de hoofdtekst van het antwoord.

Voorbeelden

Resolve endpoint example

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
EndpointResolutionContextProperty	Hiermee definieert u een contexteigenschap die wordt gebruikt in eindpuntomzetting. Deze eigenschap moet worden opgegeven in het workloadmanifest om de juiste eindpuntbepaling door Fabric te garanderen.
EndpointResolutionContextPropertyName	De naam van de eigenschap voor eindpuntomzettingscontext.
EndpointResolutionRequest
EndpointResolutionResponse
ErrorExtendedInformation	De uitgebreide foutinformatie.
ErrorResponse	Het foutbericht.
ErrorSource	De bron van de fout.
NameValuePair	Een naam-waardepaar.

EndpointResolutionContextProperty

Object

Hiermee definieert u een contexteigenschap die wordt gebruikt in eindpuntomzetting. Deze eigenschap moet worden opgegeven in het workloadmanifest om de juiste eindpuntbepaling door Fabric te garanderen.

Name	Type	Description
name	EndpointResolutionContextPropertyName	De naam van de eigenschap voor eindpuntomzettingscontext.
value	string	De waarde van de contexteigenschap.

EndpointResolutionContextPropertyName

Opsomming

De naam van de eigenschap voor eindpuntomzettingscontext.

Waarde	Description
EndpointName	De naam van het eindpunt.
TenantRegion	De tenantregio.
WorkspaceRegion	De werkruimteregio.
TenantId	De tenant-id.

EndpointResolutionRequest

Object

Name	Type	Description
context	EndpointResolutionContextProperty[]	Matrix met contexteigenschappen voor eindpuntresolutie.

EndpointResolutionResponse

Object

Name	Type	Description
ttlInMinutes	integer (int32)	Time to live in minuten voor de opgeloste URL.
url	string	De opgeloste URL van de service.

ErrorExtendedInformation

Object

De uitgebreide foutinformatie.

Name	Type	Description
additionalParameters	NameValuePair[]	Een lijst met aanvullende parameters die specifiek zijn voor de fout.
errorCode	string	De foutcode.
message	string	Het foutbericht.
messageParameters	string[]	Een lijst met parameters voor het opmaken van een gelokaliseerd bericht.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	De foutcode.
isPermanent	boolean	Geeft aan of de fout permanent is of dat de bewerking opnieuw kan worden geprobeerd.
message	string	Het foutbericht.
messageParameters	string[]	Een lijst met parameters voor het opmaken van een gelokaliseerd bericht.
moreDetails	ErrorExtendedInformation[]	Een lijst met aanvullende foutdetails.
source	ErrorSource	De bron van de fout.

ErrorSource

Opsomming

De bron van de fout.

Waarde	Description
System	De fout is afkomstig van het systeem.
User	De fout is afkomstig van gebruikersinvoer.
External	De fout is afkomstig van een externe bron.

NameValuePair

Object

Een naam-waardepaar.

Name	Type	Description
name	string	De naam.
value	string	De waarde.