All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.cosmosdb.kotlin.NotebookWorkspace.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.cosmosdb.kotlin

import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit

/**
 * Builder for [NotebookWorkspace].
 */
@PulumiTagMarker
public class NotebookWorkspaceResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: NotebookWorkspaceArgs = NotebookWorkspaceArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend NotebookWorkspaceArgsBuilder.() -> Unit) {
        val builder = NotebookWorkspaceArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): NotebookWorkspace {
        val builtJavaResource = com.pulumi.azure.cosmosdb.NotebookWorkspace(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return NotebookWorkspace(builtJavaResource)
    }
}

/**
 * Manages an SQL Notebook Workspace.
 * !> **Note:** CosmosDb Notebook Workspace is now Deprecated - as such the `azure.cosmosdb.NotebookWorkspace` 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: .
 * > **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
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = new azure.core.ResourceGroup("example", {
 *     name: "example-resources",
 *     location: "West Europe",
 * });
 * const exampleAccount = new azure.cosmosdb.Account("example", {
 *     name: "example-cosmosdb-account",
 *     location: example.location,
 *     resourceGroupName: example.name,
 *     offerType: "Standard",
 *     kind: "GlobalDocumentDB",
 *     consistencyPolicy: {
 *         consistencyLevel: "BoundedStaleness",
 *     },
 *     geoLocations: [{
 *         location: example.location,
 *         failoverPriority: 0,
 *     }],
 * });
 * const exampleNotebookWorkspace = new azure.cosmosdb.NotebookWorkspace("example", {
 *     name: "default",
 *     resourceGroupName: exampleAccount.resourceGroupName,
 *     accountName: exampleAccount.name,
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_account = azure.cosmosdb.Account("example",
 *     name="example-cosmosdb-account",
 *     location=example.location,
 *     resource_group_name=example.name,
 *     offer_type="Standard",
 *     kind="GlobalDocumentDB",
 *     consistency_policy={
 *         "consistency_level": "BoundedStaleness",
 *     },
 *     geo_locations=[{
 *         "location": example.location,
 *         "failover_priority": 0,
 *     }])
 * example_notebook_workspace = azure.cosmosdb.NotebookWorkspace("example",
 *     name="default",
 *     resource_group_name=example_account.resource_group_name,
 *     account_name=example_account.name)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.Core.ResourceGroup("example", new()
 *     {
 *         Name = "example-resources",
 *         Location = "West Europe",
 *     });
 *     var exampleAccount = new Azure.CosmosDB.Account("example", new()
 *     {
 *         Name = "example-cosmosdb-account",
 *         Location = example.Location,
 *         ResourceGroupName = example.Name,
 *         OfferType = "Standard",
 *         Kind = "GlobalDocumentDB",
 *         ConsistencyPolicy = new Azure.CosmosDB.Inputs.AccountConsistencyPolicyArgs
 *         {
 *             ConsistencyLevel = "BoundedStaleness",
 *         },
 *         GeoLocations = new[]
 *         {
 *             new Azure.CosmosDB.Inputs.AccountGeoLocationArgs
 *             {
 *                 Location = example.Location,
 *                 FailoverPriority = 0,
 *             },
 *         },
 *     });
 *     var exampleNotebookWorkspace = new Azure.CosmosDB.NotebookWorkspace("example", new()
 *     {
 *         Name = "default",
 *         ResourceGroupName = exampleAccount.ResourceGroupName,
 *         AccountName = exampleAccount.Name,
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cosmosdb"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
 * 			Name:     pulumi.String("example-resources"),
 * 			Location: pulumi.String("West Europe"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleAccount, err := cosmosdb.NewAccount(ctx, "example", &cosmosdb.AccountArgs{
 * 			Name:              pulumi.String("example-cosmosdb-account"),
 * 			Location:          example.Location,
 * 			ResourceGroupName: example.Name,
 * 			OfferType:         pulumi.String("Standard"),
 * 			Kind:              pulumi.String("GlobalDocumentDB"),
 * 			ConsistencyPolicy: &cosmosdb.AccountConsistencyPolicyArgs{
 * 				ConsistencyLevel: pulumi.String("BoundedStaleness"),
 * 			},
 * 			GeoLocations: cosmosdb.AccountGeoLocationArray{
 * 				&cosmosdb.AccountGeoLocationArgs{
 * 					Location:         example.Location,
 * 					FailoverPriority: pulumi.Int(0),
 * 				},
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = cosmosdb.NewNotebookWorkspace(ctx, "example", &cosmosdb.NotebookWorkspaceArgs{
 * 			Name:              pulumi.String("default"),
 * 			ResourceGroupName: exampleAccount.ResourceGroupName,
 * 			AccountName:       exampleAccount.Name,
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.azure.core.ResourceGroup;
 * import com.pulumi.azure.core.ResourceGroupArgs;
 * import com.pulumi.azure.cosmosdb.Account;
 * import com.pulumi.azure.cosmosdb.AccountArgs;
 * import com.pulumi.azure.cosmosdb.inputs.AccountConsistencyPolicyArgs;
 * import com.pulumi.azure.cosmosdb.inputs.AccountGeoLocationArgs;
 * import com.pulumi.azure.cosmosdb.NotebookWorkspace;
 * import com.pulumi.azure.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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
 *             .name("example-resources")
 *             .location("West Europe")
 *             .build());
 *         var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
 *             .name("example-cosmosdb-account")
 *             .location(example.location())
 *             .resourceGroupName(example.name())
 *             .offerType("Standard")
 *             .kind("GlobalDocumentDB")
 *             .consistencyPolicy(AccountConsistencyPolicyArgs.builder()
 *                 .consistencyLevel("BoundedStaleness")
 *                 .build())
 *             .geoLocations(AccountGeoLocationArgs.builder()
 *                 .location(example.location())
 *                 .failoverPriority(0)
 *                 .build())
 *             .build());
 *         var exampleNotebookWorkspace = new NotebookWorkspace("exampleNotebookWorkspace", NotebookWorkspaceArgs.builder()
 *             .name("default")
 *             .resourceGroupName(exampleAccount.resourceGroupName())
 *             .accountName(exampleAccount.name())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   exampleAccount:
 *     type: azure:cosmosdb:Account
 *     name: example
 *     properties:
 *       name: example-cosmosdb-account
 *       location: ${example.location}
 *       resourceGroupName: ${example.name}
 *       offerType: Standard
 *       kind: GlobalDocumentDB
 *       consistencyPolicy:
 *         consistencyLevel: BoundedStaleness
 *       geoLocations:
 *         - location: ${example.location}
 *           failoverPriority: 0
 *   exampleNotebookWorkspace:
 *     type: azure:cosmosdb:NotebookWorkspace
 *     name: example
 *     properties:
 *       name: default
 *       resourceGroupName: ${exampleAccount.resourceGroupName}
 *       accountName: ${exampleAccount.name}
 * ```
 * 
 * ## Import
 * =SQL Notebook Workspaces can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:cosmosdb/notebookWorkspace:NotebookWorkspace example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DocumentDB/databaseAccounts/account1/notebookWorkspaces/notebookWorkspace1
 * ```
 */
