purview

package
v5.77.1 Latest Latest
Warning

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

Go to latest
Published: May 13, 2024 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"`
	// An `identity` block as defined below.
	Identity AccountIdentityOutput `pulumi:"identity"`
	// 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 the new Resource Group where Purview Account creates the managed resources. Changing this forces a new Purview Account to be created.
	//
	// > **Note:** `managedResourceGroupName` must be a new Resource Group
	ManagedResourceGroupName pulumi.StringOutput `pulumi:"managedResourceGroupName"`
	// A `managedResources` block as defined below.
	ManagedResources AccountManagedResourceArrayOutput `pulumi:"managedResources"`
	// 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"`
	// 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/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/purview"
"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
		}
		_, err = purview.NewAccount(ctx, "example", &purview.AccountArgs{
			Name:              pulumi.String("example"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			Identity: &purview.AccountIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		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

type AccountArgs

type AccountArgs struct {
	// An `identity` block as defined below.
	Identity AccountIdentityInput
	// 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 the new Resource Group where Purview Account creates the managed resources. Changing this forces a new Purview Account to be created.
	//
	// > **Note:** `managedResourceGroupName` must be a new Resource Group
	ManagedResourceGroupName 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
	// 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 (AccountArrayOutput) ToAccountArrayOutput

func (o AccountArrayOutput) ToAccountArrayOutput() AccountArrayOutput

func (AccountArrayOutput) ToAccountArrayOutputWithContext

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

type AccountIdentity

type AccountIdentity struct {
	// Specifies a list of User Assigned Managed Identity IDs to be assigned to this Purview Account.
	//
	// > **NOTE:** This is required when `type` is set to `UserAssigned`.
	IdentityIds []string `pulumi:"identityIds"`
	// The Principal ID associated with this Managed Service Identity.
	PrincipalId *string `pulumi:"principalId"`
	// The Tenant ID associated with this Managed Service Identity.
	TenantId *string `pulumi:"tenantId"`
	// Specifies the type of Managed Service Identity that should be configured on this Purview Account. Possible values are `UserAssigned` and `SystemAssigned`.
	Type string `pulumi:"type"`
}

type AccountIdentityArgs

type AccountIdentityArgs struct {
	// Specifies a list of User Assigned Managed Identity IDs to be assigned to this Purview Account.
	//
	// > **NOTE:** This is required when `type` is set to `UserAssigned`.
	IdentityIds pulumi.StringArrayInput `pulumi:"identityIds"`
	// The Principal ID associated with this Managed Service Identity.
	PrincipalId pulumi.StringPtrInput `pulumi:"principalId"`
	// The Tenant ID associated with this Managed Service Identity.
	TenantId pulumi.StringPtrInput `pulumi:"tenantId"`
	// Specifies the type of Managed Service Identity that should be configured on this Purview Account. Possible values are `UserAssigned` and `SystemAssigned`.
	Type pulumi.StringInput `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

func (AccountIdentityArgs) ToAccountIdentityPtrOutput

func (i AccountIdentityArgs) ToAccountIdentityPtrOutput() AccountIdentityPtrOutput

func (AccountIdentityArgs) ToAccountIdentityPtrOutputWithContext

func (i AccountIdentityArgs) ToAccountIdentityPtrOutputWithContext(ctx context.Context) AccountIdentityPtrOutput

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) IdentityIds added in v5.12.0

Specifies a list of User Assigned Managed Identity IDs to be assigned to this Purview Account.

> **NOTE:** This is required when `type` is set to `UserAssigned`.

func (AccountIdentityOutput) PrincipalId

The Principal ID associated with this Managed Service Identity.

func (AccountIdentityOutput) TenantId

The Tenant ID associated with this Managed Service Identity.

func (AccountIdentityOutput) ToAccountIdentityOutput

func (o AccountIdentityOutput) ToAccountIdentityOutput() AccountIdentityOutput

func (AccountIdentityOutput) ToAccountIdentityOutputWithContext

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

func (AccountIdentityOutput) ToAccountIdentityPtrOutput

func (o AccountIdentityOutput) ToAccountIdentityPtrOutput() AccountIdentityPtrOutput

func (AccountIdentityOutput) ToAccountIdentityPtrOutputWithContext

func (o AccountIdentityOutput) ToAccountIdentityPtrOutputWithContext(ctx context.Context) AccountIdentityPtrOutput

func (AccountIdentityOutput) Type

Specifies the type of Managed Service Identity that should be configured on this Purview Account. Possible values are `UserAssigned` and `SystemAssigned`.

type AccountIdentityPtrInput

type AccountIdentityPtrInput interface {
	pulumi.Input

	ToAccountIdentityPtrOutput() AccountIdentityPtrOutput
	ToAccountIdentityPtrOutputWithContext(context.Context) AccountIdentityPtrOutput
}

AccountIdentityPtrInput is an input type that accepts AccountIdentityArgs, AccountIdentityPtr and AccountIdentityPtrOutput values. You can construct a concrete instance of `AccountIdentityPtrInput` via:

        AccountIdentityArgs{...}

or:

        nil

type AccountIdentityPtrOutput

type AccountIdentityPtrOutput struct{ *pulumi.OutputState }

func (AccountIdentityPtrOutput) Elem

func (AccountIdentityPtrOutput) ElementType

func (AccountIdentityPtrOutput) ElementType() reflect.Type

func (AccountIdentityPtrOutput) IdentityIds added in v5.12.0

Specifies a list of User Assigned Managed Identity IDs to be assigned to this Purview Account.

> **NOTE:** This is required when `type` is set to `UserAssigned`.

func (AccountIdentityPtrOutput) PrincipalId

The Principal ID associated with this Managed Service Identity.

func (AccountIdentityPtrOutput) TenantId

The Tenant ID associated with this Managed Service Identity.

func (AccountIdentityPtrOutput) ToAccountIdentityPtrOutput

func (o AccountIdentityPtrOutput) ToAccountIdentityPtrOutput() AccountIdentityPtrOutput

func (AccountIdentityPtrOutput) ToAccountIdentityPtrOutputWithContext

func (o AccountIdentityPtrOutput) ToAccountIdentityPtrOutputWithContext(ctx context.Context) AccountIdentityPtrOutput

func (AccountIdentityPtrOutput) Type

Specifies the type of Managed Service Identity that should be configured on this Purview Account. Possible values are `UserAssigned` and `SystemAssigned`.

type AccountInput

type AccountInput interface {
	pulumi.Input

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

type AccountManagedResource

type AccountManagedResource struct {
	// The ID of the managed event hub namespace.
	EventHubNamespaceId *string `pulumi:"eventHubNamespaceId"`
	// The ID of the managed resource group.
	ResourceGroupId *string `pulumi:"resourceGroupId"`
	// The ID of the managed storage account.
	StorageAccountId *string `pulumi:"storageAccountId"`
}

type AccountManagedResourceArgs

type AccountManagedResourceArgs struct {
	// The ID of the managed event hub namespace.
	EventHubNamespaceId pulumi.StringPtrInput `pulumi:"eventHubNamespaceId"`
	// The ID of the managed resource group.
	ResourceGroupId pulumi.StringPtrInput `pulumi:"resourceGroupId"`
	// The ID of the managed storage account.
	StorageAccountId pulumi.StringPtrInput `pulumi:"storageAccountId"`
}

func (AccountManagedResourceArgs) ElementType

func (AccountManagedResourceArgs) ElementType() reflect.Type

func (AccountManagedResourceArgs) ToAccountManagedResourceOutput

func (i AccountManagedResourceArgs) ToAccountManagedResourceOutput() AccountManagedResourceOutput

func (AccountManagedResourceArgs) ToAccountManagedResourceOutputWithContext

func (i AccountManagedResourceArgs) ToAccountManagedResourceOutputWithContext(ctx context.Context) AccountManagedResourceOutput

type AccountManagedResourceArray

type AccountManagedResourceArray []AccountManagedResourceInput

func (AccountManagedResourceArray) ElementType

func (AccountManagedResourceArray) ToAccountManagedResourceArrayOutput

func (i AccountManagedResourceArray) ToAccountManagedResourceArrayOutput() AccountManagedResourceArrayOutput

func (AccountManagedResourceArray) ToAccountManagedResourceArrayOutputWithContext

func (i AccountManagedResourceArray) ToAccountManagedResourceArrayOutputWithContext(ctx context.Context) AccountManagedResourceArrayOutput

type AccountManagedResourceArrayInput

type AccountManagedResourceArrayInput interface {
	pulumi.Input

	ToAccountManagedResourceArrayOutput() AccountManagedResourceArrayOutput
	ToAccountManagedResourceArrayOutputWithContext(context.Context) AccountManagedResourceArrayOutput
}

AccountManagedResourceArrayInput is an input type that accepts AccountManagedResourceArray and AccountManagedResourceArrayOutput values. You can construct a concrete instance of `AccountManagedResourceArrayInput` via:

AccountManagedResourceArray{ AccountManagedResourceArgs{...} }

type AccountManagedResourceArrayOutput

type AccountManagedResourceArrayOutput struct{ *pulumi.OutputState }

func (AccountManagedResourceArrayOutput) ElementType

func (AccountManagedResourceArrayOutput) Index

func (AccountManagedResourceArrayOutput) ToAccountManagedResourceArrayOutput

func (o AccountManagedResourceArrayOutput) ToAccountManagedResourceArrayOutput() AccountManagedResourceArrayOutput

func (AccountManagedResourceArrayOutput) ToAccountManagedResourceArrayOutputWithContext

func (o AccountManagedResourceArrayOutput) ToAccountManagedResourceArrayOutputWithContext(ctx context.Context) AccountManagedResourceArrayOutput

type AccountManagedResourceInput

type AccountManagedResourceInput interface {
	pulumi.Input

	ToAccountManagedResourceOutput() AccountManagedResourceOutput
	ToAccountManagedResourceOutputWithContext(context.Context) AccountManagedResourceOutput
}

AccountManagedResourceInput is an input type that accepts AccountManagedResourceArgs and AccountManagedResourceOutput values. You can construct a concrete instance of `AccountManagedResourceInput` via:

AccountManagedResourceArgs{...}

type AccountManagedResourceOutput

type AccountManagedResourceOutput struct{ *pulumi.OutputState }

func (AccountManagedResourceOutput) ElementType

func (AccountManagedResourceOutput) EventHubNamespaceId

func (o AccountManagedResourceOutput) EventHubNamespaceId() pulumi.StringPtrOutput

The ID of the managed event hub namespace.

func (AccountManagedResourceOutput) ResourceGroupId

The ID of the managed resource group.

func (AccountManagedResourceOutput) StorageAccountId

The ID of the managed storage account.

func (AccountManagedResourceOutput) ToAccountManagedResourceOutput

func (o AccountManagedResourceOutput) ToAccountManagedResourceOutput() AccountManagedResourceOutput

func (AccountManagedResourceOutput) ToAccountManagedResourceOutputWithContext

func (o AccountManagedResourceOutput) ToAccountManagedResourceOutputWithContext(ctx context.Context) AccountManagedResourceOutput

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 (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) AtlasKafkaEndpointPrimaryConnectionString added in v5.5.0

func (o AccountOutput) AtlasKafkaEndpointPrimaryConnectionString() pulumi.StringOutput

Atlas Kafka endpoint primary connection string.

func (AccountOutput) AtlasKafkaEndpointSecondaryConnectionString added in v5.5.0

func (o AccountOutput) AtlasKafkaEndpointSecondaryConnectionString() pulumi.StringOutput

Atlas Kafka endpoint secondary connection string.

func (AccountOutput) CatalogEndpoint added in v5.5.0

func (o AccountOutput) CatalogEndpoint() pulumi.StringOutput

Catalog endpoint.

func (AccountOutput) ElementType

func (AccountOutput) ElementType() reflect.Type

func (AccountOutput) GuardianEndpoint added in v5.5.0

func (o AccountOutput) GuardianEndpoint() pulumi.StringOutput

Guardian endpoint.

func (AccountOutput) Identity added in v5.5.0

func (o AccountOutput) Identity() AccountIdentityOutput

An `identity` block as defined below.

func (AccountOutput) Location added in v5.5.0

func (o AccountOutput) Location() pulumi.StringOutput

The Azure Region where the Purview Account should exist. Changing this forces a new Purview Account to be created.

func (AccountOutput) ManagedResourceGroupName added in v5.5.0

func (o AccountOutput) ManagedResourceGroupName() pulumi.StringOutput

The name which should be used for the new Resource Group where Purview Account creates the managed resources. Changing this forces a new Purview Account to be created.

> **Note:** `managedResourceGroupName` must be a new Resource Group

func (AccountOutput) ManagedResources added in v5.5.0

func (o AccountOutput) ManagedResources() AccountManagedResourceArrayOutput

A `managedResources` block as defined below.

func (AccountOutput) Name added in v5.5.0

The name which should be used for this Purview Account. Changing this forces a new Purview Account to be created.

func (AccountOutput) PublicNetworkEnabled added in v5.5.0

func (o AccountOutput) PublicNetworkEnabled() pulumi.BoolPtrOutput

Should the Purview Account be visible to the public network? Defaults to `true`.

func (AccountOutput) ResourceGroupName added in v5.5.0

func (o AccountOutput) ResourceGroupName() pulumi.StringOutput

The name of the Resource Group where the Purview Account should exist. Changing this forces a new Purview Account to be created.

func (AccountOutput) ScanEndpoint added in v5.5.0

func (o AccountOutput) ScanEndpoint() pulumi.StringOutput

Scan endpoint.

func (AccountOutput) Tags added in v5.5.0

A mapping of tags which should be assigned to the Purview Account.

func (AccountOutput) ToAccountOutput

func (o AccountOutput) ToAccountOutput() AccountOutput

func (AccountOutput) ToAccountOutputWithContext

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

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
	// An `identity` block as defined below.
	Identity AccountIdentityPtrInput
	// 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 the new Resource Group where Purview Account creates the managed resources. Changing this forces a new Purview Account to be created.
	//
	// > **Note:** `managedResourceGroupName` must be a new Resource Group
	ManagedResourceGroupName pulumi.StringPtrInput
	// A `managedResources` block as defined below.
	ManagedResources AccountManagedResourceArrayInput
	// 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
	// A mapping of tags which should be assigned to the Purview Account.
	Tags pulumi.StringMapInput
}

func (AccountState) ElementType

func (AccountState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL