Connections - Create Connection

Serviço:: Core

Versão da API:: v1

Cria uma conexão.
Para criptografar credenciais, consulte Configurar credenciais programaticamente.

Permissions

Se estiver criando uma conexão de gateway, o chamador deverá ter permissões para o gateway.
As Entidades de Serviço devem ter permissão concedida pelo administrador do Fabric. Para obter mais informações, consulte: as entidades de serviço podem criar workspaces, conexões e pipelines de implantação.

Escopos delegados necessários

Connection.ReadWrite.All

Identidades com suporte do Microsoft Entra

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

Identity	Support
User	Yes
entidade de serviço e identidades gerenciadas	Yes

Interface

POST https://api.fabric.microsoft.com/v1/connections

Corpo da solicitação

O corpo da solicitação pode ser um dos seguintes:

Nome	Description
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Nome	Obrigatório	Tipo	Description
connectionDetails	True	CreateConnectionDetails	Os detalhes da conexão.
connectivityType	True	string: ShareableCloud	O tipo de conectividade da conexão.
credentialDetails	True	CreateCredentialDetails	Os detalhes da credencial da conexão.
displayName	True	string	O nome de exibição da conexão. O comprimento máximo é de 200 caracteres.
allowConnectionUsageInGateway		boolean	Permitir que essa conexão seja utilizada com gateways de dados locais ou gateways de dados da VNet.
privacyLevel		PrivacyLevel	(Opcional) O nível de privacidade da conexão. Quando nenhum valor é passado, isso é definido como "Organizacional".

CreateOnPremisesConnectionRequest

Nome	Obrigatório	Tipo	Description
connectionDetails	True	CreateConnectionDetails	Os detalhes da conexão.
connectivityType	True	string: OnPremisesGateway	O tipo de conectividade da conexão.
credentialDetails	True	CreateOnPremisesCredentialDetails	Os detalhes da credencial da conexão.
displayName	True	string	O nome de exibição da conexão. O comprimento máximo é de 200 caracteres.
gatewayId	True	string (uuid)	A ID do objeto do gateway primário do gateway local no qual a conexão é criada.
privacyLevel		PrivacyLevel	(Opcional) O nível de privacidade da conexão. Quando nenhum valor é passado, isso é definido como "Organizacional".

CreateVirtualNetworkGatewayConnectionRequest

Nome	Obrigatório	Tipo	Description
connectionDetails	True	CreateConnectionDetails	Os detalhes da conexão.
connectivityType	True	string: VirtualNetworkGateway	O tipo de conectividade da conexão.
credentialDetails	True	CreateCredentialDetails	Os detalhes da credencial da conexão.
displayName	True	string	O nome de exibição da conexão. O comprimento máximo é de 200 caracteres.
gatewayId	True	string (uuid)	A ID do objeto do gateway de rede virtual no qual a conexão é criada.
privacyLevel		PrivacyLevel	(Opcional) O nível de privacidade da conexão. Quando nenhum valor é passado, isso é definido como "Organizacional".

Respostas

Nome	Tipo	Description
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. A operação foi bem-sucedida.
Other Status Codes	ErrorResponse	Códigos de erro comuns: DuplicateConnectionName – O nome da conexão já está em uso. InvalidConnectionDetails – a entrada ConnectionDetails fornecida não é válida. InvalidCredentialDetails – a entrada CredentialDetails fornecida não é válida. IncorrectCredentials – Falha ao estabelecer a conexão usando a entrada Credenciais. CreateGatewayConnectionFailed – Falha ao criar uma conexão de gateway.

Nome

Tipo

Description

201 Created

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

Created. A operação foi bem-sucedida.

Other Status Codes

ErrorResponse

Códigos de erro comuns:

DuplicateConnectionName – O nome da conexão já está em uso.
InvalidConnectionDetails – a entrada ConnectionDetails fornecida não é válida.
InvalidCredentialDetails – a entrada CredentialDetails fornecida não é válida.
IncorrectCredentials – Falha ao estabelecer a conexão usando a entrada Credenciais.
CreateGatewayConnectionFailed – Falha ao criar uma conexão de gateway.

Exemplos

Cloud example

