Connections - Create Connection

서비스:: Core

API 버전:: v1

연결을 만듭니다.
자격 증명을 암호화하려면 프로그래밍 방식으로 구성을 참조하세요.

Permissions

게이트웨이 연결을 만드는 경우 호출자에게 게이트웨이에 대한 권한이 있어야 합니다.
서비스 주체에는 패브릭 관리자가 부여한 권한이 있어야 합니다. 자세한 내용은 서비스 주체가 작업 영역, 연결 및 배포 파이프라인을 만들 수 있습니다.

필요한 위임된 범위

Connection.ReadWrite.All

Microsoft Entra 지원 ID

이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.

Identity	Support
User	Yes
서비스 주체 및 관리 ID	Yes

Interface

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

요청 본문

요청 본문은 다음 중 하나가 될 수 있습니다.

Name	Description
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Name	필수	형식	Description
connectionDetails	True	CreateConnectionDetails	연결의 연결 세부 정보입니다.
connectivityType	True	string: ShareableCloud	연결의 연결 유형입니다.
credentialDetails	True	CreateCredentialDetails	연결의 자격 증명 세부 정보입니다.
displayName	True	string	연결의 표시 이름입니다. 최대 길이는 200자입니다.
allowConnectionUsageInGateway		boolean	온-프레미스 데이터 게이트웨이 또는 VNet 데이터 게이트웨이에서 이 연결을 사용하도록 허용합니다.
privacyLevel		PrivacyLevel	(선택 사항) 연결의 개인 정보 수준입니다. 값이 전달되지 않으면 '조직'으로 설정됩니다.

CreateOnPremisesConnectionRequest

Name	필수	형식	Description
connectionDetails	True	CreateConnectionDetails	연결의 연결 세부 정보입니다.
connectivityType	True	string: OnPremisesGateway	연결의 연결 유형입니다.
credentialDetails	True	CreateOnPremisesCredentialDetails	연결의 자격 증명 세부 정보입니다.
displayName	True	string	연결의 표시 이름입니다. 최대 길이는 200자입니다.
gatewayId	True	string (uuid)	연결이 만들어지는 온-프레미스 게이트웨이의 기본 게이트웨이의 개체 ID입니다.
privacyLevel		PrivacyLevel	(선택 사항) 연결의 개인 정보 수준입니다. 값이 전달되지 않으면 '조직'으로 설정됩니다.

CreateVirtualNetworkGatewayConnectionRequest

Name	필수	형식	Description
connectionDetails	True	CreateConnectionDetails	연결의 연결 세부 정보입니다.
connectivityType	True	string: VirtualNetworkGateway	연결의 연결 유형입니다.
credentialDetails	True	CreateCredentialDetails	연결의 자격 증명 세부 정보입니다.
displayName	True	string	연결의 표시 이름입니다. 최대 길이는 200자입니다.
gatewayId	True	string (uuid)	연결이 만들어지는 가상 네트워크 게이트웨이의 개체 ID입니다.
privacyLevel		PrivacyLevel	(선택 사항) 연결의 개인 정보 수준입니다. 값이 전달되지 않으면 '조직'으로 설정됩니다.

응답

Name	형식	Description
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. 작업이 성공했습니다.
Other Status Codes	ErrorResponse	일반적인 오류 코드: DuplicateConnectionName - 연결 이름이 이미 사용 중입니다. InvalidConnectionDetails - 제공된 ConnectionDetails 입력이 잘못되었습니다. InvalidCredentialDetails - 제공된 CredentialDetails 입력이 잘못되었습니다. IncorrectCredentials - 자격 증명 입력을 사용하여 연결을 설정하지 못했습니다. CreateGatewayConnectionFailed - 게이트웨이 연결을 만들지 못했습니다.

Name

형식

Description

201 Created

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

Created. 작업이 성공했습니다.

Other Status Codes

ErrorResponse

일반적인 오류 코드:

DuplicateConnectionName - 연결 이름이 이미 사용 중입니다.
InvalidConnectionDetails - 제공된 ConnectionDetails 입력이 잘못되었습니다.
InvalidCredentialDetails - 제공된 CredentialDetails 입력이 잘못되었습니다.
IncorrectCredentials - 자격 증명 입력을 사용하여 연결을 설정하지 못했습니다.
CreateGatewayConnectionFailed - 게이트웨이 연결을 만들지 못했습니다.

