Microsoft.Purview accounts 2021-12-01
Bicep resource definition
The accounts resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2021-12-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
cloudConnectors: {}
managedEventHubState: 'string'
managedResourceGroupName: 'string'
managedResourcesPublicNetworkAccess: 'string'
publicNetworkAccess: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property values
AccountProperties
| Name | Description | Value |
|---|---|---|
| cloudConnectors | Cloud connectors. External cloud identifier used as part of scanning configuration. |
CloudConnectors |
| 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' |
| publicNetworkAccess | Gets or sets the public network access. | 'Disabled' 'Enabled' 'NotSpecified' |
CloudConnectors
| Name | Description | Value |
|---|
Identity
| Name | Description | Value |
|---|---|---|
| type | Identity Type | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | User Assigned Identities | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
Microsoft.Purview/accounts
| Name | Description | Value |
|---|---|---|
| identity | Identity Info on the tracked resource | Identity |
| location | Gets or sets the location. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (required) |
| properties | Gets or sets the properties. | AccountProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Quickstart samples
The following quickstart samples deploy 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:
- Resource groups - See resource group deployment commands
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": "2021-12-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"cloudConnectors": {
},
"managedEventHubState": "string",
"managedResourceGroupName": "string",
"managedResourcesPublicNetworkAccess": "string",
"publicNetworkAccess": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property values
AccountProperties
| Name | Description | Value |
|---|---|---|
| cloudConnectors | Cloud connectors. External cloud identifier used as part of scanning configuration. |
CloudConnectors |
| 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' |
| publicNetworkAccess | Gets or sets the public network access. | 'Disabled' 'Enabled' 'NotSpecified' |
CloudConnectors
| Name | Description | Value |
|---|
Identity
| Name | Description | Value |
|---|---|---|
| type | Identity Type | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | User Assigned Identities | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
Microsoft.Purview/accounts
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-12-01' |
| identity | Identity Info on the tracked resource | Identity |
| location | Gets or sets the location. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (required) |
| properties | Gets or sets the properties. | AccountProperties |
| 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 |
|---|
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Deploy Microsoft Purview account |
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@2021-12-01"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
cloudConnectors = {
}
managedEventHubState = "string"
managedResourceGroupName = "string"
managedResourcesPublicNetworkAccess = "string"
publicNetworkAccess = "string"
}
})
}
Property values
AccountProperties
| Name | Description | Value |
|---|---|---|
| cloudConnectors | Cloud connectors. External cloud identifier used as part of scanning configuration. |
CloudConnectors |
| 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' |
| publicNetworkAccess | Gets or sets the public network access. | 'Disabled' 'Enabled' 'NotSpecified' |
CloudConnectors
| Name | Description | Value |
|---|
Identity
| Name | Description | Value |
|---|---|---|
| type | Identity Type | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | User Assigned Identities | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
Microsoft.Purview/accounts
| Name | Description | Value |
|---|---|---|
| identity | Identity Info on the tracked resource | Identity |
| location | Gets or sets the location. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$ (required) |
| properties | Gets or sets the properties. | AccountProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Purview/accounts@2021-12-01" |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|