On-premises gateway example

Virtual network gateway example

Cloud example

Solicitação de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/connections

{
  "connectivityType": "ShareableCloud",
  "displayName": "ContosoCloudConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Basic",
      "username": "admin",
      "password": "********"
    }
  }
}

Resposta de exemplo

Código de status:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoCloudConnection",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

On-premises gateway example

Solicitação de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/connections

{
  "connectivityType": "OnPremisesGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoOnPremisesConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Windows",
      "values": [
        {
          "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
          "encryptedCredentials": "************************************"
        },
        {
          "gatewayId": "55226bab-5024-4b72-9716-6dc8ef3a97fe",
          "encryptedCredentials": "************************************"
        }
      ]
    }
  }
}

Resposta de exemplo

Código de status:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoOnPremisesConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "OnPremisesGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

Virtual network gateway example

Solicitação de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/connections

{
  "connectivityType": "VirtualNetworkGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoVirtualNetworkGatewayConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Basic",
      "username": "admin",
      "password": "*********"
    }
  }
}

Resposta de exemplo

Código de status:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoVirtualNetworkGatewayConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "VirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false
  }
}

Definições

Nome	Description
AnonymousCredentials	Credenciais para Anonymous CredentialType.
BasicCredentials	Credenciais para Basic CredentialType.
ConnectionDetailsBooleanParameter	ConnectionDetailsParameter para dataType booliano.
ConnectionDetailsDateParameter	ConnectionDetailsParameter para data dataType.
ConnectionDetailsDateTimeParameter	ConnectionDetailsParameter para dateTime dataType.
ConnectionDetailsDateTimeZoneParameter	ConnectionDetailsParameter para dateTimeZone dataType.
ConnectionDetailsDurationParameter	ConnectionDetailsParameter para dataType de duração.
ConnectionDetailsNumberParameter	ConnectionDetailsParameter para dataType numérico.
ConnectionDetailsTextParameter	ConnectionDetailsParameter para dataType de texto.
ConnectionDetailsTimeParameter	ConnectionDetailsParameter para dataType de tempo.
ConnectionEncryption	O tipo de criptografia de conexão da conexão. Valores adicionais de criptografia de conexão podem ser adicionados ao longo do tempo.
ConnectivityType	O tipo de conectividade da conexão. Tipos de conectividade adicionais podem ser adicionados ao longo do tempo.
CreateCloudConnectionRequest
CreateConnectionDetails	A entrada de detalhes da conexão para criar operações.
CreateCredentialDetails	A entrada de detalhes da credencial para criar uma conexão.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	A entrada de detalhes de credencial para criar uma conexão de gateway local.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	O tipo de credencial da conexão. Tipos de credenciais adicionais podem ser adicionados ao longo do tempo.
DataType	O tipo de dados do valor do parâmetro de criação de conexão. Valores de tipo de dados adicionais podem ser adicionados ao longo do tempo.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
KeyCredentials	Credenciais para Key CredentialType.
ListConnectionDetails	A saída de detalhes da conexão para operações de lista.
ListCredentialDetails	Os detalhes da credencial retornados ao buscar uma conexão.
OnPremisesCredentialEntry	Uma ID de gateway e suas credenciais serializadas criptografadas.
OnPremisesGatewayConnection	Uma conexão que se conecta por meio do gateway de dados local.
OnPremisesGatewayCredentials	Credenciais para autenticação por meio de um gateway local.
OnPremisesGatewayPersonalConnection	Uma conexão que se conecta por meio de um gateway de dados local pessoal.
PersonalCloudConnection	Uma conexão que se conecta por meio da nuvem e não pode ser compartilhada.
PrivacyLevel	A configuração de nível de privacidade da conexão. Níveis de privacidade adicionais podem ser adicionados ao longo do tempo.
ServicePrincipalCredentials	Credenciais para ServicePrincipal CredentialType.
ShareableCloudConnection	Uma conexão que se conecta por meio da nuvem.
SharedAccessSignatureCredentials	Credenciais para SharedAccessSignature CredentialType.
SingleSignOnType	O tipo de logon único da conexão. Tipos adicionais de logon único podem ser adicionados ao longo do tempo.
VirtualNetworkGatewayConnection	Uma conexão que se conecta por meio de um gateway de dados de rede virtual.
WindowsCredentials	Credenciais para o Windows CredentialType.
WindowsWithoutImpersonationCredentials	Credenciais para WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Credenciais para WorkspaceIdentity CredentialType.

