Notebook Workspaces - Get

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

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

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

URI パラメーター

Name In Required Type Description
accountName
 path True
  • string

DB データベース アカウント名をCosmosします。

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

ノートブック ワークスペース リソースの名前。
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

OAuth2 FlowをAzure Active Directoryする

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

Scopes

Name Description
user_impersonation ユーザー アカウントの借用

例

CosmosDBNotebookWorkspaceGet

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default?api-version=2021-04-01-preview

Sample Response

Status code:
200 
{
  "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

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

ノートブック ワークスペース リソースの名前。

ErrorResponse

エラー応答。

Name Type Description
code
  • string

エラー コード。
message
  • string

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

NotebookWorkspace

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

Name Type Description
id
  • string

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

データベース アカウントの名前。
properties.notebookServerEndpoint
  • string

Notebook サーバーのエンドポイントを指定します。
properties.status
  • string

ノートブック ワークスペースの状態。 使用可能な値は、作成、オンライン、削除、失敗、更新です。
type
  • string

Azure リソースの種類。

NotebookWorkspaceName

ノートブック ワークスペース リソースの名前。

Name Type Description
default
  • string