Notebook Workspaces - List Connection Info

Référence

Service:: Cosmos DB Resource Provider

Version d'API:: 2024-11-15

Récupère les informations de connexion de l’espace de travail notebook

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte de base de données Cosmos DB. Modèle d’expression régulière: `^[a-z0-9]+(-[a-z0-9]+)*`
notebookWorkspaceName	path	True	NotebookWorkspaceName	Nom de la ressource d’espace de travail du bloc-notes.
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	NotebookWorkspaceConnectionInfoResult	L’opération s’est terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

CosmosDBNotebookWorkspaceListConnectionInfo

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
ErrorResponse	Réponse d’erreur.
NotebookWorkspaceConnectionInfoResult	Informations de connexion pour l’espace de travail de bloc-notes donné
NotebookWorkspaceName	Nom de la ressource d’espace de travail du bloc-notes.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur indiquant pourquoi l’opération a échoué.

NotebookWorkspaceConnectionInfoResult

Informations de connexion pour l’espace de travail de bloc-notes donné

Nom	Type	Description
authToken	string	Spécifie le jeton d’authentification utilisé pour la connexion au serveur Notebook (utilise l’authentification basée sur les jetons).
notebookServerEndpoint	string	Spécifie le point de terminaison du serveur Notebook.

NotebookWorkspaceName

Nom de la ressource d’espace de travail du bloc-notes.

Nom	Type	Description
default	string

Partager via