monitoring_configs

Creates, updates, deletes, gets or lists a monitoring_configs resource.

Overview

Name	monitoring_configs
Type	Resource
Id	azure.data_box_edge.monitoring_configs

Fields

The following fields are returned by SELECT queries:

list

The monitoring config details.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	The metric setting properties.
systemData	object	Metadata pertaining to creation and last modification of MonitoringConfiguration
type	string	The hierarchical type of the object.

get

The monitoring config details.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	The metric setting properties.
systemData	object	Metadata pertaining to creation and last modification of MonitoringConfiguration
type	string	The hierarchical type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	deviceName, roleName, subscriptionId, resourceGroupName
get	select	deviceName, roleName, subscriptionId, resourceGroupName
create_or_update	insert	deviceName, roleName, subscriptionId, resourceGroupName, data__properties
delete	delete	deviceName, roleName, subscriptionId, resourceGroupName

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deviceName	string	The device name.
resourceGroupName	string	The resource group name.
roleName	string	The role name.
subscriptionId	string	The subscription ID.

SELECT examples

list

The monitoring config details.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.monitoring_configs
WHERE deviceName = '{{ deviceName }}' -- required
AND roleName = '{{ roleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

get

The monitoring config details.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.monitoring_configs
WHERE deviceName = '{{ deviceName }}' -- required
AND roleName = '{{ roleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.data_box_edge.monitoring_configs (
data__properties,
deviceName,
roleName,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ properties }}' /* required */,
'{{ deviceName }}',
'{{ roleName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: monitoring_configs
  props:
    - name: deviceName
      value: string
      description: Required parameter for the monitoring_configs resource.
    - name: roleName
      value: string
      description: Required parameter for the monitoring_configs resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the monitoring_configs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the monitoring_configs resource.
    - name: properties
      value: object
      description: |
        The metric setting properties.

DELETE examples

delete

No description available.

DELETE FROM azure.data_box_edge.monitoring_configs
WHERE deviceName = '{{ deviceName }}' --required
AND roleName = '{{ roleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
;