Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The profile 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.ChangeAnalysis/profile resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ChangeAnalysis/profile@2020-04-01-preview' = {
scope: resourceSymbolicName or scope
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
notifications: {
activationState: 'string'
azureMonitorWorkspaceProperties: {
includeChangeDetails: 'string'
workspaceId: 'string'
workspaceResourceId: 'string'
}
}
}
systemData: {}
}
Property Values
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 |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
| 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 |
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 |
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:
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
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' |
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 |
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 |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The profile 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.ChangeAnalysis/profile resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ChangeAnalysis/profile@2020-04-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
body = {
properties = {
notifications = {
activationState = "string"
azureMonitorWorkspaceProperties = {
includeChangeDetails = "string"
workspaceId = "string"
workspaceResourceId = "string"
}
}
}
systemData = {
}
}
}
Property Values
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) |
| parent_id | The ID of the resource to apply this extension resource to. | string (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" |
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 |
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 |
|---|