metrics_configurations

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

Overview

Name	metrics_configurations
Type	Resource
Id	azure.nexus.metrics_configurations

Fields

The following fields are returned by SELECT queries:

get

The resource has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: ClusterMetricsConfigurationProperties represents the properties of metrics configuration for the cluster.)
tags	object	Resource tags.

list_by_cluster

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: ClusterMetricsConfigurationProperties represents the properties of metrics configuration for the cluster.)
tags	object	Resource tags.

Methods

The following methods are available for this resource:

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

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
clusterName	string	The name of the cluster.
metricsConfigurationName	string	The name of the metrics configuration for the cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get metrics configuration of the provided cluster.

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

list_by_cluster

Get a list of metrics configurations for the provided cluster.

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

INSERT examples

create_or_update

Create new or update the existing metrics configuration of the provided cluster.

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

Manifest

# Description fields are for documentation purposes
- name: metrics_configurations
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the metrics_configurations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the metrics_configurations resource.
    - name: clusterName
      value: string
      description: Required parameter for the metrics_configurations resource.
    - name: metricsConfigurationName
      value: string
      description: Required parameter for the metrics_configurations resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the cluster associated with the resource.
    - name: properties
      value: object
      description: |
        The list of the resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Patch properties of metrics configuration for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.

UPDATE azure.nexus.metrics_configurations
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND metricsConfigurationName = '{{ metricsConfigurationName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete the metrics configuration of the provided cluster.

DELETE FROM azure.nexus.metrics_configurations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND metricsConfigurationName = '{{ metricsConfigurationName }}' --required
;