1. Packages
  2. Azure Native
  3. API Docs
  4. networkcloud
  5. MetricsConfiguration
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi

azure-native.networkcloud.MetricsConfiguration

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi

    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.

    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" },
            },
        });
    
    });
    
    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
    	})
    }
    
    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());
    
        }
    }
    
    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",
        })
    
    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",
        },
    });
    
    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
    

    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 string
    The unique name of the resource.
    args MetricsConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args MetricsConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetricsConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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 = new AzureNative.NetworkCloud.Inputs.ExtendedLocationArgs
        {
            Name = "string",
            Type = "string",
        },
        ResourceGroupName = "string",
        EnabledMetrics = new[]
        {
            "string",
        },
        Location = "string",
        MetricsConfigurationName = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := networkcloud.NewMetricsConfiguration(ctx, "metricsConfigurationResource", &networkcloud.MetricsConfigurationArgs{
    	ClusterName:        pulumi.String("string"),
    	CollectionInterval: pulumi.Float64(0),
    	ExtendedLocation: &networkcloud.ExtendedLocationArgs{
    		Name: pulumi.String("string"),
    		Type: pulumi.String("string"),
    	},
    	ResourceGroupName: pulumi.String("string"),
    	EnabledMetrics: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Location:                 pulumi.String("string"),
    	MetricsConfigurationName: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var metricsConfigurationResource = new MetricsConfiguration("metricsConfigurationResource", MetricsConfigurationArgs.builder()
        .clusterName("string")
        .collectionInterval(0)
        .extendedLocation(ExtendedLocationArgs.builder()
            .name("string")
            .type("string")
            .build())
        .resourceGroupName("string")
        .enabledMetrics("string")
        .location("string")
        .metricsConfigurationName("string")
        .tags(Map.of("string", "string"))
        .build());
    
    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",
        })
    
    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",
        },
    });
    
    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
    

    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

    The MetricsConfiguration resource accepts the following input properties:

    ClusterName string
    The name of the cluster.
    CollectionInterval double
    The interval in minutes by which metrics will be collected.
    ExtendedLocation Pulumi.AzureNative.NetworkCloud.Inputs.ExtendedLocation
    The extended location of the cluster associated with the resource.
    ResourceGroupName 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 string
    The geo-location where the resource lives
    MetricsConfigurationName string
    The name of the metrics configuration for the cluster.
    Tags Dictionary<string, string>
    Resource tags.
    ClusterName string
    The name of the cluster.
    CollectionInterval float64
    The interval in minutes by which metrics will be collected.
    ExtendedLocation ExtendedLocationArgs
    The extended location of the cluster associated with the resource.
    ResourceGroupName 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 string
    The geo-location where the resource lives
    MetricsConfigurationName string
    The name of the metrics configuration for the cluster.
    Tags map[string]string
    Resource tags.
    clusterName String
    The name of the cluster.
    collectionInterval Double
    The interval in minutes by which metrics will be collected.
    extendedLocation ExtendedLocation
    The extended location of the cluster associated with the resource.
    resourceGroupName 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 String
    The geo-location where the resource lives
    metricsConfigurationName String
    The name of the metrics configuration for the cluster.
    tags Map<String,String>
    Resource tags.
    clusterName string
    The name of the cluster.
    collectionInterval number
    The interval in minutes by which metrics will be collected.
    extendedLocation ExtendedLocation
    The extended location of the cluster associated with the resource.
    resourceGroupName 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 string
    The geo-location where the resource lives
    metricsConfigurationName string
    The name of the metrics configuration for the cluster.
    tags {[key: string]: string}
    Resource tags.
    cluster_name str
    The name of the cluster.
    collection_interval float
    The interval in minutes by which metrics will be collected.
    extended_location ExtendedLocationArgs
    The extended location of the cluster associated with the resource.
    resource_group_name 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 str
    The geo-location where the resource lives
    metrics_configuration_name str
    The name of the metrics configuration for the cluster.
    tags Mapping[str, str]
    Resource tags.
    clusterName String
    The name of the cluster.
    collectionInterval Number
    The interval in minutes by which metrics will be collected.
    extendedLocation Property Map
    The extended location of the cluster associated with the resource.
    resourceGroupName 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 String
    The geo-location where the resource lives
    metricsConfigurationName 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 string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type String
    The extended location type, for example, CustomLocation.
    name string
    The resource ID of the extended location on which the resource will be created.
    type string
    The extended location type, for example, CustomLocation.
    name str
    The resource ID of the extended location on which the resource will be created.
    type str
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type String
    The extended location type, for example, CustomLocation.

    ExtendedLocationResponse, ExtendedLocationResponseArgs

    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    Name string
    The resource ID of the extended location on which the resource will be created.
    Type string
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type String
    The extended location type, for example, CustomLocation.
    name string
    The resource ID of the extended location on which the resource will be created.
    type string
    The extended location type, for example, CustomLocation.
    name str
    The resource ID of the extended location on which the resource will be created.
    type str
    The extended location type, for example, CustomLocation.
    name String
    The resource ID of the extended location on which the resource will be created.
    type 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} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi