Notebook Workspaces - List Connection Info

Serviço:

Cosmos DB Resource Provider

Versão da API:

2024-11-15

Recupera as informações de conexão para o espaço de trabalho do bloco de anotações

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	Nome da conta do banco de dados do Cosmos DB. Padrão Regex: ^[a-z0-9]+(-[a-z0-9]+)*
notebookWorkspaceName	path	True	NotebookWorkspaceName	O nome do recurso de espaço de trabalho do bloco de anotações.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	NotebookWorkspaceConnectionInfoResult	A operação foi concluída com êxito.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Exemplos

CosmosDBNotebookWorkspaceListConnectionInfo

Pedido de amostra

HTTP

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

Python

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/2024-11-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

Go

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ded6306d00ae294c24211e5069c1f56b15ba8ef5/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json
func ExampleNotebookWorkspacesClient_ListConnectionInfo() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNotebookWorkspacesClient().ListConnectionInfo(ctx, "rg1", "ddb1", armcosmos.NotebookWorkspaceNameDefault, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.NotebookWorkspaceConnectionInfoResult = armcosmos.NotebookWorkspaceConnectionInfoResult{
	// 	AuthToken: to.Ptr("auth-token"),
	// 	NotebookServerEndpoint: to.Ptr("notebook endpoint"),
	// }
}

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

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
ErrorResponse	Resposta de erro.
NotebookWorkspaceConnectionInfoResult	As informações de conexão para o espaço de trabalho do bloco de anotações fornecido
NotebookWorkspaceName	O nome do recurso de espaço de trabalho do bloco de anotações.

ErrorResponse

Resposta de erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

NotebookWorkspaceConnectionInfoResult

As informações de conexão para o espaço de trabalho do bloco de anotações fornecido

Name	Tipo	Description
authToken	string	Especifica o token de autenticação usado para se conectar ao servidor Notebook (usa auth baseado em token).
notebookServerEndpoint	string	Especifica o ponto de extremidade do servidor Notebook.

NotebookWorkspaceName

O nome do recurso de espaço de trabalho do bloco de anotações.

Name	Tipo	Description
default	string