Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. NotebookWorkspace
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cosmosdb.NotebookWorkspace

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

A notebook workspace resource

Uses Azure REST API version 2024-11-15.

Other available API versions: 2019-08-01, 2019-12-12, 2020-03-01, 2020-04-01, 2020-06-01-preview, 2020-09-01, 2021-01-15, 2021-03-01-preview, 2021-03-15, 2021-04-01-preview, 2021-04-15, 2021-05-15, 2021-06-15, 2021-07-01-preview, 2021-10-15, 2021-10-15-preview, 2021-11-15-preview, 2022-02-15-preview, 2022-05-15, 2022-05-15-preview, 2022-08-15, 2022-08-15-preview, 2022-11-15, 2022-11-15-preview, 2023-03-01-preview, 2023-03-15, 2023-03-15-preview, 2023-04-15, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-12-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.

Example Usage

CosmosDBNotebookWorkspaceCreate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var notebookWorkspace = new AzureNative.CosmosDB.NotebookWorkspace("notebookWorkspace", new()
    {
        AccountName = "ddb1",
        NotebookWorkspaceName = "default",
        ResourceGroupName = "rg1",
    });

});
Copy
package main

import (
	cosmosdb "github.com/pulumi/pulumi-azure-native-sdk/cosmosdb/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cosmosdb.NewNotebookWorkspace(ctx, "notebookWorkspace", &cosmosdb.NotebookWorkspaceArgs{
			AccountName:           pulumi.String("ddb1"),
			NotebookWorkspaceName: pulumi.String("default"),
			ResourceGroupName:     pulumi.String("rg1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cosmosdb.NotebookWorkspace;
import com.pulumi.azurenative.cosmosdb.NotebookWorkspaceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var notebookWorkspace = new NotebookWorkspace("notebookWorkspace", NotebookWorkspaceArgs.builder()
            .accountName("ddb1")
            .notebookWorkspaceName("default")
            .resourceGroupName("rg1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const notebookWorkspace = new azure_native.cosmosdb.NotebookWorkspace("notebookWorkspace", {
    accountName: "ddb1",
    notebookWorkspaceName: "default",
    resourceGroupName: "rg1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

notebook_workspace = azure_native.cosmosdb.NotebookWorkspace("notebookWorkspace",
    account_name="ddb1",
    notebook_workspace_name="default",
    resource_group_name="rg1")
Copy
resources:
  notebookWorkspace:
    type: azure-native:cosmosdb:NotebookWorkspace
    properties:
      accountName: ddb1
      notebookWorkspaceName: default
      resourceGroupName: rg1
Copy

Create NotebookWorkspace Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new NotebookWorkspace(name: string, args: NotebookWorkspaceArgs, opts?: CustomResourceOptions);
@overload
def NotebookWorkspace(resource_name: str,
                      args: NotebookWorkspaceArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def NotebookWorkspace(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      account_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      notebook_workspace_name: Optional[str] = None)
func NewNotebookWorkspace(ctx *Context, name string, args NotebookWorkspaceArgs, opts ...ResourceOption) (*NotebookWorkspace, error)
public NotebookWorkspace(string name, NotebookWorkspaceArgs args, CustomResourceOptions? opts = null)
public NotebookWorkspace(String name, NotebookWorkspaceArgs args)
public NotebookWorkspace(String name, NotebookWorkspaceArgs args, CustomResourceOptions options)

type: azure-native:cosmosdb:NotebookWorkspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. NotebookWorkspaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. NotebookWorkspaceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. NotebookWorkspaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. NotebookWorkspaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NotebookWorkspaceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var notebookWorkspaceResource = new AzureNative.CosmosDB.NotebookWorkspace("notebookWorkspaceResource", new()
{
    AccountName = "string",
    ResourceGroupName = "string",
    NotebookWorkspaceName = "string",
});
Copy
example, err := cosmosdb.NewNotebookWorkspace(ctx, "notebookWorkspaceResource", &cosmosdb.NotebookWorkspaceArgs{
	AccountName:           pulumi.String("string"),
	ResourceGroupName:     pulumi.String("string"),
	NotebookWorkspaceName: pulumi.String("string"),
})
Copy
var notebookWorkspaceResource = new NotebookWorkspace("notebookWorkspaceResource", NotebookWorkspaceArgs.builder()
    .accountName("string")
    .resourceGroupName("string")
    .notebookWorkspaceName("string")
    .build());
Copy
notebook_workspace_resource = azure_native.cosmosdb.NotebookWorkspace("notebookWorkspaceResource",
    account_name="string",
    resource_group_name="string",
    notebook_workspace_name="string")
Copy
const notebookWorkspaceResource = new azure_native.cosmosdb.NotebookWorkspace("notebookWorkspaceResource", {
    accountName: "string",
    resourceGroupName: "string",
    notebookWorkspaceName: "string",
});
Copy
type: azure-native:cosmosdb:NotebookWorkspace
properties:
    accountName: string
    notebookWorkspaceName: string
    resourceGroupName: string
Copy

NotebookWorkspace Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The NotebookWorkspace resource accepts the following input properties:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
NotebookWorkspaceName Changes to this property will trigger replacement. string
The name of the notebook workspace resource.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
NotebookWorkspaceName Changes to this property will trigger replacement. string
The name of the notebook workspace resource.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
notebookWorkspaceName Changes to this property will trigger replacement. String
The name of the notebook workspace resource.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
notebookWorkspaceName Changes to this property will trigger replacement. string
The name of the notebook workspace resource.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
notebook_workspace_name Changes to this property will trigger replacement. str
The name of the notebook workspace resource.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
notebookWorkspaceName Changes to this property will trigger replacement. String
The name of the notebook workspace resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the NotebookWorkspace resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the database account.
NotebookServerEndpoint string
Specifies the endpoint of Notebook server.
Status string
Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
Type string
The type of Azure resource.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the database account.
NotebookServerEndpoint string
Specifies the endpoint of Notebook server.
Status string
Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
Type string
The type of Azure resource.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the database account.
notebookServerEndpoint String
Specifies the endpoint of Notebook server.
status String
Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
type String
The type of Azure resource.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the database account.
notebookServerEndpoint string
Specifies the endpoint of Notebook server.
status string
Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
type string
The type of Azure resource.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the database account.
notebook_server_endpoint str
Specifies the endpoint of Notebook server.
status str
Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
type str
The type of Azure resource.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the database account.
notebookServerEndpoint String
Specifies the endpoint of Notebook server.
status String
Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
type String
The type of Azure resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:cosmosdb:NotebookWorkspace default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native