AnonymousCredentials

Objeto

Credenciais para Anonymous CredentialType.

Nome	Tipo	Description
credentialType	string: Anonymous	O tipo de credencial da conexão.

BasicCredentials

Objeto

Credenciais para Basic CredentialType.

Nome	Tipo	Description
credentialType	string: Basic	O tipo de credencial da conexão.
password	string	A senha.
username	string	O nome de usuário.

ConnectionDetailsBooleanParameter

Objeto

ConnectionDetailsParameter para dataType booliano.

Nome	Tipo	Description
dataType	string: Boolean	O tipo de dados do parâmetro.
name	string	O nome do parâmetro.
value	boolean	O valor booliano.

ConnectionDetailsDateParameter

Objeto

ConnectionDetailsParameter para data dataType.

Nome	Tipo	Description
dataType	string: Date	O tipo de dados do parâmetro.
name	string	O nome do parâmetro.
value	string (date)	O valor de data usando o formato YYYY-MM-DD.

ConnectionDetailsDateTimeParameter

Objeto

ConnectionDetailsParameter para dateTime dataType.

Nome	Tipo	Description
dataType	string: DateTime	O tipo de dados do parâmetro.
name	string	O nome do parâmetro.
value	string (date-time)	O valor de data e hora usando YYYY-MM-DDTHH:mm:ss. Formato FFFZ.

ConnectionDetailsDateTimeZoneParameter

Objeto

ConnectionDetailsParameter para dateTimeZone dataType.

Nome	Tipo	Description
dataType	string: DateTimeZone	O tipo de dados do parâmetro.
name	string	O nome do parâmetro.
value	string (date-time-offset)	O valor de fuso horário de data usando YYYY-MM-DDTHH:mm:ss. Formato FFF±hh:mm.

ConnectionDetailsDurationParameter

Objeto

ConnectionDetailsParameter para dataType de duração.

Nome	Tipo	Description
dataType	string: Duration	O tipo de dados do parâmetro.
name	string	O nome do parâmetro.
value	string (time-span)	O valor de duração usando o formato [-]P(n)DT(n)H(n)M(n)S. Por exemplo: P3DT4H30M10S (por 3 dias, 4 horas, 30 minutos e 10 segundos).

ConnectionDetailsNumberParameter

Objeto

ConnectionDetailsParameter para dataType numérico.

Nome	Tipo	Description
dataType	string: Number	O tipo de dados do parâmetro.
name	string	O nome do parâmetro.
value	number	O valor do número.

ConnectionDetailsTextParameter

Objeto

ConnectionDetailsParameter para dataType de texto.

Nome	Tipo	Description
dataType	string: Text	O tipo de dados do parâmetro.
name	string	O nome do parâmetro.
value	string	O valor do texto.

ConnectionDetailsTimeParameter

Objeto

ConnectionDetailsParameter para dataType de tempo.

Nome	Tipo	Description
dataType	string: Time	O tipo de dados do parâmetro.
name	string	O nome do parâmetro.
value	string (time)	O valor de tempo usando HH:mm:ss. Formato FFFZ.

ConnectionEncryption

Enumeração

O tipo de criptografia de conexão da conexão. Valores adicionais de criptografia de conexão podem ser adicionados ao longo do tempo.

Valor	Description
Encrypted	A tentativa de conexão é feita usando uma conexão criptografada.
Any	A tentativa de conexão é feita primeiro usando uma conexão criptografada e, em seguida, retorna à conexão não criptografada se não tiver êxito.
NotEncrypted	A tentativa de conexão é feita usando uma conexão não criptografada.

ConnectivityType

Enumeração

O tipo de conectividade da conexão. Tipos de conectividade adicionais podem ser adicionados ao longo do tempo.

