Endpoint Resolution - Resolve

Serviço:: Workload Development

Versão da API:: v1

Resolver um endpoint para um dado serviço chamado pelo Microsoft Fabric
Resolve o endpoint para um dado serviço chamado pela Microsoft Fabric com base na região do inquilino e na região do espaço de trabalho. O Fabric fornece um conjunto de propriedades de contexto e devolve a URL apropriada do endpoint de serviço e o seu time-to-live (TTL).

A API de Resolução de Endpoints é crucial para serviços que requerem determinação dinâmica de endpoints com base no contexto operacional. Isto permite um encaminhamento otimizado e conformidade regional.

Para resolver um endpoint, o Fabric enviará um pedido POST com as propriedades de contexto necessárias no corpo do pedido. A resposta conterá a URL resolvida e o seu TTL, que indica quanto tempo a URL é considerada válida.

Para exemplos de implementação e utilização, consulte o Código de Exemplo de Resolução de Endpoint.

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

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
ActivityId	True	string (uuid)	Um ID único para correlacionar o pedido com o seu sistema quando um utilizador interage com a sua carga de trabalho.
RequestId	True	string (uuid)	Um ID globalmente único que ajuda o Fabric a correlacionar o seu pedido com os nossos registos. Forneça este ID ao reportar um problema.
Authorization	True	string	Um cabeçalho de autorização de token duplo que permite à carga de trabalho validar a origem do pedido, fornecer contexto ao utilizador e chamar 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[]	Array de propriedades contextuais para resolução de endpoint.

Respostas

Name	Tipo	Description
200 OK	EndpointResolutionResponse	Resposta de resolução do endpoint.
Other Status Codes	ErrorResponse	Para condições de erro, a carga de trabalho deve devolver um código de estado de erro HTTP apropriado (4xx, 5xx) com informação detalhada de erro no corpo da resposta.

Exemplos

Resolve endpoint example

Pedido de amostra

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
EndpointResolutionContextProperty	Define uma propriedade de contexto usada na resolução de endpoints. Esta propriedade deve ser especificada no manifesto da carga de trabalho para garantir a correta determinação dos endpoints pelo Fabric.
EndpointResolutionContextPropertyName	O nome da propriedade para o contexto de resolução do endpoint.
EndpointResolutionRequest
EndpointResolutionResponse
ErrorExtendedInformation	A informação de erro alargada.
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 endpoints. Esta propriedade deve ser especificada no manifesto da carga de trabalho para garantir a correta determinação dos endpoints pelo Fabric.

Name	Tipo	Description
name	EndpointResolutionContextPropertyName	O nome da propriedade para o contexto de resolução do endpoint.
value	string	O valor da propriedade de contexto.

EndpointResolutionContextPropertyName

Enumeração

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

Valor	Description
EndpointName	O nome do endpoint.
TenantRegion	A região inquilina.
WorkspaceRegion	A região do espaço de trabalho.
TenantId	O ID do locatário.

EndpointResolutionRequest

Object

Name	Tipo	Description
context	EndpointResolutionContextProperty[]	Array de propriedades contextuais para resolução de endpoint.

EndpointResolutionResponse

Object

Name	Tipo	Description
ttlInMinutes	integer (int32)	Hora de viver em minutos para o URL resolvido.
url	string	A URL resolvida do serviço.

ErrorExtendedInformation

Object

A informação de erro alargada.

Name	Tipo	Description
additionalParameters	NameValuePair[]	Uma lista de parâmetros adicionais específicos do 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 tentada novamente.
message	string	A mensagem de erro.
messageParameters	string[]	Uma lista de parâmetros para formatar uma mensagem localizada.
moreDetails	ErrorExtendedInformation[]	Uma lista de detalhes adicionais sobre erros.
source	ErrorSource	A origem do erro.

ErrorSource

Enumeração

A origem do erro.

Valor	Description
System	O erro originou-se no sistema.
User	O erro originou-se a partir de uma entrada do utilizador.
External	O erro teve origem numa fonte externa.

NameValuePair

Object

Um par nome-valor.

Name	Tipo	Description
name	string	O nome.
value	string	O valor.

Partilhar via

Endpoint Resolution - Resolve

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Exemplos

Resolve endpoint example

Pedido de amostra

Resposta da amostra

Definições

EndpointResolutionContextProperty

EndpointResolutionContextPropertyName

EndpointResolutionRequest

EndpointResolutionResponse

ErrorExtendedInformation

ErrorResponse

ErrorSource

NameValuePair