databricks

package
v3.55.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 9, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type LookupWorkspaceArgs added in v3.23.0 

type LookupWorkspaceArgs struct {
	// The name of the Databricks Workspace.
	Name string `pulumi:"name"`
	// The Name of the Resource Group where the Databricks Workspace exists.
	ResourceGroupName string `pulumi:"resourceGroupName"`
	// A mapping of tags to assign to the Databricks Workspace.
	Tags map[string]string `pulumi:"tags"`
}

A collection of arguments for invoking getWorkspace.

type LookupWorkspaceResult added in v3.23.0 

type LookupWorkspaceResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id                string `pulumi:"id"`
	Name              string `pulumi:"name"`
	ResourceGroupName string `pulumi:"resourceGroupName"`
	// SKU of this Databricks Workspace.
	Sku string `pulumi:"sku"`
	// A mapping of tags to assign to the Databricks Workspace.
	Tags map[string]string `pulumi:"tags"`
	// Unique ID of this Databricks Workspace in Databricks management plane.
	WorkspaceId string `pulumi:"workspaceId"`
	// URL this Databricks Workspace is accessible on.
	WorkspaceUrl string `pulumi:"workspaceUrl"`
}

A collection of values returned by getWorkspace.

func LookupWorkspace added in v3.23.0 

func LookupWorkspace(ctx *pulumi.Context, args *LookupWorkspaceArgs, opts ...pulumi.InvokeOption) (*LookupWorkspaceResult, error)

Use this data source to access information about an existing Databricks workspace.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/databricks"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := databricks.LookupWorkspace(ctx, &databricks.LookupWorkspaceArgs{
			Name:              "example-workspace",
			ResourceGroupName: "example-rg",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("databricksWorkspaceId", example.WorkspaceId)
		return nil
	})
}

```

type Workspace 

type Workspace struct {
	pulumi.CustomResourceState

	// A `customParameters` block as documented below.
	CustomParameters WorkspaceCustomParametersOutput `pulumi:"customParameters"`
	// Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// The ID of the Managed Resource Group created by the Databricks Workspace.
	ManagedResourceGroupId pulumi.StringOutput `pulumi:"managedResourceGroupId"`
	// The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.
	ManagedResourceGroupName pulumi.StringOutput `pulumi:"managedResourceGroupName"`
	// Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// The `sku` to use for the Databricks Workspace. Possible values are `standard`, `premium`, or `trial`. Changing this can force a new resource to be created in some circumstances.
	Sku pulumi.StringOutput `pulumi:"sku"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// The unique identifier of the databricks workspace in Databricks control plane.
	WorkspaceId pulumi.StringOutput `pulumi:"workspaceId"`
	// The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'
	WorkspaceUrl pulumi.StringOutput `pulumi:"workspaceUrl"`
}

Manages a Databricks Workspace

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/databricks"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewWorkspace(ctx, "exampleWorkspace", &databricks.WorkspaceArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			Sku:               pulumi.String("standard"),
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("Production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Databrick Workspaces can be imported using the `resource id`, e.g.

```sh 

$ pulumi import azure:databricks/workspace:Workspace workspace1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Databricks/workspaces/workspace1

```

func GetWorkspace 

func GetWorkspace(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *WorkspaceState, opts ...pulumi.ResourceOption) (*Workspace, error)

GetWorkspace gets an existing Workspace resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewWorkspace 

func NewWorkspace(ctx *pulumi.Context,
	name string, args *WorkspaceArgs, opts ...pulumi.ResourceOption) (*Workspace, error)

NewWorkspace registers a new resource with the given unique name, arguments, and options.

func (*Workspace) ElementType added in v3.31.1 

func (*Workspace) ElementType() reflect.Type

func (*Workspace) ToWorkspaceOutput added in v3.31.1 

func (i *Workspace) ToWorkspaceOutput() WorkspaceOutput

func (*Workspace) ToWorkspaceOutputWithContext added in v3.31.1 

func (i *Workspace) ToWorkspaceOutputWithContext(ctx context.Context) WorkspaceOutput

func (*Workspace) ToWorkspacePtrOutput added in v3.47.1 

func (i *Workspace) ToWorkspacePtrOutput() WorkspacePtrOutput

func (*Workspace) ToWorkspacePtrOutputWithContext added in v3.47.1 

func (i *Workspace) ToWorkspacePtrOutputWithContext(ctx context.Context) WorkspacePtrOutput

type WorkspaceArgs 

type WorkspaceArgs struct {
	// A `customParameters` block as documented below.
	CustomParameters WorkspaceCustomParametersPtrInput
	// Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.
	ManagedResourceGroupName pulumi.StringPtrInput
	// Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// The `sku` to use for the Databricks Workspace. Possible values are `standard`, `premium`, or `trial`. Changing this can force a new resource to be created in some circumstances.
	Sku pulumi.StringInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Workspace resource.

func (WorkspaceArgs) ElementType 

func (WorkspaceArgs) ElementType() reflect.Type

type WorkspaceArray added in v3.47.1 

type WorkspaceArray []WorkspaceInput

func (WorkspaceArray) ElementType added in v3.47.1 

func (WorkspaceArray) ElementType() reflect.Type

func (WorkspaceArray) ToWorkspaceArrayOutput added in v3.47.1 

func (i WorkspaceArray) ToWorkspaceArrayOutput() WorkspaceArrayOutput

func (WorkspaceArray) ToWorkspaceArrayOutputWithContext added in v3.47.1 

func (i WorkspaceArray) ToWorkspaceArrayOutputWithContext(ctx context.Context) WorkspaceArrayOutput

type WorkspaceArrayInput added in v3.47.1 

type WorkspaceArrayInput interface {
	pulumi.Input

	ToWorkspaceArrayOutput() WorkspaceArrayOutput
	ToWorkspaceArrayOutputWithContext(context.Context) WorkspaceArrayOutput
}

WorkspaceArrayInput is an input type that accepts WorkspaceArray and WorkspaceArrayOutput values. You can construct a concrete instance of `WorkspaceArrayInput` via: 

WorkspaceArray{ WorkspaceArgs{...} }

type WorkspaceArrayOutput added in v3.47.1 

type WorkspaceArrayOutput struct{ *pulumi.OutputState }

func (WorkspaceArrayOutput) ElementType added in v3.47.1 

func (WorkspaceArrayOutput) ElementType() reflect.Type

func (WorkspaceArrayOutput) Index added in v3.47.1 

func (o WorkspaceArrayOutput) Index(i pulumi.IntInput) WorkspaceOutput

func (WorkspaceArrayOutput) ToWorkspaceArrayOutput added in v3.47.1 

func (o WorkspaceArrayOutput) ToWorkspaceArrayOutput() WorkspaceArrayOutput

func (WorkspaceArrayOutput) ToWorkspaceArrayOutputWithContext added in v3.47.1 

func (o WorkspaceArrayOutput) ToWorkspaceArrayOutputWithContext(ctx context.Context) WorkspaceArrayOutput

type WorkspaceCustomParameters 

type WorkspaceCustomParameters struct {
	// Are public IP Addresses not allowed?
	NoPublicIp *bool `pulumi:"noPublicIp"`
	// The name of the Private Subnet within the Virtual Network. Required if `virtualNetworkId` is set.
	PrivateSubnetName *string `pulumi:"privateSubnetName"`
	// The name of the Public Subnet within the Virtual Network. Required if `virtualNetworkId` is set.
	PublicSubnetName *string `pulumi:"publicSubnetName"`
	// The ID of a Virtual Network where this Databricks Cluster should be created.
	VirtualNetworkId *string `pulumi:"virtualNetworkId"`
}

type WorkspaceCustomParametersArgs 

type WorkspaceCustomParametersArgs struct {
	// Are public IP Addresses not allowed?
	NoPublicIp pulumi.BoolPtrInput `pulumi:"noPublicIp"`
	// The name of the Private Subnet within the Virtual Network. Required if `virtualNetworkId` is set.
	PrivateSubnetName pulumi.StringPtrInput `pulumi:"privateSubnetName"`
	// The name of the Public Subnet within the Virtual Network. Required if `virtualNetworkId` is set.
	PublicSubnetName pulumi.StringPtrInput `pulumi:"publicSubnetName"`
	// The ID of a Virtual Network where this Databricks Cluster should be created.
	VirtualNetworkId pulumi.StringPtrInput `pulumi:"virtualNetworkId"`
}

func (WorkspaceCustomParametersArgs) ElementType 

func (WorkspaceCustomParametersArgs) ElementType() reflect.Type

func (WorkspaceCustomParametersArgs) ToWorkspaceCustomParametersOutput 

func (i WorkspaceCustomParametersArgs) ToWorkspaceCustomParametersOutput() WorkspaceCustomParametersOutput

func (WorkspaceCustomParametersArgs) ToWorkspaceCustomParametersOutputWithContext 

func (i WorkspaceCustomParametersArgs) ToWorkspaceCustomParametersOutputWithContext(ctx context.Context) WorkspaceCustomParametersOutput

func (WorkspaceCustomParametersArgs) ToWorkspaceCustomParametersPtrOutput 

func (i WorkspaceCustomParametersArgs) ToWorkspaceCustomParametersPtrOutput() WorkspaceCustomParametersPtrOutput

func (WorkspaceCustomParametersArgs) ToWorkspaceCustomParametersPtrOutputWithContext 

func (i WorkspaceCustomParametersArgs) ToWorkspaceCustomParametersPtrOutputWithContext(ctx context.Context) WorkspaceCustomParametersPtrOutput

type WorkspaceCustomParametersInput 

type WorkspaceCustomParametersInput interface {
	pulumi.Input

	ToWorkspaceCustomParametersOutput() WorkspaceCustomParametersOutput
	ToWorkspaceCustomParametersOutputWithContext(context.Context) WorkspaceCustomParametersOutput
}

WorkspaceCustomParametersInput is an input type that accepts WorkspaceCustomParametersArgs and WorkspaceCustomParametersOutput values. You can construct a concrete instance of `WorkspaceCustomParametersInput` via: 

WorkspaceCustomParametersArgs{...}

type WorkspaceCustomParametersOutput 

type WorkspaceCustomParametersOutput struct{ *pulumi.OutputState }

func (WorkspaceCustomParametersOutput) ElementType 

func (WorkspaceCustomParametersOutput) ElementType() reflect.Type

func (WorkspaceCustomParametersOutput) NoPublicIp 

func (o WorkspaceCustomParametersOutput) NoPublicIp() pulumi.BoolPtrOutput

Are public IP Addresses not allowed?

func (WorkspaceCustomParametersOutput) PrivateSubnetName 

func (o WorkspaceCustomParametersOutput) PrivateSubnetName() pulumi.StringPtrOutput

The name of the Private Subnet within the Virtual Network. Required if `virtualNetworkId` is set.

func (WorkspaceCustomParametersOutput) PublicSubnetName 

func (o WorkspaceCustomParametersOutput) PublicSubnetName() pulumi.StringPtrOutput

The name of the Public Subnet within the Virtual Network. Required if `virtualNetworkId` is set.

func (WorkspaceCustomParametersOutput) ToWorkspaceCustomParametersOutput 

func (o WorkspaceCustomParametersOutput) ToWorkspaceCustomParametersOutput() WorkspaceCustomParametersOutput

func (WorkspaceCustomParametersOutput) ToWorkspaceCustomParametersOutputWithContext 

func (o WorkspaceCustomParametersOutput) ToWorkspaceCustomParametersOutputWithContext(ctx context.Context) WorkspaceCustomParametersOutput

func (WorkspaceCustomParametersOutput) ToWorkspaceCustomParametersPtrOutput 

func (o WorkspaceCustomParametersOutput) ToWorkspaceCustomParametersPtrOutput() WorkspaceCustomParametersPtrOutput

func (WorkspaceCustomParametersOutput) ToWorkspaceCustomParametersPtrOutputWithContext 

func (o WorkspaceCustomParametersOutput) ToWorkspaceCustomParametersPtrOutputWithContext(ctx context.Context) WorkspaceCustomParametersPtrOutput

func (WorkspaceCustomParametersOutput) VirtualNetworkId 

func (o WorkspaceCustomParametersOutput) VirtualNetworkId() pulumi.StringPtrOutput

The ID of a Virtual Network where this Databricks Cluster should be created.

type WorkspaceCustomParametersPtrInput 

type WorkspaceCustomParametersPtrInput interface {
	pulumi.Input

	ToWorkspaceCustomParametersPtrOutput() WorkspaceCustomParametersPtrOutput
	ToWorkspaceCustomParametersPtrOutputWithContext(context.Context) WorkspaceCustomParametersPtrOutput
}

WorkspaceCustomParametersPtrInput is an input type that accepts WorkspaceCustomParametersArgs, WorkspaceCustomParametersPtr and WorkspaceCustomParametersPtrOutput values. You can construct a concrete instance of `WorkspaceCustomParametersPtrInput` via: 

        WorkspaceCustomParametersArgs{...}

or:

        nil

func WorkspaceCustomParametersPtr 

func WorkspaceCustomParametersPtr(v *WorkspaceCustomParametersArgs) WorkspaceCustomParametersPtrInput

type WorkspaceCustomParametersPtrOutput 

type WorkspaceCustomParametersPtrOutput struct{ *pulumi.OutputState }

func (WorkspaceCustomParametersPtrOutput) Elem 

func (o WorkspaceCustomParametersPtrOutput) Elem() WorkspaceCustomParametersOutput

func (WorkspaceCustomParametersPtrOutput) ElementType 

func (WorkspaceCustomParametersPtrOutput) ElementType() reflect.Type

func (WorkspaceCustomParametersPtrOutput) NoPublicIp 

func (o WorkspaceCustomParametersPtrOutput) NoPublicIp() pulumi.BoolPtrOutput

Are public IP Addresses not allowed?

func (WorkspaceCustomParametersPtrOutput) PrivateSubnetName 

func (o WorkspaceCustomParametersPtrOutput) PrivateSubnetName() pulumi.StringPtrOutput

The name of the Private Subnet within the Virtual Network. Required if `virtualNetworkId` is set.

func (WorkspaceCustomParametersPtrOutput) PublicSubnetName 

func (o WorkspaceCustomParametersPtrOutput) PublicSubnetName() pulumi.StringPtrOutput

The name of the Public Subnet within the Virtual Network. Required if `virtualNetworkId` is set.

func (WorkspaceCustomParametersPtrOutput) ToWorkspaceCustomParametersPtrOutput 

func (o WorkspaceCustomParametersPtrOutput) ToWorkspaceCustomParametersPtrOutput() WorkspaceCustomParametersPtrOutput

func (WorkspaceCustomParametersPtrOutput) ToWorkspaceCustomParametersPtrOutputWithContext 

func (o WorkspaceCustomParametersPtrOutput) ToWorkspaceCustomParametersPtrOutputWithContext(ctx context.Context) WorkspaceCustomParametersPtrOutput

func (WorkspaceCustomParametersPtrOutput) VirtualNetworkId 

func (o WorkspaceCustomParametersPtrOutput) VirtualNetworkId() pulumi.StringPtrOutput

The ID of a Virtual Network where this Databricks Cluster should be created.

type WorkspaceInput added in v3.31.1 

type WorkspaceInput interface {
	pulumi.Input

	ToWorkspaceOutput() WorkspaceOutput
	ToWorkspaceOutputWithContext(ctx context.Context) WorkspaceOutput
}

type WorkspaceMap added in v3.47.1 

type WorkspaceMap map[string]WorkspaceInput

func (WorkspaceMap) ElementType added in v3.47.1 

func (WorkspaceMap) ElementType() reflect.Type

func (WorkspaceMap) ToWorkspaceMapOutput added in v3.47.1 

func (i WorkspaceMap) ToWorkspaceMapOutput() WorkspaceMapOutput

func (WorkspaceMap) ToWorkspaceMapOutputWithContext added in v3.47.1 

func (i WorkspaceMap) ToWorkspaceMapOutputWithContext(ctx context.Context) WorkspaceMapOutput

type WorkspaceMapInput added in v3.47.1 

type WorkspaceMapInput interface {
	pulumi.Input

	ToWorkspaceMapOutput() WorkspaceMapOutput
	ToWorkspaceMapOutputWithContext(context.Context) WorkspaceMapOutput
}

WorkspaceMapInput is an input type that accepts WorkspaceMap and WorkspaceMapOutput values. You can construct a concrete instance of `WorkspaceMapInput` via: 

WorkspaceMap{ "key": WorkspaceArgs{...} }

type WorkspaceMapOutput added in v3.47.1 

type WorkspaceMapOutput struct{ *pulumi.OutputState }

func (WorkspaceMapOutput) ElementType added in v3.47.1 

func (WorkspaceMapOutput) ElementType() reflect.Type

func (WorkspaceMapOutput) MapIndex added in v3.47.1 

func (o WorkspaceMapOutput) MapIndex(k pulumi.StringInput) WorkspaceOutput

func (WorkspaceMapOutput) ToWorkspaceMapOutput added in v3.47.1 

func (o WorkspaceMapOutput) ToWorkspaceMapOutput() WorkspaceMapOutput

func (WorkspaceMapOutput) ToWorkspaceMapOutputWithContext added in v3.47.1 

func (o WorkspaceMapOutput) ToWorkspaceMapOutputWithContext(ctx context.Context) WorkspaceMapOutput

type WorkspaceOutput added in v3.31.1 

type WorkspaceOutput struct {
	*pulumi.OutputState
}

func (WorkspaceOutput) ElementType added in v3.31.1 

func (WorkspaceOutput) ElementType() reflect.Type

func (WorkspaceOutput) ToWorkspaceOutput added in v3.31.1 

func (o WorkspaceOutput) ToWorkspaceOutput() WorkspaceOutput

func (WorkspaceOutput) ToWorkspaceOutputWithContext added in v3.31.1 

func (o WorkspaceOutput) ToWorkspaceOutputWithContext(ctx context.Context) WorkspaceOutput

func (WorkspaceOutput) ToWorkspacePtrOutput added in v3.47.1 

func (o WorkspaceOutput) ToWorkspacePtrOutput() WorkspacePtrOutput

func (WorkspaceOutput) ToWorkspacePtrOutputWithContext added in v3.47.1 

func (o WorkspaceOutput) ToWorkspacePtrOutputWithContext(ctx context.Context) WorkspacePtrOutput

type WorkspacePtrInput added in v3.47.1 

type WorkspacePtrInput interface {
	pulumi.Input

	ToWorkspacePtrOutput() WorkspacePtrOutput
	ToWorkspacePtrOutputWithContext(ctx context.Context) WorkspacePtrOutput
}

type WorkspacePtrOutput added in v3.47.1 

type WorkspacePtrOutput struct {
	*pulumi.OutputState
}

func (WorkspacePtrOutput) ElementType added in v3.47.1 

func (WorkspacePtrOutput) ElementType() reflect.Type

func (WorkspacePtrOutput) ToWorkspacePtrOutput added in v3.47.1 

func (o WorkspacePtrOutput) ToWorkspacePtrOutput() WorkspacePtrOutput

func (WorkspacePtrOutput) ToWorkspacePtrOutputWithContext added in v3.47.1 

func (o WorkspacePtrOutput) ToWorkspacePtrOutputWithContext(ctx context.Context) WorkspacePtrOutput

type WorkspaceState 

type WorkspaceState struct {
	// A `customParameters` block as documented below.
	CustomParameters WorkspaceCustomParametersPtrInput
	// Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// The ID of the Managed Resource Group created by the Databricks Workspace.
	ManagedResourceGroupId pulumi.StringPtrInput
	// The name of the resource group where Azure should place the managed Databricks resources. Changing this forces a new resource to be created.
	ManagedResourceGroupName pulumi.StringPtrInput
	// Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// The `sku` to use for the Databricks Workspace. Possible values are `standard`, `premium`, or `trial`. Changing this can force a new resource to be created in some circumstances.
	Sku pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
	// The unique identifier of the databricks workspace in Databricks control plane.
	WorkspaceId pulumi.StringPtrInput
	// The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'
	WorkspaceUrl pulumi.StringPtrInput
}

func (WorkspaceState) ElementType 

func (WorkspaceState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.