user_metrics_keys

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

Overview

Name	user_metrics_keys
Type	Resource
Id	azure.traffic_manager.user_metrics_keys

Fields

The following fields are returned by SELECT queries:

get

The subscription-level Traffic Manager Real User Metrics key.

Name	Datatype	Description
properties	object	The properties of the Traffic Manager User Metrics.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId		Get the subscription-level key used for Real User Metrics collection.
create_or_update	insert	subscriptionId		Create or update a subscription-level key used for Real User Metrics collection.
delete	delete	subscriptionId		Delete a subscription-level key used for Real User Metrics collection.

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
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Get the subscription-level key used for Real User Metrics collection.

SELECT
properties
FROM azure.traffic_manager.user_metrics_keys
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update a subscription-level key used for Real User Metrics collection.

INSERT INTO azure.traffic_manager.user_metrics_keys (
subscriptionId
)
SELECT 
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: user_metrics_keys
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the user_metrics_keys resource.

DELETE examples

delete

Delete a subscription-level key used for Real User Metrics collection.

DELETE FROM azure.traffic_manager.user_metrics_keys
WHERE subscriptionId = '{{ subscriptionId }}' --required
;