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

Имя	В	Обязательно	Тип	Описание
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, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	NotebookWorkspaceConnectionInfoResult	Операция успешно завершена.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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"
}

Определения

Имя	Описание
ErrorResponse	Реакция на ошибку.
NotebookWorkspaceConnectionInfoResult	Информация о подключении к заданному рабочему пространству записной книжки
NotebookWorkspaceName	Имя ресурса рабочей области записной книжки.

ErrorResponse

Object

Реакция на ошибку.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

NotebookWorkspaceConnectionInfoResult