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 clusters/metricsConfigurations 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.NetworkCloud/clusters/metricsConfigurations resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.NetworkCloud/clusters/metricsConfigurations@2026-01-01-preview' = {
parent: resourceSymbolicName
extendedLocation: {
name: 'string'
type: 'string'
}
location: 'string'
name: 'string'
properties: {
collectionInterval: int
enabledMetrics: [
'string'
]
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.NetworkCloud/clusters/metricsConfigurations
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extended location of the resource. This property is required when creating the resource. | AzureResourceManagerCommonTypesExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^default$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: clusters |
| properties | The list of the resource properties. | ClusterMetricsConfigurationProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AzureResourceManagerCommonTypesExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string (required) |
| type | The type of the extended location. | 'CustomLocation' 'EdgeZone' (required) |
ClusterMetricsConfigurationProperties
| Name | Description | Value |
|---|---|---|
| collectionInterval | The interval in minutes by which metrics will be collected. | int Constraints: Min value = 1 Max value = 1440 (required) |
| enabledMetrics | The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. | string[] |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The clusters/metricsConfigurations 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.
Usage Examples
Resource format
To create a Microsoft.NetworkCloud/clusters/metricsConfigurations resource, add the following JSON to your template.
{
"type": "Microsoft.NetworkCloud/clusters/metricsConfigurations",
"apiVersion": "2026-01-01-preview",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"location": "string",
"properties": {
"collectionInterval": "int",
"enabledMetrics": [ "string" ]
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.NetworkCloud/clusters/metricsConfigurations
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-01-01-preview' |
| extendedLocation | The extended location of the resource. This property is required when creating the resource. | AzureResourceManagerCommonTypesExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^default$ (required) |
| properties | The list of the resource properties. | ClusterMetricsConfigurationProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.NetworkCloud/clusters/metricsConfigurations' |
AzureResourceManagerCommonTypesExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string (required) |
| type | The type of the extended location. | 'CustomLocation' 'EdgeZone' (required) |
ClusterMetricsConfigurationProperties
| Name | Description | Value |
|---|---|---|
| collectionInterval | The interval in minutes by which metrics will be collected. | int Constraints: Min value = 1 Max value = 1440 (required) |
| enabledMetrics | The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. | string[] |
TrackedResourceTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The clusters/metricsConfigurations 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.NetworkCloud/clusters/metricsConfigurations resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NetworkCloud/clusters/metricsConfigurations@2026-01-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
extendedLocation = {
name = "string"
type = "string"
}
properties = {
collectionInterval = int
enabledMetrics = [
"string"
]
}
}
}
Property Values
Microsoft.NetworkCloud/clusters/metricsConfigurations
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extended location of the resource. This property is required when creating the resource. | AzureResourceManagerCommonTypesExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^default$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: clusters |
| properties | The list of the resource properties. | ClusterMetricsConfigurationProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.NetworkCloud/clusters/metricsConfigurations@2026-01-01-preview" |
AzureResourceManagerCommonTypesExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string (required) |
| type | The type of the extended location. | 'CustomLocation' 'EdgeZone' (required) |
ClusterMetricsConfigurationProperties
| Name | Description | Value |
|---|---|---|
| collectionInterval | The interval in minutes by which metrics will be collected. | int Constraints: Min value = 1 Max value = 1440 (required) |
| enabledMetrics | The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. | string[] |
TrackedResourceTags
| Name | Description | Value |
|---|