ClusterMetricsConfiguration interface
ClusterMetricsConfiguration represents the metrics configuration of an on-premises Network Cloud cluster.
- Extends
Properties
| collection |
The interval in minutes by which metrics will be collected. |
| detailed |
The more detailed status of the metrics configuration. |
| detailed |
The descriptive message about the current detailed status. |
| disabled |
The list of metrics that are available for the cluster but disabled at the moment. |
| enabled |
The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics. |
| etag | "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") |
| extended |
The extended location of the resource. This property is required when creating the resource. |
| provisioning |
The provisioning state of the metrics configuration. |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location | The geo-location where the resource lives |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| tags | Resource tags. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
collectionInterval
The interval in minutes by which metrics will be collected.
collectionInterval: numberProperty Value
number
detailedStatus
The more detailed status of the metrics configuration.
detailedStatus?: stringProperty Value
string
detailedStatusMessage
The descriptive message about the current detailed status.
detailedStatusMessage?: stringProperty Value
string
disabledMetrics
The list of metrics that are available for the cluster but disabled at the moment.
disabledMetrics?: string[]Property Value
string[]
enabledMetrics
The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
enabledMetrics?: string[]Property Value
string[]
etag
"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
etag?: stringProperty Value
string
extendedLocation
The extended location of the resource. This property is required when creating the resource.
extendedLocation: ExtendedLocationProperty Value
provisioningState
The provisioning state of the metrics configuration.
provisioningState?: stringProperty Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: stringProperty Value
string
Inherited From TrackedResource.id
location
The geo-location where the resource lives
location: stringProperty Value
string
Inherited From TrackedResource.location
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemDataProperty Value
Inherited From TrackedResource.systemData
tags
Resource tags.
tags?: Record<string, string>Property Value
Record<string, string>
Inherited From TrackedResource.tags
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: stringProperty Value
string
Inherited From TrackedResource.type