Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. networkcloud
  5. MetricsConfiguration
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.networkcloud.MetricsConfiguration

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Azure REST API version: 2023-10-01-preview. Prior API version in Azure Native 1.x: 2022-12-12-preview.

Other available API versions: 2023-07-01, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview.

Example Usage

Create or update metrics configuration of cluster

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var metricsConfiguration = new AzureNative.NetworkCloud.MetricsConfiguration("metricsConfiguration", new()
    {
        ClusterName = "clusterName",
        CollectionInterval = 15,
        EnabledMetrics = new[]
        {
            "metric1",
            "metric2",
        },
        ExtendedLocation = new AzureNative.NetworkCloud.Inputs.ExtendedLocationArgs
        {
            Name = "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
            Type = "CustomLocation",
        },
        Location = "location",
        MetricsConfigurationName = "default",
        ResourceGroupName = "resourceGroupName",
        Tags = 
        {
            { "key1", "myvalue1" },
            { "key2", "myvalue2" },
        },
    });

});
Copy
package main

import (
	networkcloud "github.com/pulumi/pulumi-azure-native-sdk/networkcloud/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkcloud.NewMetricsConfiguration(ctx, "metricsConfiguration", &networkcloud.MetricsConfigurationArgs{
			ClusterName:        pulumi.String("clusterName"),
			CollectionInterval: pulumi.Float64(15),
			EnabledMetrics: pulumi.StringArray{
				pulumi.String("metric1"),
				pulumi.String("metric2"),
			},
			ExtendedLocation: &networkcloud.ExtendedLocationArgs{
				Name: pulumi.String("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"),
				Type: pulumi.String("CustomLocation"),
			},
			Location:                 pulumi.String("location"),
			MetricsConfigurationName: pulumi.String("default"),
			ResourceGroupName:        pulumi.String("resourceGroupName"),
			Tags: pulumi.StringMap{
				"key1": pulumi.String("myvalue1"),
				"key2": pulumi.String("myvalue2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.networkcloud.MetricsConfiguration;
import com.pulumi.azurenative.networkcloud.MetricsConfigurationArgs;
import com.pulumi.azurenative.networkcloud.inputs.ExtendedLocationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var metricsConfiguration = new MetricsConfiguration("metricsConfiguration", MetricsConfigurationArgs.builder()
            .clusterName("clusterName")
            .collectionInterval(15)
            .enabledMetrics(            
                "metric1",
                "metric2")
            .extendedLocation(ExtendedLocationArgs.builder()
                .name("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName")
                .type("CustomLocation")
                .build())
            .location("location")
            .metricsConfigurationName("default")
            .resourceGroupName("resourceGroupName")
            .tags(Map.ofEntries(
                Map.entry("key1", "myvalue1"),
                Map.entry("key2", "myvalue2")
            ))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const metricsConfiguration = new azure_native.networkcloud.MetricsConfiguration("metricsConfiguration", {
    clusterName: "clusterName",
    collectionInterval: 15,
    enabledMetrics: [
        "metric1",
        "metric2",
    ],
    extendedLocation: {
        name: "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
        type: "CustomLocation",
    },
    location: "location",
    metricsConfigurationName: "default",
    resourceGroupName: "resourceGroupName",
    tags: {
        key1: "myvalue1",
        key2: "myvalue2",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

metrics_configuration = azure_native.networkcloud.MetricsConfiguration("metricsConfiguration",
    cluster_name="clusterName",
    collection_interval=15,
    enabled_metrics=[
        "metric1",
        "metric2",
    ],
    extended_location={
        "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
        "type": "CustomLocation",
    },
    location="location",
    metrics_configuration_name="default",
    resource_group_name="resourceGroupName",
    tags={
        "key1": "myvalue1",
        "key2": "myvalue2",
    })
Copy
resources:
  metricsConfiguration:
    type: azure-native:networkcloud:MetricsConfiguration
    properties:
      clusterName: clusterName
      collectionInterval: 15
      enabledMetrics:
        - metric1
        - metric2
      extendedLocation:
        name: /subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName
        type: CustomLocation
      location: location
      metricsConfigurationName: default
      resourceGroupName: resourceGroupName
      tags:
        key1: myvalue1
        key2: myvalue2
Copy

Create MetricsConfiguration Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MetricsConfiguration(name: string, args: MetricsConfigurationArgs, opts?: CustomResourceOptions);
@overload
def MetricsConfiguration(resource_name: str,
                         args: MetricsConfigurationArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def MetricsConfiguration(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         cluster_name: Optional[str] = None,
                         collection_interval: Optional[float] = None,
                         extended_location: Optional[ExtendedLocationArgs] = None,
                         resource_group_name: Optional[str] = None,
                         enabled_metrics: Optional[Sequence[str]] = None,
                         location: Optional[str] = None,
                         metrics_configuration_name: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None)
func NewMetricsConfiguration(ctx *Context, name string, args MetricsConfigurationArgs, opts ...ResourceOption) (*MetricsConfiguration, error)
public MetricsConfiguration(string name, MetricsConfigurationArgs args, CustomResourceOptions? opts = null)
public MetricsConfiguration(String name, MetricsConfigurationArgs args)
public MetricsConfiguration(String name, MetricsConfigurationArgs args, CustomResourceOptions options)

type: azure-native:networkcloud:MetricsConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MetricsConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MetricsConfigurationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MetricsConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MetricsConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MetricsConfigurationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var metricsConfigurationResource = new AzureNative.Networkcloud.MetricsConfiguration("metricsConfigurationResource", new()
{
    ClusterName = "string",
    CollectionInterval = 0,
    ExtendedLocation = 
    {
        { "name", "string" },
        { "type", "string" },
    },
    ResourceGroupName = "string",
    EnabledMetrics = new[]
    {
        "string",
    },
    Location = "string",
    MetricsConfigurationName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := networkcloud.NewMetricsConfiguration(ctx, "metricsConfigurationResource", &networkcloud.MetricsConfigurationArgs{
	ClusterName:        "string",
	CollectionInterval: 0,
	ExtendedLocation: map[string]interface{}{
		"name": "string",
		"type": "string",
	},
	ResourceGroupName: "string",
	EnabledMetrics: []string{
		"string",
	},
	Location:                 "string",
	MetricsConfigurationName: "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})
Copy
var metricsConfigurationResource = new MetricsConfiguration("metricsConfigurationResource", MetricsConfigurationArgs.builder()
    .clusterName("string")
    .collectionInterval(0)
    .extendedLocation(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceGroupName("string")
    .enabledMetrics("string")
    .location("string")
    .metricsConfigurationName("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());
Copy
metrics_configuration_resource = azure_native.networkcloud.MetricsConfiguration("metricsConfigurationResource",
    cluster_name=string,
    collection_interval=0,
    extended_location={
        name: string,
        type: string,
    },
    resource_group_name=string,
    enabled_metrics=[string],
    location=string,
    metrics_configuration_name=string,
    tags={
        string: string,
    })
Copy
const metricsConfigurationResource = new azure_native.networkcloud.MetricsConfiguration("metricsConfigurationResource", {
    clusterName: "string",
    collectionInterval: 0,
    extendedLocation: {
        name: "string",
        type: "string",
    },
    resourceGroupName: "string",
    enabledMetrics: ["string"],
    location: "string",
    metricsConfigurationName: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:networkcloud:MetricsConfiguration
properties:
    clusterName: string
    collectionInterval: 0
    enabledMetrics:
        - string
    extendedLocation:
        name: string
        type: string
    location: string
    metricsConfigurationName: string
    resourceGroupName: string
    tags:
        string: string
Copy

MetricsConfiguration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The MetricsConfiguration resource accepts the following input properties:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
CollectionInterval This property is required. double
The interval in minutes by which metrics will be collected.
ExtendedLocation This property is required. Pulumi.AzureNative.NetworkCloud.Inputs.ExtendedLocation
The extended location of the cluster associated with the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
EnabledMetrics List<string>
The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
MetricsConfigurationName Changes to this property will trigger replacement. string
The name of the metrics configuration for the cluster.
Tags Dictionary<string, string>
Resource tags.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
CollectionInterval This property is required. float64
The interval in minutes by which metrics will be collected.
ExtendedLocation This property is required. ExtendedLocationArgs
The extended location of the cluster associated with the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
EnabledMetrics []string
The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
MetricsConfigurationName Changes to this property will trigger replacement. string
The name of the metrics configuration for the cluster.
Tags map[string]string
Resource tags.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
collectionInterval This property is required. Double
The interval in minutes by which metrics will be collected.
extendedLocation This property is required. ExtendedLocation
The extended location of the cluster associated with the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
enabledMetrics List<String>
The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
metricsConfigurationName Changes to this property will trigger replacement. String
The name of the metrics configuration for the cluster.
tags Map<String,String>
Resource tags.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
collectionInterval This property is required. number
The interval in minutes by which metrics will be collected.
extendedLocation This property is required. ExtendedLocation
The extended location of the cluster associated with the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
enabledMetrics string[]
The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
metricsConfigurationName Changes to this property will trigger replacement. string
The name of the metrics configuration for the cluster.
tags {[key: string]: string}
Resource tags.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the cluster.
collection_interval This property is required. float
The interval in minutes by which metrics will be collected.
extended_location This property is required. ExtendedLocationArgs
The extended location of the cluster associated with the resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
enabled_metrics Sequence[str]
The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
metrics_configuration_name Changes to this property will trigger replacement. str
The name of the metrics configuration for the cluster.
tags Mapping[str, str]
Resource tags.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
collectionInterval This property is required. Number
The interval in minutes by which metrics will be collected.
extendedLocation This property is required. Property Map
The extended location of the cluster associated with the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
enabledMetrics List<String>
The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
metricsConfigurationName Changes to this property will trigger replacement. String
The name of the metrics configuration for the cluster.
tags Map<String>
Resource tags.

Outputs

All input properties are implicitly available as output properties. Additionally, the MetricsConfiguration resource produces the following output properties:

DetailedStatus string
The more detailed status of the metrics configuration.
DetailedStatusMessage string
The descriptive message about the current detailed status.
DisabledMetrics List<string>
The list of metrics that are available for the cluster but disabled at the moment.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
The provisioning state of the metrics configuration.
SystemData Pulumi.AzureNative.NetworkCloud.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DetailedStatus string
The more detailed status of the metrics configuration.
DetailedStatusMessage string
The descriptive message about the current detailed status.
DisabledMetrics []string
The list of metrics that are available for the cluster but disabled at the moment.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
The provisioning state of the metrics configuration.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
detailedStatus String
The more detailed status of the metrics configuration.
detailedStatusMessage String
The descriptive message about the current detailed status.
disabledMetrics List<String>
The list of metrics that are available for the cluster but disabled at the moment.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
The provisioning state of the metrics configuration.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
detailedStatus string
The more detailed status of the metrics configuration.
detailedStatusMessage string
The descriptive message about the current detailed status.
disabledMetrics string[]
The list of metrics that are available for the cluster but disabled at the moment.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
The provisioning state of the metrics configuration.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
detailed_status str
The more detailed status of the metrics configuration.
detailed_status_message str
The descriptive message about the current detailed status.
disabled_metrics Sequence[str]
The list of metrics that are available for the cluster but disabled at the moment.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
The provisioning state of the metrics configuration.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
detailedStatus String
The more detailed status of the metrics configuration.
detailedStatusMessage String
The descriptive message about the current detailed status.
disabledMetrics List<String>
The list of metrics that are available for the cluster but disabled at the moment.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
The provisioning state of the metrics configuration.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

ExtendedLocation
, ExtendedLocationArgs

Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.
name This property is required. string
The resource ID of the extended location on which the resource will be created.
type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. str
The resource ID of the extended location on which the resource will be created.
type This property is required. str
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.

ExtendedLocationResponse
, ExtendedLocationResponseArgs

Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
Name This property is required. string
The resource ID of the extended location on which the resource will be created.
Type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.
name This property is required. string
The resource ID of the extended location on which the resource will be created.
type This property is required. string
The extended location type, for example, CustomLocation.
name This property is required. str
The resource ID of the extended location on which the resource will be created.
type This property is required. str
The extended location type, for example, CustomLocation.
name This property is required. String
The resource ID of the extended location on which the resource will be created.
type This property is required. String
The extended location type, for example, CustomLocation.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:networkcloud:MetricsConfiguration default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations/{metricsConfigurationName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native