Valor	Description
ShareableCloud	A conexão se conecta por meio da nuvem e pode ser compartilhada com outras pessoas.
PersonalCloud	A conexão se conecta por meio da nuvem e não pode ser compartilhada com outras pessoas.
OnPremisesGateway	A conexão se conecta por meio de um gateway de dados local.
OnPremisesGatewayPersonal	A conexão se conecta por meio de um gateway de dados local pessoal.
VirtualNetworkGateway	A conexão se conecta por meio de um gateway de dados de rede virtual.
Automatic	A conexão se conecta por meio da nuvem usando uma conexão de dados implícita. Essa opção só está disponível para cenários específicos, como modelos semânticos que usam SSO (single Sign-On)."
None	A conexão não está associada

CreateCloudConnectionRequest

Objeto

Nome	Tipo	Description
allowConnectionUsageInGateway	boolean	Permitir que essa conexão seja utilizada com gateways de dados locais ou gateways de dados da VNet.
connectionDetails	CreateConnectionDetails	Os detalhes da conexão.
connectivityType	string: ShareableCloud	O tipo de conectividade da conexão.
credentialDetails	CreateCredentialDetails	Os detalhes da credencial da conexão.
displayName	string	O nome de exibição da conexão. O comprimento máximo é de 200 caracteres.
privacyLevel	PrivacyLevel	(Opcional) O nível de privacidade da conexão. Quando nenhum valor é passado, isso é definido como "Organizacional".

CreateConnectionDetails

Objeto

A entrada de detalhes da conexão para criar operações.

Nome	Tipo	Description
creationMethod	string	O método de criação usado para criar a conexão. Para obter uma lista de métodos de criação, use a API ListSupportedConnectionTypes .
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	A lista de parâmetros de conexão. Para obter uma lista de parâmetros para cada método de criação, use a API ListSupportedConnectionTypes .
type	string	O tipo da conexão.

CreateCredentialDetails

Objeto

A entrada de detalhes da credencial para criar uma conexão.

Nome	Tipo	Description
connectionEncryption	ConnectionEncryption	(Opcional) A configuração de criptografia de conexão usada durante a conexão de teste. Quando nenhum valor é passado, a conexão não é criptografada.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	As credenciais da conexão.
singleSignOnType	SingleSignOnType	(Opcional) O tipo de logon único da conexão. Quando nenhum valor é passado, a conexão não usa logon único.
skipTestConnection	boolean	Se a conexão deve ignorar a conexão de teste durante a criação e atualização. True – Ignorar a conexão de teste, False – Não ignore a conexão de teste. Quando nenhum valor é passado, isso é definido como 'False'.

CreateOnPremisesConnectionRequest

Objeto

Nome	Tipo	Description
connectionDetails	CreateConnectionDetails	Os detalhes da conexão.
connectivityType	string: OnPremisesGateway	O tipo de conectividade da conexão.
credentialDetails	CreateOnPremisesCredentialDetails	Os detalhes da credencial da conexão.
displayName	string	O nome de exibição da conexão. O comprimento máximo é de 200 caracteres.
gatewayId	string (uuid)	A ID do objeto do gateway primário do gateway local no qual a conexão é criada.
privacyLevel	PrivacyLevel	(Opcional) O nível de privacidade da conexão. Quando nenhum valor é passado, isso é definido como "Organizacional".

CreateOnPremisesCredentialDetails

Objeto

A entrada de detalhes de credencial para criar uma conexão de gateway local.

Nome	Tipo	Description
connectionEncryption	ConnectionEncryption	(Opcional) A configuração de criptografia de conexão usada durante a conexão de teste. Quando nenhum valor é passado, a conexão não é criptografada.
credentials	OnPremisesGatewayCredentials	As credenciais da conexão.
singleSignOnType	SingleSignOnType	(Opcional) O tipo de logon único da conexão. Quando nenhum valor é passado, a conexão não usa logon único.
skipTestConnection	boolean	Se a conexão deve ignorar a conexão de teste durante a criação e atualização. True – Ignorar a conexão de teste, False – Não ignore a conexão de teste. Quando nenhum valor é passado, isso é definido como 'False'.

CreateVirtualNetworkGatewayConnectionRequest

Objeto

Nome	Tipo	Description
connectionDetails	CreateConnectionDetails	Os detalhes da conexão.
connectivityType	string: VirtualNetworkGateway	O tipo de conectividade da conexão.
credentialDetails	CreateCredentialDetails	Os detalhes da credencial da conexão.
displayName	string	O nome de exibição da conexão. O comprimento máximo é de 200 caracteres.
gatewayId	string (uuid)	A ID do objeto do gateway de rede virtual no qual a conexão é criada.
privacyLevel	PrivacyLevel	(Opcional) O nível de privacidade da conexão. Quando nenhum valor é passado, isso é definido como "Organizacional".

CredentialType

Enumeração

O tipo de credencial da conexão. Tipos de credenciais adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Windows	A conexão usa a autenticação do Windows para se conectar. Só há suporte para gateways locais.
Anonymous	A conexão usa a autenticação anônima para se conectar.
Basic	A conexão usa a autenticação básica para se conectar.
Key	A conexão usa a autenticação de chave para se conectar.
OAuth2	A conexão usa a autenticação OAuth 2.0 para se conectar.
WindowsWithoutImpersonation	A conexão usa a autenticação do Windows (sem a opção de representação) para se conectar. Só há suporte para gateways locais (modo pessoal).
SharedAccessSignature	A conexão usa a autenticação SAS (assinatura de acesso compartilhado) para se conectar.
ServicePrincipal	A conexão usa a autenticação da entidade de serviço para se conectar.
WorkspaceIdentity	A conexão usa a autenticação de identidade do workspace para se conectar.

DataType

Enumeração

O tipo de dados do valor do parâmetro de criação de conexão. Valores de tipo de dados adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Text	Use o texto como o valor de entrada do parâmetro.
Number	Use o número como o valor de entrada do parâmetro (inteiro ou ponto flutuante).
Boolean	Use booliano como o valor de entrada do parâmetro. False - o valor é false, True - o valor é verdadeiro.
Duration	Use a duração como o valor de entrada do parâmetro, usando o formato [-]P(n)DT(n)H(n)M(n)S. Por exemplo: P3DT4H30M10S (por 3 dias, 4 horas, 30 minutos e 10 segundos).
Date	Use a data como o valor de entrada do parâmetro usando o formato YYYY-MM-DD.
DateTime	Use a hora de data como o valor de entrada do parâmetro, usando YYYY-MM-DDTHH:mm:ss. Formato FFFZ.
DateTimeZone	Use o fuso horário de data como o valor de entrada do parâmetro, usando YYYY-MM-DDTHH:mm:ss. Formato FFF±hh:mm.
Time	Use o tempo como o valor de entrada do parâmetro, usando HH:mm:ss. Formato FFFZ.

ErrorRelatedResource

Objeto

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

Objeto

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

Objeto

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.

KeyCredentials

Objeto

Credenciais para Key CredentialType.

Nome	Tipo	Description
credentialType	string: Key	O tipo de credencial da conexão.
key	string	A chave.

ListConnectionDetails

Objeto

A saída de detalhes da conexão para operações de lista.

Nome	Tipo	Description
path	string	O caminho da conexão.
type	string	O tipo da conexão.

ListCredentialDetails

Objeto

Os detalhes da credencial retornados ao buscar uma conexão.

Nome	Tipo	Description
connectionEncryption	ConnectionEncryption	A configuração de criptografia de conexão usada durante a conexão de teste.
credentialType	CredentialType	O tipo de credencial da conexão.
singleSignOnType	SingleSignOnType	O tipo de logon único da conexão.
skipTestConnection	boolean	Se a conexão deve ignorar a conexão de teste durante a criação e atualização. True – Ignorar a conexão de teste, False – Não ignore a conexão de teste.

OnPremisesCredentialEntry

Objeto

Uma ID de gateway e suas credenciais serializadas criptografadas.

Nome	Tipo	Description
encryptedCredentials	string	O .json serializado criptografado da lista de pares de valores de nome. O nome é um nome de credencial e o valor é um valor de credencial. A criptografia é executada usando o algoritmo de criptografia RSA (Rivest-Shamir-Adleman) com a chave pública do membro do gateway local.
gatewayId	string (uuid)	A ID do objeto do gateway.

