1. Packages
  2. Azure Classic
  3. API Docs
  4. purview
  5. Account

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.purview.Account

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages a Purview Account.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleAccount = new azure.purview.Account("example", {
        name: "example",
        resourceGroupName: example.name,
        location: example.location,
        identity: {
            type: "SystemAssigned",
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_account = azure.purview.Account("example",
        name="example",
        resource_group_name=example.name,
        location=example.location,
        identity=azure.purview.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 {
    		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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleAccount = new Azure.Purview.Account("example", new()
        {
            Name = "example",
            ResourceGroupName = example.Name,
            Location = example.Location,
            Identity = new Azure.Purview.Inputs.AccountIdentityArgs
            {
                Type = "SystemAssigned",
            },
        });
    
    });
    
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
                .name("example")
                .resourceGroupName(example.name())
                .location(example.location())
                .identity(AccountIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleAccount:
        type: azure:purview:Account
        name: example
        properties:
          name: example
          resourceGroupName: ${example.name}
          location: ${example.location}
          identity:
            type: SystemAssigned
    

    Create Account Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);
    @overload
    def Account(resource_name: str,
                args: AccountArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Account(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                identity: Optional[AccountIdentityArgs] = None,
                resource_group_name: Optional[str] = None,
                location: Optional[str] = None,
                managed_resource_group_name: Optional[str] = None,
                name: Optional[str] = None,
                public_network_enabled: Optional[bool] = None,
                tags: Optional[Mapping[str, str]] = 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.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var exampleaccountResourceResourceFromPurviewaccount = new Azure.Purview.Account("exampleaccountResourceResourceFromPurviewaccount", new()
    {
        Identity = new Azure.Purview.Inputs.AccountIdentityArgs
        {
            Type = "string",
            IdentityIds = new[]
            {
                "string",
            },
            PrincipalId = "string",
            TenantId = "string",
        },
        ResourceGroupName = "string",
        Location = "string",
        ManagedResourceGroupName = "string",
        Name = "string",
        PublicNetworkEnabled = false,
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := purview.NewAccount(ctx, "exampleaccountResourceResourceFromPurviewaccount", &purview.AccountArgs{
    	Identity: &purview.AccountIdentityArgs{
    		Type: pulumi.String("string"),
    		IdentityIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		PrincipalId: pulumi.String("string"),
    		TenantId:    pulumi.String("string"),
    	},
    	ResourceGroupName:        pulumi.String("string"),
    	Location:                 pulumi.String("string"),
    	ManagedResourceGroupName: pulumi.String("string"),
    	Name:                     pulumi.String("string"),
    	PublicNetworkEnabled:     pulumi.Bool(false),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var exampleaccountResourceResourceFromPurviewaccount = new Account("exampleaccountResourceResourceFromPurviewaccount", AccountArgs.builder()
        .identity(AccountIdentityArgs.builder()
            .type("string")
            .identityIds("string")
            .principalId("string")
            .tenantId("string")
            .build())
        .resourceGroupName("string")
        .location("string")
        .managedResourceGroupName("string")
        .name("string")
        .publicNetworkEnabled(false)
        .tags(Map.of("string", "string"))
        .build());
    
    exampleaccount_resource_resource_from_purviewaccount = azure.purview.Account("exampleaccountResourceResourceFromPurviewaccount",
        identity=azure.purview.AccountIdentityArgs(
            type="string",
            identity_ids=["string"],
            principal_id="string",
            tenant_id="string",
        ),
        resource_group_name="string",
        location="string",
        managed_resource_group_name="string",
        name="string",
        public_network_enabled=False,
        tags={
            "string": "string",
        })
    
    const exampleaccountResourceResourceFromPurviewaccount = new azure.purview.Account("exampleaccountResourceResourceFromPurviewaccount", {
        identity: {
            type: "string",
            identityIds: ["string"],
            principalId: "string",
            tenantId: "string",
        },
        resourceGroupName: "string",
        location: "string",
        managedResourceGroupName: "string",
        name: "string",
        publicNetworkEnabled: false,
        tags: {
            string: "string",
        },
    });
    
    type: azure:purview:Account
    properties:
        identity:
            identityIds:
                - string
            principalId: string
            tenantId: string
            type: string
        location: string
        managedResourceGroupName: string
        name: string
        publicNetworkEnabled: false
        resourceGroupName: string
        tags:
            string: string
    

    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 AccountIdentity
    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.

    Note: managed_resource_group_name must be a new Resource Group

    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.

    Note: managed_resource_group_name must be a new Resource Group

    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 AccountIdentity
    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.

    Note: managed_resource_group_name must be a new Resource Group

    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 AccountIdentity
    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.

    Note: managed_resource_group_name must be a new Resource Group

    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.

    Note: managed_resource_group_name must be a new Resource Group

    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.

    Note: managed_resource_group_name must be a new Resource Group

    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 AccountIdentity
    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.

    Note: managed_resource_group_name must be a new Resource Group

    ManagedResources List<AccountManagedResource>
    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.

    Note: managed_resource_group_name must be a new Resource Group

    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 AccountIdentity
    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.

    Note: managed_resource_group_name must be a new Resource Group

    managedResources List<AccountManagedResource>
    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 AccountIdentity
    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.

    Note: managed_resource_group_name must be a new Resource Group

    managedResources AccountManagedResource[]
    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.

    Note: managed_resource_group_name must be a new Resource Group

    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.

    Note: managed_resource_group_name must be a new Resource Group

    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, AccountIdentityArgs

    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>

    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.

    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

    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.

    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>

    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.

    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[]

    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.

    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]

    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.

    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>

    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.

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.

    AccountManagedResource, AccountManagedResourceArgs

    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
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi