Partilhar via

Items - Get Connection String

Serviço:
SQLEndpoint
Versão da API:
v1

Retorna a cadeia de conexão SQL do depósito especificado.

Permissions

O chamador deve ter permissões de leitura para o depósito. O chamador deve ter a função de visualizador ou de espaço de trabalho superior.

Escopos delegados necessários

SqlEndpoint.Read.All ou SqlEndpoint.ReadWrite.All ou Item.Read.All ou Item.ReadWrite.All

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades Microsoft listadas nesta secção.

Identidade Support
User Yes
Entidade de serviço e identidades gerenciadas Yes

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/connectionString
Com parâmetros opcionais: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/connectionString?guestTenantId={guestTenantId}&privateLinkType={privateLinkType}

Parâmetros do URI

Name Em Necessário Tipo Description
sqlEndpointId
 path True

string (uuid)

O ID do ponto de extremidade SQL.
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.
guestTenantId
 query

string (uuid)

A ID do locatário convidado se o locatário do usuário final for diferente do locatário do ponto de extremidade SQL.
privateLinkType
 query

PrivateLinkType

Indica o tipo de link privado que essa cadeia de conexão usa. Tipos adicionais privateLinkType podem ser adicionados ao longo do tempo.

Respostas

Name Tipo Description
200 OK

ConnectionStringResponse

Pedido concluído com sucesso.
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • ItemNotFound - O item solicitado não foi encontrado.

  • InvalidGuestTenantId - A ID fornecida não existe.

Exemplos

Get connection string example

Pedido de amostra

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sqlEndpoints/5b218778-e7a5-4d73-8187-f10824047715/connectionString?guestTenantId=6e335e92-a2a2-4b5a-970a-bd6a89fbb765&privateLinkType=Workspace

Resposta da amostra

Código de estado:
200 
{
  "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m-jh0bi.zcf.datawarehouse.fabric.microsoft.com"
}

Definições

Name Description
ConnectionStringResponse

A cadeia de conexão SQL para o espaço de trabalho que contém esse ponto de extremidade SQL.
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
PrivateLinkType

Indica o tipo de link privado que essa cadeia de conexão usa. Tipos adicionais privateLinkType podem ser adicionados ao longo do tempo.

ConnectionStringResponse

Object

A cadeia de conexão SQL para o espaço de trabalho que contém esse ponto de extremidade SQL.

Name Tipo Description
connectionString

string

A cadeia de conexão SQL para o espaço de trabalho que contém esse ponto de extremidade SQL.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

PrivateLinkType

Enumeração

Indica o tipo de link privado que essa cadeia de conexão usa. Tipos adicionais privateLinkType podem ser adicionados ao longo do tempo.

Valor Description
None

Nenhum link privado (padrão).
Workspace

Link privado do espaço de trabalho.