Notebook Workspaces - List Connection Info

Referenz

Dienst:: Cosmos DB Resource Provider

API-Version:: 2024-11-15

Ruft die Verbindungsinformationen für den Notizbucharbeitsbereich ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Name des Cosmos DB-Datenbankkontos. RegEx-Muster: `^[a-z0-9]+(-[a-z0-9]+)*`
notebookWorkspaceName	path	True	NotebookWorkspaceName	Der Name der Notizbucharbeitsbereichsressource.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Die ID des Zielabonnements.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	NotebookWorkspaceConnectionInfoResult	Der Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CosmosDBNotebookWorkspaceListConnectionInfo

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
ErrorResponse	Fehlerantwort.
NotebookWorkspaceConnectionInfoResult	Die Verbindungsinformationen für den angegebenen Notizbucharbeitsbereich
NotebookWorkspaceName	Der Name der Notizbucharbeitsbereichsressource.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

NotebookWorkspaceConnectionInfoResult

Die Verbindungsinformationen für den angegebenen Notizbucharbeitsbereich

Name	Typ	Beschreibung
authToken	string	Gibt das Authentifizierungstoken an, das für die Verbindung mit dem Notizbuchserver verwendet wird (verwendet tokenbasierte Authentifizierung).
notebookServerEndpoint	string	Gibt den Endpunkt des Notizbuchservers an.

NotebookWorkspaceName

Der Name der Notizbucharbeitsbereichsressource.

Name	Typ	Beschreibung
default	string

Freigeben über