OnPremisesGatewayConnection

Objeto

Uma conexão que se conecta por meio do gateway de dados local.

Nome	Tipo	Description
connectionDetails	ListConnectionDetails	Os detalhes da conexão.
connectivityType	string: OnPremisesGateway	O tipo de conectividade da conexão.
credentialDetails	ListCredentialDetails	Os detalhes da credencial da conexão.
displayName	string	O nome de exibição da conexão.
gatewayId	string (uuid)	A ID do objeto do gateway da conexão.
id	string (uuid)	A ID do objeto da conexão.
privacyLevel	PrivacyLevel	O nível de privacidade da conexão.

OnPremisesGatewayCredentials

Objeto

Credenciais para autenticação por meio de um gateway local.

Nome	Tipo	Description
credentialType	CredentialType	O tipo de credencial da conexão.
values	OnPremisesCredentialEntry[]	O conteúdo da credencial a ser enviado para o gateway local.

OnPremisesGatewayPersonalConnection

Objeto

Uma conexão que se conecta por meio de um gateway de dados local pessoal.

Nome	Tipo	Description
connectionDetails	ListConnectionDetails	Os detalhes da conexão.
connectivityType	string: OnPremisesGatewayPersonal	O tipo de conectividade da conexão.
credentialDetails	ListCredentialDetails	Os detalhes da credencial da conexão.
displayName	string	O nome de exibição da conexão.
gatewayId	string (uuid)	A ID do objeto do gateway da conexão.
id	string (uuid)	A ID do objeto da conexão.
privacyLevel	PrivacyLevel	O nível de privacidade da conexão.

PersonalCloudConnection

Objeto

Uma conexão que se conecta por meio da nuvem e não pode ser compartilhada.

Nome	Tipo	Description
allowConnectionUsageInGateway	boolean	Permitir que essa conexão seja utilizada com gateways de dados locais ou gateways de dados da VNet.
connectionDetails	ListConnectionDetails	Os detalhes da conexão.
connectivityType	string: PersonalCloud	O tipo de conectividade da conexão.
credentialDetails	ListCredentialDetails	Os detalhes da credencial da conexão.
displayName	string	O nome de exibição da conexão.
id	string (uuid)	A ID do objeto da conexão.
privacyLevel	PrivacyLevel	O nível de privacidade da conexão.

PrivacyLevel

Enumeração

A configuração de nível de privacidade da conexão. Níveis de privacidade adicionais podem ser adicionados ao longo do tempo.

Valor	Description
None	Nenhuma configuração de nível de privacidade está configurada.
Private	As conexões definidas como privadas contêm informações confidenciais ou confidenciais. A visibilidade pode ser restrita a usuários autorizados. Os dados de uma conexão privada não serão dobrados para outras conexões, incluindo outras conexões privadas.
Organizational	As conexões definidas como organizacionais podem ser dobradas para conexões privadas e outras organizacionais. Eles não podem se dobrar a conexões públicas. A visibilidade é definida como um grupo confiável.
Public	Arquivos, conexões de Internet e dados de pasta de trabalho podem ser definidos como públicos. Os dados podem ser dobrados para outras conexões. A visibilidade está disponível para todos.

ServicePrincipalCredentials

Objeto

Credenciais para ServicePrincipal CredentialType.

Nome	Tipo	Description
credentialType	string: ServicePrincipal	O tipo de credencial da conexão.
servicePrincipalClientId	string (uuid)	A ID do cliente da entidade de serviço.
servicePrincipalSecret	string	O segredo da entidade de serviço.
tenantId	string (uuid)	A ID do locatário da entidade de serviço.

ShareableCloudConnection

Objeto

Uma conexão que se conecta por meio da nuvem.

Nome	Tipo	Description
allowConnectionUsageInGateway	boolean	Permitir que essa conexão seja utilizada com gateways de dados locais ou gateways de dados da VNet.
connectionDetails	ListConnectionDetails	Os detalhes da conexão.
connectivityType	string: ShareableCloud	O tipo de conectividade da conexão.
credentialDetails	ListCredentialDetails	Os detalhes da credencial da conexão.
displayName	string	O nome de exibição da conexão.
id	string (uuid)	A ID do objeto da conexão.
privacyLevel	PrivacyLevel	O nível de privacidade da conexão.

