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

com.pulumi.azure.apimanagement.kotlin.NamedValueArgs.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.apimanagement.kotlin

import com.pulumi.azure.apimanagement.NamedValueArgs.builder
import com.pulumi.azure.apimanagement.kotlin.inputs.NamedValueValueFromKeyVaultArgs
import com.pulumi.azure.apimanagement.kotlin.inputs.NamedValueValueFromKeyVaultArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName

/**
 * Manages an API Management Named Value.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = new azure.core.ResourceGroup("example", {
 *     name: "example-resources",
 *     location: "West Europe",
 * });
 * const exampleService = new azure.apimanagement.Service("example", {
 *     name: "example-apim",
 *     location: example.location,
 *     resourceGroupName: example.name,
 *     publisherName: "pub1",
 *     publisherEmail: "[email protected]",
 *     skuName: "Developer_1",
 * });
 * const exampleNamedValue = new azure.apimanagement.NamedValue("example", {
 *     name: "example-apimg",
 *     resourceGroupName: example.name,
 *     apiManagementName: exampleService.name,
 *     displayName: "ExampleProperty",
 *     value: "Example Value",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_service = azure.apimanagement.Service("example",
 *     name="example-apim",
 *     location=example.location,
 *     resource_group_name=example.name,
 *     publisher_name="pub1",
 *     publisher_email="[email protected]",
 *     sku_name="Developer_1")
 * example_named_value = azure.apimanagement.NamedValue("example",
 *     name="example-apimg",
 *     resource_group_name=example.name,
 *     api_management_name=example_service.name,
 *     display_name="ExampleProperty",
 *     value="Example Value")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.Core.ResourceGroup("example", new()
 *     {
 *         Name = "example-resources",
 *         Location = "West Europe",
 *     });
 *     var exampleService = new Azure.ApiManagement.Service("example", new()
 *     {
 *         Name = "example-apim",
 *         Location = example.Location,
 *         ResourceGroupName = example.Name,
 *         PublisherName = "pub1",
 *         PublisherEmail = "[email protected]",
 *         SkuName = "Developer_1",
 *     });
 *     var exampleNamedValue = new Azure.ApiManagement.NamedValue("example", new()
 *     {
 *         Name = "example-apimg",
 *         ResourceGroupName = example.Name,
 *         ApiManagementName = exampleService.Name,
 *         DisplayName = "ExampleProperty",
 *         Value = "Example Value",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
 * 			Name:     pulumi.String("example-resources"),
 * 			Location: pulumi.String("West Europe"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
 * 			Name:              pulumi.String("example-apim"),
 * 			Location:          example.Location,
 * 			ResourceGroupName: example.Name,
 * 			PublisherName:     pulumi.String("pub1"),
 * 			PublisherEmail:    pulumi.String("[email protected]"),
 * 			SkuName:           pulumi.String("Developer_1"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = apimanagement.NewNamedValue(ctx, "example", &apimanagement.NamedValueArgs{
 * 			Name:              pulumi.String("example-apimg"),
 * 			ResourceGroupName: example.Name,
 * 			ApiManagementName: exampleService.Name,
 * 			DisplayName:       pulumi.String("ExampleProperty"),
 * 			Value:             pulumi.String("Example Value"),
 * 		})
 * 		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.azure.core.ResourceGroup;
 * import com.pulumi.azure.core.ResourceGroupArgs;
 * import com.pulumi.azure.apimanagement.Service;
 * import com.pulumi.azure.apimanagement.ServiceArgs;
 * import com.pulumi.azure.apimanagement.NamedValue;
 * import com.pulumi.azure.apimanagement.NamedValueArgs;
 * 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
 *             .name("example-resources")
 *             .location("West Europe")
 *             .build());
 *         var exampleService = new Service("exampleService", ServiceArgs.builder()
 *             .name("example-apim")
 *             .location(example.location())
 *             .resourceGroupName(example.name())
 *             .publisherName("pub1")
 *             .publisherEmail("[email protected]")
 *             .skuName("Developer_1")
 *             .build());
 *         var exampleNamedValue = new NamedValue("exampleNamedValue", NamedValueArgs.builder()
 *             .name("example-apimg")
 *             .resourceGroupName(example.name())
 *             .apiManagementName(exampleService.name())
 *             .displayName("ExampleProperty")
 *             .value("Example Value")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   exampleService:
 *     type: azure:apimanagement:Service
 *     name: example
 *     properties:
 *       name: example-apim
 *       location: ${example.location}
 *       resourceGroupName: ${example.name}
 *       publisherName: pub1
 *       publisherEmail: [email protected]
 *       skuName: Developer_1
 *   exampleNamedValue:
 *     type: azure:apimanagement:NamedValue
 *     name: example
 *     properties:
 *       name: example-apimg
 *       resourceGroupName: ${example.name}
 *       apiManagementName: ${exampleService.name}
 *       displayName: ExampleProperty
 *       value: Example Value
 * ```
 * 
 * ## Import
 * API Management Properties can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:apimanagement/namedValue:NamedValue example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-resources/providers/Microsoft.ApiManagement/service/example-apim/namedValues/example-apimp
 * ```
 * @property apiManagementName The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.
 * @property displayName The display name of this API Management Named Value.
 * @property name The name of the API Management Named Value. Changing this forces a new resource to be created.
 * @property resourceGroupName The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.
 * @property secret Specifies whether the API Management Named Value is secret. Valid values are `true` or `false`. The default value is `false`.
 * > **NOTE:** setting the field `secret` to `true` doesn't make this field sensitive in the provider, instead it marks the value as secret and encrypts the value in Azure.
 * @property tags A list of tags to be applied to the API Management Named Value.
 * @property value The value of this API Management Named Value.
 * @property valueFromKeyVault A `value_from_key_vault` block as defined below. If specified, `secret` must also be set to `true`.
 */
public data class NamedValueArgs(
    public val apiManagementName: Output? = null,
    public val displayName: Output? = null,
    public val name: Output? = null,
    public val resourceGroupName: Output? = null,
    public val secret: Output? = null,
    public val tags: Output>? = null,
    public val `value`: Output? = null,
    public val valueFromKeyVault: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.apimanagement.NamedValueArgs =
        com.pulumi.azure.apimanagement.NamedValueArgs.builder()
            .apiManagementName(apiManagementName?.applyValue({ args0 -> args0 }))
            .displayName(displayName?.applyValue({ args0 -> args0 }))
            .name(name?.applyValue({ args0 -> args0 }))
            .resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
            .secret(secret?.applyValue({ args0 -> args0 }))
            .tags(tags?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
            .`value`(`value`?.applyValue({ args0 -> args0 }))
            .valueFromKeyVault(
                valueFromKeyVault?.applyValue({ args0 ->
                    args0.let({ args0 ->
                        args0.toJava()
                    })
                }),
            ).build()
}

/**
 * Builder for [NamedValueArgs].
 */
@PulumiTagMarker
public class NamedValueArgsBuilder internal constructor() {
    private var apiManagementName: Output? = null

    private var displayName: Output? = null

    private var name: Output? = null

    private var resourceGroupName: Output? = null

    private var secret: Output? = null

    private var tags: Output>? = null

    private var `value`: Output? = null

    private var valueFromKeyVault: Output? = null

    /**
     * @param value The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.
     */
    @JvmName("dsudoiqcrpkvpgil")
    public suspend fun apiManagementName(`value`: Output) {
        this.apiManagementName = value
    }

    /**
     * @param value The display name of this API Management Named Value.
     */
    @JvmName("uqftabaaaggvsjhv")
    public suspend fun displayName(`value`: Output) {
        this.displayName = value
    }

    /**
     * @param value The name of the API Management Named Value. Changing this forces a new resource to be created.
     */
    @JvmName("bfqrclxqpkfkajus")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.
     */
    @JvmName("qrviagdikqnaosjr")
    public suspend fun resourceGroupName(`value`: Output) {
        this.resourceGroupName = value
    }

    /**
     * @param value Specifies whether the API Management Named Value is secret. Valid values are `true` or `false`. The default value is `false`.
     * > **NOTE:** setting the field `secret` to `true` doesn't make this field sensitive in the provider, instead it marks the value as secret and encrypts the value in Azure.
     */
    @JvmName("tmmhnvingkgmjsrm")
    public suspend fun secret(`value`: Output) {
        this.secret = value
    }

    /**
     * @param value A list of tags to be applied to the API Management Named Value.
     */
    @JvmName("epuvhnneklajnigx")
    public suspend fun tags(`value`: Output>) {
        this.tags = value
    }

    @JvmName("ebfpdbwvcrreepfg")
    public suspend fun tags(vararg values: Output) {
        this.tags = Output.all(values.asList())
    }

    /**
     * @param values A list of tags to be applied to the API Management Named Value.
     */
    @JvmName("rjiyoeagtmxlsaka")
    public suspend fun tags(values: List>) {
        this.tags = Output.all(values)
    }

    /**
     * @param value The value of this API Management Named Value.
     */
    @JvmName("pgmmawqmiovbrmbo")
    public suspend fun `value`(`value`: Output) {
        this.`value` = value
    }

    /**
     * @param value A `value_from_key_vault` block as defined below. If specified, `secret` must also be set to `true`.
     */
    @JvmName("pqkhgykysgrxdsjn")
    public suspend fun valueFromKeyVault(`value`: Output) {
        this.valueFromKeyVault = value
    }

    /**
     * @param value The name of the API Management Service in which the API Management Named Value should exist. Changing this forces a new resource to be created.
     */
    @JvmName("sreelsbxkednjkye")
    public suspend fun apiManagementName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.apiManagementName = mapped
    }

    /**
     * @param value The display name of this API Management Named Value.
     */
    @JvmName("bqxohhoupvgrwmhn")
    public suspend fun displayName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.displayName = mapped
    }

    /**
     * @param value The name of the API Management Named Value. Changing this forces a new resource to be created.
     */
    @JvmName("akrqdbjksxhlyfyw")
    public suspend fun name(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.name = mapped
    }

    /**
     * @param value The name of the Resource Group in which the API Management Named Value should exist. Changing this forces a new resource to be created.
     */
    @JvmName("nudqvdbpjbfxqawf")
    public suspend fun resourceGroupName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.resourceGroupName = mapped
    }

    /**
     * @param value Specifies whether the API Management Named Value is secret. Valid values are `true` or `false`. The default value is `false`.
     * > **NOTE:** setting the field `secret` to `true` doesn't make this field sensitive in the provider, instead it marks the value as secret and encrypts the value in Azure.
     */
    @JvmName("agxtgichnonpsusw")
    public suspend fun secret(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.secret = mapped
    }

    /**
     * @param value A list of tags to be applied to the API Management Named Value.
     */
    @JvmName("tdooptsxirvbcgax")
    public suspend fun tags(`value`: List?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.tags = mapped
    }

    /**
     * @param values A list of tags to be applied to the API Management Named Value.
     */
    @JvmName("jlompmesebqokpoj")
    public suspend fun tags(vararg values: String) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.tags = mapped
    }

    /**
     * @param value The value of this API Management Named Value.
     */
    @JvmName("flfoulfryffryqhg")
    public suspend fun `value`(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.`value` = mapped
    }

    /**
     * @param value A `value_from_key_vault` block as defined below. If specified, `secret` must also be set to `true`.
     */
    @JvmName("uphtxkrpajvpoxys")
    public suspend fun valueFromKeyVault(`value`: NamedValueValueFromKeyVaultArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.valueFromKeyVault = mapped
    }

    /**
     * @param argument A `value_from_key_vault` block as defined below. If specified, `secret` must also be set to `true`.
     */
    @JvmName("vtkgbsjbjaphlupv")
    public suspend fun valueFromKeyVault(argument: suspend NamedValueValueFromKeyVaultArgsBuilder.() -> Unit) {
        val toBeMapped = NamedValueValueFromKeyVaultArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.valueFromKeyVault = mapped
    }

    internal fun build(): NamedValueArgs = NamedValueArgs(
        apiManagementName = apiManagementName,
        displayName = displayName,
        name = name,
        resourceGroupName = resourceGroupName,
        secret = secret,
        tags = tags,
        `value` = `value`,
        valueFromKeyVault = valueFromKeyVault,
    )
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy