metrics_configurations

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

Overview

Name	metrics_configurations
Type	Resource
Id	azure_extras.network_cloud.metrics_configurations

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.
collectionInterval	integer	The interval in minutes by which metrics will be collected. Required.
detailedStatus	string	The more detailed status of the metrics configuration. Known values are: "Processing", "Applied", and "Error". (Processing, Applied, Error)
detailedStatusMessage	string	The descriptive message about the current detailed status.
disabledMetrics	array	The list of metrics that are available for the cluster but disabled at the moment.
enabledMetrics	array	The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the metrics configuration. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Provisioning". (Succeeded, Failed, Canceled, Accepted, Provisioning)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_cluster

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.
collectionInterval	integer	The interval in minutes by which metrics will be collected. Required.
detailedStatus	string	The more detailed status of the metrics configuration. Known values are: "Processing", "Applied", and "Error". (Processing, Applied, Error)
detailedStatusMessage	string	The descriptive message about the current detailed status.
disabledMetrics	array	The list of metrics that are available for the cluster but disabled at the moment.
enabledMetrics	array	The list of metric names that have been chosen to be enabled in addition to the core set of enabled metrics.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
extendedLocation	object	The extended location of the resource. This property is required when creating the resource. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the metrics configuration. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Provisioning". (Succeeded, Failed, Canceled, Accepted, Provisioning)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	resource_group_name, cluster_name, metrics_configuration_name, subscription_id		Get metrics configuration of the provided cluster.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id	$top, $skipToken	Get a list of metrics configurations for the provided cluster.
create_or_update	insert	resource_group_name, cluster_name, metrics_configuration_name, subscription_id, location, properties, extendedLocation		Create new or update the existing metrics configuration of the provided cluster.
update	update	resource_group_name, cluster_name, metrics_configuration_name, subscription_id		Patch properties of metrics configuration for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.
create_or_update	replace	resource_group_name, cluster_name, metrics_configuration_name, subscription_id, location, properties, extendedLocation		Create new or update the existing metrics configuration of the provided cluster.
delete	delete	resource_group_name, cluster_name, metrics_configuration_name, subscription_id		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
cluster_name	string	The name of the cluster. Required.
metrics_configuration_name	string	The name of the metrics configuration for the cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$skipToken	string	The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get metrics configuration of the provided cluster.

SELECT
id,
name,
collectionInterval,
detailedStatus,
detailedStatusMessage,
disabledMetrics,
enabledMetrics,
etag,
extendedLocation,
location,
provisioningState,
systemData,
tags,
type
FROM azure_extras.network_cloud.metrics_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND metrics_configuration_name = '{{ metrics_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_cluster

Get a list of metrics configurations for the provided cluster.

SELECT
id,
name,
collectionInterval,
detailedStatus,
detailedStatusMessage,
disabledMetrics,
enabledMetrics,
etag,
extendedLocation,
location,
provisioningState,
systemData,
tags,
type
FROM azure_extras.network_cloud.metrics_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.network_cloud.metrics_configurations (
tags,
location,
properties,
extendedLocation,
resource_group_name,
cluster_name,
metrics_configuration_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ extendedLocation }}' /* required */,
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ metrics_configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: metrics_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the metrics_configurations resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the metrics_configurations resource.
  - name: metrics_configuration_name
    value: "{{ metrics_configuration_name }}"
    description: Required parameter for the metrics_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the metrics_configurations resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The list of the resource properties. Required.
    value:
      enabledMetrics:
        - "{{ enabledMetrics }}"
      collectionInterval: {{ collectionInterval }}
      detailedStatus: "{{ detailedStatus }}"
      detailedStatusMessage: "{{ detailedStatusMessage }}"
      disabledMetrics:
        - "{{ disabledMetrics }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location of the resource. This property is required when creating the resource. Required.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

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_extras.network_cloud.metrics_configurations
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND metrics_configuration_name = '{{ metrics_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure_extras.network_cloud.metrics_configurations
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND metrics_configuration_name = '{{ metrics_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the metrics configuration of the provided cluster.

DELETE FROM azure_extras.network_cloud.metrics_configurations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND metrics_configuration_name = '{{ metrics_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;