1. Packages
  2. Dynatrace
  3. API Docs
  4. MetricMetadata
Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse

dynatrace.MetricMetadata

Explore with Pulumi AI

dynatrace logo
Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse

    Create MetricMetadata Resource

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

    Constructor syntax

    new MetricMetadata(name: string, args: MetricMetadataArgs, opts?: CustomResourceOptions);
    @overload
    def MetricMetadata(resource_name: str,
                       args: MetricMetadataArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def MetricMetadata(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       metric_id: Optional[str] = None,
                       unit: Optional[str] = None,
                       description: Optional[str] = None,
                       dimensions: Optional[MetricMetadataDimensionsArgs] = None,
                       display_name: Optional[str] = None,
                       metric_properties: Optional[MetricMetadataMetricPropertiesArgs] = None,
                       source_entity_type: Optional[str] = None,
                       tags: Optional[Sequence[str]] = None,
                       unit_display_format: Optional[str] = None)
    func NewMetricMetadata(ctx *Context, name string, args MetricMetadataArgs, opts ...ResourceOption) (*MetricMetadata, error)
    public MetricMetadata(string name, MetricMetadataArgs args, CustomResourceOptions? opts = null)
    public MetricMetadata(String name, MetricMetadataArgs args)
    public MetricMetadata(String name, MetricMetadataArgs args, CustomResourceOptions options)
    
    type: dynatrace:MetricMetadata
    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 MetricMetadataArgs
    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 MetricMetadataArgs
    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 MetricMetadataArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetricMetadataArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MetricMetadataArgs
    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 metricMetadataResource = new Dynatrace.MetricMetadata("metricMetadataResource", new()
    {
        MetricId = "string",
        Unit = "string",
        Description = "string",
        Dimensions = new Dynatrace.Inputs.MetricMetadataDimensionsArgs
        {
            Dimensions = new[]
            {
                new Dynatrace.Inputs.MetricMetadataDimensionsDimensionArgs
                {
                    Key = "string",
                    DisplayName = "string",
                },
            },
        },
        DisplayName = "string",
        MetricProperties = new Dynatrace.Inputs.MetricMetadataMetricPropertiesArgs
        {
            ValueType = "string",
            ImpactRelevant = false,
            Latency = 0,
            MaxValue = 0,
            MinValue = 0,
            RootCauseRelevant = false,
        },
        SourceEntityType = "string",
        Tags = new[]
        {
            "string",
        },
        UnitDisplayFormat = "string",
    });
    
    example, err := dynatrace.NewMetricMetadata(ctx, "metricMetadataResource", &dynatrace.MetricMetadataArgs{
    	MetricId:    pulumi.String("string"),
    	Unit:        pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Dimensions: &dynatrace.MetricMetadataDimensionsArgs{
    		Dimensions: dynatrace.MetricMetadataDimensionsDimensionArray{
    			&dynatrace.MetricMetadataDimensionsDimensionArgs{
    				Key:         pulumi.String("string"),
    				DisplayName: pulumi.String("string"),
    			},
    		},
    	},
    	DisplayName: pulumi.String("string"),
    	MetricProperties: &dynatrace.MetricMetadataMetricPropertiesArgs{
    		ValueType:         pulumi.String("string"),
    		ImpactRelevant:    pulumi.Bool(false),
    		Latency:           pulumi.Int(0),
    		MaxValue:          pulumi.Float64(0),
    		MinValue:          pulumi.Float64(0),
    		RootCauseRelevant: pulumi.Bool(false),
    	},
    	SourceEntityType: pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	UnitDisplayFormat: pulumi.String("string"),
    })
    
    var metricMetadataResource = new MetricMetadata("metricMetadataResource", MetricMetadataArgs.builder()
        .metricId("string")
        .unit("string")
        .description("string")
        .dimensions(MetricMetadataDimensionsArgs.builder()
            .dimensions(MetricMetadataDimensionsDimensionArgs.builder()
                .key("string")
                .displayName("string")
                .build())
            .build())
        .displayName("string")
        .metricProperties(MetricMetadataMetricPropertiesArgs.builder()
            .valueType("string")
            .impactRelevant(false)
            .latency(0)
            .maxValue(0)
            .minValue(0)
            .rootCauseRelevant(false)
            .build())
        .sourceEntityType("string")
        .tags("string")
        .unitDisplayFormat("string")
        .build());
    
    metric_metadata_resource = dynatrace.MetricMetadata("metricMetadataResource",
        metric_id="string",
        unit="string",
        description="string",
        dimensions={
            "dimensions": [{
                "key": "string",
                "display_name": "string",
            }],
        },
        display_name="string",
        metric_properties={
            "value_type": "string",
            "impact_relevant": False,
            "latency": 0,
            "max_value": 0,
            "min_value": 0,
            "root_cause_relevant": False,
        },
        source_entity_type="string",
        tags=["string"],
        unit_display_format="string")
    
    const metricMetadataResource = new dynatrace.MetricMetadata("metricMetadataResource", {
        metricId: "string",
        unit: "string",
        description: "string",
        dimensions: {
            dimensions: [{
                key: "string",
                displayName: "string",
            }],
        },
        displayName: "string",
        metricProperties: {
            valueType: "string",
            impactRelevant: false,
            latency: 0,
            maxValue: 0,
            minValue: 0,
            rootCauseRelevant: false,
        },
        sourceEntityType: "string",
        tags: ["string"],
        unitDisplayFormat: "string",
    });
    
    type: dynatrace:MetricMetadata
    properties:
        description: string
        dimensions:
            dimensions:
                - displayName: string
                  key: string
        displayName: string
        metricId: string
        metricProperties:
            impactRelevant: false
            latency: 0
            maxValue: 0
            minValue: 0
            rootCauseRelevant: false
            valueType: string
        sourceEntityType: string
        tags:
            - string
        unit: string
        unitDisplayFormat: string
    

    MetricMetadata 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 MetricMetadata resource accepts the following input properties:

    MetricId string
    The scope of this setting (metric)
    Unit string
    Unit
    Description string
    Description
    Dimensions Pulumiverse.Dynatrace.Inputs.MetricMetadataDimensions
    Define metadata per metric dimension.
    DisplayName string
    Display name
    MetricProperties Pulumiverse.Dynatrace.Inputs.MetricMetadataMetricProperties
    Metric properties
    SourceEntityType string
    Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.
    Tags List<string>
    Tags
    UnitDisplayFormat string
    The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:
    MetricId string
    The scope of this setting (metric)
    Unit string
    Unit
    Description string
    Description
    Dimensions MetricMetadataDimensionsArgs
    Define metadata per metric dimension.
    DisplayName string
    Display name
    MetricProperties MetricMetadataMetricPropertiesArgs
    Metric properties
    SourceEntityType string
    Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.
    Tags []string
    Tags
    UnitDisplayFormat string
    The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:
    metricId String
    The scope of this setting (metric)
    unit String
    Unit
    description String
    Description
    dimensions MetricMetadataDimensions
    Define metadata per metric dimension.
    displayName String
    Display name
    metricProperties MetricMetadataMetricProperties
    Metric properties
    sourceEntityType String
    Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.
    tags List<String>
    Tags
    unitDisplayFormat String
    The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:
    metricId string
    The scope of this setting (metric)
    unit string
    Unit
    description string
    Description
    dimensions MetricMetadataDimensions
    Define metadata per metric dimension.
    displayName string
    Display name
    metricProperties MetricMetadataMetricProperties
    Metric properties
    sourceEntityType string
    Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.
    tags string[]
    Tags
    unitDisplayFormat string
    The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:
    metric_id str
    The scope of this setting (metric)
    unit str
    Unit
    description str
    Description
    dimensions MetricMetadataDimensionsArgs
    Define metadata per metric dimension.
    display_name str
    Display name
    metric_properties MetricMetadataMetricPropertiesArgs
    Metric properties
    source_entity_type str
    Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.
    tags Sequence[str]
    Tags
    unit_display_format str
    The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:
    metricId String
    The scope of this setting (metric)
    unit String
    Unit
    description String
    Description
    dimensions Property Map
    Define metadata per metric dimension.
    displayName String
    Display name
    metricProperties Property Map
    Metric properties
    sourceEntityType String
    Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.
    tags List<String>
    Tags
    unitDisplayFormat String
    The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing MetricMetadata Resource

    Get an existing MetricMetadata resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MetricMetadataState, opts?: CustomResourceOptions): MetricMetadata
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            dimensions: Optional[MetricMetadataDimensionsArgs] = None,
            display_name: Optional[str] = None,
            metric_id: Optional[str] = None,
            metric_properties: Optional[MetricMetadataMetricPropertiesArgs] = None,
            source_entity_type: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            unit: Optional[str] = None,
            unit_display_format: Optional[str] = None) -> MetricMetadata
    func GetMetricMetadata(ctx *Context, name string, id IDInput, state *MetricMetadataState, opts ...ResourceOption) (*MetricMetadata, error)
    public static MetricMetadata Get(string name, Input<string> id, MetricMetadataState? state, CustomResourceOptions? opts = null)
    public static MetricMetadata get(String name, Output<String> id, MetricMetadataState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description
    Dimensions Pulumiverse.Dynatrace.Inputs.MetricMetadataDimensions
    Define metadata per metric dimension.
    DisplayName string
    Display name
    MetricId string
    The scope of this setting (metric)
    MetricProperties Pulumiverse.Dynatrace.Inputs.MetricMetadataMetricProperties
    Metric properties
    SourceEntityType string
    Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.
    Tags List<string>
    Tags
    Unit string
    Unit
    UnitDisplayFormat string
    The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:
    Description string
    Description
    Dimensions MetricMetadataDimensionsArgs
    Define metadata per metric dimension.
    DisplayName string
    Display name
    MetricId string
    The scope of this setting (metric)
    MetricProperties MetricMetadataMetricPropertiesArgs
    Metric properties
    SourceEntityType string
    Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.
    Tags []string
    Tags
    Unit string
    Unit
    UnitDisplayFormat string
    The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:
    description String
    Description
    dimensions MetricMetadataDimensions
    Define metadata per metric dimension.
    displayName String
    Display name
    metricId String
    The scope of this setting (metric)
    metricProperties MetricMetadataMetricProperties
    Metric properties
    sourceEntityType String
    Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.
    tags List<String>
    Tags
    unit String
    Unit
    unitDisplayFormat String
    The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:
    description string
    Description
    dimensions MetricMetadataDimensions
    Define metadata per metric dimension.
    displayName string
    Display name
    metricId string
    The scope of this setting (metric)
    metricProperties MetricMetadataMetricProperties
    Metric properties
    sourceEntityType string
    Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.
    tags string[]
    Tags
    unit string
    Unit
    unitDisplayFormat string
    The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:
    description str
    Description
    dimensions MetricMetadataDimensionsArgs
    Define metadata per metric dimension.
    display_name str
    Display name
    metric_id str
    The scope of this setting (metric)
    metric_properties MetricMetadataMetricPropertiesArgs
    Metric properties
    source_entity_type str
    Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.
    tags Sequence[str]
    Tags
    unit str
    Unit
    unit_display_format str
    The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:
    description String
    Description
    dimensions Property Map
    Define metadata per metric dimension.
    displayName String
    Display name
    metricId String
    The scope of this setting (metric)
    metricProperties Property Map
    Metric properties
    sourceEntityType String
    Specifies which entity dimension should be used as the primary dimension. The property can only be configured for metrics ingested with the Metrics API.
    tags List<String>
    Tags
    unit String
    Unit
    unitDisplayFormat String
    The raw value is stored in bits or bytes. The user interface can display it in these numeral systems:

    Supporting Types

    MetricMetadataDimensions, MetricMetadataDimensionsArgs

    MetricMetadataDimensionsDimension, MetricMetadataDimensionsDimensionArgs

    Key string
    Dimension key
    DisplayName string
    Display name
    Key string
    Dimension key
    DisplayName string
    Display name
    key String
    Dimension key
    displayName String
    Display name
    key string
    Dimension key
    displayName string
    Display name
    key str
    Dimension key
    display_name str
    Display name
    key String
    Dimension key
    displayName String
    Display name

    MetricMetadataMetricProperties, MetricMetadataMetricPropertiesArgs

    ValueType string
    Possible Values: Error, Score, Unknown
    ImpactRelevant bool
    Whether (true or false) the metric is relevant to a problem's impact.
    Latency int

    The latency of the metric, in minutes.

    The latency is the expected reporting delay (for example, caused by constraints of cloud vendors or other third-party data sources) between the observation of a metric data point and its availability in Dynatrace.

    The allowed value range is from 1 to 60 minutes.

    MaxValue double
    The maximum allowed value of the metric.
    MinValue double
    The minimum allowed value of the metric.
    RootCauseRelevant bool

    Whether (true or false) the metric is related to a root cause of a problem.

    A root-cause relevant metric represents a strong indicator for a faulty component.

    ValueType string
    Possible Values: Error, Score, Unknown
    ImpactRelevant bool
    Whether (true or false) the metric is relevant to a problem's impact.
    Latency int

    The latency of the metric, in minutes.

    The latency is the expected reporting delay (for example, caused by constraints of cloud vendors or other third-party data sources) between the observation of a metric data point and its availability in Dynatrace.

    The allowed value range is from 1 to 60 minutes.

    MaxValue float64
    The maximum allowed value of the metric.
    MinValue float64
    The minimum allowed value of the metric.
    RootCauseRelevant bool

    Whether (true or false) the metric is related to a root cause of a problem.

    A root-cause relevant metric represents a strong indicator for a faulty component.

    valueType String
    Possible Values: Error, Score, Unknown
    impactRelevant Boolean
    Whether (true or false) the metric is relevant to a problem's impact.
    latency Integer

    The latency of the metric, in minutes.

    The latency is the expected reporting delay (for example, caused by constraints of cloud vendors or other third-party data sources) between the observation of a metric data point and its availability in Dynatrace.

    The allowed value range is from 1 to 60 minutes.

    maxValue Double
    The maximum allowed value of the metric.
    minValue Double
    The minimum allowed value of the metric.
    rootCauseRelevant Boolean

    Whether (true or false) the metric is related to a root cause of a problem.

    A root-cause relevant metric represents a strong indicator for a faulty component.

    valueType string
    Possible Values: Error, Score, Unknown
    impactRelevant boolean
    Whether (true or false) the metric is relevant to a problem's impact.
    latency number

    The latency of the metric, in minutes.

    The latency is the expected reporting delay (for example, caused by constraints of cloud vendors or other third-party data sources) between the observation of a metric data point and its availability in Dynatrace.

    The allowed value range is from 1 to 60 minutes.

    maxValue number
    The maximum allowed value of the metric.
    minValue number
    The minimum allowed value of the metric.
    rootCauseRelevant boolean

    Whether (true or false) the metric is related to a root cause of a problem.

    A root-cause relevant metric represents a strong indicator for a faulty component.

    value_type str
    Possible Values: Error, Score, Unknown
    impact_relevant bool
    Whether (true or false) the metric is relevant to a problem's impact.
    latency int

    The latency of the metric, in minutes.

    The latency is the expected reporting delay (for example, caused by constraints of cloud vendors or other third-party data sources) between the observation of a metric data point and its availability in Dynatrace.

    The allowed value range is from 1 to 60 minutes.

    max_value float
    The maximum allowed value of the metric.
    min_value float
    The minimum allowed value of the metric.
    root_cause_relevant bool

    Whether (true or false) the metric is related to a root cause of a problem.

    A root-cause relevant metric represents a strong indicator for a faulty component.

    valueType String
    Possible Values: Error, Score, Unknown
    impactRelevant Boolean
    Whether (true or false) the metric is relevant to a problem's impact.
    latency Number

    The latency of the metric, in minutes.

    The latency is the expected reporting delay (for example, caused by constraints of cloud vendors or other third-party data sources) between the observation of a metric data point and its availability in Dynatrace.

    The allowed value range is from 1 to 60 minutes.

    maxValue Number
    The maximum allowed value of the metric.
    minValue Number
    The minimum allowed value of the metric.
    rootCauseRelevant Boolean

    Whether (true or false) the metric is related to a root cause of a problem.

    A root-cause relevant metric represents a strong indicator for a faulty component.

    Package Details

    Repository
    dynatrace pulumiverse/pulumi-dynatrace
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dynatrace Terraform Provider.
    dynatrace logo
    Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse