purview

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 Account 

type Account struct {
	pulumi.CustomResourceState

	// Atlas Kafka endpoint primary connection string.
	AtlasKafkaEndpointPrimaryConnectionString pulumi.StringOutput `pulumi:"atlasKafkaEndpointPrimaryConnectionString"`
	// Atlas Kafka endpoint secondary connection string.
	AtlasKafkaEndpointSecondaryConnectionString pulumi.StringOutput `pulumi:"atlasKafkaEndpointSecondaryConnectionString"`
	// Catalog endpoint.
	CatalogEndpoint pulumi.StringOutput `pulumi:"catalogEndpoint"`
	// Guardian endpoint.
	GuardianEndpoint pulumi.StringOutput `pulumi:"guardianEndpoint"`
	// A `identity` block as defined below.
	Identities AccountIdentityArrayOutput `pulumi:"identities"`
	// The Azure Region where the Purview Account should exist. Changing this forces a new Purview Account to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// The name which should be used for this Purview Account. Changing this forces a new Purview Account to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// Should the Purview Account be visible to the public network? Defaults to `true`.
	PublicNetworkEnabled pulumi.BoolPtrOutput `pulumi:"publicNetworkEnabled"`
	// The name of the Resource Group where the Purview Account should exist. Changing this forces a new Purview Account to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// Scan endpoint.
	ScanEndpoint pulumi.StringOutput `pulumi:"scanEndpoint"`
	// The SKU's capacity for platform size and catalog capabilities. Accepted values are `Standard_4` and `Standard_16`.
	SkuName pulumi.StringOutput `pulumi:"skuName"`
	// A mapping of tags which should be assigned to the Purview Account.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Manages a Purview Account.

## 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/purview"
"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 = purview.NewAccount(ctx, "exampleAccount", &purview.AccountArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			SkuName:           pulumi.String("Standard_4"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Purview Accounts can be imported using the `resource id`, e.g.

```sh 

$ pulumi import azure:purview/account:Account example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Purview/accounts/account1

```

func GetAccount 

func GetAccount(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AccountState, opts ...pulumi.ResourceOption) (*Account, error)

GetAccount gets an existing Account 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 NewAccount 

func NewAccount(ctx *pulumi.Context,
	name string, args *AccountArgs, opts ...pulumi.ResourceOption) (*Account, error)

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

func (*Account) ElementType 

func (*Account) ElementType() reflect.Type

func (*Account) ToAccountOutput 

func (i *Account) ToAccountOutput() AccountOutput

func (*Account) ToAccountOutputWithContext 

func (i *Account) ToAccountOutputWithContext(ctx context.Context) AccountOutput

func (*Account) ToAccountPtrOutput 

func (i *Account) ToAccountPtrOutput() AccountPtrOutput

func (*Account) ToAccountPtrOutputWithContext 

func (i *Account) ToAccountPtrOutputWithContext(ctx context.Context) AccountPtrOutput

type AccountArgs 

type AccountArgs struct {
	// The Azure Region where the Purview Account should exist. Changing this forces a new Purview Account to be created.
	Location pulumi.StringPtrInput
	// The name which should be used for this Purview Account. Changing this forces a new Purview Account to be created.
	Name pulumi.StringPtrInput
	// Should the Purview Account be visible to the public network? Defaults to `true`.
	PublicNetworkEnabled pulumi.BoolPtrInput
	// The name of the Resource Group where the Purview Account should exist. Changing this forces a new Purview Account to be created.
	ResourceGroupName pulumi.StringInput
	// The SKU's capacity for platform size and catalog capabilities. Accepted values are `Standard_4` and `Standard_16`.
	SkuName pulumi.StringInput
	// A mapping of tags which should be assigned to the Purview Account.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Account resource.

func (AccountArgs) ElementType 

func (AccountArgs) ElementType() reflect.Type

type AccountArray 

type AccountArray []AccountInput

func (AccountArray) ElementType 

func (AccountArray) ElementType() reflect.Type

func (AccountArray) ToAccountArrayOutput 

func (i AccountArray) ToAccountArrayOutput() AccountArrayOutput

func (AccountArray) ToAccountArrayOutputWithContext 

func (i AccountArray) ToAccountArrayOutputWithContext(ctx context.Context) AccountArrayOutput

type AccountArrayInput 

type AccountArrayInput interface {
	pulumi.Input

	ToAccountArrayOutput() AccountArrayOutput
	ToAccountArrayOutputWithContext(context.Context) AccountArrayOutput
}

AccountArrayInput is an input type that accepts AccountArray and AccountArrayOutput values. You can construct a concrete instance of `AccountArrayInput` via: 

AccountArray{ AccountArgs{...} }

type AccountArrayOutput 

type AccountArrayOutput struct{ *pulumi.OutputState }

func (AccountArrayOutput) ElementType 

func (AccountArrayOutput) ElementType() reflect.Type

func (AccountArrayOutput) Index 

func (o AccountArrayOutput) Index(i pulumi.IntInput) AccountOutput

func (AccountArrayOutput) ToAccountArrayOutput 

func (o AccountArrayOutput) ToAccountArrayOutput() AccountArrayOutput

func (AccountArrayOutput) ToAccountArrayOutputWithContext 

func (o AccountArrayOutput) ToAccountArrayOutputWithContext(ctx context.Context) AccountArrayOutput

type AccountIdentity 

type AccountIdentity struct {
	// The ID of the Principal (Client) in Azure Active Directory.
	PrincipalId *string `pulumi:"principalId"`
	// The ID of the Azure Active Directory Tenant.
	TenantId *string `pulumi:"tenantId"`
	// The type of Managed Identity assigned to this Purview Account.
	Type *string `pulumi:"type"`
}

type AccountIdentityArgs 

type AccountIdentityArgs struct {
	// The ID of the Principal (Client) in Azure Active Directory.
	PrincipalId pulumi.StringPtrInput `pulumi:"principalId"`
	// The ID of the Azure Active Directory Tenant.
	TenantId pulumi.StringPtrInput `pulumi:"tenantId"`
	// The type of Managed Identity assigned to this Purview Account.
	Type pulumi.StringPtrInput `pulumi:"type"`
}

func (AccountIdentityArgs) ElementType 

func (AccountIdentityArgs) ElementType() reflect.Type

func (AccountIdentityArgs) ToAccountIdentityOutput 

func (i AccountIdentityArgs) ToAccountIdentityOutput() AccountIdentityOutput

func (AccountIdentityArgs) ToAccountIdentityOutputWithContext 

func (i AccountIdentityArgs) ToAccountIdentityOutputWithContext(ctx context.Context) AccountIdentityOutput

type AccountIdentityArray 

type AccountIdentityArray []AccountIdentityInput

func (AccountIdentityArray) ElementType 

func (AccountIdentityArray) ElementType() reflect.Type

func (AccountIdentityArray) ToAccountIdentityArrayOutput 

func (i AccountIdentityArray) ToAccountIdentityArrayOutput() AccountIdentityArrayOutput

func (AccountIdentityArray) ToAccountIdentityArrayOutputWithContext 

func (i AccountIdentityArray) ToAccountIdentityArrayOutputWithContext(ctx context.Context) AccountIdentityArrayOutput

type AccountIdentityArrayInput 

type AccountIdentityArrayInput interface {
	pulumi.Input

	ToAccountIdentityArrayOutput() AccountIdentityArrayOutput
	ToAccountIdentityArrayOutputWithContext(context.Context) AccountIdentityArrayOutput
}

AccountIdentityArrayInput is an input type that accepts AccountIdentityArray and AccountIdentityArrayOutput values. You can construct a concrete instance of `AccountIdentityArrayInput` via: 

AccountIdentityArray{ AccountIdentityArgs{...} }

type AccountIdentityArrayOutput 

type AccountIdentityArrayOutput struct{ *pulumi.OutputState }

func (AccountIdentityArrayOutput) ElementType 

func (AccountIdentityArrayOutput) ElementType() reflect.Type

func (AccountIdentityArrayOutput) Index 

func (o AccountIdentityArrayOutput) Index(i pulumi.IntInput) AccountIdentityOutput

func (AccountIdentityArrayOutput) ToAccountIdentityArrayOutput 

func (o AccountIdentityArrayOutput) ToAccountIdentityArrayOutput() AccountIdentityArrayOutput

func (AccountIdentityArrayOutput) ToAccountIdentityArrayOutputWithContext 

func (o AccountIdentityArrayOutput) ToAccountIdentityArrayOutputWithContext(ctx context.Context) AccountIdentityArrayOutput

type AccountIdentityInput 

type AccountIdentityInput interface {
	pulumi.Input

	ToAccountIdentityOutput() AccountIdentityOutput
	ToAccountIdentityOutputWithContext(context.Context) AccountIdentityOutput
}

AccountIdentityInput is an input type that accepts AccountIdentityArgs and AccountIdentityOutput values. You can construct a concrete instance of `AccountIdentityInput` via: 

AccountIdentityArgs{...}

type AccountIdentityOutput 

type AccountIdentityOutput struct{ *pulumi.OutputState }

func (AccountIdentityOutput) ElementType 

func (AccountIdentityOutput) ElementType() reflect.Type

func (AccountIdentityOutput) PrincipalId 

func (o AccountIdentityOutput) PrincipalId() pulumi.StringPtrOutput

The ID of the Principal (Client) in Azure Active Directory.

func (AccountIdentityOutput) TenantId 

func (o AccountIdentityOutput) TenantId() pulumi.StringPtrOutput

The ID of the Azure Active Directory Tenant.

func (AccountIdentityOutput) ToAccountIdentityOutput 

func (o AccountIdentityOutput) ToAccountIdentityOutput() AccountIdentityOutput

func (AccountIdentityOutput) ToAccountIdentityOutputWithContext 

func (o AccountIdentityOutput) ToAccountIdentityOutputWithContext(ctx context.Context) AccountIdentityOutput

func (AccountIdentityOutput) Type 

func (o AccountIdentityOutput) Type() pulumi.StringPtrOutput

The type of Managed Identity assigned to this Purview Account.

type AccountInput 

type AccountInput interface {
	pulumi.Input

	ToAccountOutput() AccountOutput
	ToAccountOutputWithContext(ctx context.Context) AccountOutput
}

type AccountMap 

type AccountMap map[string]AccountInput

func (AccountMap) ElementType 

func (AccountMap) ElementType() reflect.Type

func (AccountMap) ToAccountMapOutput 

func (i AccountMap) ToAccountMapOutput() AccountMapOutput

func (AccountMap) ToAccountMapOutputWithContext 

func (i AccountMap) ToAccountMapOutputWithContext(ctx context.Context) AccountMapOutput

type AccountMapInput 

type AccountMapInput interface {
	pulumi.Input

	ToAccountMapOutput() AccountMapOutput
	ToAccountMapOutputWithContext(context.Context) AccountMapOutput
}

AccountMapInput is an input type that accepts AccountMap and AccountMapOutput values. You can construct a concrete instance of `AccountMapInput` via: 

AccountMap{ "key": AccountArgs{...} }

type AccountMapOutput 

type AccountMapOutput struct{ *pulumi.OutputState }

func (AccountMapOutput) ElementType 

func (AccountMapOutput) ElementType() reflect.Type

func (AccountMapOutput) MapIndex 

func (o AccountMapOutput) MapIndex(k pulumi.StringInput) AccountOutput

func (AccountMapOutput) ToAccountMapOutput 

func (o AccountMapOutput) ToAccountMapOutput() AccountMapOutput

func (AccountMapOutput) ToAccountMapOutputWithContext 

func (o AccountMapOutput) ToAccountMapOutputWithContext(ctx context.Context) AccountMapOutput

type AccountOutput 

type AccountOutput struct {
	*pulumi.OutputState
}

func (AccountOutput) ElementType 

func (AccountOutput) ElementType() reflect.Type

func (AccountOutput) ToAccountOutput 

func (o AccountOutput) ToAccountOutput() AccountOutput

func (AccountOutput) ToAccountOutputWithContext 

func (o AccountOutput) ToAccountOutputWithContext(ctx context.Context) AccountOutput

func (AccountOutput) ToAccountPtrOutput 

func (o AccountOutput) ToAccountPtrOutput() AccountPtrOutput

func (AccountOutput) ToAccountPtrOutputWithContext 

func (o AccountOutput) ToAccountPtrOutputWithContext(ctx context.Context) AccountPtrOutput

type AccountPtrInput 

type AccountPtrInput interface {
	pulumi.Input

	ToAccountPtrOutput() AccountPtrOutput
	ToAccountPtrOutputWithContext(ctx context.Context) AccountPtrOutput
}

type AccountPtrOutput 

type AccountPtrOutput struct {
	*pulumi.OutputState
}

func (AccountPtrOutput) ElementType 

func (AccountPtrOutput) ElementType() reflect.Type

func (AccountPtrOutput) ToAccountPtrOutput 

func (o AccountPtrOutput) ToAccountPtrOutput() AccountPtrOutput

func (AccountPtrOutput) ToAccountPtrOutputWithContext 

func (o AccountPtrOutput) ToAccountPtrOutputWithContext(ctx context.Context) AccountPtrOutput

type AccountState 

type AccountState struct {
	// Atlas Kafka endpoint primary connection string.
	AtlasKafkaEndpointPrimaryConnectionString pulumi.StringPtrInput
	// Atlas Kafka endpoint secondary connection string.
	AtlasKafkaEndpointSecondaryConnectionString pulumi.StringPtrInput
	// Catalog endpoint.
	CatalogEndpoint pulumi.StringPtrInput
	// Guardian endpoint.
	GuardianEndpoint pulumi.StringPtrInput
	// A `identity` block as defined below.
	Identities AccountIdentityArrayInput
	// The Azure Region where the Purview Account should exist. Changing this forces a new Purview Account to be created.
	Location pulumi.StringPtrInput
	// The name which should be used for this Purview Account. Changing this forces a new Purview Account to be created.
	Name pulumi.StringPtrInput
	// Should the Purview Account be visible to the public network? Defaults to `true`.
	PublicNetworkEnabled pulumi.BoolPtrInput
	// The name of the Resource Group where the Purview Account should exist. Changing this forces a new Purview Account to be created.
	ResourceGroupName pulumi.StringPtrInput
	// Scan endpoint.
	ScanEndpoint pulumi.StringPtrInput
	// The SKU's capacity for platform size and catalog capabilities. Accepted values are `Standard_4` and `Standard_16`.
	SkuName pulumi.StringPtrInput
	// A mapping of tags which should be assigned to the Purview Account.
	Tags pulumi.StringMapInput
}

func (AccountState) ElementType 

func (AccountState) 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.