Notebook Workspaces - List By Database Account

既存の Cosmos DB アカウントのノートブック ワークスペース リソースを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces?api-version=2023-11-15

URI パラメーター

名前 / 必須 説明
accountName
path True

string

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

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

resourceGroupName
path True

string

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

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

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

応答

名前 説明
200 OK

NotebookWorkspaceListResult

ノートブック ワークスペース リソースが正常に取得されました。

Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

CosmosDBNotebookWorkspaceList

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default",
      "name": "default",
      "type": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces",
      "properties": {
        "notebookServerEndpoint": "endpoint",
        "status": "Online"
      }
    }
  ]
}

定義

名前 説明
ErrorResponse

エラー応答。

NotebookWorkspace

ノートブック ワークスペース リソース

NotebookWorkspaceListResult

ノートブック ワークスペース リソースの一覧

ErrorResponse

エラー応答。

名前 説明
code

string

エラー コード。

message

string

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

NotebookWorkspace

ノートブック ワークスペース リソース

名前 説明
id

string

データベース アカウントの一意のリソース識別子。

name

string

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

properties.notebookServerEndpoint

string

Notebook サーバーのエンドポイントを指定します。

properties.status

string

ノートブック ワークスペースの状態。 指定できる値は、Creating、Online、Deleting、Failed、Updating です。

type

string

Azure リソースの種類。

NotebookWorkspaceListResult

ノートブック ワークスペース リソースの一覧

名前 説明
value

NotebookWorkspace[]

ノートブック ワークスペース リソースの配列