Notebook Workspaces - List Connection Info

服務:

Cosmos DB Resource Provider

API 版本:

2025-10-15

擷取筆記本工作區的連線資訊

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/default/listConnectionInfo?api-version=2025-10-15

URI 參數

名稱	位於	必要	類型	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB 資料庫帳戶名稱。
notebookWorkspaceName	path	True	NotebookWorkspaceName	筆記本工作區資源的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	NotebookWorkspaceConnectionInfoResult	作業已順利完成。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

CosmosDBNotebookWorkspaceListConnectionInfo

範例要求

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default/listConnectionInfo?api-version=2025-10-15

範例回覆

狀態碼:

200

{
  "authToken": "auth-token",
  "notebookServerEndpoint": "notebook endpoint"
}

定義

名稱	Description
ErrorResponse	錯誤回應。
NotebookWorkspaceConnectionInfoResult	指定筆記本工作區的連線資訊
NotebookWorkspaceName	筆記本工作區資源的名稱。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息，指出作業失敗的原因。

NotebookWorkspaceConnectionInfoResult

Object

指定筆記本工作區的連線資訊

名稱	類型	Description
authToken	string	指定用於連線至 Notebook 伺服器的驗證權杖 （使用權杖型驗證）。
notebookServerEndpoint	string	指定筆記本伺服器的端點。

NotebookWorkspaceName

列舉型別

筆記本工作區資源的名稱。

值	Description
default