Connections - Update Connection
依標識碼更新連線。
若要加密認證,請參閱 以程式設計方式設定認證。
Permissions
呼叫端必須具有連線之閘道的連線許可權或管理員許可權。
必要的委派範圍
Connection.ReadWrite.All
Microsoft Entra 支援的身分識別
此 API 支援本節中列出的Microsoft 身分識別。
| Identity | Support |
|---|---|
| User | Yes |
| 服務主體 和 受控識別 | Yes |
Interface
PATCH https://api.fabric.microsoft.com/v1/connections/{connectionId}
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
connection
|
path | True |
string (uuid) |
連接的識別碼。 |
要求本文
要求主體可以是下列其中一項:
UpdateOnPremisesGatewayConnectionRequest
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| connectivityType | True |
string:
On |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
||
| displayName |
string |
連接的顯示名稱。 長度上限為 200 個字元。 |
|
| privacyLevel |
線上的隱私權層級。 |
UpdateOnPremisesGatewayPersonalConnectionRequest
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| connectivityType | True |
string:
On |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
||
| privacyLevel |
線上的隱私權層級。 |
UpdatePersonalCloudConnectionRequest
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| connectivityType | True |
string:
Personal |
連接的連線類型。 |
| allowConnectionUsageInGateway |
boolean |
允許此連線與內部部署數據閘道或 VNet 數據閘道搭配使用。 |
|
| credentialDetails |
線上認證詳細數據。 |
||
| privacyLevel |
線上的隱私權層級。 |
UpdateShareableCloudConnectionRequest
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| connectivityType | True |
string:
Shareable |
連接的連線類型。 |
| allowConnectionUsageInGateway |
boolean |
允許此連線與內部部署數據閘道或 VNet 數據閘道搭配使用。 |
|
| credentialDetails |
線上認證詳細數據。 |
||
| displayName |
string |
連接的顯示名稱。 長度上限為 200 個字元。 |
|
| privacyLevel |
線上的隱私權層級。 |
UpdateStreamingVirtualNetworkGatewayConnectionRequest
更新透過串流虛擬網路資料閘道連接的連線。
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| connectivityType | True |
string:
Streaming |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
||
| displayName |
string |
連接的顯示名稱。 長度上限為 200 個字元。 |
|
| privacyLevel |
線上的隱私權層級。 |
UpdateVirtualNetworkGatewayConnectionRequest
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| connectivityType | True |
string:
Virtual |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
||
| displayName |
string |
連接的顯示名稱。 長度上限為 200 個字元。 |
|
| privacyLevel |
線上的隱私權層級。 |
回覆
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK | Connection: |
OK. 作業成功。 |
| 429 Too Many Requests |
服務費率上限被超標。 伺服器會回傳一個 標題 Retry-After: integer |
|
| Other Status Codes |
常見的錯誤碼:
|
範例
| On-premises gateway (personal mode) example |
| On-premises gateway example |
| Personal cloud example |
| Shareable cloud example |
| Streaming virtual network gateway example |
| Virtual network gateway example |
On-premises gateway (personal mode) example
範例要求
PATCH https://api.fabric.microsoft.com/v1/connections/ef8f408d-2ab7-4a18-b662-9251febda49c
{
"connectivityType": "OnPremisesGatewayPersonal",
"credentialDetails": {
"credentials": {
"credentialType": "WindowsWithoutImpersonation",
"encryptedCredentials": "************************************"
}
}
}
範例回覆
{
"id": "ef8f408d-2ab7-4a18-b662-9251febda49c",
"gatewayId": "429a773e-5633-45ee-8584-a192bd79c16a",
"connectivityType": "OnPremisesGatewayPersonal",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;reporting"
},
"privacyLevel": "Private",
"credentialDetails": {
"credentialType": "WindowsWithoutImpersonation",
"singleSignOnType": "None",
"connectionEncryption": "NotEncrypted",
"skipTestConnection": false
},
"connectionRecency": {
"createdDateTime": "2023-05-23T16:22:20Z",
"lastBoundDateTime": "2023-05-26T16:22:20Z",
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
},
"myRole": "Owner"
}
On-premises gateway example
範例要求
PATCH https://api.fabric.microsoft.com/v1/connections/70b17680-48f1-4729-9df6-02576647dc3a
{
"connectivityType": "OnPremisesGateway",
"displayName": "ContosoSalesOnPremisesConnection",
"credentialDetails": {
"skipTestConnection": false,
"credentials": {
"credentialType": "Windows",
"values": [
{
"gatewayId": "4f8b5d6e-8e99-4817-8b9e-6b6a613be707",
"encryptedCredentials": "************************************"
},
{
"gatewayId": "c6961028-1309-4183-9799-a0b0fa28a235",
"encryptedCredentials": "************************************"
}
]
}
}
}
範例回覆
{
"id": "70b17680-48f1-4729-9df6-02576647dc3a",
"displayName": "ContosoSalesOnPremisesConnection",
"gatewayId": "4f8b5d6e-8e99-4817-8b9e-6b6a613be707",
"connectivityType": "OnPremisesGateway",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;sales"
},
"privacyLevel": "Organizational",
"credentialDetails": {
"credentialType": "Windows",
"singleSignOnType": "None",
"connectionEncryption": "NotEncrypted",
"skipTestConnection": false
},
"connectionRecency": {
"createdDateTime": "2023-05-23T16:22:20Z",
"lastBoundDateTime": "2023-05-26T16:22:20Z",
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
},
"myRole": "Owner"
}
Personal cloud example
範例要求
PATCH https://api.fabric.microsoft.com/v1/connections/7a0369b2-58c4-4b67-b3f3-92156a95f1cd
{
"connectivityType": "PersonalCloud",
"privacyLevel": "Organizational"
}
範例回覆
{
"id": "7a0369b2-58c4-4b67-b3f3-92156a95f1cd",
"gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
"connectivityType": "PersonalCloud",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;finances"
},
"privacyLevel": "Organizational",
"credentialDetails": {
"credentialType": "OAuth2",
"singleSignOnType": "None",
"connectionEncryption": "NotEncrypted",
"skipTestConnection": false
},
"connectionRecency": {
"createdDateTime": "2023-05-23T16:22:20Z",
"lastBoundDateTime": "2023-05-26T16:22:20Z",
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
},
"myRole": "Owner"
}
Shareable cloud example
範例要求
PATCH https://api.fabric.microsoft.com/v1/connections/fa968eee-8075-48f6-8c6d-41260ee1396d
{
"connectivityType": "ShareableCloud",
"displayName": "ContosoCloudConnection"
}
範例回覆
{
"id": "fa968eee-8075-48f6-8c6d-41260ee1396d",
"displayName": "ContosoCloudConnection",
"gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
"connectivityType": "ShareableCloud",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;networks"
},
"privacyLevel": "Public",
"credentialDetails": {
"credentialType": "Basic",
"singleSignOnType": "None",
"connectionEncryption": "NotEncrypted",
"skipTestConnection": true
},
"connectionRecency": {
"createdDateTime": "2023-05-23T16:22:20Z",
"lastBoundDateTime": "2023-05-26T16:22:20Z",
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
},
"myRole": "Owner"
}
Streaming virtual network gateway example
範例要求
PATCH https://api.fabric.microsoft.com/v1/connections/6b571614-2e98-4bfd-b9ed-1cb8d3ffc396
{
"connectivityType": "StreamingVirtualNetworkGateway",
"displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
"credentialDetails": {
"singleSignOnType": "None"
}
}
範例回覆
{
"id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
"displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
"gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
"connectivityType": "StreamingVirtualNetworkGateway",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;marketing"
},
"privacyLevel": "Organizational",
"credentialDetails": {
"credentialType": "Basic",
"singleSignOnType": "None",
"connectionEncryption": "Encrypted",
"skipTestConnection": false
},
"myRole": "Owner"
}
Virtual network gateway example
範例要求
PATCH https://api.fabric.microsoft.com/v1/connections/6b571614-2e98-4bfd-b9ed-1cb8d3ffc396
{
"connectivityType": "VirtualNetworkGateway",
"displayName": "ContosoMarketingVirtualNetworkGatewayConnection",
"privacyLevel": "Organizational",
"credentialDetails": {
"singleSignOnType": "None"
}
}
範例回覆
{
"id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
"displayName": "ContosoMarketingVirtualNetworkGatewayConnection",
"gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
"connectivityType": "VirtualNetworkGateway",
"connectionDetails": {
"type": "SQL",
"path": "contoso.database.windows.net;marketing"
},
"privacyLevel": "Organizational",
"credentialDetails": {
"credentialType": "Basic",
"singleSignOnType": "None",
"connectionEncryption": "NotEncrypted",
"skipTestConnection": false
},
"connectionRecency": {
"createdDateTime": "2023-05-23T16:22:20Z",
"lastBoundDateTime": "2023-05-26T16:22:20Z",
"lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
"myLastBoundDateTime": "2023-05-24T16:22:20Z",
"myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
},
"myRole": "Owner"
}
定義
AnonymousCredentials
匿名 CredentialType 的認證。
| 名稱 | 類型 | Description |
|---|---|---|
| credentialType |
string:
Anonymous |
連接的認證類型。 |
BasicCredentials
Basic CredentialType 的認證。
| 名稱 | 類型 | Description |
|---|---|---|
| credentialType |
string:
Basic |
連接的認證類型。 |
| password |
string |
密碼。 請使用密碼或passwordReference。 你不能同時使用兩者 |
| passwordReference |
指的是儲存在 Azure Key Vault 中的密碼。 請使用密碼或passwordReference。 您無法同時使用這兩者。 |
|
| username |
string |
使用者名稱。 |
ConnectionEncryption
連接的連線加密類型。 可能會隨著時間新增其他連線加密值。
| 值 | Description |
|---|---|
| Encrypted |
線上嘗試是使用加密的連線進行。 |
| Any |
第一次使用加密連線進行連線嘗試,如果失敗,則會回復為未加密的連線。 |
| NotEncrypted |
使用未加密的連線進行連線嘗試。 |
ConnectionRecency
代表該連結的最新細節。
| 名稱 | 類型 | Description |
|---|---|---|
| createdDateTime |
string (date-time) |
連線建立的時間戳記為 UTC,格式為 YYYY-MM-DDTHH:mm:ssZ。 |
| lastBoundDateTime |
string (date-time) |
連線最近綁定到任何 UTC 項目的時間戳,使用 YYYY-MM-DDTHH:mm:ssZ 格式。 |
| lastCredentialUsedDateTime |
string (date-time) |
連線憑證最近一次在UTC使用的時間戳,格式為YYYY-MM-DDTHH:mm:ssZ格式。 |
| myLastBoundDateTime |
string (date-time) |
連線最近一次被呼叫使用者以 UTC 綁定到任何項目的時間戳,格式為 YYYY-MM-DDTHH:mm:ssZ。 |
| myLastCredentialUsedDateTime |
string (date-time) |
連線憑證最近一次被呼叫使用者使用的時間戳(UTC),格式為 YYYY-MM-DDTHH:mm:ssZ。 |
ConnectionRole
一個連結角色。 可能會隨著時間新增其他連線角色。
| 值 | Description |
|---|---|
| User |
啟用連線的用戶存取權。 |
| UserWithReshare |
讓用戶能夠重新共享連線的存取權。 |
| Owner |
啟用連線的擁有權存取。 |
| PendingOwner |
該連接所有權尚未生效;主體必須透過更新連線憑證(使用 Update Connection API)來使其有效。 |
ConnectivityType
連接的連線類型。 可能會隨著時間新增其他連線類型。
| 值 | Description |
|---|---|
| ShareableCloud |
聯機會透過雲端連線,並可與其他人共用。 |
| PersonalCloud |
聯機會透過雲端連線,無法與其他人共用。 |
| OnPremisesGateway |
聯機會透過內部部署數據網關聯機。 |
| OnPremisesGatewayPersonal |
聯機會透過個人內部部署數據網關聯機。 |
| VirtualNetworkGateway |
聯機會透過虛擬網路數據網關聯機。 |
| StreamingVirtualNetworkGateway |
連線透過串流虛擬網路資料閘道連接。 |
| Automatic |
聯機會使用隱含數據連線透過雲端連線。 此選項僅適用於使用單一 Sign-On(SSO)的特定案例,例如語意模型。 |
| None |
線上未系結 |
CredentialType
連接的認證類型。 可能會隨著時間新增其他認證類型。
| 值 | Description |
|---|---|
| Windows |
聯機會使用 Windows 驗證進行連線。 僅支援內部部署閘道。 |
| Anonymous |
聯機會使用匿名驗證進行連線。 |
| Basic |
聯機會使用基本身份驗證進行連線。 |
| Key |
聯機會使用金鑰驗證進行連線。 |
| OAuth2 |
聯機會使用 OAuth 2.0 驗證進行連線。 |
| WindowsWithoutImpersonation |
聯機會使用 Windows(沒有仿真的選項)驗證進行連線。 僅支持內部部署閘道 (個人模式)。 |
| SharedAccessSignature |
聯機會使用共用存取簽章 (SAS) 驗證進行連線。 |
| ServicePrincipal |
聯機會使用服務主體驗證進行連線。 |
| WorkspaceIdentity |
聯機會使用工作區身分識別驗證進行連線。 |
| KeyPair |
連線使用金鑰對認證來連接。 |
ErrorParameter
一個結構化參數,提供關於錯誤的額外機器可讀上下文。
| 名稱 | 類型 | Description |
|---|---|---|
| message |
string |
一個人類可讀的參數意義描述。 |
| name |
string |
參數識別碼。 |
| value |
string |
這是參數值。 |
ErrorRelatedResource
錯誤相關的資源詳細資料物件。
| 名稱 | 類型 | Description |
|---|---|---|
| resourceId |
string |
發生錯誤的資源識別碼。 |
| resourceType |
string |
發生錯誤的資源類型。 |
ErrorResponse
錯誤回應。
| 名稱 | 類型 | Description |
|---|---|---|
| errorCode |
string |
提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。 |
| isRetriable |
boolean |
若屬實,請求可重新嘗試。 如果有延遲,請使用 |
| message |
string |
錯誤的人類可讀取表示法。 |
| moreDetails |
其他錯誤詳細數據的清單。 |
|
| parameters |
結構化參數提供更多機器可讀的錯誤上下文。 |
|
| relatedResource |
錯誤相關的資源詳細數據。 |
|
| requestId |
string (uuid) |
與錯誤相關聯的要求標識碼。 |
ErrorResponseDetails
錯誤回應詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| errorCode |
string |
提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。 |
| message |
string |
錯誤的人類可讀取表示法。 |
| parameters |
結構化參數提供更多機器可讀的錯誤上下文。 |
|
| relatedResource |
錯誤相關的資源詳細數據。 |
KeyCredentials
Key CredentialType 的認證。
| 名稱 | 類型 | Description |
|---|---|---|
| credentialType |
string:
Key |
連接的認證類型。 |
| key |
string |
索引鍵。 使用 key 或 keyReference。 您無法同時使用這兩者。 |
| keyReference |
指的是儲存在 Azure Key Vault 中的金鑰。 使用 key 或 keyReference。 您無法同時使用這兩者。 |
KeyPairCredentials
KeyPair CredentialType 的憑證。
| 名稱 | 類型 | Description |
|---|---|---|
| credentialType |
string:
Key |
連接的認證類型。 |
| identifier |
string |
金鑰的識別碼。 |
| passphrase |
string |
如果私鑰是加密的,則是該私鑰的密碼短語。 |
| privateKey |
string |
基於 PKCS #8 標準的私鑰。 |
KeyVaultSecretReference
指的是儲存在 Azure Key Vault 中的一個秘密。
| 名稱 | 類型 | Description |
|---|---|---|
| connectionId |
string (uuid) |
就是 金鑰保存庫 連線的連線 ID。 |
| secretName |
string |
鑰匙庫裡的秘密名稱。 |
| version |
string |
鑰匙庫裡的秘密版本。 |
ListConnectionDetails
清單作業的連線詳細資料輸出。
| 名稱 | 類型 | Description |
|---|---|---|
| path |
string |
連接的路徑。 |
| type |
string |
連接的型別。 |
ListCredentialDetails
擷取連線時傳回的認證詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| connectionEncryption |
測試連接期間所使用的連線加密設定。 |
|
| credentialType |
連接的認證類型。 |
|
| singleSignOnType |
線上的單一登錄類型。 |
|
| skipTestConnection |
boolean |
連接是否應該在建立和更新期間略過測試連線。 True - 略過測試連線,False - 不要略過測試連線。 |
OnPremisesCredentialEntry
閘道識別碼及其加密的串行化認證。
| 名稱 | 類型 | Description |
|---|---|---|
| encryptedCredentials |
string |
名稱值組清單的加密串行化 .json。 名稱是認證名稱,而值是認證值。 加密是使用 Rivest-Shamir-Adleman (RSA) 加密演算法搭配內部部署閘道成員的公鑰來執行。 |
| gatewayId |
string (uuid) |
閘道的物件識別碼。 |
OnPremisesGatewayConnection
透過內部部署數據網關聯機的連線。
| 名稱 | 類型 | Description |
|---|---|---|
| connectionDetails |
線上的連線詳細數據。 |
|
| connectionRecency |
最近關係的細節。 |
|
| connectivityType |
string:
On |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
|
| displayName |
string |
連接的顯示名稱。 |
| gatewayId |
string (uuid) |
連接所透過的閘道物件 ID。 對於雲端連線,這是虛擬閘道 ID。 |
| id |
string (uuid) |
連接的物件識別碼。 |
| myRole |
來電負責人在連線中扮演的有效角色。 當主體同時屬於多個具有不同角色的安全群組時,會回傳最高的角色。 若委託人在連接中沒有角色,該屬性不會被歸還。 |
|
| privacyLevel |
線上的隱私權層級。 |
OnPremisesGatewayCredentials
透過內部部署閘道進行驗證的認證。
| 名稱 | 類型 | Description |
|---|---|---|
| credentialType |
連接的認證類型。 |
|
| values |
要傳送至內部部署閘道的認證承載。 |
OnPremisesGatewayPersonalConnection
透過個人內部部署數據網關聯機的連線。
| 名稱 | 類型 | Description |
|---|---|---|
| connectionDetails |
線上的連線詳細數據。 |
|
| connectionRecency |
最近關係的細節。 |
|
| connectivityType |
string:
On |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
|
| displayName |
string |
連接的顯示名稱。 |
| gatewayId |
string (uuid) |
連接所透過的閘道物件 ID。 對於雲端連線,這是虛擬閘道 ID。 |
| id |
string (uuid) |
連接的物件識別碼。 |
| myRole |
來電負責人在連線中扮演的有效角色。 當主體同時屬於多個具有不同角色的安全群組時,會回傳最高的角色。 若委託人在連接中沒有角色,該屬性不會被歸還。 |
|
| privacyLevel |
線上的隱私權層級。 |
OnPremisesGatewayPersonalCredentials
透過內部部署閘道進行驗證的認證(個人模式)。
| 名稱 | 類型 | Description |
|---|---|---|
| credentialType |
連接的認證類型。 |
|
| encryptedCredentials |
string |
名稱值組清單的加密串行化 .json。 名稱是認證名稱,而值是認證值。 加密是使用 Rivest-Shamir-Adleman (RSA) 加密演算法搭配內部部署閘道的公鑰來執行。 |
PersonalCloudConnection
透過雲端連線且無法共享的連線。
| 名稱 | 類型 | Description |
|---|---|---|
| allowConnectionUsageInGateway |
boolean |
允許此連線與內部部署數據閘道或 VNet 數據閘道搭配使用。 |
| connectionDetails |
線上的連線詳細數據。 |
|
| connectionRecency |
最近關係的細節。 |
|
| connectivityType |
string:
Personal |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
|
| displayName |
string |
連接的顯示名稱。 |
| gatewayId |
string (uuid) |
連接所透過的閘道物件 ID。 對於雲端連線,這是虛擬閘道 ID。 |
| id |
string (uuid) |
連接的物件識別碼。 |
| myRole |
來電負責人在連線中扮演的有效角色。 當主體同時屬於多個具有不同角色的安全群組時,會回傳最高的角色。 若委託人在連接中沒有角色,該屬性不會被歸還。 |
|
| privacyLevel |
線上的隱私權層級。 |
PrivacyLevel
線上的隱私權等級設定。 可能會隨著時間新增其他隱私權等級。
| 值 | Description |
|---|---|
| None |
未設定隱私權等級設定。 |
| Private |
設定為私人的連線包含敏感性或機密資訊。 可見度可以限制為授權的使用者。 私人連線的數據不會折疊至其他連線,包括其他私人連線。 |
| Organizational |
設定為組織的連線可以折疊為私人和其他組織連線。 它們無法折疊至公用連線。 可見度會設定為信任的群組。 |
| Public |
檔案、因特網連線和活頁簿數據可以設定為公用。 數據可以折疊至其他連接。 每個人都可以使用可見度。 |
ServicePrincipalCredentials
ServicePrincipal CredentialType 的認證。
| 名稱 | 類型 | Description |
|---|---|---|
| credentialType |
string:
Service |
連接的認證類型。 |
| servicePrincipalClientId |
string (uuid) |
服務主體的用戶端標識碼。 |
| servicePrincipalSecret |
string |
服務主體的秘密。 請使用 servicePrincipalSecret 或 servicePrincipalSecretReference。 您無法同時使用這兩者。 |
| servicePrincipalSecretReference |
指的是儲存在 Azure Key Vault 中的服務主體祕密。 請使用 servicePrincipalSecret 或 servicePrincipalSecretReference。 您無法同時使用這兩者。 |
|
| tenantId |
string (uuid) |
服務主體的租用戶標識碼。 |
ShareableCloudConnection
透過雲端連線的連線。
| 名稱 | 類型 | Description |
|---|---|---|
| allowConnectionUsageInGateway |
boolean |
允許此連線與內部部署數據閘道或 VNet 數據閘道搭配使用。 |
| allowUsageInUserControlledCode |
boolean |
允許此連線與允許使用者控制程式碼的項目(如 Notebook)一起使用。 |
| connectionDetails |
線上的連線詳細數據。 |
|
| connectionRecency |
最近關係的細節。 |
|
| connectivityType |
string:
Shareable |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
|
| displayName |
string |
連接的顯示名稱。 |
| gatewayId |
string (uuid) |
連接所透過的閘道物件 ID。 對於雲端連線,這是虛擬閘道 ID。 |
| id |
string (uuid) |
連接的物件識別碼。 |
| myRole |
來電負責人在連線中扮演的有效角色。 當主體同時屬於多個具有不同角色的安全群組時,會回傳最高的角色。 若委託人在連接中沒有角色,該屬性不會被歸還。 |
|
| privacyLevel |
線上的隱私權層級。 |
SharedAccessSignatureCredentials
SharedAccessSignature CredentialType 的認證。
| 名稱 | 類型 | Description |
|---|---|---|
| credentialType |
string:
Shared |
連接的認證類型。 |
| token |
string |
語彙基元。 使用 token 或 tokenReference。 您無法同時使用這兩者。 |
| tokenReference |
指的是存放在 Azure Key Vault 中的一個令牌。 使用 token 或 tokenReference。 您無法同時使用這兩者。 |
SingleSignOnType
線上的單一登錄類型。 可能會隨著時間新增其他單一登錄類型。
| 值 | Description |
|---|---|
| None |
線上不會使用單一登錄進行連線。 |
| Kerberos |
聯機會使用 Kerberos 單一登錄進行連線。 |
| MicrosoftEntraID |
聯機會使用 Microsoft Entra ID 單一登錄進行連線。 |
| SecurityAssertionMarkupLanguage |
聯機會使用安全性判斷提示標記語言 (SAML) 單一登錄進行連線。 |
| KerberosDirectQueryAndRefresh |
聯機會使用 Kerberos DirectQuery 和 Refresh 單一登錄進行連線。 |
StreamingVirtualNetworkGatewayConnection
一個透過串流虛擬網路資料閘道連接的連線。
| 名稱 | 類型 | Description |
|---|---|---|
| connectionDetails |
線上的連線詳細數據。 |
|
| connectionRecency |
最近關係的細節。 |
|
| connectivityType |
string:
Streaming |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
|
| displayName |
string |
連接的顯示名稱。 |
| gatewayId |
string (uuid) |
連接的閘道物件識別碼。 |
| id |
string (uuid) |
連接的物件識別碼。 |
| myRole |
來電負責人在連線中扮演的有效角色。 當主體同時屬於多個具有不同角色的安全群組時,會回傳最高的角色。 若委託人在連接中沒有角色,該屬性不會被歸還。 |
|
| privacyLevel |
線上的隱私權層級。 |
UpdateCredentialDetails
更新連線的認證詳細數據輸入。
| 名稱 | 類型 | Description |
|---|---|---|
| connectionEncryption |
測試連接期間所使用的連線加密設定。 |
|
| credentials | Credentials: |
連接的認證。 |
| singleSignOnType |
線上的單一登錄類型。 |
|
| skipTestConnection |
boolean |
連接是否應該在建立和更新期間略過測試連線。 True - 略過測試連線,False - 不要略過測試連線。 |
UpdateOnPremisesGatewayConnectionRequest
| 名稱 | 類型 | Description |
|---|---|---|
| connectivityType |
string:
On |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
|
| displayName |
string |
連接的顯示名稱。 長度上限為 200 個字元。 |
| privacyLevel |
線上的隱私權層級。 |
UpdateOnPremisesGatewayCredentialDetails
更新內部部署網關聯機的認證詳細數據輸入。
| 名稱 | 類型 | Description |
|---|---|---|
| connectionEncryption |
測試連接期間所使用的連線加密設定。 |
|
| credentials |
連接的認證。 |
|
| singleSignOnType |
線上的單一登錄類型。 |
|
| skipTestConnection |
boolean |
連接是否應該在建立和更新期間略過測試連線。 True - 略過測試連線,False - 不要略過測試連線。 |
UpdateOnPremisesGatewayPersonalConnectionRequest
| 名稱 | 類型 | Description |
|---|---|---|
| connectivityType |
string:
On |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
|
| privacyLevel |
線上的隱私權層級。 |
UpdateOnPremisesGatewayPersonalCredentialDetails
更新內部部署網關聯機的認證詳細數據輸入。
| 名稱 | 類型 | Description |
|---|---|---|
| connectionEncryption |
測試連接期間所使用的連線加密設定。 |
|
| credentials |
連接的認證。 |
|
| singleSignOnType |
線上的單一登錄類型。 |
|
| skipTestConnection |
boolean |
連接是否應該在建立和更新期間略過測試連線。 True - 略過測試連線,False - 不要略過測試連線。 |
UpdatePersonalCloudConnectionRequest
| 名稱 | 類型 | Description |
|---|---|---|
| allowConnectionUsageInGateway |
boolean |
允許此連線與內部部署數據閘道或 VNet 數據閘道搭配使用。 |
| connectivityType |
string:
Personal |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
|
| privacyLevel |
線上的隱私權層級。 |
UpdateShareableCloudConnectionRequest
| 名稱 | 類型 | Description |
|---|---|---|
| allowConnectionUsageInGateway |
boolean |
允許此連線與內部部署數據閘道或 VNet 數據閘道搭配使用。 |
| connectivityType |
string:
Shareable |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
|
| displayName |
string |
連接的顯示名稱。 長度上限為 200 個字元。 |
| privacyLevel |
線上的隱私權層級。 |
UpdateStreamingVirtualNetworkGatewayConnectionRequest
更新透過串流虛擬網路資料閘道連接的連線。
| 名稱 | 類型 | Description |
|---|---|---|
| connectivityType |
string:
Streaming |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
|
| displayName |
string |
連接的顯示名稱。 長度上限為 200 個字元。 |
| privacyLevel |
線上的隱私權層級。 |
UpdateVirtualNetworkGatewayConnectionRequest
| 名稱 | 類型 | Description |
|---|---|---|
| connectivityType |
string:
Virtual |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
|
| displayName |
string |
連接的顯示名稱。 長度上限為 200 個字元。 |
| privacyLevel |
線上的隱私權層級。 |
VirtualNetworkGatewayConnection
透過虛擬網路數據網關聯機的連線。
| 名稱 | 類型 | Description |
|---|---|---|
| connectionDetails |
線上的連線詳細數據。 |
|
| connectionRecency |
最近關係的細節。 |
|
| connectivityType |
string:
Virtual |
連接的連線類型。 |
| credentialDetails |
線上認證詳細數據。 |
|
| displayName |
string |
連接的顯示名稱。 |
| gatewayId |
string (uuid) |
連接所透過的閘道物件 ID。 對於雲端連線,這是虛擬閘道 ID。 |
| id |
string (uuid) |
連接的物件識別碼。 |
| myRole |
來電負責人在連線中扮演的有效角色。 當主體同時屬於多個具有不同角色的安全群組時,會回傳最高的角色。 若委託人在連接中沒有角色,該屬性不會被歸還。 |
|
| privacyLevel |
線上的隱私權層級。 |
WindowsCredentials
Windows CredentialType 的認證。
| 名稱 | 類型 | Description |
|---|---|---|
| credentialType |
string:
Windows |
連接的認證類型。 |
| password |
string |
密碼。 |
| username |
string |
使用者名稱。 |
WindowsWithoutImpersonationCredentials
WindowsWithoutImpersonation CredentialType 的認證。
| 名稱 | 類型 | Description |
|---|---|---|
| credentialType |
string:
Windows |
連接的認證類型。 |
WorkspaceIdentityCredentials
WorkspaceIdentity CredentialType 的認證。
| 名稱 | 類型 | Description |
|---|---|---|
| credentialType |
string:
Workspace |
連接的認證類型。 |