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
SqlEndpoint.Read.All ou SqlEndpoint.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}/sqlEndpoints/{sqlEndpointId}/connectionStringGET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/connectionString?guestTenantId={guestTenantId}&privateLinkType={privateLinkType}Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
sql
|
path | True |
string (uuid) |
A ID do ponto de extremidade do SQL. |
|
workspace
|
path | True |
string (uuid) |
A ID do workspace. |
|
guest
|
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 do SQL. |
|
|
private
|
query |
Indica o tipo de link privado que essa cadeia de conexão usa. Tipos adicionais |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
Solicitação concluída com êxito. |
|
| Other Status Codes |
Códigos de erro comuns:
|
Exemplos
Get connection string example
Solicitação de exemplo
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 de exemplo
{
"connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m-jh0bi.zcf.datawarehouse.fabric.microsoft.com"
}Definições
| Nome | Description |
|---|---|
|
Connection |
A cadeia de conexão SQL para o workspace que contém esse ponto de extremidade SQL. |
|
Error |
O objeto de detalhes do recurso relacionado ao erro. |
|
Error |
A resposta de erro. |
|
Error |
Os detalhes da resposta de erro. |
|
Private |
Indica o tipo de link privado que essa cadeia de conexão usa. Tipos adicionais |
ConnectionStringResponse
A cadeia de conexão SQL para o workspace que contém esse ponto de extremidade SQL.
| Nome | Tipo | Description |
|---|---|---|
| connectionString |
string |
A cadeia de conexão SQL para o workspace que contém esse ponto de extremidade SQL. |
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 |
Lista de detalhes de erro adicionais. |
|
| relatedResource |
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 |
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. |