Microsoft.Purview accounts
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' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
cloudConnectors: {}
managedEventHubState: 'string'
managedResourceGroupName: 'string'
managedResourcesPublicNetworkAccess: 'string'
publicNetworkAccess: 'string'
}
}
Property values
accounts
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| location | Gets or sets the location. | string |
| tags | Tags on the azure resource. | Dictionary of tag names and values. See Tags in templates |
| identity | Identity Info on the tracked resource | Identity |
| properties | Gets or sets the properties. | AccountProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | Identity Type | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | User Assigned Identities | object |
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
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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. |
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",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"cloudConnectors": {},
"managedEventHubState": "string",
"managedResourceGroupName": "string",
"managedResourcesPublicNetworkAccess": "string",
"publicNetworkAccess": "string"
}
}
Property values
accounts
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Purview/accounts' |
| apiVersion | The resource api version | '2021-12-01' |
| name | The resource name | string (required) |
| location | Gets or sets the location. | string |
| tags | Tags on the azure resource. | Dictionary of tag names and values. See Tags in templates |
| identity | Identity Info on the tracked resource | Identity |
| properties | Gets or sets the properties. | AccountProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | Identity Type | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | User Assigned Identities | object |
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
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
cloudConnectors = {}
managedEventHubState = "string"
managedResourceGroupName = "string"
managedResourcesPublicNetworkAccess = "string"
publicNetworkAccess = "string"
}
})
}
Property values
accounts
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Purview/accounts@2021-12-01" |
| name | The resource name | string (required) |
| location | Gets or sets the location. | string |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Tags on the azure resource. | Dictionary of tag names and values. |
| identity | Identity Info on the tracked resource | Identity |
| properties | Gets or sets the properties. | AccountProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | Identity Type | "SystemAssigned" "UserAssigned" |
| identity_ids | User Assigned Identities | Array of user identity IDs. |
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
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for