@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.38 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets the details of the Diagnostic specified by its identifier.
*
* Uses Azure REST API version 2022-09-01-preview.
*
* 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 function getDiagnostic(args: GetDiagnosticArgs, opts?: pulumi.InvokeOptions): Promise<GetDiagnosticResult>;
export interface GetDiagnosticArgs {
/**
* Diagnostic identifier. Must be unique in the current API Management service instance.
*/
diagnosticId: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The name of the API Management service.
*/
serviceName: string;
}
/**
* Diagnostic details.
*/
export interface GetDiagnosticResult {
/**
* Specifies for what type of messages sampling settings should not apply.
*/
readonly alwaysLog?: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Diagnostic settings for incoming/outgoing HTTP messages to the Backend
*/
readonly backend?: outputs.apimanagement.PipelineDiagnosticSettingsResponse;
/**
* Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
*/
readonly frontend?: outputs.apimanagement.PipelineDiagnosticSettingsResponse;
/**
* Sets correlation protocol to use for Application Insights diagnostics.
*/
readonly httpCorrelationProtocol?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* Log the ClientIP. Default is false.
*/
readonly logClientIp?: boolean;
/**
* Resource Id of a target logger.
*/
readonly loggerId: string;
/**
* Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
*/
readonly metrics?: boolean;
/**
* The name of the resource
*/
readonly name: string;
/**
* The format of the Operation Name for Application Insights telemetries. Default is Name.
*/
readonly operationNameFormat?: string;
/**
* Sampling settings for Diagnostic.
*/
readonly sampling?: outputs.apimanagement.SamplingSettingsResponse;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* The verbosity level applied to traces emitted by trace policies.
*/
readonly verbosity?: string;
}
/**
* Gets the details of the Diagnostic specified by its identifier.
*
* Uses Azure REST API version 2022-09-01-preview.
*
* 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 function getDiagnosticOutput(args: GetDiagnosticOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDiagnosticResult>;
export interface GetDiagnosticOutputArgs {
/**
* Diagnostic identifier. Must be unique in the current API Management service instance.
*/
diagnosticId: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the API Management service.
*/
serviceName: pulumi.Input<string>;
}