Поделиться через


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

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

Образец запроса

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