Ottiene l'area di lavoro notebook per un account Cosmos DB.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/default?api-version=2023-11-15
Parametri dell'URI
Nome |
In |
Necessario |
Tipo |
Descrizione |
accountName
|
path |
True
|
string
|
Nome dell'account del database Cosmos DB.
Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
|
notebookWorkspaceName
|
path |
True
|
NotebookWorkspaceName
|
Nome della risorsa dell'area di lavoro del notebook.
|
resourceGroupName
|
path |
True
|
string
|
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
|
subscriptionId
|
path |
True
|
string
|
ID della sottoscrizione di destinazione.
|
api-version
|
query |
True
|
string
|
Versione dell'API da usare per questa operazione.
|
Risposte
Nome |
Tipo |
Descrizione |
200 OK
|
NotebookWorkspace
|
È stata recuperata correttamente una risorsa dell'area di lavoro del notebook specificata.
|
Other Status Codes
|
ErrorResponse
|
Risposta di errore che descrive perché l'operazione non è riuscita.
|
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome |
Descrizione |
user_impersonation
|
Rappresentare l'account utente
|
Esempio
CosmosDBNotebookWorkspaceGet
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default?api-version=2023-11-15
import com.azure.resourcemanager.cosmos.models.NotebookWorkspaceName;
/**
* Samples for NotebookWorkspaces Get.
*/
public final class Main {
/*
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
* CosmosDBNotebookWorkspaceGet.json
*/
/**
* Sample code: CosmosDBNotebookWorkspaceGet.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void cosmosDBNotebookWorkspaceGet(com.azure.resourcemanager.AzureResourceManager azure) {
azure.cosmosDBAccounts().manager().serviceClient().getNotebookWorkspaces().getWithResponse("rg1", "ddb1",
NotebookWorkspaceName.DEFAULT, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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_get.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.get(
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/2023-11-15/examples/CosmosDBNotebookWorkspaceGet.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
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/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceGet.json
func ExampleNotebookWorkspacesClient_Get() {
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().Get(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.NotebookWorkspace = armcosmos.NotebookWorkspace{
// Name: to.Ptr("default"),
// Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default"),
// Properties: &armcosmos.NotebookWorkspaceProperties{
// NotebookServerEndpoint: to.Ptr("endpoint"),
// Status: to.Ptr("Online"),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets the notebook workspace for a Cosmos DB account.
*
* @summary Gets the notebook workspace for a Cosmos DB account.
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceGet.json
*/
async function cosmosDbNotebookWorkspaceGet() {
const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
const accountName = "ddb1";
const notebookWorkspaceName = "default";
const credential = new DefaultAzureCredential();
const client = new CosmosDBManagementClient(credential, subscriptionId);
const result = await client.notebookWorkspaces.get(
resourceGroupName,
accountName,
notebookWorkspaceName,
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default",
"name": "default",
"type": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces",
"properties": {
"notebookServerEndpoint": "endpoint",
"status": "Online"
}
}
Definizioni
ErrorResponse
Risposta errore.
Nome |
Tipo |
Descrizione |
code
|
string
|
Codice di errore.
|
message
|
string
|
Messaggio di errore che indica perché l'operazione non è riuscita.
|
NotebookWorkspace
Risorsa dell'area di lavoro notebook
Nome |
Tipo |
Descrizione |
id
|
string
|
Identificatore univoco della risorsa dell'account del database.
|
name
|
string
|
Nome dell'account del database.
|
properties.notebookServerEndpoint
|
string
|
Specifica l'endpoint del server Notebook.
|
properties.status
|
string
|
Stato dell'area di lavoro notebook. I valori possibili sono: Creazione, Online, Eliminazione, Errore, Aggiornamento.
|
type
|
string
|
Tipo di risorsa di Azure.
|
NotebookWorkspaceName
Nome della risorsa dell'area di lavoro del notebook.
Nome |
Tipo |
Descrizione |
default
|
string
|
|