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 monitors 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.Workloads/monitors resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Workloads/monitors@2024-02-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
appLocation: 'string'
appServicePlanConfiguration: {
capacity: int
tier: 'string'
}
logAnalyticsWorkspaceArmId: 'string'
managedResourceGroupConfiguration: {
name: 'string'
}
monitorSubnet: 'string'
routingPreference: 'string'
zoneRedundancyPreference: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Workloads/monitors
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-_]+$ (required) |
| properties | The resource-specific properties for this resource. | MonitorProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AppServicePlanConfiguration
| Name | Description | Value |
|---|---|---|
| capacity | The number of workers in app service plan. If this is not set or set to 0, auto scale will be configured for the app service plan, otherwise, instance count is set to this number. | int Constraints: Min value = 0 |
| tier | The App Service plan tier. | 'ElasticPremium' 'PremiumV3' |
ManagedResourceGroupConfiguration
| Name | Description | Value |
|---|---|---|
| name | Managed resource group name | string |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
MonitorProperties
| Name | Description | Value |
|---|---|---|
| appLocation | The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region. | string |
| appServicePlanConfiguration | App service plan configuration | AppServicePlanConfiguration |
| logAnalyticsWorkspaceArmId | The ARM ID of the Log Analytics Workspace that is used for SAP monitoring. | string |
| managedResourceGroupConfiguration | Managed resource group configuration | ManagedResourceGroupConfiguration |
| monitorSubnet | The subnet which the SAP monitor will be deployed in | string |
| routingPreference | Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET. | 'Default' 'RouteAll' |
| zoneRedundancyPreference | Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
ARM template resource definition
The monitors 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.Workloads/monitors resource, add the following JSON to your template.
{
"type": "Microsoft.Workloads/monitors",
"apiVersion": "2024-02-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"appLocation": "string",
"appServicePlanConfiguration": {
"capacity": "int",
"tier": "string"
},
"logAnalyticsWorkspaceArmId": "string",
"managedResourceGroupConfiguration": {
"name": "string"
},
"monitorSubnet": "string",
"routingPreference": "string",
"zoneRedundancyPreference": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Workloads/monitors
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-02-01-preview' |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-_]+$ (required) |
| properties | The resource-specific properties for this resource. | MonitorProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Workloads/monitors' |
AppServicePlanConfiguration
| Name | Description | Value |
|---|---|---|
| capacity | The number of workers in app service plan. If this is not set or set to 0, auto scale will be configured for the app service plan, otherwise, instance count is set to this number. | int Constraints: Min value = 0 |
| tier | The App Service plan tier. | 'ElasticPremium' 'PremiumV3' |
ManagedResourceGroupConfiguration
| Name | Description | Value |
|---|---|---|
| name | Managed resource group name | string |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
MonitorProperties
| Name | Description | Value |
|---|---|---|
| appLocation | The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region. | string |
| appServicePlanConfiguration | App service plan configuration | AppServicePlanConfiguration |
| logAnalyticsWorkspaceArmId | The ARM ID of the Log Analytics Workspace that is used for SAP monitoring. | string |
| managedResourceGroupConfiguration | Managed resource group configuration | ManagedResourceGroupConfiguration |
| monitorSubnet | The subnet which the SAP monitor will be deployed in | string |
| routingPreference | Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET. | 'Default' 'RouteAll' |
| zoneRedundancyPreference | Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The monitors 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.Workloads/monitors resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Workloads/monitors@2024-02-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
appLocation = "string"
appServicePlanConfiguration = {
capacity = int
tier = "string"
}
logAnalyticsWorkspaceArmId = "string"
managedResourceGroupConfiguration = {
name = "string"
}
monitorSubnet = "string"
routingPreference = "string"
zoneRedundancyPreference = "string"
}
}
}
Property Values
Microsoft.Workloads/monitors
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-_]+$ (required) |
| properties | The resource-specific properties for this resource. | MonitorProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Workloads/monitors@2024-02-01-preview" |
AppServicePlanConfiguration
| Name | Description | Value |
|---|---|---|
| capacity | The number of workers in app service plan. If this is not set or set to 0, auto scale will be configured for the app service plan, otherwise, instance count is set to this number. | int Constraints: Min value = 0 |
| tier | The App Service plan tier. | 'ElasticPremium' 'PremiumV3' |
ManagedResourceGroupConfiguration
| Name | Description | Value |
|---|---|---|
| name | Managed resource group name | string |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
MonitorProperties
| Name | Description | Value |
|---|---|---|
| appLocation | The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region. | string |
| appServicePlanConfiguration | App service plan configuration | AppServicePlanConfiguration |
| logAnalyticsWorkspaceArmId | The ARM ID of the Log Analytics Workspace that is used for SAP monitoring. | string |
| managedResourceGroupConfiguration | Managed resource group configuration | ManagedResourceGroupConfiguration |
| monitorSubnet | The subnet which the SAP monitor will be deployed in | string |
| routingPreference | Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET. | 'Default' 'RouteAll' |
| zoneRedundancyPreference | Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|