1. Packages
  2. Azure Native v1
  3. API Docs
  4. databoxedge
  5. MonitoringConfig
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

azure-native.databoxedge.MonitoringConfig

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

    The metric setting details for the role API Version: 2020-12-01.

    Example Usage

    PutMonitoringConfig

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var monitoringConfig = new AzureNative.DataBoxEdge.MonitoringConfig("monitoringConfig", new()
        {
            DeviceName = "testedgedevice",
            MetricConfigurations = new[]
            {
                new AzureNative.DataBoxEdge.Inputs.MetricConfigurationArgs
                {
                    CounterSets = new[]
                    {
                        new AzureNative.DataBoxEdge.Inputs.MetricCounterSetArgs
                        {
                            Counters = new[]
                            {
                                new AzureNative.DataBoxEdge.Inputs.MetricCounterArgs
                                {
                                    Name = "test",
                                },
                            },
                        },
                    },
                    MdmAccount = "test",
                    MetricNameSpace = "test",
                    ResourceId = "test",
                },
            },
            ResourceGroupName = "GroupForEdgeAutomation",
            RoleName = "testrole",
        });
    
    });
    
    package main
    
    import (
    	databoxedge "github.com/pulumi/pulumi-azure-native-sdk/databoxedge"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := databoxedge.NewMonitoringConfig(ctx, "monitoringConfig", &databoxedge.MonitoringConfigArgs{
    			DeviceName: pulumi.String("testedgedevice"),
    			MetricConfigurations: []databoxedge.MetricConfigurationArgs{
    				{
    					CounterSets: databoxedge.MetricCounterSetArray{
    						{
    							Counters: databoxedge.MetricCounterArray{
    								{
    									Name: pulumi.String("test"),
    								},
    							},
    						},
    					},
    					MdmAccount:      pulumi.String("test"),
    					MetricNameSpace: pulumi.String("test"),
    					ResourceId:      pulumi.String("test"),
    				},
    			},
    			ResourceGroupName: pulumi.String("GroupForEdgeAutomation"),
    			RoleName:          pulumi.String("testrole"),
    		})
    		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.databoxedge.MonitoringConfig;
    import com.pulumi.azurenative.databoxedge.MonitoringConfigArgs;
    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 monitoringConfig = new MonitoringConfig("monitoringConfig", MonitoringConfigArgs.builder()        
                .deviceName("testedgedevice")
                .metricConfigurations(Map.ofEntries(
                    Map.entry("counterSets", Map.of("counters", Map.of("name", "test"))),
                    Map.entry("mdmAccount", "test"),
                    Map.entry("metricNameSpace", "test"),
                    Map.entry("resourceId", "test")
                ))
                .resourceGroupName("GroupForEdgeAutomation")
                .roleName("testrole")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    monitoring_config = azure_native.databoxedge.MonitoringConfig("monitoringConfig",
        device_name="testedgedevice",
        metric_configurations=[{
            "counterSets": [{
                "counters": [azure_native.databoxedge.MetricCounterArgs(
                    name="test",
                )],
            }],
            "mdmAccount": "test",
            "metricNameSpace": "test",
            "resourceId": "test",
        }],
        resource_group_name="GroupForEdgeAutomation",
        role_name="testrole")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const monitoringConfig = new azure_native.databoxedge.MonitoringConfig("monitoringConfig", {
        deviceName: "testedgedevice",
        metricConfigurations: [{
            counterSets: [{
                counters: [{
                    name: "test",
                }],
            }],
            mdmAccount: "test",
            metricNameSpace: "test",
            resourceId: "test",
        }],
        resourceGroupName: "GroupForEdgeAutomation",
        roleName: "testrole",
    });
    
    resources:
      monitoringConfig:
        type: azure-native:databoxedge:MonitoringConfig
        properties:
          deviceName: testedgedevice
          metricConfigurations:
            - counterSets:
                - counters:
                    - name: test
              mdmAccount: test
              metricNameSpace: test
              resourceId: test
          resourceGroupName: GroupForEdgeAutomation
          roleName: testrole
    

    Create MonitoringConfig Resource

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

    Constructor syntax

    new MonitoringConfig(name: string, args: MonitoringConfigArgs, opts?: CustomResourceOptions);
    @overload
    def MonitoringConfig(resource_name: str,
                         args: MonitoringConfigArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def MonitoringConfig(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         device_name: Optional[str] = None,
                         metric_configurations: Optional[Sequence[MetricConfigurationArgs]] = None,
                         resource_group_name: Optional[str] = None,
                         role_name: Optional[str] = None)
    func NewMonitoringConfig(ctx *Context, name string, args MonitoringConfigArgs, opts ...ResourceOption) (*MonitoringConfig, error)
    public MonitoringConfig(string name, MonitoringConfigArgs args, CustomResourceOptions? opts = null)
    public MonitoringConfig(String name, MonitoringConfigArgs args)
    public MonitoringConfig(String name, MonitoringConfigArgs args, CustomResourceOptions options)
    
    type: azure-native:databoxedge:MonitoringConfig
    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 MonitoringConfigArgs
    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 MonitoringConfigArgs
    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 MonitoringConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MonitoringConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MonitoringConfigArgs
    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 monitoringConfigResource = new AzureNative.Databoxedge.MonitoringConfig("monitoringConfigResource", new()
    {
        DeviceName = "string",
        MetricConfigurations = new[]
        {
            
            {
                { "counterSets", new[]
                {
                    
                    {
                        { "counters", new[]
                        {
                            
                            {
                                { "name", "string" },
                                { "additionalDimensions", new[]
                                {
                                    
                                    {
                                        { "sourceName", "string" },
                                        { "sourceType", "string" },
                                    },
                                } },
                                { "dimensionFilter", new[]
                                {
                                    
                                    {
                                        { "sourceName", "string" },
                                        { "sourceType", "string" },
                                    },
                                } },
                                { "instance", "string" },
                            },
                        } },
                    },
                } },
                { "resourceId", "string" },
                { "mdmAccount", "string" },
                { "metricNameSpace", "string" },
            },
        },
        ResourceGroupName = "string",
        RoleName = "string",
    });
    
    example, err := databoxedge.NewMonitoringConfig(ctx, "monitoringConfigResource", &databoxedge.MonitoringConfigArgs{
    	DeviceName: "string",
    	MetricConfigurations: []map[string]interface{}{
    		map[string]interface{}{
    			"counterSets": []map[string]interface{}{
    				map[string]interface{}{
    					"counters": []map[string]interface{}{
    						map[string]interface{}{
    							"name": "string",
    							"additionalDimensions": []map[string]interface{}{
    								map[string]interface{}{
    									"sourceName": "string",
    									"sourceType": "string",
    								},
    							},
    							"dimensionFilter": []map[string]interface{}{
    								map[string]interface{}{
    									"sourceName": "string",
    									"sourceType": "string",
    								},
    							},
    							"instance": "string",
    						},
    					},
    				},
    			},
    			"resourceId":      "string",
    			"mdmAccount":      "string",
    			"metricNameSpace": "string",
    		},
    	},
    	ResourceGroupName: "string",
    	RoleName:          "string",
    })
    
    var monitoringConfigResource = new MonitoringConfig("monitoringConfigResource", MonitoringConfigArgs.builder()
        .deviceName("string")
        .metricConfigurations(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
        .resourceGroupName("string")
        .roleName("string")
        .build());
    
    monitoring_config_resource = azure_native.databoxedge.MonitoringConfig("monitoringConfigResource",
        device_name=string,
        metric_configurations=[{
            counterSets: [{
                counters: [{
                    name: string,
                    additionalDimensions: [{
                        sourceName: string,
                        sourceType: string,
                    }],
                    dimensionFilter: [{
                        sourceName: string,
                        sourceType: string,
                    }],
                    instance: string,
                }],
            }],
            resourceId: string,
            mdmAccount: string,
            metricNameSpace: string,
        }],
        resource_group_name=string,
        role_name=string)
    
    const monitoringConfigResource = new azure_native.databoxedge.MonitoringConfig("monitoringConfigResource", {
        deviceName: "string",
        metricConfigurations: [{
            counterSets: [{
                counters: [{
                    name: "string",
                    additionalDimensions: [{
                        sourceName: "string",
                        sourceType: "string",
                    }],
                    dimensionFilter: [{
                        sourceName: "string",
                        sourceType: "string",
                    }],
                    instance: "string",
                }],
            }],
            resourceId: "string",
            mdmAccount: "string",
            metricNameSpace: "string",
        }],
        resourceGroupName: "string",
        roleName: "string",
    });
    
    type: azure-native:databoxedge:MonitoringConfig
    properties:
        deviceName: string
        metricConfigurations:
            - counterSets:
                - counters:
                    - additionalDimensions:
                        - sourceName: string
                          sourceType: string
                      dimensionFilter:
                        - sourceName: string
                          sourceType: string
                      instance: string
                      name: string
              mdmAccount: string
              metricNameSpace: string
              resourceId: string
        resourceGroupName: string
        roleName: string
    

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

    DeviceName string
    The device name.
    MetricConfigurations List<Pulumi.AzureNative.DataBoxEdge.Inputs.MetricConfiguration>
    The metrics configuration details
    ResourceGroupName string
    The resource group name.
    RoleName string
    The role name.
    DeviceName string
    The device name.
    MetricConfigurations []MetricConfigurationArgs
    The metrics configuration details
    ResourceGroupName string
    The resource group name.
    RoleName string
    The role name.
    deviceName String
    The device name.
    metricConfigurations List<MetricConfiguration>
    The metrics configuration details
    resourceGroupName String
    The resource group name.
    roleName String
    The role name.
    deviceName string
    The device name.
    metricConfigurations MetricConfiguration[]
    The metrics configuration details
    resourceGroupName string
    The resource group name.
    roleName string
    The role name.
    device_name str
    The device name.
    metric_configurations Sequence[MetricConfigurationArgs]
    The metrics configuration details
    resource_group_name str
    The resource group name.
    role_name str
    The role name.
    deviceName String
    The device name.
    metricConfigurations List<Property Map>
    The metrics configuration details
    resourceGroupName String
    The resource group name.
    roleName String
    The role name.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The object name.
    Type string
    The hierarchical type of the object.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The object name.
    Type string
    The hierarchical type of the object.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The object name.
    type String
    The hierarchical type of the object.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The object name.
    type string
    The hierarchical type of the object.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The object name.
    type str
    The hierarchical type of the object.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The object name.
    type String
    The hierarchical type of the object.

    Supporting Types

    MetricConfiguration, MetricConfigurationArgs

    CounterSets List<Pulumi.AzureNative.DataBoxEdge.Inputs.MetricCounterSet>
    Host name for the IoT hub associated to the device.
    ResourceId string
    The Resource ID on which the metrics should be pushed.
    MdmAccount string
    The MDM account to which the counters should be pushed.
    MetricNameSpace string
    The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
    CounterSets []MetricCounterSet
    Host name for the IoT hub associated to the device.
    ResourceId string
    The Resource ID on which the metrics should be pushed.
    MdmAccount string
    The MDM account to which the counters should be pushed.
    MetricNameSpace string
    The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
    counterSets List<MetricCounterSet>
    Host name for the IoT hub associated to the device.
    resourceId String
    The Resource ID on which the metrics should be pushed.
    mdmAccount String
    The MDM account to which the counters should be pushed.
    metricNameSpace String
    The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
    counterSets MetricCounterSet[]
    Host name for the IoT hub associated to the device.
    resourceId string
    The Resource ID on which the metrics should be pushed.
    mdmAccount string
    The MDM account to which the counters should be pushed.
    metricNameSpace string
    The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
    counter_sets Sequence[MetricCounterSet]
    Host name for the IoT hub associated to the device.
    resource_id str
    The Resource ID on which the metrics should be pushed.
    mdm_account str
    The MDM account to which the counters should be pushed.
    metric_name_space str
    The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
    counterSets List<Property Map>
    Host name for the IoT hub associated to the device.
    resourceId String
    The Resource ID on which the metrics should be pushed.
    mdmAccount String
    The MDM account to which the counters should be pushed.
    metricNameSpace String
    The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified

    MetricConfigurationResponse, MetricConfigurationResponseArgs

    CounterSets List<Pulumi.AzureNative.DataBoxEdge.Inputs.MetricCounterSetResponse>
    Host name for the IoT hub associated to the device.
    ResourceId string
    The Resource ID on which the metrics should be pushed.
    MdmAccount string
    The MDM account to which the counters should be pushed.
    MetricNameSpace string
    The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
    CounterSets []MetricCounterSetResponse
    Host name for the IoT hub associated to the device.
    ResourceId string
    The Resource ID on which the metrics should be pushed.
    MdmAccount string
    The MDM account to which the counters should be pushed.
    MetricNameSpace string
    The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
    counterSets List<MetricCounterSetResponse>
    Host name for the IoT hub associated to the device.
    resourceId String
    The Resource ID on which the metrics should be pushed.
    mdmAccount String
    The MDM account to which the counters should be pushed.
    metricNameSpace String
    The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
    counterSets MetricCounterSetResponse[]
    Host name for the IoT hub associated to the device.
    resourceId string
    The Resource ID on which the metrics should be pushed.
    mdmAccount string
    The MDM account to which the counters should be pushed.
    metricNameSpace string
    The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
    counter_sets Sequence[MetricCounterSetResponse]
    Host name for the IoT hub associated to the device.
    resource_id str
    The Resource ID on which the metrics should be pushed.
    mdm_account str
    The MDM account to which the counters should be pushed.
    metric_name_space str
    The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
    counterSets List<Property Map>
    Host name for the IoT hub associated to the device.
    resourceId String
    The Resource ID on which the metrics should be pushed.
    mdmAccount String
    The MDM account to which the counters should be pushed.
    metricNameSpace String
    The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified

    MetricCounter, MetricCounterArgs

    Name string
    The counter name.
    AdditionalDimensions List<Pulumi.AzureNative.DataBoxEdge.Inputs.MetricDimension>
    The additional dimensions to be added to metric.
    DimensionFilter List<Pulumi.AzureNative.DataBoxEdge.Inputs.MetricDimension>
    The dimension filter.
    Instance string
    The instance from which counter should be collected.
    Name string
    The counter name.
    AdditionalDimensions []MetricDimension
    The additional dimensions to be added to metric.
    DimensionFilter []MetricDimension
    The dimension filter.
    Instance string
    The instance from which counter should be collected.
    name String
    The counter name.
    additionalDimensions List<MetricDimension>
    The additional dimensions to be added to metric.
    dimensionFilter List<MetricDimension>
    The dimension filter.
    instance String
    The instance from which counter should be collected.
    name string
    The counter name.
    additionalDimensions MetricDimension[]
    The additional dimensions to be added to metric.
    dimensionFilter MetricDimension[]
    The dimension filter.
    instance string
    The instance from which counter should be collected.
    name str
    The counter name.
    additional_dimensions Sequence[MetricDimension]
    The additional dimensions to be added to metric.
    dimension_filter Sequence[MetricDimension]
    The dimension filter.
    instance str
    The instance from which counter should be collected.
    name String
    The counter name.
    additionalDimensions List<Property Map>
    The additional dimensions to be added to metric.
    dimensionFilter List<Property Map>
    The dimension filter.
    instance String
    The instance from which counter should be collected.

    MetricCounterResponse, MetricCounterResponseArgs

    Name string
    The counter name.
    AdditionalDimensions List<Pulumi.AzureNative.DataBoxEdge.Inputs.MetricDimensionResponse>
    The additional dimensions to be added to metric.
    DimensionFilter List<Pulumi.AzureNative.DataBoxEdge.Inputs.MetricDimensionResponse>
    The dimension filter.
    Instance string
    The instance from which counter should be collected.
    Name string
    The counter name.
    AdditionalDimensions []MetricDimensionResponse
    The additional dimensions to be added to metric.
    DimensionFilter []MetricDimensionResponse
    The dimension filter.
    Instance string
    The instance from which counter should be collected.
    name String
    The counter name.
    additionalDimensions List<MetricDimensionResponse>
    The additional dimensions to be added to metric.
    dimensionFilter List<MetricDimensionResponse>
    The dimension filter.
    instance String
    The instance from which counter should be collected.
    name string
    The counter name.
    additionalDimensions MetricDimensionResponse[]
    The additional dimensions to be added to metric.
    dimensionFilter MetricDimensionResponse[]
    The dimension filter.
    instance string
    The instance from which counter should be collected.
    name str
    The counter name.
    additional_dimensions Sequence[MetricDimensionResponse]
    The additional dimensions to be added to metric.
    dimension_filter Sequence[MetricDimensionResponse]
    The dimension filter.
    instance str
    The instance from which counter should be collected.
    name String
    The counter name.
    additionalDimensions List<Property Map>
    The additional dimensions to be added to metric.
    dimensionFilter List<Property Map>
    The dimension filter.
    instance String
    The instance from which counter should be collected.

    MetricCounterSet, MetricCounterSetArgs

    Counters List<Pulumi.AzureNative.DataBoxEdge.Inputs.MetricCounter>
    The counters that should be collected in this set.
    Counters []MetricCounter
    The counters that should be collected in this set.
    counters List<MetricCounter>
    The counters that should be collected in this set.
    counters MetricCounter[]
    The counters that should be collected in this set.
    counters Sequence[MetricCounter]
    The counters that should be collected in this set.
    counters List<Property Map>
    The counters that should be collected in this set.

    MetricCounterSetResponse, MetricCounterSetResponseArgs

    Counters List<Pulumi.AzureNative.DataBoxEdge.Inputs.MetricCounterResponse>
    The counters that should be collected in this set.
    Counters []MetricCounterResponse
    The counters that should be collected in this set.
    counters List<MetricCounterResponse>
    The counters that should be collected in this set.
    counters MetricCounterResponse[]
    The counters that should be collected in this set.
    counters Sequence[MetricCounterResponse]
    The counters that should be collected in this set.
    counters List<Property Map>
    The counters that should be collected in this set.

    MetricDimension, MetricDimensionArgs

    SourceName string
    The dimension value.
    SourceType string
    The dimension type.
    SourceName string
    The dimension value.
    SourceType string
    The dimension type.
    sourceName String
    The dimension value.
    sourceType String
    The dimension type.
    sourceName string
    The dimension value.
    sourceType string
    The dimension type.
    source_name str
    The dimension value.
    source_type str
    The dimension type.
    sourceName String
    The dimension value.
    sourceType String
    The dimension type.

    MetricDimensionResponse, MetricDimensionResponseArgs

    SourceName string
    The dimension value.
    SourceType string
    The dimension type.
    SourceName string
    The dimension value.
    SourceType string
    The dimension type.
    sourceName String
    The dimension value.
    sourceType String
    The dimension type.
    sourceName string
    The dimension value.
    sourceType string
    The dimension type.
    source_name str
    The dimension value.
    source_type str
    The dimension type.
    sourceName String
    The dimension value.
    sourceType String
    The dimension type.

    Import

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

    $ pulumi import azure-native:databoxedge:MonitoringConfig myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default 
    

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi