Share via

Microsoft.Purview accounts

  • Article
  • 02/13/2025

Bicep resource definition

The accounts resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Purview/accounts resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Purview/accounts@2024-04-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    cloudConnectors: {}
    ingestionStorage: {
      publicNetworkAccess: 'string'
    }
    managedEventHubState: 'string'
    managedResourceGroupName: 'string'
    managedResourcesPublicNetworkAccess: 'string'
    mergeInfo: {}
    publicNetworkAccess: 'string'
    tenantEndpointState: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

AccountMergeInfo

Name Description Value

AccountProperties

Name Description Value
cloudConnectors External Cloud Service connectors CloudConnectors
ingestionStorage Ingestion Storage Account Info IngestionStorage
managedEventHubState Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. 'Disabled'
'Enabled'
'NotSpecified'
managedResourceGroupName Gets or sets the managed resource group name string
managedResourcesPublicNetworkAccess Gets or sets the public network access for managed resources. 'Disabled'
'Enabled'
'NotSpecified'
mergeInfo Gets or sets the Merge Info. AccountMergeInfo
publicNetworkAccess Gets or sets the public network access. 'Disabled'
'Enabled'
'NotSpecified'
tenantEndpointState Gets or sets the state of tenant endpoint. 'Disabled'
'Enabled'
'NotSpecified'

AccountSku

Name Description Value
capacity Gets or sets the sku capacity. int
name Gets or sets the sku name. 'Free'
'Standard'

CloudConnectors

Name Description Value

Identity

Name Description Value
type Identity Type 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities User Assigned Identities IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Name Description Value

IngestionStorage

Name Description Value
publicNetworkAccess Gets or sets the public network access setting 'Disabled'
'Enabled'
'NotSpecified'

Microsoft.Purview/accounts

Name Description Value
identity The Managed Identity of the resource Identity
location Gets or sets the location. string
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (required)
properties The account properties AccountProperties
sku Gets or sets the Sku. AccountSku
tags Resource tags Dictionary of tag names and values. See Tags in templates

TrackedResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Purview Account AVM Resource Module for Purview Account

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Deploy Microsoft Purview account This template will deploy a Microsoft Purview account to a new or existing resource group.

ARM template resource definition

The accounts resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Purview/accounts resource, add the following JSON to your template.

{
  "type": "Microsoft.Purview/accounts",
  "apiVersion": "2024-04-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "cloudConnectors": {
    },
    "ingestionStorage": {
      "publicNetworkAccess": "string"
    },
    "managedEventHubState": "string",
    "managedResourceGroupName": "string",
    "managedResourcesPublicNetworkAccess": "string",
    "mergeInfo": {
    },
    "publicNetworkAccess": "string",
    "tenantEndpointState": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

AccountMergeInfo

Name Description Value

AccountProperties

Name Description Value
cloudConnectors External Cloud Service connectors CloudConnectors
ingestionStorage Ingestion Storage Account Info IngestionStorage
managedEventHubState Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. 'Disabled'
'Enabled'
'NotSpecified'
managedResourceGroupName Gets or sets the managed resource group name string
managedResourcesPublicNetworkAccess Gets or sets the public network access for managed resources. 'Disabled'
'Enabled'
'NotSpecified'
mergeInfo Gets or sets the Merge Info. AccountMergeInfo
publicNetworkAccess Gets or sets the public network access. 'Disabled'
'Enabled'
'NotSpecified'
tenantEndpointState Gets or sets the state of tenant endpoint. 'Disabled'
'Enabled'
'NotSpecified'

AccountSku

Name Description Value
capacity Gets or sets the sku capacity. int
name Gets or sets the sku name. 'Free'
'Standard'

CloudConnectors

Name Description Value

Identity

Name Description Value
type Identity Type 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities User Assigned Identities IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Name Description Value

IngestionStorage

Name Description Value
publicNetworkAccess Gets or sets the public network access setting 'Disabled'
'Enabled'
'NotSpecified'

Microsoft.Purview/accounts

Name Description Value
apiVersion The api version '2024-04-01-preview'
identity The Managed Identity of the resource Identity
location Gets or sets the location. string
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (required)
properties The account properties AccountProperties
sku Gets or sets the Sku. AccountSku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Purview/accounts'

TrackedResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Deploy Microsoft Purview account

Deploy to Azure		 This template will deploy a Microsoft Purview account to a new or existing resource group.

Terraform (AzAPI provider) resource definition

The accounts resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Purview/accounts resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Purview/accounts@2024-04-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      cloudConnectors = {
      }
      ingestionStorage = {
        publicNetworkAccess = "string"
      }
      managedEventHubState = "string"
      managedResourceGroupName = "string"
      managedResourcesPublicNetworkAccess = "string"
      mergeInfo = {
      }
      publicNetworkAccess = "string"
      tenantEndpointState = "string"
    }
    sku = {
      capacity = int
      name = "string"
    }
  }
}

Property Values

AccountMergeInfo

Name Description Value

AccountProperties

Name Description Value
cloudConnectors External Cloud Service connectors CloudConnectors
ingestionStorage Ingestion Storage Account Info IngestionStorage
managedEventHubState Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. 'Disabled'
'Enabled'
'NotSpecified'
managedResourceGroupName Gets or sets the managed resource group name string
managedResourcesPublicNetworkAccess Gets or sets the public network access for managed resources. 'Disabled'
'Enabled'
'NotSpecified'
mergeInfo Gets or sets the Merge Info. AccountMergeInfo
publicNetworkAccess Gets or sets the public network access. 'Disabled'
'Enabled'
'NotSpecified'
tenantEndpointState Gets or sets the state of tenant endpoint. 'Disabled'
'Enabled'
'NotSpecified'

AccountSku

Name Description Value
capacity Gets or sets the sku capacity. int
name Gets or sets the sku name. 'Free'
'Standard'

CloudConnectors

Name Description Value

Identity

Name Description Value
type Identity Type 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities User Assigned Identities IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Name Description Value

IngestionStorage

Name Description Value
publicNetworkAccess Gets or sets the public network access setting 'Disabled'
'Enabled'
'NotSpecified'

Microsoft.Purview/accounts

Name Description Value
identity The Managed Identity of the resource Identity
location Gets or sets the location. string
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (required)
properties The account properties AccountProperties
sku Gets or sets the Sku. AccountSku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Purview/accounts@2024-04-01-preview"

TrackedResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value