synapse

package
v3.15.0 Latest Latest
Warning

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

 Go to latest Published: Aug 10, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type LookupWorkspaceArgs 

type LookupWorkspaceArgs struct {
	// The name of this Synapse Workspace.
	Name string `pulumi:"name"`
	// The name of the Resource Group where the Synapse Workspace exists.
	ResourceGroupName string `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getWorkspace.

type LookupWorkspaceResult 

type LookupWorkspaceResult struct {
	// A list of Connectivity endpoints for this Synapse Workspace.
	ConnectivityEndpoints map[string]string `pulumi:"connectivityEndpoints"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The Azure location where the Synapse Workspace exists.
	Location          string `pulumi:"location"`
	Name              string `pulumi:"name"`
	ResourceGroupName string `pulumi:"resourceGroupName"`
	// A mapping of tags assigned to the resource.
	Tags map[string]string `pulumi:"tags"`
}

A collection of values returned by getWorkspace.

func LookupWorkspace 

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

Use this data source to access information about an existing Synapse Workspace.

## Example Usage

```go package main

import ( 

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

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := synapse.LookupWorkspace(ctx, &synapse.LookupWorkspaceArgs{
			Name:              "existing",
			ResourceGroupName: "example-resource-group",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		return nil
	})
}

```

type Workspace 

type Workspace struct {
	pulumi.CustomResourceState

	// An `aadAdmin` block as defined below.
	AadAdmin WorkspaceAadAdminOutput `pulumi:"aadAdmin"`
	// A list of Connectivity endpoints for this Synapse Workspace.
	ConnectivityEndpoints pulumi.StringMapOutput `pulumi:"connectivityEndpoints"`
	// An `identity` block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
	Identities WorkspaceIdentityArrayOutput `pulumi:"identities"`
	// Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// Workspace managed resource group.
	ManagedResourceGroupName pulumi.StringOutput `pulumi:"managedResourceGroupName"`
	// Is Virtual Network enabled for all computes in this workspace. Changing this forces a new resource to be created.
	ManagedVirtualNetworkEnabled pulumi.BoolPtrOutput `pulumi:"managedVirtualNetworkEnabled"`
	// Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// Specifies The Login Name of the SQL administrator. Changing this forces a new resource to be created.
	SqlAdministratorLogin pulumi.StringOutput `pulumi:"sqlAdministratorLogin"`
	// The Password associated with the `sqlAdministratorLogin` for the SQL administrator.
	SqlAdministratorLoginPassword pulumi.StringOutput `pulumi:"sqlAdministratorLoginPassword"`
	// Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.
	StorageDataLakeGen2FilesystemId pulumi.StringOutput `pulumi:"storageDataLakeGen2FilesystemId"`
	// A mapping of tags which should be assigned to the Synapse Workspace.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Manages a Synapse 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/storage"
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/synapse"
"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
		}
		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
			AccountKind:            pulumi.String("StorageV2"),
			IsHnsEnabled:           pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "exampleDataLakeGen2Filesystem", &storage.DataLakeGen2FilesystemArgs{
			StorageAccountId: exampleAccount.ID(),
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewWorkspace(ctx, "exampleWorkspace", &synapse.WorkspaceArgs{
			ResourceGroupName:               exampleResourceGroup.Name,
			Location:                        exampleResourceGroup.Location,
			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
			AadAdmin: &synapse.WorkspaceAadAdminArgs{
				Login:    pulumi.String("AzureAD Admin"),
				ObjectId: pulumi.String("00000000-0000-0000-0000-000000000000"),
				TenantId: pulumi.String("00000000-0000-0000-0000-000000000000"),
			},
			Tags: pulumi.StringMap{
				"Env": pulumi.String("production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

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.

type WorkspaceAadAdmin 

type WorkspaceAadAdmin struct {
	// The login name of the Azure AD Administrator of this Synapse Workspace.
	Login string `pulumi:"login"`
	// The object id of the Azure AD Administrator of this Synapse Workspace.
	ObjectId string `pulumi:"objectId"`
	// The tenant id of the Azure AD Administrator of this Synapse Workspace.
	TenantId string `pulumi:"tenantId"`
}

type WorkspaceAadAdminArgs 

type WorkspaceAadAdminArgs struct {
	// The login name of the Azure AD Administrator of this Synapse Workspace.
	Login pulumi.StringInput `pulumi:"login"`
	// The object id of the Azure AD Administrator of this Synapse Workspace.
	ObjectId pulumi.StringInput `pulumi:"objectId"`
	// The tenant id of the Azure AD Administrator of this Synapse Workspace.
	TenantId pulumi.StringInput `pulumi:"tenantId"`
}

func (WorkspaceAadAdminArgs) ElementType 

func (WorkspaceAadAdminArgs) ElementType() reflect.Type

func (WorkspaceAadAdminArgs) ToWorkspaceAadAdminOutput 

func (i WorkspaceAadAdminArgs) ToWorkspaceAadAdminOutput() WorkspaceAadAdminOutput

func (WorkspaceAadAdminArgs) ToWorkspaceAadAdminOutputWithContext 

func (i WorkspaceAadAdminArgs) ToWorkspaceAadAdminOutputWithContext(ctx context.Context) WorkspaceAadAdminOutput

func (WorkspaceAadAdminArgs) ToWorkspaceAadAdminPtrOutput 

func (i WorkspaceAadAdminArgs) ToWorkspaceAadAdminPtrOutput() WorkspaceAadAdminPtrOutput

func (WorkspaceAadAdminArgs) ToWorkspaceAadAdminPtrOutputWithContext 

func (i WorkspaceAadAdminArgs) ToWorkspaceAadAdminPtrOutputWithContext(ctx context.Context) WorkspaceAadAdminPtrOutput

type WorkspaceAadAdminInput 

type WorkspaceAadAdminInput interface {
	pulumi.Input

	ToWorkspaceAadAdminOutput() WorkspaceAadAdminOutput
	ToWorkspaceAadAdminOutputWithContext(context.Context) WorkspaceAadAdminOutput
}

WorkspaceAadAdminInput is an input type that accepts WorkspaceAadAdminArgs and WorkspaceAadAdminOutput values. You can construct a concrete instance of `WorkspaceAadAdminInput` via: 

WorkspaceAadAdminArgs{...}

type WorkspaceAadAdminOutput 

type WorkspaceAadAdminOutput struct{ *pulumi.OutputState }

func (WorkspaceAadAdminOutput) ElementType 

func (WorkspaceAadAdminOutput) ElementType() reflect.Type

func (WorkspaceAadAdminOutput) Login 

func (o WorkspaceAadAdminOutput) Login() pulumi.StringOutput

The login name of the Azure AD Administrator of this Synapse Workspace.

func (WorkspaceAadAdminOutput) ObjectId 

func (o WorkspaceAadAdminOutput) ObjectId() pulumi.StringOutput

The object id of the Azure AD Administrator of this Synapse Workspace.

func (WorkspaceAadAdminOutput) TenantId 

func (o WorkspaceAadAdminOutput) TenantId() pulumi.StringOutput

The tenant id of the Azure AD Administrator of this Synapse Workspace.

func (WorkspaceAadAdminOutput) ToWorkspaceAadAdminOutput 

func (o WorkspaceAadAdminOutput) ToWorkspaceAadAdminOutput() WorkspaceAadAdminOutput

func (WorkspaceAadAdminOutput) ToWorkspaceAadAdminOutputWithContext 

func (o WorkspaceAadAdminOutput) ToWorkspaceAadAdminOutputWithContext(ctx context.Context) WorkspaceAadAdminOutput

func (WorkspaceAadAdminOutput) ToWorkspaceAadAdminPtrOutput 

func (o WorkspaceAadAdminOutput) ToWorkspaceAadAdminPtrOutput() WorkspaceAadAdminPtrOutput

func (WorkspaceAadAdminOutput) ToWorkspaceAadAdminPtrOutputWithContext 

func (o WorkspaceAadAdminOutput) ToWorkspaceAadAdminPtrOutputWithContext(ctx context.Context) WorkspaceAadAdminPtrOutput

type WorkspaceAadAdminPtrInput 

type WorkspaceAadAdminPtrInput interface {
	pulumi.Input

	ToWorkspaceAadAdminPtrOutput() WorkspaceAadAdminPtrOutput
	ToWorkspaceAadAdminPtrOutputWithContext(context.Context) WorkspaceAadAdminPtrOutput
}

WorkspaceAadAdminPtrInput is an input type that accepts WorkspaceAadAdminArgs, WorkspaceAadAdminPtr and WorkspaceAadAdminPtrOutput values. You can construct a concrete instance of `WorkspaceAadAdminPtrInput` via: 

        WorkspaceAadAdminArgs{...}

or:

        nil

func WorkspaceAadAdminPtr 

func WorkspaceAadAdminPtr(v *WorkspaceAadAdminArgs) WorkspaceAadAdminPtrInput

type WorkspaceAadAdminPtrOutput 

type WorkspaceAadAdminPtrOutput struct{ *pulumi.OutputState }

func (WorkspaceAadAdminPtrOutput) Elem 

func (o WorkspaceAadAdminPtrOutput) Elem() WorkspaceAadAdminOutput

func (WorkspaceAadAdminPtrOutput) ElementType 

func (WorkspaceAadAdminPtrOutput) ElementType() reflect.Type

func (WorkspaceAadAdminPtrOutput) Login 

func (o WorkspaceAadAdminPtrOutput) Login() pulumi.StringPtrOutput

The login name of the Azure AD Administrator of this Synapse Workspace.

func (WorkspaceAadAdminPtrOutput) ObjectId 

func (o WorkspaceAadAdminPtrOutput) ObjectId() pulumi.StringPtrOutput

The object id of the Azure AD Administrator of this Synapse Workspace.

func (WorkspaceAadAdminPtrOutput) TenantId 

func (o WorkspaceAadAdminPtrOutput) TenantId() pulumi.StringPtrOutput

The tenant id of the Azure AD Administrator of this Synapse Workspace.

func (WorkspaceAadAdminPtrOutput) ToWorkspaceAadAdminPtrOutput 

func (o WorkspaceAadAdminPtrOutput) ToWorkspaceAadAdminPtrOutput() WorkspaceAadAdminPtrOutput

func (WorkspaceAadAdminPtrOutput) ToWorkspaceAadAdminPtrOutputWithContext 

func (o WorkspaceAadAdminPtrOutput) ToWorkspaceAadAdminPtrOutputWithContext(ctx context.Context) WorkspaceAadAdminPtrOutput

type WorkspaceArgs 

type WorkspaceArgs struct {
	// An `aadAdmin` block as defined below.
	AadAdmin WorkspaceAadAdminPtrInput
	// Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// Is Virtual Network enabled for all computes in this workspace. Changing this forces a new resource to be created.
	ManagedVirtualNetworkEnabled pulumi.BoolPtrInput
	// Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// Specifies The Login Name of the SQL administrator. Changing this forces a new resource to be created.
	SqlAdministratorLogin pulumi.StringInput
	// The Password associated with the `sqlAdministratorLogin` for the SQL administrator.
	SqlAdministratorLoginPassword pulumi.StringInput
	// Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.
	StorageDataLakeGen2FilesystemId pulumi.StringInput
	// A mapping of tags which should be assigned to the Synapse Workspace.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Workspace resource.

func (WorkspaceArgs) ElementType 

func (WorkspaceArgs) ElementType() reflect.Type

type WorkspaceIdentity 

type WorkspaceIdentity struct {
	// The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
	PrincipalId *string `pulumi:"principalId"`
	// The tenant id of the Azure AD Administrator of this Synapse Workspace.
	TenantId *string `pulumi:"tenantId"`
	// The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
	Type *string `pulumi:"type"`
}

type WorkspaceIdentityArgs 

type WorkspaceIdentityArgs struct {
	// The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
	PrincipalId pulumi.StringPtrInput `pulumi:"principalId"`
	// The tenant id of the Azure AD Administrator of this Synapse Workspace.
	TenantId pulumi.StringPtrInput `pulumi:"tenantId"`
	// The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.
	Type pulumi.StringPtrInput `pulumi:"type"`
}

func (WorkspaceIdentityArgs) ElementType 

func (WorkspaceIdentityArgs) ElementType() reflect.Type

func (WorkspaceIdentityArgs) ToWorkspaceIdentityOutput 

func (i WorkspaceIdentityArgs) ToWorkspaceIdentityOutput() WorkspaceIdentityOutput

func (WorkspaceIdentityArgs) ToWorkspaceIdentityOutputWithContext 

func (i WorkspaceIdentityArgs) ToWorkspaceIdentityOutputWithContext(ctx context.Context) WorkspaceIdentityOutput

type WorkspaceIdentityArray 

type WorkspaceIdentityArray []WorkspaceIdentityInput

func (WorkspaceIdentityArray) ElementType 

func (WorkspaceIdentityArray) ElementType() reflect.Type

func (WorkspaceIdentityArray) ToWorkspaceIdentityArrayOutput 

func (i WorkspaceIdentityArray) ToWorkspaceIdentityArrayOutput() WorkspaceIdentityArrayOutput

func (WorkspaceIdentityArray) ToWorkspaceIdentityArrayOutputWithContext 

func (i WorkspaceIdentityArray) ToWorkspaceIdentityArrayOutputWithContext(ctx context.Context) WorkspaceIdentityArrayOutput

type WorkspaceIdentityArrayInput 

type WorkspaceIdentityArrayInput interface {
	pulumi.Input

	ToWorkspaceIdentityArrayOutput() WorkspaceIdentityArrayOutput
	ToWorkspaceIdentityArrayOutputWithContext(context.Context) WorkspaceIdentityArrayOutput
}

WorkspaceIdentityArrayInput is an input type that accepts WorkspaceIdentityArray and WorkspaceIdentityArrayOutput values. You can construct a concrete instance of `WorkspaceIdentityArrayInput` via: 

WorkspaceIdentityArray{ WorkspaceIdentityArgs{...} }

type WorkspaceIdentityArrayOutput 

type WorkspaceIdentityArrayOutput struct{ *pulumi.OutputState }

func (WorkspaceIdentityArrayOutput) ElementType 

func (WorkspaceIdentityArrayOutput) ElementType() reflect.Type

func (WorkspaceIdentityArrayOutput) Index 

func (o WorkspaceIdentityArrayOutput) Index(i pulumi.IntInput) WorkspaceIdentityOutput

func (WorkspaceIdentityArrayOutput) ToWorkspaceIdentityArrayOutput 

func (o WorkspaceIdentityArrayOutput) ToWorkspaceIdentityArrayOutput() WorkspaceIdentityArrayOutput

func (WorkspaceIdentityArrayOutput) ToWorkspaceIdentityArrayOutputWithContext 

func (o WorkspaceIdentityArrayOutput) ToWorkspaceIdentityArrayOutputWithContext(ctx context.Context) WorkspaceIdentityArrayOutput

type WorkspaceIdentityInput 

type WorkspaceIdentityInput interface {
	pulumi.Input

	ToWorkspaceIdentityOutput() WorkspaceIdentityOutput
	ToWorkspaceIdentityOutputWithContext(context.Context) WorkspaceIdentityOutput
}

WorkspaceIdentityInput is an input type that accepts WorkspaceIdentityArgs and WorkspaceIdentityOutput values. You can construct a concrete instance of `WorkspaceIdentityInput` via: 

WorkspaceIdentityArgs{...}

type WorkspaceIdentityOutput 

type WorkspaceIdentityOutput struct{ *pulumi.OutputState }

func (WorkspaceIdentityOutput) ElementType 

func (WorkspaceIdentityOutput) ElementType() reflect.Type

func (WorkspaceIdentityOutput) PrincipalId 

func (o WorkspaceIdentityOutput) PrincipalId() pulumi.StringPtrOutput

The Principal ID for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

func (WorkspaceIdentityOutput) TenantId 

func (o WorkspaceIdentityOutput) TenantId() pulumi.StringPtrOutput

The tenant id of the Azure AD Administrator of this Synapse Workspace.

func (WorkspaceIdentityOutput) ToWorkspaceIdentityOutput 

func (o WorkspaceIdentityOutput) ToWorkspaceIdentityOutput() WorkspaceIdentityOutput

func (WorkspaceIdentityOutput) ToWorkspaceIdentityOutputWithContext 

func (o WorkspaceIdentityOutput) ToWorkspaceIdentityOutputWithContext(ctx context.Context) WorkspaceIdentityOutput

func (WorkspaceIdentityOutput) Type 

func (o WorkspaceIdentityOutput) Type() pulumi.StringPtrOutput

The Identity Type for the Service Principal associated with the Managed Service Identity of this Synapse Workspace.

type WorkspaceState 

type WorkspaceState struct {
	// An `aadAdmin` block as defined below.
	AadAdmin WorkspaceAadAdminPtrInput
	// A list of Connectivity endpoints for this Synapse Workspace.
	ConnectivityEndpoints pulumi.StringMapInput
	// An `identity` block as defined below, which contains the Managed Service Identity information for this Synapse Workspace.
	Identities WorkspaceIdentityArrayInput
	// Specifies the Azure Region where the synapse Workspace should exist. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// Workspace managed resource group.
	ManagedResourceGroupName pulumi.StringPtrInput
	// Is Virtual Network enabled for all computes in this workspace. Changing this forces a new resource to be created.
	ManagedVirtualNetworkEnabled pulumi.BoolPtrInput
	// Specifies the name which should be used for this synapse Workspace. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// Specifies the name of the Resource Group where the synapse Workspace should exist. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// Specifies The Login Name of the SQL administrator. Changing this forces a new resource to be created.
	SqlAdministratorLogin pulumi.StringPtrInput
	// The Password associated with the `sqlAdministratorLogin` for the SQL administrator.
	SqlAdministratorLoginPassword pulumi.StringPtrInput
	// Specifies the ID of storage data lake gen2 filesystem resource. Changing this forces a new resource to be created.
	StorageDataLakeGen2FilesystemId pulumi.StringPtrInput
	// A mapping of tags which should be assigned to the Synapse Workspace.
	Tags pulumi.StringMapInput
}

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.