metrics_configurations

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

Overview

Name	metrics_configurations
Type	Resource
Id	azure.nexus.metrics_configurations

Fields

vw_metrics_configurations

Name	Datatype	Description
clusterName	text	field from the properties object
collection_interval	text	field from the properties object
detailed_status	text	field from the properties object
detailed_status_message	text	field from the properties object
disabled_metrics	text	field from the properties object
enabled_metrics	text	field from the properties object
extended_location	text	field from the properties object
location	text	The geo-location where the resource lives
metricsConfigurationName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

metrics_configurations

Name	Datatype	Description
extendedLocation	object
location	string	The geo-location where the resource lives
properties	object
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clusterName, metricsConfigurationName, resourceGroupName, subscriptionId	Get metrics configuration of the provided cluster.
list_by_cluster	SELECT	clusterName, resourceGroupName, subscriptionId	Get a list of metrics configurations for the provided cluster.
create_or_update	INSERT	clusterName, metricsConfigurationName, resourceGroupName, subscriptionId, data__extendedLocation, data__properties	Create new or update the existing metrics configuration of the provided cluster.
delete	DELETE	clusterName, metricsConfigurationName, resourceGroupName, subscriptionId	Delete the metrics configuration of the provided cluster.
update	UPDATE	clusterName, metricsConfigurationName, resourceGroupName, subscriptionId	Patch properties of metrics configuration for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.

SELECT examples

Get a list of metrics configurations for the provided cluster.

vw_metrics_configurations

SELECT
clusterName,
collection_interval,
detailed_status,
detailed_status_message,
disabled_metrics,
enabled_metrics,
extended_location,
location,
metricsConfigurationName,
provisioning_state,
resourceGroupName,
subscriptionId,
tags
FROM azure.nexus.vw_metrics_configurations
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

metrics_configurations

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.metrics_configurations
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new metrics_configurations resource.

All Properties

/*+ create */
INSERT INTO azure.nexus.metrics_configurations (
clusterName,
metricsConfigurationName,
resourceGroupName,
subscriptionId,
data__extendedLocation,
data__properties,
extendedLocation,
properties,
tags,
location
)
SELECT 
'{{ clusterName }}',
'{{ metricsConfigurationName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__extendedLocation }}',
'{{ data__properties }}',
'{{ extendedLocation }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: string
    - name: properties
      value:
        - name: collectionInterval
          value: integer
        - name: detailedStatus
          value: string
        - name: detailedStatusMessage
          value: string
        - name: disabledMetrics
          value:
            - string
        - name: enabledMetrics
          value:
            - string
        - name: provisioningState
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a metrics_configurations resource.

/*+ update */
UPDATE azure.nexus.metrics_configurations
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
clusterName = '{{ clusterName }}'
AND metricsConfigurationName = '{{ metricsConfigurationName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified metrics_configurations resource.

/*+ delete */
DELETE FROM azure.nexus.metrics_configurations
WHERE clusterName = '{{ clusterName }}'
AND metricsConfigurationName = '{{ metricsConfigurationName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';