Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. networkcloud
  5. getMetricsConfiguration
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.networkcloud.getMetricsConfiguration

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get metrics configuration of the provided cluster.

    Uses Azure REST API version 2025-02-01.

    Other available API versions: 2023-10-01-preview, 2024-06-01-preview, 2024-07-01, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native networkcloud [ApiVersion]. See the version guide for details.

    Using getMetricsConfiguration

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getMetricsConfiguration(args: GetMetricsConfigurationArgs, opts?: InvokeOptions): Promise<GetMetricsConfigurationResult>
function getMetricsConfigurationOutput(args: GetMetricsConfigurationOutputArgs, opts?: InvokeOptions): Output<GetMetricsConfigurationResult>
    def get_metrics_configuration(cluster_name: Optional[str] = None,
                              metrics_configuration_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetMetricsConfigurationResult
def get_metrics_configuration_output(cluster_name: Optional[pulumi.Input[str]] = None,
                              metrics_configuration_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetMetricsConfigurationResult]
    func LookupMetricsConfiguration(ctx *Context, args *LookupMetricsConfigurationArgs, opts ...InvokeOption) (*LookupMetricsConfigurationResult, error)
func LookupMetricsConfigurationOutput(ctx *Context, args *LookupMetricsConfigurationOutputArgs, opts ...InvokeOption) LookupMetricsConfigurationResultOutput

    > Note: This function is named LookupMetricsConfiguration in the Go SDK.

    public static class GetMetricsConfiguration 
{
    public static Task<GetMetricsConfigurationResult> InvokeAsync(GetMetricsConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetMetricsConfigurationResult> Invoke(GetMetricsConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMetricsConfigurationResult> getMetricsConfiguration(GetMetricsConfigurationArgs args, InvokeOptions options)
public static Output<GetMetricsConfigurationResult> getMetricsConfiguration(GetMetricsConfigurationArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:networkcloud:getMetricsConfiguration
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterName string
    The name of the cluster.
    MetricsConfigurationName string
    The name of the metrics configuration for the cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ClusterName string
    The name of the cluster.
    MetricsConfigurationName string
    The name of the metrics configuration for the cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the cluster.
    metricsConfigurationName String
    The name of the metrics configuration for the cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    clusterName string
    The name of the cluster.
    metricsConfigurationName string
    The name of the metrics configuration for the cluster.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    cluster_name str
    The name of the cluster.
    metrics_configuration_name str
    The name of the metrics configuration for the cluster.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the cluster.
    metricsConfigurationName String
    The name of the metrics configuration for the cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getMetricsConfiguration Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    CollectionInterval double
    The interval in minutes by which metrics will be collected.
    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.
    Etag string
    Resource ETag.
    ExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    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"
    EnabledMetrics List<string>
    The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    CollectionInterval float64
    The interval in minutes by which metrics will be collected.
    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.
    Etag string
    Resource ETag.
    ExtendedLocation ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    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"
    EnabledMetrics []string
    The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    collectionInterval Double
    The interval in minutes by which metrics will be collected.
    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.
    etag String
    Resource ETag.
    extendedLocation ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    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"
    enabledMetrics List<String>
    The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    collectionInterval number
    The interval in minutes by which metrics will be collected.
    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.
    etag string
    Resource ETag.
    extendedLocation ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    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"
    enabledMetrics string[]
    The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    collection_interval float
    The interval in minutes by which metrics will be collected.
    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.
    etag str
    Resource ETag.
    extended_location ExtendedLocationResponse
    The extended location of the cluster associated with the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    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"
    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.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    collectionInterval Number
    The interval in minutes by which metrics will be collected.
    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.
    etag String
    Resource ETag.
    extendedLocation Property Map
    The extended location of the cluster associated with the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    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"
    enabledMetrics List<String>
    The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
    tags Map<String>
    Resource tags.

    Supporting Types

    ExtendedLocationResponse

    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

    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.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native