Compartilhar via


Items - Get Connection String

Retorna a cadeia de conexão SQL do warehouse especificado.

Permissions

O chamador deve ter permissões de leitura para o armazém. O chamador deve ter função de visualizador ou de workspace superior.

Escopos delegados necessários

Warehouse.Read.All ou Warehouse.ReadWrite.All ou Item.Read.All ou Item.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades da Microsoft listadas nesta seção.

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

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString?guestTenantId={guestTenantId}&privateLinkType={privateLinkType}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
warehouseId
path True

string (uuid)

A ID do armazém.

workspaceId
path True

string (uuid)

A ID do workspace.

guestTenantId
query

string (uuid)

A ID do locatário convidado se o locatário do usuário final for diferente do locatário do armazém.

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

Nome Tipo Description
200 OK

ConnectionStringResponse

Solicitação concluída com êxito.

Other Status Codes

ErrorResponse

Códigos de erro comuns:

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

  • InvalidGuestTenantId – A ID do locatário convidado fornecida não existe.

Exemplos

Get connection string example

Solicitação de exemplo

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

Resposta de exemplo

{
  "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m-jh0bi.zcf.datawarehouse.fabric.microsoft.com"
}

Definições

Nome Description
ConnectionStringResponse

A cadeia de conexão SQL para o workspace que contém esse warehouse.

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

A cadeia de conexão SQL para o workspace que contém esse warehouse.

Nome Tipo Description
connectionString

string

A cadeia de conexão SQL para o workspace que contém esse warehouse.

ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.

Nome Tipo Description
resourceId

string

A ID do recurso envolvida no erro.

resourceType

string

O tipo do recurso envolvido no erro.

ErrorResponse

A resposta de erro.

Nome Tipo Description
errorCode

string

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

message

string

Uma representação legível humana do erro.

moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.

relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao erro.

requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Os detalhes da resposta de erro.

Nome Tipo Description
errorCode

string

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

message

string

Uma representação legível humana do erro.

relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionado ao 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.

Valor Description
None

Nenhum link privado (padrão).

Workspace

Link privado do workspace.