Top / Microsoft Azure / Azure CosmosDB (DocumentDB) / Notebook Workspace

Azure CosmosDB (DocumentDB) Notebook Workspace

This page shows how to write Terraform and Azure Resource Manager for CosmosDB (DocumentDB) Notebook Workspace and write them securely.

terraform-logo

Review your .tf file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

azurerm_cosmosdb_notebook_workspace (Terraform)

The Notebook Workspace in CosmosDB (DocumentDB) can be configured in Terraform with the resource name azurerm_cosmosdb_notebook_workspace. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for Azure best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are supported:

  • name - (Required) The name which should be used for this SQL Notebook Workspace. Possible value is default. Changing this forces a new SQL Notebook Workspace to be created.

  • resource_group_name - (Required) The name of the Resource Group where the SQL Notebook Workspace should exist. Changing this forces a new SQL Notebook Workspace to be created.

  • account_name - (Required) The name of the Cosmos DB Account to create the SQL Notebook Workspace within. Changing this forces a new SQL Notebook Workspace to be created.

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the SQL Notebook Workspace.

  • server_endpoint - Specifies the endpoint of Notebook server.

>> from Terraform Registry

Explanation in Terraform Registry

Manages an SQL Notebook Workspace.

>> from Terraform Registry

Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces (Azure Resource Manager)

The databaseAccounts/notebookWorkspaces in Microsoft.DocumentDB can be configured in Azure Resource Manager with the resource name Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

  • apiVersion required - string
  • name required - string

    The name of the notebook workspace resource.

  • type required - string

>> from Azure Resource Manager Documentation

The Other Related Azure CosmosDB (DocumentDB) Resources

Frequently asked questions

What is Azure CosmosDB (DocumentDB) Notebook Workspace?

Azure CosmosDB (DocumentDB) Notebook Workspace is a resource for CosmosDB (DocumentDB) of Microsoft Azure. Settings can be wrote in Terraform.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents