Compartilhar 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 e na região do workspace do locatário. O Fabric fornece um conjunto de propriedades de contexto e retorna a URL de ponto de extremidade de serviço apropriada e sua TTL (vida útil).

A API de Resolução de Ponto de Extremidade é crucial para serviços que exigem determinação dinâmica de ponto de extremidade 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á a URL resolvida e sua TTL, que indica por quanto tempo a URL é considerada válida.

Para obter exemplos de implementação e uso de exemplo, consulte o de código de exemplo de resolução de ponto de extremidade.

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

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
ActivityId True

string

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

string

Uma ID global exclusiva que ajuda o Fabric a correlacionar sua solicitação com nossos logs. 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 o contexto do usuário e chame outros serviços. Esse cabeçalho tem o seguinte formato: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".

Corpo da solicitação

Nome Obrigatório Tipo Description
context True

EndpointResolutionContextProperty[]

Matriz de propriedades de contexto para resolução de ponto de extremidade.

Respostas

Nome Tipo Description
200 OK

EndpointResolutionResponse

Resposta de resolução de ponto de extremidade
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

Nome Description
EndpointResolutionContextProperty

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

O nome da propriedade para o contexto de resolução de 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

Objeto

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

Nome Tipo Description
name

EndpointResolutionContextPropertyName

O nome da propriedade de contexto.
value

string

O valor da propriedade de contexto.

EndpointResolutionContextPropertyName

Enumeração

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

Valor Description
EndpointName
TenantRegion
WorkspaceRegion
TenantId

EndpointResolutionRequest

Objeto
Nome Tipo Description
context

EndpointResolutionContextProperty[]

Matriz de propriedades de contexto para resolução de ponto de extremidade.

EndpointResolutionResponse

Objeto
Nome Tipo Description
ttlInMinutes

integer (int32)

Tempo de vida útil em minutos para a URL resolvida.
url

string

A URL resolvida do serviço.

ErrorExtendedInformation

Objeto

As informações de erro estendidas.

Nome Tipo Description
additionalParameters

NameValuePair[]

Uma lista de parâmetros adicionais específicos ao 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

Objeto

A resposta de erro.

Nome 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

Objeto

Um par nome-valor.

Nome Tipo Description
name

string

O nome.
value

string

O valor.