is_subscribeds

Creates, updates, deletes, gets or lists an is_subscribeds resource.

Overview

Name	is_subscribeds
Type	Resource
Id	azure.monitor_opentelemetry_exporter.is_subscribeds

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
is_subscribed	exec	ikey, host, api_version, Version, InvariantVersion, Instance, RoleName, MachineName, StreamId, IsWebApp, PerformanceCollectionSupported	x-ms-qps-transmission-time, x-ms-qps-machine-name, x-ms-qps-instance-name, x-ms-qps-stream-id, x-ms-qps-role-name, x-ms-qps-invariant-version, x-ms-qps-configuration-etag	Determine whether there is any subscription to the metrics and documents.

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
api_version	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client apiVersion parameter. (default: )
host	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client host parameter. (default: )
ikey	string	The instrumentation key of the target Application Insights component for which the client checks whether there's any subscription to it. Required.
x-ms-qps-configuration-etag	string	An encoded string that indicates whether the collection configuration is changed. Default value is None.
x-ms-qps-instance-name	string	Service instance name where Application Insights SDK lives. Live Metrics uses machine name with instance name as a backup. Default value is None.
x-ms-qps-invariant-version	string	Version/generation of the data contract (MonitoringDataPoint) between the client and Live Metrics. Default value is None.
x-ms-qps-machine-name	string	Computer name where Application Insights SDK lives. Live Metrics uses machine name with instance name as a backup. Default value is None.
x-ms-qps-role-name	string	Cloud role name of the service. Default value is None.
x-ms-qps-stream-id	string	Identifies an Application Insights SDK as trusted agent to report metrics and documents. Default value is None.
x-ms-qps-transmission-time	integer	Timestamp when the client transmits the metrics and documents to Live Metrics. A 8-byte long type of ticks. Default value is None.

Lifecycle Methods

is_subscribed

Determine whether there is any subscription to the metrics and documents.

EXEC azure.monitor_opentelemetry_exporter.is_subscribeds.is_subscribed 
@ikey='{{ ikey }}' --required, 
@host='{{ host }}' --required, 
@api_version='{{ api_version }}' --required, 
@x-ms-qps-transmission-time='{{ x-ms-qps-transmission-time }}', 
@x-ms-qps-machine-name='{{ x-ms-qps-machine-name }}', 
@x-ms-qps-instance-name='{{ x-ms-qps-instance-name }}', 
@x-ms-qps-stream-id='{{ x-ms-qps-stream-id }}', 
@x-ms-qps-role-name='{{ x-ms-qps-role-name }}', 
@x-ms-qps-invariant-version='{{ x-ms-qps-invariant-version }}', 
@x-ms-qps-configuration-etag='{{ x-ms-qps-configuration-etag }}' 
@@json=
'{
"Version": "{{ Version }}", 
"InvariantVersion": {{ InvariantVersion }}, 
"Instance": "{{ Instance }}", 
"RoleName": "{{ RoleName }}", 
"MachineName": "{{ MachineName }}", 
"StreamId": "{{ StreamId }}", 
"Timestamp": "{{ Timestamp }}", 
"TransmissionTime": "{{ TransmissionTime }}", 
"IsWebApp": {{ IsWebApp }}, 
"PerformanceCollectionSupported": {{ PerformanceCollectionSupported }}, 
"Metrics": "{{ Metrics }}", 
"Documents": "{{ Documents }}", 
"TopCpuProcesses": "{{ TopCpuProcesses }}", 
"CollectionConfigurationErrors": "{{ CollectionConfigurationErrors }}"
}'
;