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

com.pulumi.azure.bot.kotlin.ServiceAzureBot.kt Maven / Gradle / Ivy

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

package com.pulumi.azure.bot.kotlin

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 kotlin.collections.List
import kotlin.collections.Map

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

    public var args: ServiceAzureBotArgs = ServiceAzureBotArgs()

    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 ServiceAzureBotArgsBuilder.() -> Unit) {
        val builder = ServiceAzureBotArgsBuilder()
        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(): ServiceAzureBot {
        val builtJavaResource = com.pulumi.azure.bot.ServiceAzureBot(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return ServiceAzureBot(builtJavaResource)
    }
}

/**
 * Manages an Azure Bot Service.
 * ## 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 exampleInsights = new azure.appinsights.Insights("example", {
 *     name: "example-appinsights",
 *     location: example.location,
 *     resourceGroupName: example.name,
 *     applicationType: "web",
 * });
 * const exampleApiKey = new azure.appinsights.ApiKey("example", {
 *     name: "example-appinsightsapikey",
 *     applicationInsightsId: exampleInsights.id,
 *     readPermissions: [
 *         "aggregate",
 *         "api",
 *         "draft",
 *         "extendqueries",
 *         "search",
 *     ],
 * });
 * const current = azure.core.getClientConfig({});
 * const exampleServiceAzureBot = new azure.bot.ServiceAzureBot("example", {
 *     name: "exampleazurebot",
 *     resourceGroupName: example.name,
 *     location: "global",
 *     microsoftAppId: current.then(current => current.clientId),
 *     sku: "F0",
 *     endpoint: "https://example.com",
 *     developerAppInsightsApiKey: exampleApiKey.apiKey,
 *     developerAppInsightsApplicationId: exampleInsights.appId,
 *     tags: {
 *         environment: "test",
 *     },
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_insights = azure.appinsights.Insights("example",
 *     name="example-appinsights",
 *     location=example.location,
 *     resource_group_name=example.name,
 *     application_type="web")
 * example_api_key = azure.appinsights.ApiKey("example",
 *     name="example-appinsightsapikey",
 *     application_insights_id=example_insights.id,
 *     read_permissions=[
 *         "aggregate",
 *         "api",
 *         "draft",
 *         "extendqueries",
 *         "search",
 *     ])
 * current = azure.core.get_client_config()
 * example_service_azure_bot = azure.bot.ServiceAzureBot("example",
 *     name="exampleazurebot",
 *     resource_group_name=example.name,
 *     location="global",
 *     microsoft_app_id=current.client_id,
 *     sku="F0",
 *     endpoint="https://example.com",
 *     developer_app_insights_api_key=example_api_key.api_key,
 *     developer_app_insights_application_id=example_insights.app_id,
 *     tags={
 *         "environment": "test",
 *     })
 * ```
 * ```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 exampleInsights = new Azure.AppInsights.Insights("example", new()
 *     {
 *         Name = "example-appinsights",
 *         Location = example.Location,
 *         ResourceGroupName = example.Name,
 *         ApplicationType = "web",
 *     });
 *     var exampleApiKey = new Azure.AppInsights.ApiKey("example", new()
 *     {
 *         Name = "example-appinsightsapikey",
 *         ApplicationInsightsId = exampleInsights.Id,
 *         ReadPermissions = new[]
 *         {
 *             "aggregate",
 *             "api",
 *             "draft",
 *             "extendqueries",
 *             "search",
 *         },
 *     });
 *     var current = Azure.Core.GetClientConfig.Invoke();
 *     var exampleServiceAzureBot = new Azure.Bot.ServiceAzureBot("example", new()
 *     {
 *         Name = "exampleazurebot",
 *         ResourceGroupName = example.Name,
 *         Location = "global",
 *         MicrosoftAppId = current.Apply(getClientConfigResult => getClientConfigResult.ClientId),
 *         Sku = "F0",
 *         Endpoint = "https://example.com",
 *         DeveloperAppInsightsApiKey = exampleApiKey.ApiKey,
 *         DeveloperAppInsightsApplicationId = exampleInsights.AppId,
 *         Tags =
 *         {
 *             { "environment", "test" },
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/appinsights"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/bot"
 * 	"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
 * 		}
 * 		exampleInsights, err := appinsights.NewInsights(ctx, "example", &appinsights.InsightsArgs{
 * 			Name:              pulumi.String("example-appinsights"),
 * 			Location:          example.Location,
 * 			ResourceGroupName: example.Name,
 * 			ApplicationType:   pulumi.String("web"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleApiKey, err := appinsights.NewApiKey(ctx, "example", &appinsights.ApiKeyArgs{
 * 			Name:                  pulumi.String("example-appinsightsapikey"),
 * 			ApplicationInsightsId: exampleInsights.ID(),
 * 			ReadPermissions: pulumi.StringArray{
 * 				pulumi.String("aggregate"),
 * 				pulumi.String("api"),
 * 				pulumi.String("draft"),
 * 				pulumi.String("extendqueries"),
 * 				pulumi.String("search"),
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		current, err := core.GetClientConfig(ctx, nil, nil)
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = bot.NewServiceAzureBot(ctx, "example", &bot.ServiceAzureBotArgs{
 * 			Name:                              pulumi.String("exampleazurebot"),
 * 			ResourceGroupName:                 example.Name,
 * 			Location:                          pulumi.String("global"),
 * 			MicrosoftAppId:                    pulumi.String(current.ClientId),
 * 			Sku:                               pulumi.String("F0"),
 * 			Endpoint:                          pulumi.String("https://example.com"),
 * 			DeveloperAppInsightsApiKey:        exampleApiKey.ApiKey,
 * 			DeveloperAppInsightsApplicationId: exampleInsights.AppId,
 * 			Tags: pulumi.StringMap{
 * 				"environment": pulumi.String("test"),
 * 			},
 * 		})
 * 		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.appinsights.Insights;
 * import com.pulumi.azure.appinsights.InsightsArgs;
 * import com.pulumi.azure.appinsights.ApiKey;
 * import com.pulumi.azure.appinsights.ApiKeyArgs;
 * import com.pulumi.azure.core.CoreFunctions;
 * import com.pulumi.azure.bot.ServiceAzureBot;
 * import com.pulumi.azure.bot.ServiceAzureBotArgs;
 * 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 exampleInsights = new Insights("exampleInsights", InsightsArgs.builder()
 *             .name("example-appinsights")
 *             .location(example.location())
 *             .resourceGroupName(example.name())
 *             .applicationType("web")
 *             .build());
 *         var exampleApiKey = new ApiKey("exampleApiKey", ApiKeyArgs.builder()
 *             .name("example-appinsightsapikey")
 *             .applicationInsightsId(exampleInsights.id())
 *             .readPermissions(
 *                 "aggregate",
 *                 "api",
 *                 "draft",
 *                 "extendqueries",
 *                 "search")
 *             .build());
 *         final var current = CoreFunctions.getClientConfig();
 *         var exampleServiceAzureBot = new ServiceAzureBot("exampleServiceAzureBot", ServiceAzureBotArgs.builder()
 *             .name("exampleazurebot")
 *             .resourceGroupName(example.name())
 *             .location("global")
 *             .microsoftAppId(current.applyValue(getClientConfigResult -> getClientConfigResult.clientId()))
 *             .sku("F0")
 *             .endpoint("https://example.com")
 *             .developerAppInsightsApiKey(exampleApiKey.apiKey())
 *             .developerAppInsightsApplicationId(exampleInsights.appId())
 *             .tags(Map.of("environment", "test"))
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   exampleInsights:
 *     type: azure:appinsights:Insights
 *     name: example
 *     properties:
 *       name: example-appinsights
 *       location: ${example.location}
 *       resourceGroupName: ${example.name}
 *       applicationType: web
 *   exampleApiKey:
 *     type: azure:appinsights:ApiKey
 *     name: example
 *     properties:
 *       name: example-appinsightsapikey
 *       applicationInsightsId: ${exampleInsights.id}
 *       readPermissions:
 *         - aggregate
 *         - api
 *         - draft
 *         - extendqueries
 *         - search
 *   exampleServiceAzureBot:
 *     type: azure:bot:ServiceAzureBot
 *     name: example
 *     properties:
 *       name: exampleazurebot
 *       resourceGroupName: ${example.name}
 *       location: global
 *       microsoftAppId: ${current.clientId}
 *       sku: F0
 *       endpoint: https://example.com
 *       developerAppInsightsApiKey: ${exampleApiKey.apiKey}
 *       developerAppInsightsApplicationId: ${exampleInsights.appId}
 *       tags:
 *         environment: test
 * variables:
 *   current:
 *     fn::invoke:
 *       Function: azure:core:getClientConfig
 *       Arguments: {}
 * ```
 * 
 * ## Import
 * Azure Bot Services can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:bot/serviceAzureBot:ServiceAzureBot example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.BotService/botServices/botService1
 * ```
 */
public class ServiceAzureBot internal constructor(
    override val javaResource: com.pulumi.azure.bot.ServiceAzureBot,
) : KotlinCustomResource(javaResource, ServiceAzureBotMapper) {
    /**
     * The CMK Key Vault Key URL that will be used to encrypt the Bot with the Customer Managed Encryption Key.
     * > **Note:** In order to utilize CMEK, you must add the `Key Vault Crypto Service Encryption User` role to the Azure-defined `Bot Service CMEK Prod` Service Principal. You must also enable `soft_delete_enabled` and `purge_protection_enabled` on the `azure.keyvault.KeyVault` that `cmk_key_vault_key_url` refers to. [See Azure Documentation](https://learn.microsoft.com/en-us/azure/bot-service/bot-service-encryption?view=azure-bot-service-4.0#how-to-configure-your-azure-key-vault-instance)
     */
    public val cmkKeyVaultKeyUrl: Output?
        get() = javaResource.cmkKeyVaultKeyUrl().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The Application Insights API Key to associate with this Azure Bot Service.
     */
    public val developerAppInsightsApiKey: Output?
        get() = javaResource.developerAppInsightsApiKey().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The resource ID of the Application Insights instance to associate with this Azure Bot Service.
     */
    public val developerAppInsightsApplicationId: Output?
        get() = javaResource.developerAppInsightsApplicationId().applyValue({ args0 ->
            args0.map({ args0 -> args0 }).orElse(null)
        })

    /**
     * The Application Insight Key to associate with this Azure Bot Service.
     */
    public val developerAppInsightsKey: Output?
        get() = javaResource.developerAppInsightsKey().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The name that the Azure Bot Service will be displayed as. This defaults to the value set for `name` if not specified.
     */
    public val displayName: Output
        get() = javaResource.displayName().applyValue({ args0 -> args0 })

    /**
     * The Azure Bot Service endpoint.
     */
    public val endpoint: Output?
        get() = javaResource.endpoint().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The Icon Url of the Azure Bot Service. Defaults to `https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png`.
     */
    public val iconUrl: Output?
        get() = javaResource.iconUrl().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * Is local authentication enabled? Defaults to `true`.
     */
    public val localAuthenticationEnabled: Output?
        get() = javaResource.localAuthenticationEnabled().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The supported Azure location where the Azure Bot Service should exist. Changing this forces a new resource to be created.
     */
    public val location: Output
        get() = javaResource.location().applyValue({ args0 -> args0 })

    /**
     * A list of LUIS App IDs to associate with this Azure Bot Service.
     */
    public val luisAppIds: Output>?
        get() = javaResource.luisAppIds().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0
                })
            }).orElse(null)
        })

    /**
     * The LUIS key to associate with this Azure Bot Service.
     */
    public val luisKey: Output?
        get() = javaResource.luisKey().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The Microsoft Application ID for the Azure Bot Service. Changing this forces a new resource to be created.
     */
    public val microsoftAppId: Output
        get() = javaResource.microsoftAppId().applyValue({ args0 -> args0 })

    /**
     * The ID of the Microsoft App Managed Identity for this Azure Bot Service. Changing this forces a new resource to be created.
     */
    public val microsoftAppMsiId: Output?
        get() = javaResource.microsoftAppMsiId().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The Tenant ID of the Microsoft App for this Azure Bot Service. Changing this forces a new resource to be created.
     */
    public val microsoftAppTenantId: Output?
        get() = javaResource.microsoftAppTenantId().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The Microsoft App Type for this Azure Bot Service. Possible values are `MultiTenant`, `SingleTenant` and `UserAssignedMSI`. Changing this forces a new resource to be created.
     */
    public val microsoftAppType: Output?
        get() = javaResource.microsoftAppType().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The name which should be used for this Azure Bot Service. Changing this forces a new resource to be created.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * Whether public network access is enabled. Defaults to `true`.
     */
    public val publicNetworkAccessEnabled: Output?
        get() = javaResource.publicNetworkAccessEnabled().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The name of the Resource Group where the Azure Bot Service should exist. Changing this forces a new resource to be created.
     */
    public val resourceGroupName: Output
        get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })

    /**
     * The SKU of the Azure Bot Service. Accepted values are `F0` or `S1`. Changing this forces a new resource to be created.
     */
    public val sku: Output
        get() = javaResource.sku().applyValue({ args0 -> args0 })

    /**
     * Is the streaming endpoint enabled for this Azure Bot Service. Defaults to `false`.
     */
    public val streamingEndpointEnabled: Output?
        get() = javaResource.streamingEndpointEnabled().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * A mapping of tags which should be assigned to this Azure Bot Service.
     */
    public val tags: Output>?
        get() = javaResource.tags().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }).orElse(null)
        })
}

public object ServiceAzureBotMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.bot.ServiceAzureBot::class == javaResource::class

    override fun map(javaResource: Resource): ServiceAzureBot = ServiceAzureBot(
        javaResource as
            com.pulumi.azure.bot.ServiceAzureBot,
    )
}

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

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy