Partilhar via

Endpoint Resolution - Resolve

Serviço:
Workload Development
Versão da API:
v1

Resolver um ponto de extremidade para um determinado serviço chamado pelo Microsoft Fabric
Resolve o ponto de extremidade de um determinado serviço chamado pelo Microsoft Fabric com base na região do locatário e na região do espaço de trabalho. O Fabric fornece um conjunto de propriedades de contexto e retorna a URL de ponto de extremidade de serviço apropriada e seu tempo de vida (TTL).

A API de Resolução de Pontos Finais é crucial para serviços que exigem determinação dinâmica de pontos finais com base no contexto operacional. Isso permite roteamento otimizado e conformidade regional.

Para resolver um ponto de extremidade, o Fabric enviará uma solicitação POST com as propriedades de contexto necessárias no corpo da solicitação. A resposta conterá o URL resolvido e seu TTL, que indica por quanto tempo o URL é considerado válido.

Para obter exemplos de implementação e uso, consulte o Endpoint Resolution Sample Code.

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

Cabeçalho do Pedido

Name Necessário Tipo Description
ActivityId True

string

Um ID exclusivo para correlacionar a solicitação com seu sistema quando um usuário interage com sua carga de trabalho.
RequestId True

string

Um ID exclusivo globalmente que ajuda o Fabric a correlacionar sua solicitação com nossos registros. Forneça essa ID ao relatar um problema.
Authorization True

string

Um cabeçalho de autorização de token duplo que permite que a carga de trabalho valide a origem da solicitação, forneça contexto de usuário e chame outros serviços. Este cabeçalho tem o seguinte formato: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".

Corpo do Pedido

Name Necessário Tipo Description
context True

EndpointResolutionContextProperty[]

Matriz de propriedades de contexto para resolução de pontos finais.

Respostas

Name Tipo Description
200 OK

EndpointResolutionResponse

Resposta de resolução de endpoint
Other Status Codes

ErrorResponse

Para condições de erro, a carga de trabalho deve retornar um código de status de erro HTTP apropriado (4xx, 5xx) com informações detalhadas de erro no corpo da resposta.

Definições

Name Description
EndpointResolutionContextProperty

Define uma propriedade de contexto usada na resolução de pontos de extremidade. Essa propriedade deve ser especificada no manifesto da carga de trabalho para garantir a determinação correta do ponto de extremidade pela malha.
EndpointResolutionContextPropertyName

O nome da propriedade para o contexto de resolução do ponto de extremidade.
EndpointResolutionRequest
EndpointResolutionResponse
ErrorExtendedInformation

As informações de erro estendidas.
ErrorResponse

A resposta de erro.
ErrorSource

A origem do erro.
NameValuePair

Um par nome-valor.

EndpointResolutionContextProperty

Object

Define uma propriedade de contexto usada na resolução de pontos de extremidade. Essa propriedade deve ser especificada no manifesto da carga de trabalho para garantir a determinação correta do ponto de extremidade pela malha.

Name Tipo Description
name

EndpointResolutionContextPropertyName

O nome da propriedade context.
value

string

O valor da propriedade context.

EndpointResolutionContextPropertyName

Enumeração

O nome da propriedade para o contexto de resolução do ponto de extremidade.

Valor Description
EndpointName
TenantRegion
WorkspaceRegion
TenantId

EndpointResolutionRequest

Object
Name Tipo Description
context

EndpointResolutionContextProperty[]

Matriz de propriedades de contexto para resolução de pontos finais.

EndpointResolutionResponse

Object
Name Tipo Description
ttlInMinutes

integer (int32)

Tempo de vida em minutos para o URL resolvido.
url

string

A URL resolvida do serviço.

ErrorExtendedInformation

Object

As informações de erro estendidas.

Name Tipo Description
additionalParameters

NameValuePair[]

Uma lista de parâmetros adicionais específicos para o erro.
errorCode

string

O código de erro.
message

string

A mensagem de erro.
messageParameters

string[]

Uma lista de parâmetros para formatar uma mensagem localizada.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

O código de erro.
isPermanent

boolean

Indica se o erro é permanente ou se a operação pode ser repetida.
message

string

A mensagem de erro.
messageParameters

string[]

Uma lista de parâmetros para formatar uma mensagem localizada.
moreDetails

ErrorExtendedInformation[]

Uma lista de detalhes de erro adicionais.
source

ErrorSource

A origem do erro.

ErrorSource

Enumeração

A origem do erro.

Valor Description
System
User
External

NameValuePair

Object

Um par nome-valor.

Name Tipo Description
name

string

O nome.
value

string

O valor.