azurermCosmosdbNotebookWorkspace
Manages an SQL Notebook Workspace.
!> Note: CosmosDb Notebook Workspace is now Deprecated - as such the azurermCosmosdbNotebookWorkspace resource is deprecated and will be removed in v4.0 of the AzureRM Provider.
\~> NOTE: CosmosDb Notebook (the feature itself) is not deprecated and will return: https://learn.microsoft.com/en-us/azure/cosmos-db/notebooks-faq.
\~> NOTE: However, CosmosDb Notebook feature no longer uses the permanent notebook workspace being referred to the public surface in the RP (have since moved to temporary notebooks workspaces which are short-lived <1 hour).
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
this,
"example",
{
location: "West Europe",
name: "example-resources",
}
);
const azurermCosmosdbAccountExample =
new azurerm.cosmosdbAccount.CosmosdbAccount(this, "example_1", {
consistency_policy: [
{
consistency_level: "BoundedStaleness",
},
],
geo_location: [
{
failover_priority: 0,
location: azurermResourceGroupExample.location,
},
],
kind: "GlobalDocumentDB",
location: azurermResourceGroupExample.location,
name: "example-cosmosdb-account",
offer_type: "Standard",
resource_group_name: azurermResourceGroupExample.name,
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermCosmosdbAccountExample.overrideLogicalId("example");
const azurermCosmosdbNotebookWorkspaceExample =
new azurerm.cosmosdbNotebookWorkspace.CosmosdbNotebookWorkspace(
this,
"example_2",
{
account_name: azurermCosmosdbAccountExample.name,
name: "default",
resource_group_name: azurermCosmosdbAccountExample.resourceGroupName,
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermCosmosdbNotebookWorkspaceExample.overrideLogicalId("example");
Arguments Reference
The following arguments are supported:
-
name- (Required) The name which should be used for this SQL Notebook Workspace. Possible value isdefault. Changing this forces a new SQL Notebook Workspace to be created. -
resourceGroupName- (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. -
accountName- (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.
Attributes Reference
In addition to the Arguments listed above - the following Attributes are exported:
-
id- The ID of the SQL Notebook Workspace. -
serverEndpoint- Specifies the endpoint of Notebook server.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 30 minutes) Used when creating the =SQL Notebook Workspace.read- (Defaults to 5 minutes) Used when retrieving the =SQL Notebook Workspace.delete- (Defaults to 30 minutes) Used when deleting the =SQL Notebook Workspace.
Import
\=SQL Notebook Workspaces can be imported using the resourceId, e.g.