예제

Cloud example

On-premises gateway example

Virtual network gateway example

Cloud example

샘플 요청

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": "********"
    }
  }
}

샘플 응답

상태 코드:: 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

샘플 요청

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": "************************************"
        }
      ]
    }
  }
}

샘플 응답

상태 코드:: 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

샘플 요청

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": "*********"
    }
  }
}

샘플 응답

상태 코드:: 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
  }
}

정의

Name	Description
AnonymousCredentials	Anonymous CredentialType에 대한 자격 증명입니다.
BasicCredentials	기본 CredentialType에 대한 자격 증명입니다.
ConnectionDetailsBooleanParameter	부울 dataType에 대한 ConnectionDetailsParameter입니다.
ConnectionDetailsDateParameter	date dataType에 대한 ConnectionDetailsParameter입니다.
ConnectionDetailsDateTimeParameter	dateTime dataType에 대한 ConnectionDetailsParameter입니다.
ConnectionDetailsDateTimeZoneParameter	dateTimeZone dataType에 대한 ConnectionDetailsParameter입니다.
ConnectionDetailsDurationParameter	duration dataType에 대한 ConnectionDetailsParameter입니다.
ConnectionDetailsNumberParameter	number dataType에 대한 ConnectionDetailsParameter입니다.
ConnectionDetailsTextParameter	text dataType에 대한 ConnectionDetailsParameter입니다.
ConnectionDetailsTimeParameter	Time dataType에 대한 ConnectionDetailsParameter입니다.
ConnectionEncryption	연결의 연결 암호화 유형입니다. 추가 연결 암호화 값은 시간이 지남에 따라 추가될 수 있습니다.
ConnectivityType	연결의 연결 유형입니다. 시간이 지남에 따라 추가 연결 유형을 추가할 수 있습니다.
CreateCloudConnectionRequest
CreateConnectionDetails	만들기 작업에 대한 연결 세부 정보 입력입니다.
CreateCredentialDetails	연결을 만들기 위한 자격 증명 세부 정보 입력입니다.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	온-프레미스 게이트웨이 연결을 만들기 위한 자격 증명 세부 정보 입력입니다.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	연결의 자격 증명 형식입니다. 시간이 지남에 따라 추가 자격 증명 형식을 추가할 수 있습니다.
DataType	연결 생성 매개 변수 값의 데이터 형식입니다. 추가 데이터 형식 값은 시간이 지남에 따라 추가될 수 있습니다.
ErrorRelatedResource	오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse	오류 응답입니다.
ErrorResponseDetails	오류 응답 세부 정보입니다.
KeyCredentials	Key CredentialType에 대한 자격 증명입니다.
ListConnectionDetails	목록 작업에 대한 연결 세부 정보 출력입니다.
ListCredentialDetails	연결을 가져올 때 반환되는 자격 증명 세부 정보입니다.
OnPremisesCredentialEntry	게이트웨이 ID 및 암호화된 직렬화된 자격 증명입니다.
OnPremisesGatewayConnection	온-프레미스 데이터 게이트웨이를 통해 연결하는 연결입니다.
OnPremisesGatewayCredentials	온-프레미스 게이트웨이를 통해 인증하기 위한 자격 증명입니다.
OnPremisesGatewayPersonalConnection	개인 온-프레미스 데이터 게이트웨이를 통해 연결하는 연결입니다.
PersonalCloudConnection	클라우드를 통해 연결되고 공유할 수 없는 연결입니다.
PrivacyLevel	연결의 개인 정보 수준 설정입니다. 추가 개인 정보 수준은 시간이 지남에 따라 추가될 수 있습니다.
ServicePrincipalCredentials	ServicePrincipal CredentialType에 대한 자격 증명입니다.
ShareableCloudConnection	클라우드를 통해 연결하는 연결입니다.
SharedAccessSignatureCredentials	SharedAccessSignature CredentialType에 대한 자격 증명입니다.
SingleSignOnType	연결의 Single Sign-On 유형입니다. 추가 Single Sign-On 형식은 시간이 지남에 따라 추가될 수 있습니다.
VirtualNetworkGatewayConnection	가상 네트워크 데이터 게이트웨이를 통해 연결하는 연결입니다.
WindowsCredentials	Windows CredentialType에 대한 자격 증명입니다.
WindowsWithoutImpersonationCredentials	WindowsWithoutImpersonation CredentialType에 대한 자격 증명입니다.
WorkspaceIdentityCredentials	WorkspaceIdentity CredentialType에 대한 자격 증명입니다.

