Notebook Workspaces - List Connection Info
Ruft die Verbindungsinformationen für den Notebookarbeitsbereich ab.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/default/listConnectionInfo?api-version=2023-11-15
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
account
|
path | True |
string |
Name des Cosmos DB-Datenbankkontos. RegEx-Muster: |
notebook
|
path | True |
Der Name der Notebook-Arbeitsbereichsressource. |
|
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Der Vorgang wurde erfolgreich abgeschlossen. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
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
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default/listConnectionInfo?api-version=2023-11-15
Beispiel für eine Antwort
{
"authToken": "auth-token",
"notebookServerEndpoint": "notebook endpoint"
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Fehlerantwort. |
Notebook |
Die Verbindungsinformationen für den angegebenen Notebookarbeitsbereich |
Notebook |
Der Name der Notebook-Arbeitsbereichsressource. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode |
message |
string |
Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist. |
NotebookWorkspaceConnectionInfoResult
Die Verbindungsinformationen für den angegebenen Notebookarbeitsbereich
Name | Typ | Beschreibung |
---|---|---|
authToken |
string |
Gibt das Authentifizierungstoken an, das zum Herstellen einer Verbindung mit dem Notebook-Server verwendet wird (verwendet die tokenbasierte Authentifizierung). |
notebookServerEndpoint |
string |
Gibt den Endpunkt des Notebook-Servers an. |
NotebookWorkspaceName
Der Name der Notebook-Arbeitsbereichsressource.
Name | Typ | Beschreibung |
---|---|---|
default |
string |