Notebook Workspaces - Get

Obtém o workspace do notebook para uma conta de banco de dados Cosmos.

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

Parâmetros de URI

Name In Required Type Description
accountName
path True
  • string

Cosmos nome da conta de banco de dados do BD.

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

notebookWorkspaceName
path True

O nome do recurso de workspace do notebook.

resourceGroupName
path True
  • string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True
  • string

A ID da assinatura de destino.

api-version
query True
  • string

A versão da API a ser usada para essa operação.

Respostas

Name Type Description
200 OK

Recuperou com êxito um recurso de workspace do notebook especificado.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Flow Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation Representar sua conta de usuário

Exemplos

CosmosDBNotebookWorkspaceGet

Sample Request

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

Sample Response

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

Definições

ErrorResponse

Resposta de erro.

NotebookWorkspace

Um recurso de workspace do notebook

NotebookWorkspaceName

O nome do recurso de workspace do notebook.

ErrorResponse

Resposta de erro.

Name Type Description
code
  • string

Código do erro.

message
  • string

Mensagem de erro indicando por que a operação falhou.

NotebookWorkspace

Um recurso de workspace do notebook

Name Type Description
id
  • string

O identificador de recurso exclusivo da conta de banco de dados.

name
  • string

O nome da conta de banco de dados.

properties.notebookServerEndpoint
  • string

Especifica o ponto de extremidade do servidor notebook.

properties.status
  • string

Status do workspace do notebook. Os valores possíveis são: Criando, Online, Excluindo, Falha, Atualização.

type
  • string

O tipo de recurso do Azure.

NotebookWorkspaceName

O nome do recurso de workspace do notebook.

Name Type Description
default
  • string