Notebook Workspaces - List Connection Info

Riferimento

Servizio:: Cosmos DB Resource Provider

Versione API:: 2025-04-15

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=2025-04-15

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nome dell'account del database Cosmos DB.
notebookWorkspaceName	path	True	NotebookWorkspaceName	Nome della risorsa dell'area di lavoro del notebook.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	NotebookWorkspaceConnectionInfoResult	Operazione riuscita.
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

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_notebook_workspace_list_connection_info.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.notebook_workspaces.list_connection_info(
        resource_group_name="rg1",
        account_name="ddb1",
        notebook_workspace_name="default",
    )
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:: 200

{
  "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

Object

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