Condividi tramite


Notebook Workspaces - List Connection Info

Recupera le informazioni di connessione per l'area di lavoro notebook

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
accountName
path True

string

Nome dell'account del database Cosmos DB.

Criterio di espressione regolare: ^[a-z0-9]+(-[a-z0-9]+)*

notebookWorkspaceName
path True

NotebookWorkspaceName

Nome della risorsa dell'area di lavoro del notebook.

resourceGroupName
path True

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

NotebookWorkspaceConnectionInfoResult

Operazione completata correttamente.

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation Rappresentare l'account utente

Esempio

CosmosDBNotebookWorkspaceListConnectionInfo

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
ErrorResponse

Risposta errore.

NotebookWorkspaceConnectionInfoResult

Informazioni di connessione per l'area di lavoro notebook specificata

NotebookWorkspaceName

Nome della risorsa dell'area di lavoro del notebook.

ErrorResponse

Risposta errore.

Nome Tipo Descrizione
code

string

Codice di errore.

message

string

Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

NotebookWorkspaceConnectionInfoResult

Informazioni di connessione per l'area di lavoro notebook specificata

Nome Tipo Descrizione
authToken

string

Specifica il token di autenticazione usato per la connessione al server Notebook (usa l'autenticazione basata su token).

notebookServerEndpoint

string

Specifica l'endpoint del server Notebook.

NotebookWorkspaceName

Nome della risorsa dell'area di lavoro del notebook.

Nome Tipo Descrizione
default

string