Notebook Workspaces - List Connection Info

  • リファレンス
Service:
Cosmos DB Resource Provider
API Version:
2021-04-01-preview

Notebook ワークスペースの接続情報を取得します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/default/listConnectionInfo?api-version=2021-04-01-preview

URI パラメーター

Name In Required Type Description
accountName
 path True
  • string

CosmosDB データベースアカウント名。

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
notebookWorkspaceName
 path True

Notebook ワークスペースリソースの名前。
resourceGroupName
 path True
  • string

リソース グループの名前。 名前の大文字と小文字は区別されます。
subscriptionId
 path True
  • string

ターゲット サブスクリプションの ID。
api-version
 query True
  • string

この操作に使用する API バージョン。

応答

Name Type Description
200 OK

操作は正常に完了しました。
Other Status Codes

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name 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=2021-04-01-preview

Sample Response

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

定義

ErrorResponse

エラー応答。
NotebookWorkspaceConnectionInfoResult

指定されたノートブックワークスペースの接続情報
NotebookWorkspaceName

Notebook ワークスペースリソースの名前。

ErrorResponse

エラー応答。

Name Type Description
code
  • string

エラー コード。
message
  • string

操作が失敗した理由を示すエラー メッセージ。

NotebookWorkspaceConnectionInfoResult

指定されたノートブックワークスペースの接続情報

Name Type Description
authToken
  • string

Notebook サーバーへの接続に使用する認証トークンを指定します (トークンベースの認証を使用します)。
notebookServerEndpoint
  • string

ノートブックサーバーのエンドポイントを指定します。

NotebookWorkspaceName

Notebook ワークスペースリソースの名前。

Name Type Description
default
  • string