monitoring_config

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

Overview

Name	monitoring_config
Type	Resource
Id	azure.data_box_edge.monitoring_config

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
metricConfigurations	array	The metrics configuration details. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	device_name, role_name, resource_group_name, subscription_id		Gets a metric configuration of a role. Gets a metric configuration of a role.
create_or_update	insert	device_name, role_name, resource_group_name, subscription_id, properties		Creates a new metric configuration or updates an existing one for a role. Creates a new metric configuration or updates an existing one for a role.
create_or_update	replace	device_name, role_name, resource_group_name, subscription_id, properties		Creates a new metric configuration or updates an existing one for a role. Creates a new metric configuration or updates an existing one for a role.
delete	delete	device_name, role_name, resource_group_name, subscription_id		deletes a new metric configuration for a role. deletes a new metric configuration for a role.
list_raw	exec	device_name, role_name, resource_group_name, subscription_id		Lists metric configurations in a role. Lists metric configurations in a role.

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
device_name	string	The name of the device. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
role_name	string	The name of the role. Required.
subscription_id	string

SELECT examples

get

Gets a metric configuration of a role. Gets a metric configuration of a role.

SELECT
id,
name,
metricConfigurations,
systemData,
type
FROM azure.data_box_edge.monitoring_config
WHERE device_name = '{{ device_name }}' -- required
AND role_name = '{{ role_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a new metric configuration or updates an existing one for a role. Creates a new metric configuration or updates an existing one for a role.

INSERT INTO azure.data_box_edge.monitoring_config (
properties,
device_name,
role_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ device_name }}',
'{{ role_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: monitoring_config
props:
  - name: device_name
    value: "{{ device_name }}"
    description: Required parameter for the monitoring_config resource.
  - name: role_name
    value: "{{ role_name }}"
    description: Required parameter for the monitoring_config resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the monitoring_config resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the monitoring_config resource.
  - name: properties
    description: |
      The metric setting properties. Required.
    value:
      metricConfigurations:
        - resourceId: "{{ resourceId }}"
          mdmAccount: "{{ mdmAccount }}"
          metricNameSpace: "{{ metricNameSpace }}"
          counterSets: "{{ counterSets }}"

REPLACE examples

create_or_update

Creates a new metric configuration or updates an existing one for a role. Creates a new metric configuration or updates an existing one for a role.

REPLACE azure.data_box_edge.monitoring_config
SET 
properties = '{{ properties }}'
WHERE 
device_name = '{{ device_name }}' --required
AND role_name = '{{ role_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

deletes a new metric configuration for a role. deletes a new metric configuration for a role.

DELETE FROM azure.data_box_edge.monitoring_config
WHERE device_name = '{{ device_name }}' --required
AND role_name = '{{ role_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_raw

Lists metric configurations in a role. Lists metric configurations in a role.

EXEC azure.data_box_edge.monitoring_config.list_raw 
@device_name='{{ device_name }}' --required, 
@role_name='{{ role_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;