public class NotebookWorkspace internal constructor(
    override val javaResource: com.pulumi.azure.cosmosdb.NotebookWorkspace,
) : KotlinCustomResource(javaResource, NotebookWorkspaceMapper) {
    /**
     * 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.
     */
    public val accountName: Output
        get() = javaResource.accountName().applyValue({ args0 -> args0 })

    /**
     * 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.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The name of the Resource Group where the SQL Notebook Workspace should exist. Changing this forces a new SQL Notebook Workspace to be created.
     */
    public val resourceGroupName: Output
        get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })

    /**
     * Specifies the endpoint of Notebook server.
     */
    public val serverEndpoint: Output
        get() = javaResource.serverEndpoint().applyValue({ args0 -> args0 })
}

public object NotebookWorkspaceMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.cosmosdb.NotebookWorkspace::class == javaResource::class

    override fun map(javaResource: Resource): NotebookWorkspace = NotebookWorkspace(
        javaResource as
            com.pulumi.azure.cosmosdb.NotebookWorkspace,
    )
}

/**
 * @see [NotebookWorkspace].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [NotebookWorkspace].
 */
public suspend fun notebookWorkspace(
    name: String,
    block: suspend NotebookWorkspaceResourceBuilder.() -> Unit,
): NotebookWorkspace {
    val builder = NotebookWorkspaceResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [NotebookWorkspace].
 * @param name The _unique_ name of the resulting resource.
 */
public fun notebookWorkspace(name: String): NotebookWorkspace {
    val builder = NotebookWorkspaceResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy