WorkspaceApiDiagnostic

class WorkspaceApiDiagnostic : KotlinCustomResource

Diagnostic details. Uses Azure REST API version 2024-06-01-preview. In version 2.x of the Azure Native provider, it used API version 2023-09-01-preview. Other available API versions: 2023-09-01-preview, 2024-05-01. 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/#accessing-any-api-version-via-local-packages for details.

Example Usage

ApiManagementCreateWorkspaceApiDiagnostic

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var workspaceApiDiagnostic = new AzureNative.ApiManagement.WorkspaceApiDiagnostic("workspaceApiDiagnostic", new()
{
AlwaysLog = AzureNative.ApiManagement.AlwaysLog.AllErrors,
ApiId = "57d1f7558aa04f15146d9d8a",
Backend = new AzureNative.ApiManagement.Inputs.PipelineDiagnosticSettingsArgs
{
Request = new AzureNative.ApiManagement.Inputs.HttpMessageDiagnosticArgs
{
Body = new AzureNative.ApiManagement.Inputs.BodyDiagnosticSettingsArgs
{
Bytes = 512,
},
Headers = new[]
{
"Content-type",
},
},
Response = new AzureNative.ApiManagement.Inputs.HttpMessageDiagnosticArgs
{
Body = new AzureNative.ApiManagement.Inputs.BodyDiagnosticSettingsArgs
{
Bytes = 512,
},
Headers = new[]
{
"Content-type",
},
},
},
DiagnosticId = "applicationinsights",
Frontend = new AzureNative.ApiManagement.Inputs.PipelineDiagnosticSettingsArgs
{
Request = new AzureNative.ApiManagement.Inputs.HttpMessageDiagnosticArgs
{
Body = new AzureNative.ApiManagement.Inputs.BodyDiagnosticSettingsArgs
{
Bytes = 512,
},
Headers = new[]
{
"Content-type",
},
},
Response = new AzureNative.ApiManagement.Inputs.HttpMessageDiagnosticArgs
{
Body = new AzureNative.ApiManagement.Inputs.BodyDiagnosticSettingsArgs
{
Bytes = 512,
},
Headers = new[]
{
"Content-type",
},
},
},
LoggerId = "/workspaces/wks1/loggers/applicationinsights",
ResourceGroupName = "rg1",
Sampling = new AzureNative.ApiManagement.Inputs.SamplingSettingsArgs
{
Percentage = 50,
SamplingType = AzureNative.ApiManagement.SamplingType.@Fixed,
},
ServiceName = "apimService1",
WorkspaceId = "wks1",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewWorkspaceApiDiagnostic(ctx, "workspaceApiDiagnostic", &apimanagement.WorkspaceApiDiagnosticArgs{
AlwaysLog: pulumi.String(apimanagement.AlwaysLogAllErrors),
ApiId: pulumi.String("57d1f7558aa04f15146d9d8a"),
Backend: &apimanagement.PipelineDiagnosticSettingsArgs{
Request: &apimanagement.HttpMessageDiagnosticArgs{
Body: &apimanagement.BodyDiagnosticSettingsArgs{
Bytes: pulumi.Int(512),
},
Headers: pulumi.StringArray{
pulumi.String("Content-type"),
},
},
Response: &apimanagement.HttpMessageDiagnosticArgs{
Body: &apimanagement.BodyDiagnosticSettingsArgs{
Bytes: pulumi.Int(512),
},
Headers: pulumi.StringArray{
pulumi.String("Content-type"),
},
},
},
DiagnosticId: pulumi.String("applicationinsights"),
Frontend: &apimanagement.PipelineDiagnosticSettingsArgs{
Request: &apimanagement.HttpMessageDiagnosticArgs{
Body: &apimanagement.BodyDiagnosticSettingsArgs{
Bytes: pulumi.Int(512),
},
Headers: pulumi.StringArray{
pulumi.String("Content-type"),
},
},
Response: &apimanagement.HttpMessageDiagnosticArgs{
Body: &apimanagement.BodyDiagnosticSettingsArgs{
Bytes: pulumi.Int(512),
},
Headers: pulumi.StringArray{
pulumi.String("Content-type"),
},
},
},
LoggerId: pulumi.String("/workspaces/wks1/loggers/applicationinsights"),
ResourceGroupName: pulumi.String("rg1"),
Sampling: &apimanagement.SamplingSettingsArgs{
Percentage: pulumi.Float64(50),
SamplingType: pulumi.String(apimanagement.SamplingTypeFixed),
},
ServiceName: pulumi.String("apimService1"),
WorkspaceId: pulumi.String("wks1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.WorkspaceApiDiagnostic;
import com.pulumi.azurenative.apimanagement.WorkspaceApiDiagnosticArgs;
import com.pulumi.azurenative.apimanagement.inputs.PipelineDiagnosticSettingsArgs;
import com.pulumi.azurenative.apimanagement.inputs.HttpMessageDiagnosticArgs;
import com.pulumi.azurenative.apimanagement.inputs.BodyDiagnosticSettingsArgs;
import com.pulumi.azurenative.apimanagement.inputs.SamplingSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var workspaceApiDiagnostic = new WorkspaceApiDiagnostic("workspaceApiDiagnostic", WorkspaceApiDiagnosticArgs.builder()
.alwaysLog("allErrors")
.apiId("57d1f7558aa04f15146d9d8a")
.backend(PipelineDiagnosticSettingsArgs.builder()
.request(HttpMessageDiagnosticArgs.builder()
.body(BodyDiagnosticSettingsArgs.builder()
.bytes(512)
.build())
.headers("Content-type")
.build())
.response(HttpMessageDiagnosticArgs.builder()
.body(BodyDiagnosticSettingsArgs.builder()
.bytes(512)
.build())
.headers("Content-type")
.build())
.build())
.diagnosticId("applicationinsights")
.frontend(PipelineDiagnosticSettingsArgs.builder()
.request(HttpMessageDiagnosticArgs.builder()
.body(BodyDiagnosticSettingsArgs.builder()
.bytes(512)
.build())
.headers("Content-type")
.build())
.response(HttpMessageDiagnosticArgs.builder()
.body(BodyDiagnosticSettingsArgs.builder()
.bytes(512)
.build())
.headers("Content-type")
.build())
.build())
.loggerId("/workspaces/wks1/loggers/applicationinsights")
.resourceGroupName("rg1")
.sampling(SamplingSettingsArgs.builder()
.percentage(50.0)
.samplingType("fixed")
.build())
.serviceName("apimService1")
.workspaceId("wks1")
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:WorkspaceApiDiagnostic applicationinsights /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/diagnostics/{diagnosticId}

Properties

Link copied to clipboard
val alwaysLog: Output<String>?

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

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard

Diagnostic settings for incoming/outgoing HTTP messages to the Backend

Link copied to clipboard

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

Link copied to clipboard

Sets correlation protocol to use for Application Insights diagnostics.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

Large Language Models diagnostic settings

Link copied to clipboard
val logClientIp: Output<Boolean>?

Log the ClientIP. Default is false.

Link copied to clipboard
val loggerId: Output<String>

Resource Id of a target logger.

Link copied to clipboard
val metrics: Output<Boolean>?

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

Link copied to clipboard
val name: Output<String>

The name of the resource

Link copied to clipboard

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Sampling settings for Diagnostic.

Link copied to clipboard
val type: Output<String>

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val verbosity: Output<String>?

The verbosity level applied to traces emitted by trace policies.