Notebook Workspaces - Create Or Update

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Membuat ruang kerja notebook untuk akun Cosmos DB.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string	Nama akun database Cosmos DB. Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
notebookWorkspaceName	path	True	NotebookWorkspaceName	Nama sumber daya ruang kerja notebook.
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	NotebookWorkspace	Pembuatan ruang kerja notebook akan selesai secara asinkron.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Contoh

CosmosDBNotebookWorkspaceCreate

Sample Request

HTTP

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

{}

Java

import com.azure.resourcemanager.cosmos.models.NotebookWorkspaceCreateUpdateParameters;
import com.azure.resourcemanager.cosmos.models.NotebookWorkspaceName;

/**
 * Samples for NotebookWorkspaces CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBNotebookWorkspaceCreate.json
     */
    /**
     * Sample code: CosmosDBNotebookWorkspaceCreate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBNotebookWorkspaceCreate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getNotebookWorkspaces().createOrUpdate("rg1", "ddb1",
            NotebookWorkspaceName.DEFAULT, new NotebookWorkspaceCreateUpdateParameters(),
            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

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/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/CosmosDBNotebookWorkspaceCreate.json
func ExampleNotebookWorkspacesClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewNotebookWorkspacesClient().BeginCreateOrUpdate(ctx, "rg1", "ddb1", armcosmos.NotebookWorkspaceNameDefault, armcosmos.NotebookWorkspaceCreateUpdateParameters{}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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

JavaScript

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates the notebook workspace for a Cosmos DB account.
 *
 * @summary Creates the notebook workspace for a Cosmos DB account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceCreate.json
 */
async function cosmosDbNotebookWorkspaceCreate() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const notebookWorkspaceName = "default";
  const notebookCreateUpdateParameters = {};
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.notebookWorkspaces.beginCreateOrUpdateAndWait(
    resourceGroupName,
    accountName,
    notebookWorkspaceName,
    notebookCreateUpdateParameters,
  );
  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

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default",
  "name": "default",
  "type": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces",
  "properties": {
    "notebookServerEndpoint": "endpoint",
    "status": "Online"
  }
}

Definisi

Nama	Deskripsi
ErrorResponse	Respons Kesalahan.
NotebookWorkspace	Sumber daya ruang kerja notebook
NotebookWorkspaceCreateUpdateParameters	Parameter untuk membuat sumber daya ruang kerja notebook
NotebookWorkspaceName	Nama sumber daya ruang kerja notebook.

ErrorResponse

Respons Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

NotebookWorkspace

Sumber daya ruang kerja notebook

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya unik akun database.
name	string	Nama akun database.
properties.notebookServerEndpoint	string	Menentukan titik akhir server Notebook.
properties.status	string	Status ruang kerja buku catatan. Nilai yang mungkin adalah: Membuat, Online, Menghapus, Gagal, Memperbarui.
type	string	Jenis sumber daya Azure.

NotebookWorkspaceCreateUpdateParameters

Parameter untuk membuat sumber daya ruang kerja notebook

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya unik akun database.
name	string	Nama akun database.
type	string	Jenis sumber daya Azure.

NotebookWorkspaceName

Nama sumber daya ruang kerja notebook.

Nama	Jenis	Deskripsi
default	string