AnonymousCredentials

Object

Anonymous CredentialType에 대한 자격 증명입니다.

Name	형식	Description
credentialType	string: Anonymous	연결의 자격 증명 형식입니다.

BasicCredentials

Object

기본 CredentialType에 대한 자격 증명입니다.

Name	형식	Description
credentialType	string: Basic	연결의 자격 증명 형식입니다.
password	string	암호입니다.
username	string	사용자 이름입니다.

ConnectionDetailsBooleanParameter

Object

부울 dataType에 대한 ConnectionDetailsParameter입니다.

Name	형식	Description
dataType	string: Boolean	매개 변수의 데이터 형식입니다.
name	string	매개 변수의 이름입니다.
value	boolean	부울 값입니다.

ConnectionDetailsDateParameter

Object

date dataType에 대한 ConnectionDetailsParameter입니다.

Name	형식	Description
dataType	string: Date	매개 변수의 데이터 형식입니다.
name	string	매개 변수의 이름입니다.
value	string (date)	YYYY-MM-DD 형식을 사용하는 날짜 값입니다.

ConnectionDetailsDateTimeParameter

Object

dateTime dataType에 대한 ConnectionDetailsParameter입니다.

Name	형식	Description
dataType	string: DateTime	매개 변수의 데이터 형식입니다.
name	string	매개 변수의 이름입니다.
value	string (date-time)	YYYY-MM-DDTHH:mm:ss를 사용하는 날짜 시간 값입니다. FFFZ 형식입니다.

ConnectionDetailsDateTimeZoneParameter

Object

dateTimeZone dataType에 대한 ConnectionDetailsParameter입니다.

Name	형식	Description
dataType	string: DateTimeZone	매개 변수의 데이터 형식입니다.
name	string	매개 변수의 이름입니다.
value	string (date-time-offset)	YYYY-MM-DDTHH:mm:ss를 사용하는 날짜 표준 시간대 값입니다. FFF±hh:mm 형식입니다.

ConnectionDetailsDurationParameter

Object

duration dataType에 대한 ConnectionDetailsParameter입니다.

Name	형식	Description
dataType	string: Duration	매개 변수의 데이터 형식입니다.
name	string	매개 변수의 이름입니다.
value	string (time-span)	[-]P(n)DT(n)H(n)M(n)S 형식을 사용하는 기간 값입니다. 예: P3DT4H30M10S(3일, 4시간, 30분, 10초)

ConnectionDetailsNumberParameter

Object

number dataType에 대한 ConnectionDetailsParameter입니다.

Name	형식	Description
dataType	string: Number	매개 변수의 데이터 형식입니다.
name	string	매개 변수의 이름입니다.
value	number	숫자 값입니다.

ConnectionDetailsTextParameter

Object

text dataType에 대한 ConnectionDetailsParameter입니다.

Name	형식	Description
dataType	string: Text	매개 변수의 데이터 형식입니다.
name	string	매개 변수의 이름입니다.
value	string	텍스트 값입니다.

ConnectionDetailsTimeParameter

Object

Time dataType에 대한 ConnectionDetailsParameter입니다.

Name	형식	Description
dataType	string: Time	매개 변수의 데이터 형식입니다.
name	string	매개 변수의 이름입니다.
value	string (time)	HH:mm:ss를 사용하는 시간 값입니다. FFFZ 형식입니다.

ConnectionEncryption

열거형

연결의 연결 암호화 유형입니다. 추가 연결 암호화 값은 시간이 지남에 따라 추가될 수 있습니다.

값	Description
Encrypted	암호화된 연결을 사용하여 연결을 시도합니다.
Any	먼저 암호화된 연결을 사용하여 연결 시도를 수행한 다음, 실패하면 암호화되지 않은 연결로 대체됩니다.
NotEncrypted	암호화되지 않은 연결을 사용하여 연결을 시도합니다.

ConnectivityType

열거형

연결의 연결 유형입니다. 시간이 지남에 따라 추가 연결 유형을 추가할 수 있습니다.

