GradientEdge CDK Utils
    Preparing search index...

    Interface ApiDiagnosticProps

    interface ApiDiagnosticProps {
        alwaysLog?: Input<string>;
        apiId: Input<string>;
        backend?: Input<PipelineDiagnosticSettingsArgs>;
        diagnosticId?: Input<string>;
        frontend?: Input<PipelineDiagnosticSettingsArgs>;
        httpCorrelationProtocol?: Input<string>;
        logClientIp?: Input<boolean>;
        loggerId: Input<string>;
        metrics?: Input<boolean>;
        operationNameFormat?: Input<string>;
        resourceGroupName: Input<string>;
        sampling?: Input<SamplingSettingsArgs>;
        serviceName: Input<string>;
        verbosity?: Input<string>;
    }

    Hierarchy

    • ApiDiagnosticArgs
      • ApiDiagnosticProps
    Index

    Properties

    alwaysLog? apiId backend? diagnosticId? frontend? httpCorrelationProtocol? logClientIp? loggerId metrics? operationNameFormat? resourceGroupName sampling? serviceName verbosity?

    Properties

    alwaysLog?: Input<string>

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

    apiId: Input<string>

    API identifier. Must be unique in the current API Management service instance.

    backend?: Input<PipelineDiagnosticSettingsArgs>

    Diagnostic settings for incoming/outgoing HTTP messages to the Backend

    diagnosticId?: Input<string>

    Diagnostic identifier. Must be unique in the current API Management service instance.

    frontend?: Input<PipelineDiagnosticSettingsArgs>

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

    httpCorrelationProtocol?: Input<string>

    Sets correlation protocol to use for Application Insights diagnostics.

    logClientIp?: Input<boolean>

    Log the ClientIP. Default is false.

    loggerId: Input<string>

    Resource Id of a target logger.

    metrics?: Input<boolean>

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

    operationNameFormat?: Input<string>

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

    resourceGroupName: Input<string>

    The name of the resource group. The name is case insensitive.

    sampling?: Input<SamplingSettingsArgs>

    Sampling settings for Diagnostic.

    serviceName: Input<string>

    The name of the API Management service.

    verbosity?: Input<string>

    The verbosity level applied to traces emitted by trace policies.

    Settings

    Member Visibility

    On This Page

    Properties