traffic_manager_user_metrics_keys

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

Overview

Name	traffic_manager_user_metrics_keys
Type	Resource
Id	azure.traffic_manager.traffic_manager_user_metrics_keys

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/Microsoft.Network/trafficManagerProfiles/{resourceName}.
name	string	The name of the resource.
key	string	The key returned by the User Metrics operation.
type	string	The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscription_id		Get the subscription-level key used for Real User Metrics collection.
create_or_update	insert	subscription_id		Create or update a subscription-level key used for Real User Metrics collection.
create_or_update	replace	subscription_id		Create or update a subscription-level key used for Real User Metrics collection.
delete	delete	subscription_id		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
subscription_id	string

SELECT examples

get

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

SELECT
id,
name,
key,
type
FROM azure.traffic_manager.traffic_manager_user_metrics_keys
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.traffic_manager.traffic_manager_user_metrics_keys (
subscription_id
)
SELECT 
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: traffic_manager_user_metrics_keys
props:
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the traffic_manager_user_metrics_keys resource.

REPLACE examples

create_or_update

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

REPLACE azure.traffic_manager.traffic_manager_user_metrics_keys
SET 
-- No updatable properties
WHERE 
subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

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

DELETE FROM azure.traffic_manager.traffic_manager_user_metrics_keys
WHERE subscription_id = '{{ subscription_id }}' --required
;