你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

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-11-15

URI 参数

名称 必需 类型 说明
accountName
path True

string

Cosmos DB 数据库帐户名称。

正则表达式模式: ^[a-z0-9]+(-[a-z0-9]+)*

notebookWorkspaceName
path True

NotebookWorkspaceName

笔记本工作区资源的名称。

resourceGroupName
path True

string

资源组的名称。 名称不区分大小写。

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

NotebookWorkspaceConnectionInfoResult

操作已成功完成。

Other Status Codes

ErrorResponse

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

CosmosDBNotebookWorkspaceListConnectionInfo

示例请求

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

示例响应

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

定义

名称 说明
ErrorResponse

错误响应。

NotebookWorkspaceConnectionInfoResult

给定笔记本工作区的连接信息

NotebookWorkspaceName

笔记本工作区资源的名称。

ErrorResponse

错误响应。

名称 类型 说明
code

string

错误代码。

message

string

指示操作失败的原因的错误消息。

NotebookWorkspaceConnectionInfoResult

给定笔记本工作区的连接信息

名称 类型 说明
authToken

string

指定用于连接到 Notebook 服务器的身份验证令牌(使用基于令牌的身份验证)。

notebookServerEndpoint

string

指定 Notebook 服务器的终结点。

NotebookWorkspaceName

笔记本工作区资源的名称。

名称 类型 说明
default

string