Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. databoxedge
  5. getMonitoringConfig
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.databoxedge.getMonitoringConfig

Explore with Pulumi AI

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

The metric setting details for the role

Uses Azure REST API version 2023-07-01.

Other available API versions: 2022-03-01, 2022-04-01-preview, 2022-12-01-preview, 2023-01-01-preview, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native databoxedge [ApiVersion]. See the version guide for details.

Using getMonitoringConfig

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 getMonitoringConfig(args: GetMonitoringConfigArgs, opts?: InvokeOptions): Promise<GetMonitoringConfigResult>
function getMonitoringConfigOutput(args: GetMonitoringConfigOutputArgs, opts?: InvokeOptions): Output<GetMonitoringConfigResult>
Copy
def get_monitoring_config(device_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          role_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetMonitoringConfigResult
def get_monitoring_config_output(device_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          role_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetMonitoringConfigResult]
Copy
func LookupMonitoringConfig(ctx *Context, args *LookupMonitoringConfigArgs, opts ...InvokeOption) (*LookupMonitoringConfigResult, error)
func LookupMonitoringConfigOutput(ctx *Context, args *LookupMonitoringConfigOutputArgs, opts ...InvokeOption) LookupMonitoringConfigResultOutput
Copy

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

public static class GetMonitoringConfig 
{
    public static Task<GetMonitoringConfigResult> InvokeAsync(GetMonitoringConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetMonitoringConfigResult> Invoke(GetMonitoringConfigInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMonitoringConfigResult> getMonitoringConfig(GetMonitoringConfigArgs args, InvokeOptions options)
public static Output<GetMonitoringConfigResult> getMonitoringConfig(GetMonitoringConfigArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:databoxedge:getMonitoringConfig
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
RoleName
This property is required.
Changes to this property will trigger replacement.
string
The role name.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
RoleName
This property is required.
Changes to this property will trigger replacement.
string
The role name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
roleName
This property is required.
Changes to this property will trigger replacement.
String
The role name.
deviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
roleName
This property is required.
Changes to this property will trigger replacement.
string
The role name.
device_name
This property is required.
Changes to this property will trigger replacement.
str
The device name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name.
role_name
This property is required.
Changes to this property will trigger replacement.
str
The role name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
roleName
This property is required.
Changes to this property will trigger replacement.
String
The role name.

getMonitoringConfig Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
The path ID that uniquely identifies the object.
MetricConfigurations List<Pulumi.AzureNative.DataBoxEdge.Outputs.MetricConfigurationResponse>
The metrics configuration details
Name string
The object name.
SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of MonitoringConfiguration
Type string
The hierarchical type of the object.
AzureApiVersion string
The Azure API version of the resource.
Id string
The path ID that uniquely identifies the object.
MetricConfigurations []MetricConfigurationResponse
The metrics configuration details
Name string
The object name.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of MonitoringConfiguration
Type string
The hierarchical type of the object.
azureApiVersion String
The Azure API version of the resource.
id String
The path ID that uniquely identifies the object.
metricConfigurations List<MetricConfigurationResponse>
The metrics configuration details
name String
The object name.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of MonitoringConfiguration
type String
The hierarchical type of the object.
azureApiVersion string
The Azure API version of the resource.
id string
The path ID that uniquely identifies the object.
metricConfigurations MetricConfigurationResponse[]
The metrics configuration details
name string
The object name.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of MonitoringConfiguration
type string
The hierarchical type of the object.
azure_api_version str
The Azure API version of the resource.
id str
The path ID that uniquely identifies the object.
metric_configurations Sequence[MetricConfigurationResponse]
The metrics configuration details
name str
The object name.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of MonitoringConfiguration
type str
The hierarchical type of the object.
azureApiVersion String
The Azure API version of the resource.
id String
The path ID that uniquely identifies the object.
metricConfigurations List<Property Map>
The metrics configuration details
name String
The object name.
systemData Property Map
Metadata pertaining to creation and last modification of MonitoringConfiguration
type String
The hierarchical type of the object.

Supporting Types

MetricConfigurationResponse

CounterSets This property is required. List<Pulumi.AzureNative.DataBoxEdge.Inputs.MetricCounterSetResponse>
Host name for the IoT hub associated to the device.
ResourceId This property is required. 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 This property is required. []MetricCounterSetResponse
Host name for the IoT hub associated to the device.
ResourceId This property is required. 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 This property is required. List<MetricCounterSetResponse>
Host name for the IoT hub associated to the device.
resourceId This property is required. 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 This property is required. MetricCounterSetResponse[]
Host name for the IoT hub associated to the device.
resourceId This property is required. 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 This property is required. Sequence[MetricCounterSetResponse]
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_space str
The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified
counterSets This property is required. List<Property Map>
Host name for the IoT hub associated to the device.
resourceId This property is required. 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

MetricCounterResponse

Name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

MetricCounterSetResponse

Counters This property is required. List<Pulumi.AzureNative.DataBoxEdge.Inputs.MetricCounterResponse>
The counters that should be collected in this set.
Counters This property is required. []MetricCounterResponse
The counters that should be collected in this set.
counters This property is required. List<MetricCounterResponse>
The counters that should be collected in this set.
counters This property is required. MetricCounterResponse[]
The counters that should be collected in this set.
counters This property is required. Sequence[MetricCounterResponse]
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.

MetricDimensionResponse

SourceName This property is required. string
The dimension value.
SourceType This property is required. string
The dimension type.
SourceName This property is required. string
The dimension value.
SourceType This property is required. string
The dimension type.
sourceName This property is required. String
The dimension value.
sourceType This property is required. String
The dimension type.
sourceName This property is required. string
The dimension value.
sourceType 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.
sourceName This property is required. String
The dimension value.
sourceType This property is required. String
The dimension type.

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
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native