Notebook Workspaces - List Connection Info
擷取筆記本工作區的聯機資訊
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/default/listConnectionInfo?api-version=2024-05-15
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
account
|
path | True |
string |
Cosmos DB 資料庫帳戶名稱。 Regex 模式: |
notebook
|
path | True |
筆記本工作區資源的名稱。 |
|
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
作業已成功完成。 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
CosmosDBNotebookWorkspaceListConnectionInfo
Sample request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default/listConnectionInfo?api-version=2024-05-15
Sample response
{
"authToken": "auth-token",
"notebookServerEndpoint": "notebook endpoint"
}
定義
名稱 | Description |
---|---|
Error |
錯誤回應。 |
Notebook |
指定筆記本工作區的連線資訊 |
Notebook |
筆記本工作區資源的名稱。 |
ErrorResponse
錯誤回應。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
message |
string |
錯誤訊息,指出作業失敗的原因。 |
NotebookWorkspaceConnectionInfoResult
指定筆記本工作區的連線資訊
名稱 | 類型 | Description |
---|---|---|
authToken |
string |
指定用來連線到 Notebook 伺服器的驗證令牌, (使用令牌型驗證) 。 |
notebookServerEndpoint |
string |
指定 Notebook 伺服器的端點。 |
NotebookWorkspaceName
筆記本工作區資源的名稱。
名稱 | 類型 | Description |
---|---|---|
default |
string |