@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.06 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Diagnostic details.
*
* Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-08-01.
*
* Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native apimanagement [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Diagnostic extends pulumi.CustomResource {
/**
* Get an existing Diagnostic resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Diagnostic;
/**
* Returns true if the given object is an instance of Diagnostic. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Diagnostic;
/**
* Specifies for what type of messages sampling settings should not apply.
*/
readonly alwaysLog: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Diagnostic settings for incoming/outgoing HTTP messages to the Backend
*/
readonly backend: pulumi.Output<outputs.apimanagement.PipelineDiagnosticSettingsResponse | undefined>;
/**
* Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
*/
readonly frontend: pulumi.Output<outputs.apimanagement.PipelineDiagnosticSettingsResponse | undefined>;
/**
* Sets correlation protocol to use for Application Insights diagnostics.
*/
readonly httpCorrelationProtocol: pulumi.Output<string | undefined>;
/**
* Log the ClientIP. Default is false.
*/
readonly logClientIp: pulumi.Output<boolean | undefined>;
/**
* Resource Id of a target logger.
*/
readonly loggerId: pulumi.Output<string>;
/**
* Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
*/
readonly metrics: pulumi.Output<boolean | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The format of the Operation Name for Application Insights telemetries. Default is Name.
*/
readonly operationNameFormat: pulumi.Output<string | undefined>;
/**
* Sampling settings for Diagnostic.
*/
readonly sampling: pulumi.Output<outputs.apimanagement.SamplingSettingsResponse | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* The verbosity level applied to traces emitted by trace policies.
*/
readonly verbosity: pulumi.Output<string | undefined>;
/**
* Create a Diagnostic resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DiagnosticArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Diagnostic resource.
*/
export interface DiagnosticArgs {
/**
* Specifies for what type of messages sampling settings should not apply.
*/
alwaysLog?: pulumi.Input<string | enums.apimanagement.AlwaysLog>;
/**
* Diagnostic settings for incoming/outgoing HTTP messages to the Backend
*/
backend?: pulumi.Input<inputs.apimanagement.PipelineDiagnosticSettingsArgs>;
/**
* Diagnostic identifier. Must be unique in the current API Management service instance.
*/
diagnosticId?: pulumi.Input<string>;
/**
* Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
*/
frontend?: pulumi.Input<inputs.apimanagement.PipelineDiagnosticSettingsArgs>;
/**
* Sets correlation protocol to use for Application Insights diagnostics.
*/
httpCorrelationProtocol?: pulumi.Input<string | enums.apimanagement.HttpCorrelationProtocol>;
/**
* Log the ClientIP. Default is false.
*/
logClientIp?: pulumi.Input<boolean>;
/**
* Resource Id of a target logger.
*/
loggerId: pulumi.Input<string>;
/**
* Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
*/
metrics?: pulumi.Input<boolean>;
/**
* The format of the Operation Name for Application Insights telemetries. Default is Name.
*/
operationNameFormat?: pulumi.Input<string | enums.apimanagement.OperationNameFormat>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Sampling settings for Diagnostic.
*/
sampling?: pulumi.Input<inputs.apimanagement.SamplingSettingsArgs>;
/**
* The name of the API Management service.
*/
serviceName: pulumi.Input<string>;
/**
* The verbosity level applied to traces emitted by trace policies.
*/
verbosity?: pulumi.Input<string | enums.apimanagement.Verbosity>;
}