SharedAccessSignatureCredentials

Objeto

Credenciais para SharedAccessSignature CredentialType.

Nome	Tipo	Description
credentialType	string: SharedAccessSignature	O tipo de credencial da conexão.
token	string	O token.

SingleSignOnType

Enumeração

O tipo de logon único da conexão. Tipos adicionais de logon único podem ser adicionados ao longo do tempo.

Valor	Description
None	A conexão não usa logon único para se conectar.
Kerberos	A conexão usa o logon único kerberos para se conectar.
MicrosoftEntraID	A conexão usa o logon único do Microsoft Entra ID para se conectar.
SecurityAssertionMarkupLanguage	A conexão usa o logon único SAML (Security Assertion Markup Language) para se conectar.
KerberosDirectQueryAndRefresh	A conexão usa o logon único Kerberos DirectQuery e Refresh para se conectar.

VirtualNetworkGatewayConnection

Objeto

Uma conexão que se conecta por meio de um gateway de dados de rede virtual.

Nome	Tipo	Description
connectionDetails	ListConnectionDetails	Os detalhes da conexão.
connectivityType	string: VirtualNetworkGateway	O tipo de conectividade da conexão.
credentialDetails	ListCredentialDetails	Os detalhes da credencial da conexão.
displayName	string	O nome de exibição da conexão.
gatewayId	string (uuid)	A ID do objeto do gateway da conexão.
id	string (uuid)	A ID do objeto da conexão.
privacyLevel	PrivacyLevel	O nível de privacidade da conexão.

WindowsCredentials

Objeto

Credenciais para o Windows CredentialType.

Nome	Tipo	Description
credentialType	string: Windows	O tipo de credencial da conexão.
password	string	A senha.
username	string	O nome de usuário.

WindowsWithoutImpersonationCredentials

Objeto

Credenciais para WindowsWithoutImpersonation CredentialType.

Nome	Tipo	Description
credentialType	string: WindowsWithoutImpersonation	O tipo de credencial da conexão.

WorkspaceIdentityCredentials

Objeto

Credenciais para WorkspaceIdentity CredentialType.

Nome	Tipo	Description
credentialType	string: WorkspaceIdentity	O tipo de credencial da conexão.

Compartilhar via

Connections - Create Connection

Permissions

Escopos delegados necessários

Identidades com suporte do Microsoft Entra

Interface

Corpo da solicitação

CreateCloudConnectionRequest

CreateOnPremisesConnectionRequest

CreateVirtualNetworkGatewayConnectionRequest

Respostas

Exemplos

Cloud example

Solicitação de exemplo

Resposta de exemplo

On-premises gateway example

Solicitação de exemplo

Resposta de exemplo

Virtual network gateway example

Solicitação de exemplo

Resposta de exemplo

Definições

AnonymousCredentials

BasicCredentials

ConnectionDetailsBooleanParameter

ConnectionDetailsDateParameter

ConnectionDetailsDateTimeParameter

ConnectionDetailsDateTimeZoneParameter

ConnectionDetailsDurationParameter

ConnectionDetailsNumberParameter

ConnectionDetailsTextParameter

ConnectionDetailsTimeParameter

ConnectionEncryption

ConnectivityType

CreateCloudConnectionRequest

CreateConnectionDetails

CreateCredentialDetails

CreateOnPremisesConnectionRequest

CreateOnPremisesCredentialDetails

CreateVirtualNetworkGatewayConnectionRequest

CredentialType

DataType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

KeyCredentials

ListConnectionDetails

ListCredentialDetails

OnPremisesCredentialEntry

OnPremisesGatewayConnection

OnPremisesGatewayCredentials

OnPremisesGatewayPersonalConnection

PersonalCloudConnection

PrivacyLevel

ServicePrincipalCredentials

ShareableCloudConnection

SharedAccessSignatureCredentials

SingleSignOnType

VirtualNetworkGatewayConnection

WindowsCredentials

WindowsWithoutImpersonationCredentials

WorkspaceIdentityCredentials