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 configurationProfilePreferences 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.Automanage/configurationProfilePreferences resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Automanage/configurationProfilePreferences@2020-06-30-preview' = {
location: 'string'
name: 'string'
properties: {
antiMalware: {
enableRealTimeProtection: 'string'
exclusions: any(...)
runScheduledScan: 'string'
scanDay: 'string'
scanTimeInMinutes: 'string'
scanType: 'string'
}
vmBackup: {
instantRpRetentionRangeInDays: int
retentionPolicy: 'string'
schedulePolicy: 'string'
timeZone: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Automanage/configurationProfilePreferences
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the configuration profile preference. | ConfigurationProfilePreferenceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ConfigurationProfilePreferenceAntiMalware
| Name | Description | Value |
|---|---|---|
| enableRealTimeProtection | Enables or disables Real Time Protection | 'False' 'True' |
| exclusions | Extensions, Paths and Processes that must be excluded from scan | any |
| runScheduledScan | Enables or disables a periodic scan for antimalware | 'False' 'True' |
| scanDay | Schedule scan settings day | string |
| scanTimeInMinutes | Schedule scan settings time | string |
| scanType | Type of scheduled scan | 'Full' 'Quick' |
ConfigurationProfilePreferenceProperties
| Name | Description | Value |
|---|---|---|
| antiMalware | The custom preferences for Azure Antimalware. | ConfigurationProfilePreferenceAntiMalware |
| vmBackup | The custom preferences for Azure VM Backup. | ConfigurationProfilePreferenceVmBackup |
ConfigurationProfilePreferenceVmBackup
| Name | Description | Value |
|---|---|---|
| instantRpRetentionRangeInDays | Instant RP retention policy range in days | int |
| retentionPolicy | Retention policy with the details on backup copy retention ranges. | string |
| schedulePolicy | Backup schedule specified as part of backup policy. | string |
| timeZone | TimeZone optional input as string. For example: Pacific Standard Time | string |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The configurationProfilePreferences 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.Automanage/configurationProfilePreferences resource, add the following JSON to your template.
{
"type": "Microsoft.Automanage/configurationProfilePreferences",
"apiVersion": "2020-06-30-preview",
"name": "string",
"location": "string",
"properties": {
"antiMalware": {
"enableRealTimeProtection": "string",
"exclusions": {},
"runScheduledScan": "string",
"scanDay": "string",
"scanTimeInMinutes": "string",
"scanType": "string"
},
"vmBackup": {
"instantRpRetentionRangeInDays": "int",
"retentionPolicy": "string",
"schedulePolicy": "string",
"timeZone": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Automanage/configurationProfilePreferences
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-06-30-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the configuration profile preference. | ConfigurationProfilePreferenceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Automanage/configurationProfilePreferences' |
ConfigurationProfilePreferenceAntiMalware
| Name | Description | Value |
|---|---|---|
| enableRealTimeProtection | Enables or disables Real Time Protection | 'False' 'True' |
| exclusions | Extensions, Paths and Processes that must be excluded from scan | any |
| runScheduledScan | Enables or disables a periodic scan for antimalware | 'False' 'True' |
| scanDay | Schedule scan settings day | string |
| scanTimeInMinutes | Schedule scan settings time | string |
| scanType | Type of scheduled scan | 'Full' 'Quick' |
ConfigurationProfilePreferenceProperties
| Name | Description | Value |
|---|---|---|
| antiMalware | The custom preferences for Azure Antimalware. | ConfigurationProfilePreferenceAntiMalware |
| vmBackup | The custom preferences for Azure VM Backup. | ConfigurationProfilePreferenceVmBackup |
ConfigurationProfilePreferenceVmBackup
| Name | Description | Value |
|---|---|---|
| instantRpRetentionRangeInDays | Instant RP retention policy range in days | int |
| retentionPolicy | Retention policy with the details on backup copy retention ranges. | string |
| schedulePolicy | Backup schedule specified as part of backup policy. | string |
| timeZone | TimeZone optional input as string. For example: Pacific Standard Time | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The configurationProfilePreferences 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.Automanage/configurationProfilePreferences resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Automanage/configurationProfilePreferences@2020-06-30-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
antiMalware = {
enableRealTimeProtection = "string"
exclusions = ?
runScheduledScan = "string"
scanDay = "string"
scanTimeInMinutes = "string"
scanType = "string"
}
vmBackup = {
instantRpRetentionRangeInDays = int
retentionPolicy = "string"
schedulePolicy = "string"
timeZone = "string"
}
}
}
}
Property Values
Microsoft.Automanage/configurationProfilePreferences
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | Properties of the configuration profile preference. | ConfigurationProfilePreferenceProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Automanage/configurationProfilePreferences@2020-06-30-preview" |
ConfigurationProfilePreferenceAntiMalware
| Name | Description | Value |
|---|---|---|
| enableRealTimeProtection | Enables or disables Real Time Protection | 'False' 'True' |
| exclusions | Extensions, Paths and Processes that must be excluded from scan | any |
| runScheduledScan | Enables or disables a periodic scan for antimalware | 'False' 'True' |
| scanDay | Schedule scan settings day | string |
| scanTimeInMinutes | Schedule scan settings time | string |
| scanType | Type of scheduled scan | 'Full' 'Quick' |
ConfigurationProfilePreferenceProperties
| Name | Description | Value |
|---|---|---|
| antiMalware | The custom preferences for Azure Antimalware. | ConfigurationProfilePreferenceAntiMalware |
| vmBackup | The custom preferences for Azure VM Backup. | ConfigurationProfilePreferenceVmBackup |
ConfigurationProfilePreferenceVmBackup
| Name | Description | Value |
|---|---|---|
| instantRpRetentionRangeInDays | Instant RP retention policy range in days | int |
| retentionPolicy | Retention policy with the details on backup copy retention ranges. | string |
| schedulePolicy | Backup schedule specified as part of backup policy. | string |
| timeZone | TimeZone optional input as string. For example: Pacific Standard Time | string |
TrackedResourceTags
| Name | Description | Value |
|---|