Microsoft.ChangeAnalysis profile 2020-04-01-preview
Bicep resource definition
The profile resource type can be deployed with operations that target:
- Subscription - 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' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
notifications: {
activationState: 'string'
azureMonitorWorkspaceProperties: {
includeChangeDetails: 'string'
workspaceId: 'string'
workspaceResourceId: 'string'
}
}
}
systemData: {}
}
Property values
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 |
ConfigurationProfileResourceProperties
| Name | Description | Value |
|---|---|---|
| notifications | Settings of change notification configuration for a subscription. | NotificationSettings |
Microsoft.ChangeAnalysis/profile
| Name | Description | Value |
|---|---|---|
| identity | The identity block returned by ARM resource that supports managed identity. | ResourceIdentity |
| location | The location where the resource is to be deployed. | string |
| name | The resource name | string Constraints: Pattern = ^(?!.*-$)[^-][a-zA-Z0-9-]*$ (required) |
| 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 |
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 |
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' |
SystemData
| Name | Description | Value |
|---|
ARM template resource definition
The profile resource type can be deployed with operations that target:
- Subscription - 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",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"notifications": {
"activationState": "string",
"azureMonitorWorkspaceProperties": {
"includeChangeDetails": "string",
"workspaceId": "string",
"workspaceResourceId": "string"
}
}
},
"systemData": {
}
}
Property values
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 |
ConfigurationProfileResourceProperties
| Name | Description | Value |
|---|---|---|
| notifications | Settings of change notification configuration for a subscription. | NotificationSettings |
Microsoft.ChangeAnalysis/profile
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-04-01-preview' |
| identity | The identity block returned by ARM resource that supports managed identity. | ResourceIdentity |
| location | The location where the resource is to be deployed. | string |
| name | The resource name | string Constraints: Pattern = ^(?!.*-$)[^-][a-zA-Z0-9-]*$ (required) |
| 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 |
| type | The resource type | 'Microsoft.ChangeAnalysis/profile' |
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 |
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' |
SystemData
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The profile resource type can be deployed with operations that target:
- Subscription
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"
identity = {
type = "string"
}
location = "string"
systemData = {
}
body = jsonencode({
properties = {
notifications = {
activationState = "string"
azureMonitorWorkspaceProperties = {
includeChangeDetails = "string"
workspaceId = "string"
workspaceResourceId = "string"
}
}
}
})
}
Property values
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 |
ConfigurationProfileResourceProperties
| Name | Description | Value |
|---|---|---|
| notifications | Settings of change notification configuration for a subscription. | NotificationSettings |
Microsoft.ChangeAnalysis/profile
| Name | Description | Value |
|---|---|---|
| identity | The identity block returned by ARM resource that supports managed identity. | ResourceIdentity |
| location | The location where the resource is to be deployed. | string |
| name | The resource name | string Constraints: Pattern = ^(?!.*-$)[^-][a-zA-Z0-9-]*$ (required) |
| 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 |
| type | The resource type | "Microsoft.ChangeAnalysis/profile@2020-04-01-preview" |
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 |
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' |
SystemData
| Name | Description | Value |
|---|