azure-native-v2.databoxedge.MonitoringConfig
Explore with Pulumi AI
The metric setting details for the role Azure REST API version: 2022-03-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.
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
This property is required. string - The unique name of the resource.
- args
This property is required. MonitoringConfigArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. MonitoringConfigArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. MonitoringConfigArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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:
- Device
Name This property is required. Changes to this property will trigger replacement.
- The device name.
- Metric
Configurations This property is required. List<Pulumi.Azure Native. Data Box Edge. Inputs. Metric Configuration> - The metrics configuration details
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group name.
- Role
Name This property is required. Changes to this property will trigger replacement.
- The role name.
- Device
Name This property is required. Changes to this property will trigger replacement.
- The device name.
- Metric
Configurations This property is required. []MetricConfiguration Args - The metrics configuration details
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group name.
- Role
Name This property is required. Changes to this property will trigger replacement.
- The role name.
- device
Name This property is required. Changes to this property will trigger replacement.
- The device name.
- metric
Configurations This property is required. List<MetricConfiguration> - The metrics configuration details
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group name.
- role
Name This property is required. Changes to this property will trigger replacement.
- The role name.
- device
Name This property is required. Changes to this property will trigger replacement.
- The device name.
- metric
Configurations This property is required. MetricConfiguration[] - The metrics configuration details
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group name.
- role
Name This property is required. Changes to this property will trigger replacement.
- The role name.
- device_
name This property is required. Changes to this property will trigger replacement.
- The device name.
- metric_
configurations This property is required. Sequence[MetricConfiguration Args] - The metrics configuration details
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The resource group name.
- role_
name This property is required. Changes to this property will trigger replacement.
- The role name.
- device
Name This property is required. Changes to this property will trigger replacement.
- The device name.
- metric
Configurations This property is required. List<Property Map> - The metrics configuration details
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The resource group name.
- role
Name This property is required. Changes to this property will trigger replacement.
- 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.
- System
Data Pulumi.Azure Native. Data Box Edge. Outputs. System Data Response - Metadata pertaining to creation and last modification of MonitoringConfiguration
- Type string
- The hierarchical type of the object.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The object name.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of MonitoringConfiguration
- Type string
- The hierarchical type of the object.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The object name.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of MonitoringConfiguration
- type String
- The hierarchical type of the object.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The object name.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of MonitoringConfiguration
- type string
- The hierarchical type of the object.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The object name.
- system_
data SystemData Response - Metadata pertaining to creation and last modification of MonitoringConfiguration
- type str
- The hierarchical type of the object.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The object name.
- system
Data Property Map - Metadata pertaining to creation and last modification of MonitoringConfiguration
- type String
- The hierarchical type of the object.
Supporting Types
MetricConfiguration, MetricConfigurationArgs
- Counter
Sets This property is required. List<Pulumi.Azure Native. Data Box Edge. Inputs. Metric Counter Set> - Host name for the IoT hub associated to the device.
- Resource
Id This property is required. string - The Resource ID on which the metrics should be pushed.
- Mdm
Account string - The MDM account to which the counters should be pushed.
- Metric
Name stringSpace - The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
- Counter
Sets This property is required. []MetricCounter Set - Host name for the IoT hub associated to the device.
- Resource
Id This property is required. string - The Resource ID on which the metrics should be pushed.
- Mdm
Account string - The MDM account to which the counters should be pushed.
- Metric
Name stringSpace - The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
- counter
Sets This property is required. List<MetricCounter Set> - Host name for the IoT hub associated to the device.
- resource
Id This property is required. String - The Resource ID on which the metrics should be pushed.
- mdm
Account String - The MDM account to which the counters should be pushed.
- metric
Name StringSpace - The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
- counter
Sets This property is required. MetricCounter Set[] - Host name for the IoT hub associated to the device.
- resource
Id This property is required. string - The Resource ID on which the metrics should be pushed.
- mdm
Account string - The MDM account to which the counters should be pushed.
- metric
Name stringSpace - The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
- counter_
sets This property is required. Sequence[MetricCounter Set] - Host name for the IoT hub associated to the device.
- resource_
id This property is required. 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_ strspace - The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
- counter
Sets This property is required. List<Property Map> - Host name for the IoT hub associated to the device.
- resource
Id This property is required. String - The Resource ID on which the metrics should be pushed.
- mdm
Account String - The MDM account to which the counters should be pushed.
- metric
Name StringSpace - The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
MetricConfigurationResponse, MetricConfigurationResponseArgs
- Counter
Sets This property is required. List<Pulumi.Azure Native. Data Box Edge. Inputs. Metric Counter Set Response> - Host name for the IoT hub associated to the device.
- Resource
Id This property is required. string - The Resource ID on which the metrics should be pushed.
- Mdm
Account string - The MDM account to which the counters should be pushed.
- Metric
Name stringSpace - The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
- Counter
Sets This property is required. []MetricCounter Set Response - Host name for the IoT hub associated to the device.
- Resource
Id This property is required. string - The Resource ID on which the metrics should be pushed.
- Mdm
Account string - The MDM account to which the counters should be pushed.
- Metric
Name stringSpace - The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
- counter
Sets This property is required. List<MetricCounter Set Response> - Host name for the IoT hub associated to the device.
- resource
Id This property is required. String - The Resource ID on which the metrics should be pushed.
- mdm
Account String - The MDM account to which the counters should be pushed.
- metric
Name StringSpace - The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
- counter
Sets This property is required. MetricCounter Set Response[] - Host name for the IoT hub associated to the device.
- resource
Id This property is required. string - The Resource ID on which the metrics should be pushed.
- mdm
Account string - The MDM account to which the counters should be pushed.
- metric
Name stringSpace - The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
- counter_
sets This property is required. Sequence[MetricCounter Set Response] - Host name for the IoT hub associated to the device.
- resource_
id This property is required. 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_ strspace - The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
- counter
Sets This property is required. List<Property Map> - Host name for the IoT hub associated to the device.
- resource
Id This property is required. String - The Resource ID on which the metrics should be pushed.
- mdm
Account String - The MDM account to which the counters should be pushed.
- metric
Name StringSpace - The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
MetricCounter, MetricCounterArgs
- Name
This property is required. string - The counter name.
- Additional
Dimensions List<Pulumi.Azure Native. Data Box Edge. Inputs. Metric Dimension> - The additional dimensions to be added to metric.
- Dimension
Filter List<Pulumi.Azure Native. Data Box Edge. Inputs. Metric Dimension> - The dimension filter.
- Instance string
- The instance from which counter should be collected.
- Name
This property is required. string - The counter name.
- Additional
Dimensions []MetricDimension - The additional dimensions to be added to metric.
- Dimension
Filter []MetricDimension - The dimension filter.
- Instance string
- The instance from which counter should be collected.
- name
This property is required. String - The counter name.
- additional
Dimensions List<MetricDimension> - The additional dimensions to be added to metric.
- dimension
Filter List<MetricDimension> - The dimension filter.
- instance String
- The instance from which counter should be collected.
- name
This property is required. string - The counter name.
- additional
Dimensions MetricDimension[] - The additional dimensions to be added to metric.
- dimension
Filter MetricDimension[] - The dimension filter.
- instance string
- The instance from which counter should be collected.
- name
This property is required. 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
This property is required. String - The counter name.
- additional
Dimensions List<Property Map> - The additional dimensions to be added to metric.
- dimension
Filter List<Property Map> - The dimension filter.
- instance String
- The instance from which counter should be collected.
MetricCounterResponse, MetricCounterResponseArgs
- Name
This property is required. string - The counter name.
- Additional
Dimensions List<Pulumi.Azure Native. Data Box Edge. Inputs. Metric Dimension Response> - The additional dimensions to be added to metric.
- Dimension
Filter List<Pulumi.Azure Native. Data Box Edge. Inputs. Metric Dimension Response> - The dimension filter.
- Instance string
- The instance from which counter should be collected.
- Name
This property is required. string - The counter name.
- Additional
Dimensions []MetricDimension Response - The additional dimensions to be added to metric.
- Dimension
Filter []MetricDimension Response - The dimension filter.
- Instance string
- The instance from which counter should be collected.
- name
This property is required. String - The counter name.
- additional
Dimensions List<MetricDimension Response> - The additional dimensions to be added to metric.
- dimension
Filter List<MetricDimension Response> - The dimension filter.
- instance String
- The instance from which counter should be collected.
- name
This property is required. string - The counter name.
- additional
Dimensions MetricDimension Response[] - The additional dimensions to be added to metric.
- dimension
Filter MetricDimension Response[] - The dimension filter.
- instance string
- The instance from which counter should be collected.
- name
This property is required. str - The counter name.
- additional_
dimensions Sequence[MetricDimension Response] - The additional dimensions to be added to metric.
- dimension_
filter Sequence[MetricDimension Response] - The dimension filter.
- instance str
- The instance from which counter should be collected.
- name
This property is required. String - The counter name.
- additional
Dimensions List<Property Map> - The additional dimensions to be added to metric.
- dimension
Filter List<Property Map> - The dimension filter.
- instance String
- The instance from which counter should be collected.
MetricCounterSet, MetricCounterSetArgs
- Counters
This property is required. List<Pulumi.Azure Native. Data Box Edge. Inputs. Metric Counter> - The counters that should be collected in this set.
- Counters
This property is required. []MetricCounter - The counters that should be collected in this set.
- counters
This property is required. List<MetricCounter> - The counters that should be collected in this set.
- counters
This property is required. MetricCounter[] - The counters that should be collected in this set.
- counters
This property is required. Sequence[MetricCounter] - The counters that should be collected in this set.
- counters
This property is required. List<Property Map> - The counters that should be collected in this set.
MetricCounterSetResponse, MetricCounterSetResponseArgs
- Counters
This property is required. List<Pulumi.Azure Native. Data Box Edge. Inputs. Metric Counter Response> - The counters that should be collected in this set.
- Counters
This property is required. []MetricCounter Response - The counters that should be collected in this set.
- counters
This property is required. List<MetricCounter Response> - The counters that should be collected in this set.
- counters
This property is required. MetricCounter Response[] - The counters that should be collected in this set.
- counters
This property is required. Sequence[MetricCounter Response] - The counters that should be collected in this set.
- counters
This property is required. List<Property Map> - The counters that should be collected in this set.
MetricDimension, MetricDimensionArgs
- Source
Name This property is required. string - The dimension value.
- Source
Type This property is required. string - The dimension type.
- Source
Name This property is required. string - The dimension value.
- Source
Type This property is required. string - The dimension type.
- source
Name This property is required. String - The dimension value.
- source
Type This property is required. String - The dimension type.
- source
Name This property is required. string - The dimension value.
- source
Type This property is required. string - The dimension type.
- source_
name This property is required. str - The dimension value.
- source_
type This property is required. str - The dimension type.
- source
Name This property is required. String - The dimension value.
- source
Type This property is required. String - The dimension type.
MetricDimensionResponse, MetricDimensionResponseArgs
- Source
Name This property is required. string - The dimension value.
- Source
Type This property is required. string - The dimension type.
- Source
Name This property is required. string - The dimension value.
- Source
Type This property is required. string - The dimension type.
- source
Name This property is required. String - The dimension value.
- source
Type This property is required. String - The dimension type.
- source
Name This property is required. string - The dimension value.
- source
Type This property is required. string - The dimension type.
- source_
name This property is required. str - The dimension value.
- source_
type This property is required. str - The dimension type.
- source
Name This property is required. String - The dimension value.
- source
Type This property is required. String - The dimension type.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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: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-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0