Account

Manages a Purview Account.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleAccount = new Azure.Purview.Account("exampleAccount", new()
    {
        ResourceGroupName = exampleResourceGroup.Name,
        Location = exampleResourceGroup.Location,
        Identity = new Azure.Purview.Inputs.AccountIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });

});
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 {
		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,
			Identity: &purview.AccountIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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.purview.Account;
import com.pulumi.azure.purview.AccountArgs;
import com.pulumi.azure.purview.inputs.AccountIdentityArgs;
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .identity(AccountIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.purview.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    identity=azure.purview.AccountIdentityArgs(
        type="SystemAssigned",
    ))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.purview.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    identity: {
        type: "SystemAssigned",
    },
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleAccount:
    type: azure:purview:Account
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      identity:
        type: SystemAssigned

Create Account Resource

new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);
@overload
def Account(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            identity: Optional[AccountIdentityArgs] = None,
            location: Optional[str] = None,
            managed_resource_group_name: Optional[str] = None,
            name: Optional[str] = None,
            public_network_enabled: Optional[bool] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
@overload
def Account(resource_name: str,
            args: AccountArgs,
            opts: Optional[ResourceOptions] = None)
func NewAccount(ctx *Context, name string, args AccountArgs, opts ...ResourceOption) (*Account, error)
public Account(string name, AccountArgs args, CustomResourceOptions? opts = null)
public Account(String name, AccountArgs args)
public Account(String name, AccountArgs args, CustomResourceOptions options)
type: azure:purview:Account
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AccountArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AccountArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AccountArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AccountArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Account Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Account resource accepts the following input properties:

Identity AccountIdentityArgs

An identity block as defined below.

ResourceGroupName string

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

Location string

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

ManagedResourceGroupName string

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.

Name string

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

PublicNetworkEnabled bool

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

Tags Dictionary<string, string>

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

Identity AccountIdentityArgs

An identity block as defined below.

ResourceGroupName string

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

Location string

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

ManagedResourceGroupName string

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.

Name string

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

PublicNetworkEnabled bool

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

Tags map[string]string

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

identity AccountIdentityArgs

An identity block as defined below.

resourceGroupName String

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

location String

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

managedResourceGroupName String

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.

name String

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

publicNetworkEnabled Boolean

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

tags Map<String,String>

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

identity AccountIdentityArgs

An identity block as defined below.

resourceGroupName string

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

location string

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

managedResourceGroupName string

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.

name string

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

publicNetworkEnabled boolean

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

tags {[key: string]: string}

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

identity AccountIdentityArgs

An identity block as defined below.

resource_group_name str

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

location str

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

managed_resource_group_name str

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.

name str

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

public_network_enabled bool

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

tags Mapping[str, str]

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

identity Property Map

An identity block as defined below.

resourceGroupName String

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

location String

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

managedResourceGroupName String

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.

name String

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

publicNetworkEnabled Boolean

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

tags Map<String>

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

Outputs

All input properties are implicitly available as output properties. Additionally, the Account resource produces the following output properties:

AtlasKafkaEndpointPrimaryConnectionString string

Atlas Kafka endpoint primary connection string.

AtlasKafkaEndpointSecondaryConnectionString string

Atlas Kafka endpoint secondary connection string.

CatalogEndpoint string

Catalog endpoint.

GuardianEndpoint string

Guardian endpoint.

Id string

The provider-assigned unique ID for this managed resource.

ManagedResources List<AccountManagedResource>

A managed_resources block as defined below.

ScanEndpoint string

Scan endpoint.

AtlasKafkaEndpointPrimaryConnectionString string

Atlas Kafka endpoint primary connection string.

AtlasKafkaEndpointSecondaryConnectionString string

Atlas Kafka endpoint secondary connection string.

CatalogEndpoint string

Catalog endpoint.

GuardianEndpoint string

Guardian endpoint.

Id string

The provider-assigned unique ID for this managed resource.

ManagedResources []AccountManagedResource

A managed_resources block as defined below.

ScanEndpoint string

Scan endpoint.

atlasKafkaEndpointPrimaryConnectionString String

Atlas Kafka endpoint primary connection string.

atlasKafkaEndpointSecondaryConnectionString String

Atlas Kafka endpoint secondary connection string.

catalogEndpoint String

Catalog endpoint.

guardianEndpoint String

Guardian endpoint.

id String

The provider-assigned unique ID for this managed resource.

managedResources List<AccountManagedResource>

A managed_resources block as defined below.

scanEndpoint String

Scan endpoint.

atlasKafkaEndpointPrimaryConnectionString string

Atlas Kafka endpoint primary connection string.

atlasKafkaEndpointSecondaryConnectionString string

Atlas Kafka endpoint secondary connection string.

catalogEndpoint string

Catalog endpoint.

guardianEndpoint string

Guardian endpoint.

id string

The provider-assigned unique ID for this managed resource.

managedResources AccountManagedResource[]

A managed_resources block as defined below.

scanEndpoint string

Scan endpoint.

atlas_kafka_endpoint_primary_connection_string str

Atlas Kafka endpoint primary connection string.

atlas_kafka_endpoint_secondary_connection_string str

Atlas Kafka endpoint secondary connection string.

catalog_endpoint str

Catalog endpoint.

guardian_endpoint str

Guardian endpoint.

id str

The provider-assigned unique ID for this managed resource.

managed_resources Sequence[AccountManagedResource]

A managed_resources block as defined below.

scan_endpoint str

Scan endpoint.

atlasKafkaEndpointPrimaryConnectionString String

Atlas Kafka endpoint primary connection string.

atlasKafkaEndpointSecondaryConnectionString String

Atlas Kafka endpoint secondary connection string.

catalogEndpoint String

Catalog endpoint.

guardianEndpoint String

Guardian endpoint.

id String

The provider-assigned unique ID for this managed resource.

managedResources List<Property Map>

A managed_resources block as defined below.

scanEndpoint String

Scan endpoint.

Look up Existing Account Resource

Get an existing Account resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AccountState, opts?: CustomResourceOptions): Account
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        atlas_kafka_endpoint_primary_connection_string: Optional[str] = None,
        atlas_kafka_endpoint_secondary_connection_string: Optional[str] = None,
        catalog_endpoint: Optional[str] = None,
        guardian_endpoint: Optional[str] = None,
        identity: Optional[AccountIdentityArgs] = None,
        location: Optional[str] = None,
        managed_resource_group_name: Optional[str] = None,
        managed_resources: Optional[Sequence[AccountManagedResourceArgs]] = None,
        name: Optional[str] = None,
        public_network_enabled: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        scan_endpoint: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Account
func GetAccount(ctx *Context, name string, id IDInput, state *AccountState, opts ...ResourceOption) (*Account, error)
public static Account Get(string name, Input<string> id, AccountState? state, CustomResourceOptions? opts = null)
public static Account get(String name, Output<String> id, AccountState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AtlasKafkaEndpointPrimaryConnectionString string

Atlas Kafka endpoint primary connection string.

AtlasKafkaEndpointSecondaryConnectionString string

Atlas Kafka endpoint secondary connection string.

CatalogEndpoint string

Catalog endpoint.

GuardianEndpoint string

Guardian endpoint.

Identity AccountIdentityArgs

An identity block as defined below.

Location string

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

ManagedResourceGroupName string

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.

ManagedResources List<AccountManagedResourceArgs>

A managed_resources block as defined below.

Name string

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

PublicNetworkEnabled bool

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

ResourceGroupName string

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

ScanEndpoint string

Scan endpoint.

Tags Dictionary<string, string>

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

AtlasKafkaEndpointPrimaryConnectionString string

Atlas Kafka endpoint primary connection string.

AtlasKafkaEndpointSecondaryConnectionString string

Atlas Kafka endpoint secondary connection string.

CatalogEndpoint string

Catalog endpoint.

GuardianEndpoint string

Guardian endpoint.

Identity AccountIdentityArgs

An identity block as defined below.

Location string

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

ManagedResourceGroupName string

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.

ManagedResources []AccountManagedResourceArgs

A managed_resources block as defined below.

Name string

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

PublicNetworkEnabled bool

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

ResourceGroupName string

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

ScanEndpoint string

Scan endpoint.

Tags map[string]string

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

atlasKafkaEndpointPrimaryConnectionString String

Atlas Kafka endpoint primary connection string.

atlasKafkaEndpointSecondaryConnectionString String

Atlas Kafka endpoint secondary connection string.

catalogEndpoint String

Catalog endpoint.

guardianEndpoint String

Guardian endpoint.

identity AccountIdentityArgs

An identity block as defined below.

location String

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

managedResourceGroupName String

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.

managedResources List<AccountManagedResourceArgs>

A managed_resources block as defined below.

name String

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

publicNetworkEnabled Boolean

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

resourceGroupName String

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

scanEndpoint String

Scan endpoint.

tags Map<String,String>

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

atlasKafkaEndpointPrimaryConnectionString string

Atlas Kafka endpoint primary connection string.

atlasKafkaEndpointSecondaryConnectionString string

Atlas Kafka endpoint secondary connection string.

catalogEndpoint string

Catalog endpoint.

guardianEndpoint string

Guardian endpoint.

identity AccountIdentityArgs

An identity block as defined below.

location string

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

managedResourceGroupName string

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.

managedResources AccountManagedResourceArgs[]

A managed_resources block as defined below.

name string

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

publicNetworkEnabled boolean

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

resourceGroupName string

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

scanEndpoint string

Scan endpoint.

tags {[key: string]: string}

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

atlas_kafka_endpoint_primary_connection_string str

Atlas Kafka endpoint primary connection string.

atlas_kafka_endpoint_secondary_connection_string str

Atlas Kafka endpoint secondary connection string.

catalog_endpoint str

Catalog endpoint.

guardian_endpoint str

Guardian endpoint.

identity AccountIdentityArgs

An identity block as defined below.

location str

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

managed_resource_group_name str

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.

managed_resources Sequence[AccountManagedResourceArgs]

A managed_resources block as defined below.

name str

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

public_network_enabled bool

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

resource_group_name str

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

scan_endpoint str

Scan endpoint.

tags Mapping[str, str]

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

atlasKafkaEndpointPrimaryConnectionString String

Atlas Kafka endpoint primary connection string.

atlasKafkaEndpointSecondaryConnectionString String

Atlas Kafka endpoint secondary connection string.

catalogEndpoint String

Catalog endpoint.

guardianEndpoint String

Guardian endpoint.

identity Property Map

An identity block as defined below.

location String

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

managedResourceGroupName String

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.

managedResources List<Property Map>

A managed_resources block as defined below.

name String

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

publicNetworkEnabled Boolean

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

resourceGroupName String

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

scanEndpoint String

Scan endpoint.

tags Map<String>

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

Supporting Types

AccountIdentity

Type string

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

IdentityIds List<string>
PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The Tenant ID associated with this Managed Service Identity.

Type string

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

IdentityIds []string
PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The Tenant ID associated with this Managed Service Identity.

type String

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

identityIds List<String>
principalId String

The Principal ID associated with this Managed Service Identity.

tenantId String

The Tenant ID associated with this Managed Service Identity.

type string

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

identityIds string[]
principalId string

The Principal ID associated with this Managed Service Identity.

tenantId string

The Tenant ID associated with this Managed Service Identity.

type str

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

identity_ids Sequence[str]
principal_id str

The Principal ID associated with this Managed Service Identity.

tenant_id str

The Tenant ID associated with this Managed Service Identity.

type String

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

identityIds List<String>
principalId String

The Principal ID associated with this Managed Service Identity.

tenantId String

The Tenant ID associated with this Managed Service Identity.

AccountManagedResource

EventHubNamespaceId string

The ID of the managed event hub namespace.

ResourceGroupId string

The ID of the managed resource group.

StorageAccountId string

The ID of the managed storage account.

EventHubNamespaceId string

The ID of the managed event hub namespace.

ResourceGroupId string

The ID of the managed resource group.

StorageAccountId string

The ID of the managed storage account.

eventHubNamespaceId String

The ID of the managed event hub namespace.

resourceGroupId String

The ID of the managed resource group.

storageAccountId String

The ID of the managed storage account.

eventHubNamespaceId string

The ID of the managed event hub namespace.

resourceGroupId string

The ID of the managed resource group.

storageAccountId string

The ID of the managed storage account.

event_hub_namespace_id str

The ID of the managed event hub namespace.

resource_group_id str

The ID of the managed resource group.

storage_account_id str

The ID of the managed storage account.

eventHubNamespaceId String

The ID of the managed event hub namespace.

resourceGroupId String

The ID of the managed resource group.

storageAccountId String

The ID of the managed storage account.

Import

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

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.