Microsoft.ChangeAnalysis profile
Bicep resource definition
The profile resource type can be deployed with operations that target:
- Subscriptions - See subscription deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ChangeAnalysis/profile resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ChangeAnalysis/profile@2020-04-01-preview' = {
name: 'string'
location: 'string'
identity: {
type: 'string'
}
properties: {
notifications: {
activationState: 'string'
azureMonitorWorkspaceProperties: {
includeChangeDetails: 'string'
workspaceId: 'string'
workspaceResourceId: 'string'
}
}
}
systemData: {}
}
Property values
profile
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| location | The location where the resource is to be deployed. | string |
| identity | The identity block returned by ARM resource that supports managed identity. | ResourceIdentity |
| properties | The properties of a configuration profile. | ConfigurationProfileResourceProperties |
| systemData | Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources |
SystemData |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. | 'None' 'SystemAssigned' |
ConfigurationProfileResourceProperties
| Name | Description | Value |
|---|---|---|
| notifications | Settings of change notification configuration for a subscription. | NotificationSettings |
NotificationSettings
| Name | Description | Value |
|---|---|---|
| activationState | The state of notifications feature. | 'Disabled' 'Enabled' 'None' |
| azureMonitorWorkspaceProperties | Configuration properties of an Azure Monitor workspace that receives change notifications. | AzureMonitorWorkspaceProperties |
AzureMonitorWorkspaceProperties
| Name | Description | Value |
|---|---|---|
| includeChangeDetails | The mode of includeChangeDetails feature. The flag configures whether to include or exclude content of the change before and after values. | 'Exclude' 'Include' 'None' |
| workspaceId | The Azure Monitor workspace ID - the unique identifier for the Log Analytics workspace. | string |
| workspaceResourceId | The Azure Monitor workspace ARM Resource ID. The resource ID should be in the following format: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName} | string |
SystemData
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
ARM template resource definition
The profile resource type can be deployed with operations that target:
- Subscriptions - See subscription deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ChangeAnalysis/profile resource, add the following JSON to your template.
{
"type": "Microsoft.ChangeAnalysis/profile",
"apiVersion": "2020-04-01-preview",
"name": "string",
"location": "string",
"identity": {
"type": "string"
},
"properties": {
"notifications": {
"activationState": "string",
"azureMonitorWorkspaceProperties": {
"includeChangeDetails": "string",
"workspaceId": "string",
"workspaceResourceId": "string"
}
}
},
"systemData": {}
}
Property values
profile
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ChangeAnalysis/profile' |
| apiVersion | The resource api version | '2020-04-01-preview' |
| name | The resource name | string (required) |
| location | The location where the resource is to be deployed. | string |
| identity | The identity block returned by ARM resource that supports managed identity. | ResourceIdentity |
| properties | The properties of a configuration profile. | ConfigurationProfileResourceProperties |
| systemData | Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources |
SystemData |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. | 'None' 'SystemAssigned' |
ConfigurationProfileResourceProperties
| Name | Description | Value |
|---|---|---|
| notifications | Settings of change notification configuration for a subscription. | NotificationSettings |
NotificationSettings
| Name | Description | Value |
|---|---|---|
| activationState | The state of notifications feature. | 'Disabled' 'Enabled' 'None' |
| azureMonitorWorkspaceProperties | Configuration properties of an Azure Monitor workspace that receives change notifications. | AzureMonitorWorkspaceProperties |
AzureMonitorWorkspaceProperties
| Name | Description | Value |
|---|---|---|
| includeChangeDetails | The mode of includeChangeDetails feature. The flag configures whether to include or exclude content of the change before and after values. | 'Exclude' 'Include' 'None' |
| workspaceId | The Azure Monitor workspace ID - the unique identifier for the Log Analytics workspace. | string |
| workspaceResourceId | The Azure Monitor workspace ARM Resource ID. The resource ID should be in the following format: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName} | string |
SystemData
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
Terraform (AzAPI provider) resource definition
The profile resource type can be deployed with operations that target:
- Subscriptions
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ChangeAnalysis/profile resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ChangeAnalysis/profile@2020-04-01-preview"
name = "string"
location = "string"
parent_id = "string"
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
notifications = {
activationState = "string"
azureMonitorWorkspaceProperties = {
includeChangeDetails = "string"
workspaceId = "string"
workspaceResourceId = "string"
}
}
}
systemData = {}
})
}
Property values
profile
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ChangeAnalysis/profile@2020-04-01-preview" |
| name | The resource name | string (required) |
| location | The location where the resource is to be deployed. | string |
| parent_id | To deploy to a subscription, use the ID of that subscription. | string (required) |
| identity | The identity block returned by ARM resource that supports managed identity. | ResourceIdentity |
| properties | The properties of a configuration profile. | ConfigurationProfileResourceProperties |
| systemData | Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources |
SystemData |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. | "SystemAssigned" |
ConfigurationProfileResourceProperties
| Name | Description | Value |
|---|---|---|
| notifications | Settings of change notification configuration for a subscription. | NotificationSettings |
NotificationSettings
| Name | Description | Value |
|---|---|---|
| activationState | The state of notifications feature. | "Disabled" "Enabled" "None" |
| azureMonitorWorkspaceProperties | Configuration properties of an Azure Monitor workspace that receives change notifications. | AzureMonitorWorkspaceProperties |
AzureMonitorWorkspaceProperties
| Name | Description | Value |
|---|---|---|
| includeChangeDetails | The mode of includeChangeDetails feature. The flag configures whether to include or exclude content of the change before and after values. | "Exclude" "Include" "None" |
| workspaceId | The Azure Monitor workspace ID - the unique identifier for the Log Analytics workspace. | string |
| workspaceResourceId | The Azure Monitor workspace ARM Resource ID. The resource ID should be in the following format: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName} | string |
SystemData
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.