값	Description
ShareableCloud	연결은 클라우드를 통해 연결되며 다른 사용자와 공유할 수 있습니다.
PersonalCloud	연결은 클라우드를 통해 연결되며 다른 사용자와 공유할 수 없습니다.
OnPremisesGateway	연결은 온-프레미스 데이터 게이트웨이를 통해 연결됩니다.
OnPremisesGatewayPersonal	연결은 개인 온-프레미스 데이터 게이트웨이를 통해 연결됩니다.
VirtualNetworkGateway	연결은 가상 네트워크 데이터 게이트웨이를 통해 연결됩니다.
Automatic	연결은 암시적 데이터 연결을 사용하여 클라우드를 통해 연결됩니다. 이 옵션은 SSO(Single Sign-On)를 사용하는 의미 체계 모델과 같은 특정 시나리오에서만 사용할 수 있습니다.
None	연결이 바인딩되지 않음

CreateCloudConnectionRequest

Object

Name	형식	Description
allowConnectionUsageInGateway	boolean	온-프레미스 데이터 게이트웨이 또는 VNet 데이터 게이트웨이에서 이 연결을 사용하도록 허용합니다.
connectionDetails	CreateConnectionDetails	연결의 연결 세부 정보입니다.
connectivityType	string: ShareableCloud	연결의 연결 유형입니다.
credentialDetails	CreateCredentialDetails	연결의 자격 증명 세부 정보입니다.
displayName	string	연결의 표시 이름입니다. 최대 길이는 200자입니다.
privacyLevel	PrivacyLevel	(선택 사항) 연결의 개인 정보 수준입니다. 값이 전달되지 않으면 '조직'으로 설정됩니다.

CreateConnectionDetails

Object

만들기 작업에 대한 연결 세부 정보 입력입니다.

Name	형식	Description
creationMethod	string	연결을 만드는 데 사용되는 생성 메서드입니다. 만들기 메서드 목록의 경우 ListSupportedConnectionTypes API를 사용합니다.
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	연결 매개 변수 목록입니다. 각 만들기 메서드에 대한 매개 변수 목록의 경우 ListSupportedConnectionTypes API를 사용합니다.
type	string	연결의 형식입니다.

CreateCredentialDetails

Object

연결을 만들기 위한 자격 증명 세부 정보 입력입니다.

Name	형식	Description
connectionEncryption	ConnectionEncryption	(선택 사항) 테스트 연결 중에 사용되는 연결 암호화 설정입니다. 값이 전달되지 않으면 연결이 암호화되지 않습니다.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	연결의 자격 증명입니다.
singleSignOnType	SingleSignOnType	(선택 사항) 연결의 Single Sign-On 유형입니다. 값이 전달되지 않으면 연결에서 Single Sign-On을 사용하지 않습니다.
skipTestConnection	boolean	생성 및 업데이트 중에 연결이 테스트 연결을 건너뛰어야 하는지 여부입니다. True - 테스트 연결 건너뛰기, False - 테스트 연결을 건너뛰지 마세요. 값이 전달되지 않으면 'False'로 설정됩니다.

CreateOnPremisesConnectionRequest

Object

Name	형식	Description
connectionDetails	CreateConnectionDetails	연결의 연결 세부 정보입니다.
connectivityType	string: OnPremisesGateway	연결의 연결 유형입니다.
credentialDetails	CreateOnPremisesCredentialDetails	연결의 자격 증명 세부 정보입니다.
displayName	string	연결의 표시 이름입니다. 최대 길이는 200자입니다.
gatewayId	string (uuid)	연결이 만들어지는 온-프레미스 게이트웨이의 기본 게이트웨이의 개체 ID입니다.
privacyLevel	PrivacyLevel	(선택 사항) 연결의 개인 정보 수준입니다. 값이 전달되지 않으면 '조직'으로 설정됩니다.

CreateOnPremisesCredentialDetails

Object

온-프레미스 게이트웨이 연결을 만들기 위한 자격 증명 세부 정보 입력입니다.

Name	형식	Description
connectionEncryption	ConnectionEncryption	(선택 사항) 테스트 연결 중에 사용되는 연결 암호화 설정입니다. 값이 전달되지 않으면 연결이 암호화되지 않습니다.
credentials	OnPremisesGatewayCredentials	연결의 자격 증명입니다.
singleSignOnType	SingleSignOnType	(선택 사항) 연결의 Single Sign-On 유형입니다. 값이 전달되지 않으면 연결에서 Single Sign-On을 사용하지 않습니다.
skipTestConnection	boolean	생성 및 업데이트 중에 연결이 테스트 연결을 건너뛰어야 하는지 여부입니다. True - 테스트 연결 건너뛰기, False - 테스트 연결을 건너뛰지 마세요. 값이 전달되지 않으면 'False'로 설정됩니다.

CreateVirtualNetworkGatewayConnectionRequest

Object

Name	형식	Description
connectionDetails	CreateConnectionDetails	연결의 연결 세부 정보입니다.
connectivityType	string: VirtualNetworkGateway	연결의 연결 유형입니다.
credentialDetails	CreateCredentialDetails	연결의 자격 증명 세부 정보입니다.
displayName	string	연결의 표시 이름입니다. 최대 길이는 200자입니다.
gatewayId	string (uuid)	연결이 만들어지는 가상 네트워크 게이트웨이의 개체 ID입니다.
privacyLevel	PrivacyLevel	(선택 사항) 연결의 개인 정보 수준입니다. 값이 전달되지 않으면 '조직'으로 설정됩니다.

CredentialType

열거형

연결의 자격 증명 형식입니다. 시간이 지남에 따라 추가 자격 증명 형식을 추가할 수 있습니다.

값	Description
Windows	연결은 Windows 인증을 사용하여 연결합니다. 온-프레미스 게이트웨이에 대해서만 지원됩니다.
Anonymous	연결은 익명 인증을 사용하여 연결합니다.
Basic	연결은 기본 인증을 사용하여 연결합니다.
Key	연결은 키 인증을 사용하여 연결합니다.
OAuth2	연결은 OAuth 2.0 인증을 사용하여 연결합니다.
WindowsWithoutImpersonation	연결은 Windows(가장 옵션 제외) 인증을 사용하여 연결합니다. 온-프레미스 게이트웨이(개인 모드)에 대해서만 지원됩니다.
SharedAccessSignature	연결은 SAS(공유 액세스 서명) 인증을 사용하여 연결합니다.
ServicePrincipal	연결은 서비스 주체 인증을 사용하여 연결합니다.
WorkspaceIdentity	연결은 작업 영역 ID 인증을 사용하여 연결합니다.

DataType

열거형

연결 생성 매개 변수 값의 데이터 형식입니다. 추가 데이터 형식 값은 시간이 지남에 따라 추가될 수 있습니다.

값	Description
Text	텍스트를 매개 변수 입력 값으로 사용합니다.
Number	숫자를 매개 변수 입력 값(정수 또는 부동 소수점)으로 사용합니다.
Boolean	부울을 매개 변수 입력 값으로 사용합니다. False - 값이 false이고 True이며 값이 true입니다.
Duration	[-]P(n)DT(n)H(n)M(n)S 형식을 사용하여 기간을 매개 변수 입력 값으로 사용합니다. 예: P3DT4H30M10S(3일, 4시간, 30분, 10초)
Date	YYYY-MM-DD 형식을 사용하여 날짜를 매개 변수 입력 값으로 사용합니다.
DateTime	YYYY-MM-DDTHH:mm:ss를 사용하여 날짜 시간을 매개 변수 입력 값으로 사용합니다. FFFZ 형식입니다.
DateTimeZone	YYYY-MM-DDTHH:mm:ss를 사용하여 날짜 표준 시간대를 매개 변수 입력 값으로 사용합니다. FFF±hh:mm 형식입니다.
Time	HH:mm:ss를 사용하여 시간을 매개 변수 입력 값으로 사용합니다. FFFZ 형식입니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name	형식	Description
resourceId	string	오류와 관련된 리소스 ID입니다.
resourceType	string	오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
moreDetails	ErrorResponseDetails[]	추가 오류 세부 정보 목록입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.
requestId	string	오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.

KeyCredentials

Object

Key CredentialType에 대한 자격 증명입니다.

Name	형식	Description
credentialType	string: Key	연결의 자격 증명 형식입니다.
key	string	열쇠.

ListConnectionDetails

Object

목록 작업에 대한 연결 세부 정보 출력입니다.

Name	형식	Description
path	string	연결 경로입니다.
type	string	연결의 형식입니다.

ListCredentialDetails

Object

연결을 가져올 때 반환되는 자격 증명 세부 정보입니다.

Name	형식	Description
connectionEncryption	ConnectionEncryption	테스트 연결 중에 사용되는 연결 암호화 설정입니다.
credentialType	CredentialType	연결의 자격 증명 형식입니다.
singleSignOnType	SingleSignOnType	연결의 Single Sign-On 유형입니다.
skipTestConnection	boolean	생성 및 업데이트 중에 연결이 테스트 연결을 건너뛰어야 하는지 여부입니다. True - 테스트 연결 건너뛰기, False - 테스트 연결을 건너뛰지 마세요.

OnPremisesCredentialEntry

Object

게이트웨이 ID 및 암호화된 직렬화된 자격 증명입니다.

Name	형식	Description
encryptedCredentials	string	이름 값 쌍 목록의 암호화된 직렬화된 .json. 이름은 자격 증명 이름이고 값은 자격 증명 값입니다. 암호화는 온-프레미스 게이트웨이 멤버의 공개 키와 함께 RSA(Rivest-Shamir-Adleman) 암호화 알고리즘을 사용하여 수행됩니다.
gatewayId	string (uuid)	게이트웨이의 개체 ID입니다.

OnPremisesGatewayConnection

Object

온-프레미스 데이터 게이트웨이를 통해 연결하는 연결입니다.

Name	형식	Description
connectionDetails	ListConnectionDetails	연결의 연결 세부 정보입니다.
connectivityType	string: OnPremisesGateway	연결의 연결 유형입니다.
credentialDetails	ListCredentialDetails	연결의 자격 증명 세부 정보입니다.
displayName	string	연결의 표시 이름입니다.
gatewayId	string (uuid)	연결의 게이트웨이 개체 ID입니다.
id	string (uuid)	연결의 개체 ID입니다.
privacyLevel	PrivacyLevel	연결의 개인 정보 수준입니다.

OnPremisesGatewayCredentials

Object

온-프레미스 게이트웨이를 통해 인증하기 위한 자격 증명입니다.

Name	형식	Description
credentialType	CredentialType	연결의 자격 증명 형식입니다.
values	OnPremisesCredentialEntry[]	온-프레미스 게이트웨이로 보낼 자격 증명 페이로드입니다.

OnPremisesGatewayPersonalConnection

Object

개인 온-프레미스 데이터 게이트웨이를 통해 연결하는 연결입니다.

Name	형식	Description
connectionDetails	ListConnectionDetails	연결의 연결 세부 정보입니다.
connectivityType	string: OnPremisesGatewayPersonal	연결의 연결 유형입니다.
credentialDetails	ListCredentialDetails	연결의 자격 증명 세부 정보입니다.
displayName	string	연결의 표시 이름입니다.
gatewayId	string (uuid)	연결의 게이트웨이 개체 ID입니다.
id	string (uuid)	연결의 개체 ID입니다.
privacyLevel	PrivacyLevel	연결의 개인 정보 수준입니다.

PersonalCloudConnection

Object

클라우드를 통해 연결되고 공유할 수 없는 연결입니다.

Name	형식	Description
allowConnectionUsageInGateway	boolean	온-프레미스 데이터 게이트웨이 또는 VNet 데이터 게이트웨이에서 이 연결을 사용하도록 허용합니다.
connectionDetails	ListConnectionDetails	연결의 연결 세부 정보입니다.
connectivityType	string: PersonalCloud	연결의 연결 유형입니다.
credentialDetails	ListCredentialDetails	연결의 자격 증명 세부 정보입니다.
displayName	string	연결의 표시 이름입니다.
id	string (uuid)	연결의 개체 ID입니다.
privacyLevel	PrivacyLevel	연결의 개인 정보 수준입니다.

PrivacyLevel

열거형

연결의 개인 정보 수준 설정입니다. 추가 개인 정보 수준은 시간이 지남에 따라 추가될 수 있습니다.

값	Description
None	개인 정보 수준 설정이 구성되지 않았습니다.
Private	비공개로 설정된 연결에는 중요한 정보 또는 기밀 정보가 포함됩니다. 권한 있는 사용자로 가시성을 제한할 수 있습니다. 프라이빗 연결의 데이터는 다른 프라이빗 연결을 비롯한 다른 연결로 접어 들지 않습니다.
Organizational	조직으로 설정된 연결은 프라이빗 및 기타 조직 연결로 접을 수 있습니다. 공용 연결로 접을 수 없습니다. 표시 유형이 신뢰할 수 있는 그룹으로 설정됩니다.
Public	파일, 인터넷 연결 및 통합 문서 데이터를 공용으로 설정할 수 있습니다. 데이터는 다른 연결로 접을 수 있습니다. 모든 사용자가 가시성을 사용할 수 있습니다.

ServicePrincipalCredentials

Object

ServicePrincipal CredentialType에 대한 자격 증명입니다.

Name	형식	Description
credentialType	string: ServicePrincipal	연결의 자격 증명 형식입니다.
servicePrincipalClientId	string (uuid)	서비스 주체의 클라이언트 ID입니다.
servicePrincipalSecret	string	서비스 주체의 비밀입니다.
tenantId	string (uuid)	서비스 주체의 테넌트 ID입니다.

ShareableCloudConnection

Object

클라우드를 통해 연결하는 연결입니다.

Name	형식	Description
allowConnectionUsageInGateway	boolean	온-프레미스 데이터 게이트웨이 또는 VNet 데이터 게이트웨이에서 이 연결을 사용하도록 허용합니다.
connectionDetails	ListConnectionDetails	연결의 연결 세부 정보입니다.
connectivityType	string: ShareableCloud	연결의 연결 유형입니다.
credentialDetails	ListCredentialDetails	연결의 자격 증명 세부 정보입니다.
displayName	string	연결의 표시 이름입니다.
id	string (uuid)	연결의 개체 ID입니다.
privacyLevel	PrivacyLevel	연결의 개인 정보 수준입니다.

SharedAccessSignatureCredentials

Object

SharedAccessSignature CredentialType에 대한 자격 증명입니다.

Name	형식	Description
credentialType	string: SharedAccessSignature	연결의 자격 증명 형식입니다.
token	string	토큰입니다.

SingleSignOnType

열거형

연결의 Single Sign-On 유형입니다. 추가 Single Sign-On 형식은 시간이 지남에 따라 추가될 수 있습니다.

값	Description
None	연결은 Single Sign-On을 사용하여 연결하지 않습니다.
Kerberos	연결은 Kerberos Single Sign-On을 사용하여 연결합니다.
MicrosoftEntraID	연결은 Microsoft Entra ID Single Sign-On을 사용하여 연결합니다.
SecurityAssertionMarkupLanguage	연결은 SAML(Security Assertion Markup Language) Single Sign-On을 사용하여 연결합니다.
KerberosDirectQueryAndRefresh	연결은 Kerberos DirectQuery를 사용하고 Single Sign-On 새로 고침을 사용하여 연결합니다.

VirtualNetworkGatewayConnection

Object

가상 네트워크 데이터 게이트웨이를 통해 연결하는 연결입니다.

Name	형식	Description
connectionDetails	ListConnectionDetails	연결의 연결 세부 정보입니다.
connectivityType	string: VirtualNetworkGateway	연결의 연결 유형입니다.
credentialDetails	ListCredentialDetails	연결의 자격 증명 세부 정보입니다.
displayName	string	연결의 표시 이름입니다.
gatewayId	string (uuid)	연결의 게이트웨이 개체 ID입니다.
id	string (uuid)	연결의 개체 ID입니다.
privacyLevel	PrivacyLevel	연결의 개인 정보 수준입니다.

WindowsCredentials

Object

Windows CredentialType에 대한 자격 증명입니다.

Name	형식	Description
credentialType	string: Windows	연결의 자격 증명 형식입니다.
password	string	암호입니다.
username	string	사용자 이름입니다.

WindowsWithoutImpersonationCredentials

Object

WindowsWithoutImpersonation CredentialType에 대한 자격 증명입니다.

Name	형식	Description
credentialType	string: WindowsWithoutImpersonation	연결의 자격 증명 형식입니다.

WorkspaceIdentityCredentials

Object

WorkspaceIdentity CredentialType에 대한 자격 증명입니다.

Name	형식	Description
credentialType	string: WorkspaceIdentity	연결의 자격 증명 형식입니다.

다음을 통해 공유

Connections - Create Connection

Permissions

필요한 위임된 범위

Microsoft Entra 지원 ID

Interface

요청 본문

CreateCloudConnectionRequest

CreateOnPremisesConnectionRequest

CreateVirtualNetworkGatewayConnectionRequest

응답

예제

Cloud example

샘플 요청

샘플 응답

On-premises gateway example

샘플 요청

샘플 응답

Virtual network gateway example

샘플 요청

샘플 응답

정의

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