Connections - List Supported Connection Types

Referência

Serviço:: Core

Versão da API:: v1

Lista os tipos de conexão com suporte.

Permissões

Se chamado com gatewayId, o chamador deve ter permissão para o gateway.

Escopos delegados necessários

Connection.Read.All ou Connection.ReadWrite.All

Identidades com suporte do Microsoft Entra

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

Identidade	Apoio
Utilizador	Sim
Entidade de serviço e identidades gerenciadas	Sim

Interfase

GET https://api.fabric.microsoft.com/v1/connections/supportedConnectionTypes

Com parâmetros opcionais:

GET https://api.fabric.microsoft.com/v1/connections/supportedConnectionTypes?gatewayId={gatewayId}&showAllCreationMethods={showAllCreationMethods}&continuationToken={continuationToken}

Parâmetros de URI

Nome	Em	Tipo	Description
continuationToken	query	string	Um token para recuperar a próxima página de resultados.
gatewayId	query	string (uuid)	O gateway para listar tipos de conexão com suporte. Se omitida, a API lista os tipos de conexão com suporte na nuvem.
showAllCreationMethods	query	boolean	Configuração que controla se todos os métodos de criação devem ser mostrados. True – Mostrar todos os métodos de criação, False – Mostrar somente métodos de criação recomendados.

Respostas

Nome	Tipo	Description
200 OK	ListSupportedConnectionTypesResponse	OKEY. A operação foi bem-sucedida.
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError – Ocorreu um erro.

Nome

Tipo

Description

200 OK

ListSupportedConnectionTypesResponse

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

Other Status Codes

ErrorResponse

Códigos de erro comuns:

UnknownError – Ocorreu um erro.

Exemplos

Example

Solicitação de exemplo

HTTP

GET https://api.fabric.microsoft.com/v1/connections/supportedConnectionTypes?gatewayId=6d824cb9-6bfb-4bdb-a702-238e172a8743

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "type": "SQL",
      "creationMethods": [
        {
          "name": "SQL",
          "parameters": [
            {
              "name": "server",
              "dataType": "Text",
              "required": true
            },
            {
              "name": "database",
              "dataType": "Text",
              "required": false
            }
          ]
        }
      ],
      "supportedCredentialTypes": [
        "Basic",
        "OAuth2"
      ],
      "supportedConnectionEncryptionTypes": [
        "Encrypted",
        "NotEncrypted"
      ],
      "supportsSkipTestConnection": true
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/connections/supportedConnections?connectivityType=ShareableCloud&continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definições

Nome	Description
ConnectionCreationMetadata
ConnectionCreationMethod
ConnectionCreationParameter
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.
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.
ListSupportedConnectionTypesResponse

ConnectionCreationMetadata

Objeto

Nome	Tipo	Description
creationMethods	ConnectionCreationMethod[]	Uma lista de métodos de criação para a conexão.
supportedConnectionEncryptionTypes	ConnectionEncryption[]	Uma lista de valores de criptografia de conexão que a conexão dá suporte.
supportedCredentialTypes	CredentialType[]	Uma lista de valores de tipo de credencial que a conexão dá suporte.
supportsSkipTestConnection	boolean	Se o tipo de conexão dá suporte a ignorar a conexão de teste. True – O tipo de conexão dá suporte a ignorar a conexão de teste, False – o tipo de conexão não dá suporte a ignorar a conexão de teste.
type	string	O tipo da conexão.

ConnectionCreationMethod

Objeto

Nome	Tipo	Description
name	string	O nome do método de criação.
parameters	ConnectionCreationParameter[]	Uma lista de parâmetros de método de criação para a conexão.

ConnectionCreationParameter

Objeto

Nome	Tipo	Description
allowedValues	string[]	Uma lista de valores permitidos para o parâmetro de criação de conexão.
dataType	DataType	O tipo de dados do parâmetro de criação de conexão.
name	string	O nome do parâmetro de criação de conexão.
required	boolean	Se o parâmetro de criação de conexão é necessário. True – O parâmetro de criação de conexão é necessário, False – o parâmetro de criação de conexão não é necessário.

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
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.
Encrypted	A tentativa de conexão é feita usando uma conexão criptografada.
NotEncrypted	A tentativa de conexão é feita usando uma conexão não criptografada.

CredentialType

Enumeração

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

Valor	Description
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.
ServicePrincipal	A conexão usa a autenticação da entidade de serviço para se conectar.
SharedAccessSignature	A conexão usa a autenticação SAS (assinatura de acesso compartilhado) para se conectar.
Windows	A conexão usa a autenticação do Windows para se conectar. Só há suporte para gateways locais.
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).
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
Boolean	Use booliano como o valor de entrada do parâmetro. False - o valor é false, True - o valor é verdadeiro.
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.
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).
Number	Use o número como o valor de entrada do parâmetro (inteiro ou ponto flutuante).
Text	Use o texto como o valor de entrada do parâmetro.
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.

ListSupportedConnectionTypesResponse

Objeto

Nome	Tipo	Description
continuationToken	string	O token do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri	string	O URI do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
value	ConnectionCreationMetadata[]	Uma lista de tipos de conexão com suporte retornados.

Compartilhar via

Connections - List Supported Connection Types

Permissões

Escopos delegados necessários

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Respostas

Exemplos

Example

Solicitação de exemplo

Resposta de exemplo

Definições

ConnectionCreationMetadata

ConnectionCreationMethod

ConnectionCreationParameter

ConnectionEncryption

CredentialType

DataType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ListSupportedConnectionTypesResponse