DiagnosticContract interface

Package:

@azure/arm-apimanagement

Diagnostic details.

Extends

ProxyResource

Properties

alwaysLog	Specifies for what type of messages sampling settings should not apply.
backend	Diagnostic settings for incoming/outgoing HTTP messages to the Backend
frontend	Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
httpCorrelationProtocol	Sets correlation protocol to use for Application Insights diagnostics.
logClientIp	Log the ClientIP. Default is false.
loggerId	Resource Id of a target logger.
metrics	Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
operationNameFormat	The format of the Operation Name for Application Insights telemetries. Default is Name.
sampling	Sampling settings for Diagnostic.
verbosity	The verbosity level applied to traces emitted by trace policies.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

alwaysLog

Specifies for what type of messages sampling settings should not apply.

alwaysLog?: string

Property Value

string

backend

Diagnostic settings for incoming/outgoing HTTP messages to the Backend

backend?: PipelineDiagnosticSettings

Property Value

PipelineDiagnosticSettings

frontend

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

frontend?: PipelineDiagnosticSettings

Property Value

PipelineDiagnosticSettings

httpCorrelationProtocol

Sets correlation protocol to use for Application Insights diagnostics.

httpCorrelationProtocol?: string

Property Value

string

logClientIp

Log the ClientIP. Default is false.

logClientIp?: boolean

Property Value

boolean

loggerId

Resource Id of a target logger.

loggerId?: string

Property Value

string

metrics

Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.

metrics?: boolean

Property Value

boolean

operationNameFormat

The format of the Operation Name for Application Insights telemetries. Default is Name.

operationNameFormat?: string

Property Value

string

sampling

Sampling settings for Diagnostic.

sampling?: SamplingSettings

Property Value

SamplingSettings

verbosity

The verbosity level applied to traces emitted by trace policies.

verbosity?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type