All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azurenative.apimanagement.kotlin.ApiDiagnostic.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 2.82.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azurenative.apimanagement.kotlin

import com.pulumi.azurenative.apimanagement.kotlin.outputs.PipelineDiagnosticSettingsResponse
import com.pulumi.azurenative.apimanagement.kotlin.outputs.SamplingSettingsResponse
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import com.pulumi.azurenative.apimanagement.kotlin.outputs.PipelineDiagnosticSettingsResponse.Companion.toKotlin as pipelineDiagnosticSettingsResponseToKotlin
import com.pulumi.azurenative.apimanagement.kotlin.outputs.SamplingSettingsResponse.Companion.toKotlin as samplingSettingsResponseToKotlin

/**
 * Builder for [ApiDiagnostic].
 */
@PulumiTagMarker
public class ApiDiagnosticResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: ApiDiagnosticArgs = ApiDiagnosticArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend ApiDiagnosticArgsBuilder.() -> Unit) {
        val builder = ApiDiagnosticArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): ApiDiagnostic {
        val builtJavaResource =
            com.pulumi.azurenative.apimanagement.ApiDiagnostic(
                this.name,
                this.args.toJava(),
                this.opts.toJava(),
            )
        return ApiDiagnostic(builtJavaResource)
    }
}

/**
 * Diagnostic details.
 * Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
 * Other available API versions: 2018-01-01, 2019-01-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01.
 * ## Example Usage
 * ### ApiManagementCreateApiDiagnostic
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using AzureNative = Pulumi.AzureNative;
 * return await Deployment.RunAsync(() =>
 * {
 *     var apiDiagnostic = new AzureNative.ApiManagement.ApiDiagnostic("apiDiagnostic", 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 = "/loggers/applicationinsights",
 *         ResourceGroupName = "rg1",
 *         Sampling = new AzureNative.ApiManagement.Inputs.SamplingSettingsArgs
 *         {
 *             Percentage = 50,
 *             SamplingType = AzureNative.ApiManagement.SamplingType.@Fixed,
 *         },
 *         ServiceName = "apimService1",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := apimanagement.NewApiDiagnostic(ctx, "apiDiagnostic", &apimanagement.ApiDiagnosticArgs{
 * 			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("/loggers/applicationinsights"),
 * 			ResourceGroupName: pulumi.String("rg1"),
 * 			Sampling: &apimanagement.SamplingSettingsArgs{
 * 				Percentage:   pulumi.Float64(50),
 * 				SamplingType: pulumi.String(apimanagement.SamplingTypeFixed),
 * 			},
 * 			ServiceName: pulumi.String("apimService1"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.azurenative.apimanagement.ApiDiagnostic;
 * import com.pulumi.azurenative.apimanagement.ApiDiagnosticArgs;
 * 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 apiDiagnostic = new ApiDiagnostic("apiDiagnostic", ApiDiagnosticArgs.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("/loggers/applicationinsights")
 *             .resourceGroupName("rg1")
 *             .sampling(SamplingSettingsArgs.builder()
 *                 .percentage(50)
 *                 .samplingType("fixed")
 *                 .build())
 *             .serviceName("apimService1")
 *             .build());
 *     }
 * }
 * ```
 * ## Import
 * An existing resource can be imported using its type token, name, and identifier, e.g.
 * ```sh
 * $ pulumi import azure-native:apimanagement:ApiDiagnostic applicationinsights /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}
 * ```
 */
public class ApiDiagnostic internal constructor(
    override val javaResource: com.pulumi.azurenative.apimanagement.ApiDiagnostic,
) : KotlinCustomResource(javaResource, ApiDiagnosticMapper) {
    /**
     * Specifies for what type of messages sampling settings should not apply.
     */
    public val alwaysLog: Output?
        get() = javaResource.alwaysLog().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * Diagnostic settings for incoming/outgoing HTTP messages to the Backend
     */
    public val backend: Output?
        get() = javaResource.backend().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    pipelineDiagnosticSettingsResponseToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
     */
    public val frontend: Output?
        get() = javaResource.frontend().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    pipelineDiagnosticSettingsResponseToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * Sets correlation protocol to use for Application Insights diagnostics.
     */
    public val httpCorrelationProtocol: Output?
        get() = javaResource.httpCorrelationProtocol().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Log the ClientIP. Default is false.
     */
    public val logClientIp: Output?
        get() = javaResource.logClientIp().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Resource Id of a target logger.
     */
    public val loggerId: Output
        get() = javaResource.loggerId().applyValue({ args0 -> args0 })

    /**
     * Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
     */
    public val metrics: Output?
        get() = javaResource.metrics().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The name of the resource
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The format of the Operation Name for Application Insights telemetries. Default is Name.
     */
    public val operationNameFormat: Output?
        get() = javaResource.operationNameFormat().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * Sampling settings for Diagnostic.
     */
    public val sampling: Output?
        get() = javaResource.sampling().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    samplingSettingsResponseToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     */
    public val type: Output
        get() = javaResource.type().applyValue({ args0 -> args0 })

    /**
     * The verbosity level applied to traces emitted by trace policies.
     */
    public val verbosity: Output?
        get() = javaResource.verbosity().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}

public object ApiDiagnosticMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azurenative.apimanagement.ApiDiagnostic::class == javaResource::class

    override fun map(javaResource: Resource): ApiDiagnostic = ApiDiagnostic(
        javaResource as
            com.pulumi.azurenative.apimanagement.ApiDiagnostic,
    )
}

/**
 * @see [ApiDiagnostic].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [ApiDiagnostic].
 */
public suspend fun apiDiagnostic(
    name: String,
    block: suspend ApiDiagnosticResourceBuilder.() -> Unit,
): ApiDiagnostic {
    val builder = ApiDiagnosticResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [ApiDiagnostic].
 * @param name The _unique_ name of the resulting resource.
 */
public fun apiDiagnostic(name: String): ApiDiagnostic {
    val builder = ApiDiagnosticResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy