Share via

ClusterMetricsConfiguration interface

  • Reference
Package:
@azure/arm-networkcloud

ClusterMetricsConfiguration represents the metrics configuration of an on-premises Network Cloud cluster.

Extends
TrackedResource

Properties

collectionInterval

The interval in minutes by which metrics will be collected.
detailedStatus

The more detailed status of the metrics configuration. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.
disabledMetrics

The list of metrics that are available for the cluster but disabled at the moment. NOTE: This property will not be serialized. It can only be populated by the server.
enabledMetrics

The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
extendedLocation

The extended location of the cluster associated with the resource.
provisioningState

The provisioning state of the metrics configuration. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

collectionInterval

The interval in minutes by which metrics will be collected.

collectionInterval: number

Property Value

number

detailedStatus

The more detailed status of the metrics configuration. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatusMessage?: string

Property Value

string

disabledMetrics

The list of metrics that are available for the cluster but disabled at the moment. NOTE: This property will not be serialized. It can only be populated by the server.

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[]

extendedLocation

The extended location of the cluster associated with the resource.

extendedLocation: ExtendedLocation

Property Value

ExtendedLocation

provisioningState

The provisioning state of the metrics configuration. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type