com.pulumi.azure.bot.kotlin.Connection.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@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.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [Connection].
*/
@PulumiTagMarker
public class ConnectionResourceBuilder internal constructor() {
public var name: String? = null
public var args: ConnectionArgs = ConnectionArgs()
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 ConnectionArgsBuilder.() -> Unit) {
val builder = ConnectionArgsBuilder()
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(): Connection {
val builtJavaResource = com.pulumi.azure.bot.Connection(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Connection(builtJavaResource)
}
}
/**
* Manages a Bot Connection.
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
* const current = azure.core.getClientConfig({});
* const example = new azure.core.ResourceGroup("example", {
* name: "example-resources",
* location: "West Europe",
* });
* const exampleChannelsRegistration = new azure.bot.ChannelsRegistration("example", {
* name: "example",
* location: "global",
* resourceGroupName: example.name,
* sku: "F0",
* microsoftAppId: current.then(current => current.clientId),
* });
* const exampleConnection = new azure.bot.Connection("example", {
* name: "example",
* botName: exampleChannelsRegistration.name,
* location: exampleChannelsRegistration.location,
* resourceGroupName: example.name,
* serviceProviderName: "box",
* clientId: "exampleId",
* clientSecret: "exampleSecret",
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* current = azure.core.get_client_config()
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_channels_registration = azure.bot.ChannelsRegistration("example",
* name="example",
* location="global",
* resource_group_name=example.name,
* sku="F0",
* microsoft_app_id=current.client_id)
* example_connection = azure.bot.Connection("example",
* name="example",
* bot_name=example_channels_registration.name,
* location=example_channels_registration.location,
* resource_group_name=example.name,
* service_provider_name="box",
* client_id="exampleId",
* client_secret="exampleSecret")
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Azure = Pulumi.Azure;
* return await Deployment.RunAsync(() =>
* {
* var current = Azure.Core.GetClientConfig.Invoke();
* var example = new Azure.Core.ResourceGroup("example", new()
* {
* Name = "example-resources",
* Location = "West Europe",
* });
* var exampleChannelsRegistration = new Azure.Bot.ChannelsRegistration("example", new()
* {
* Name = "example",
* Location = "global",
* ResourceGroupName = example.Name,
* Sku = "F0",
* MicrosoftAppId = current.Apply(getClientConfigResult => getClientConfigResult.ClientId),
* });
* var exampleConnection = new Azure.Bot.Connection("example", new()
* {
* Name = "example",
* BotName = exampleChannelsRegistration.Name,
* Location = exampleChannelsRegistration.Location,
* ResourceGroupName = example.Name,
* ServiceProviderName = "box",
* ClientId = "exampleId",
* ClientSecret = "exampleSecret",
* });
* });
* ```
* ```go
* package main
* import (
* "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 {
* current, err := core.GetClientConfig(ctx, nil, nil)
* if err != nil {
* return err
* }
* example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
* Name: pulumi.String("example-resources"),
* Location: pulumi.String("West Europe"),
* })
* if err != nil {
* return err
* }
* exampleChannelsRegistration, err := bot.NewChannelsRegistration(ctx, "example", &bot.ChannelsRegistrationArgs{
* Name: pulumi.String("example"),
* Location: pulumi.String("global"),
* ResourceGroupName: example.Name,
* Sku: pulumi.String("F0"),
* MicrosoftAppId: pulumi.String(current.ClientId),
* })
* if err != nil {
* return err
* }
* _, err = bot.NewConnection(ctx, "example", &bot.ConnectionArgs{
* Name: pulumi.String("example"),
* BotName: exampleChannelsRegistration.Name,
* Location: exampleChannelsRegistration.Location,
* ResourceGroupName: example.Name,
* ServiceProviderName: pulumi.String("box"),
* ClientId: pulumi.String("exampleId"),
* ClientSecret: pulumi.String("exampleSecret"),
* })
* 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.CoreFunctions;
* import com.pulumi.azure.core.ResourceGroup;
* import com.pulumi.azure.core.ResourceGroupArgs;
* import com.pulumi.azure.bot.ChannelsRegistration;
* import com.pulumi.azure.bot.ChannelsRegistrationArgs;
* import com.pulumi.azure.bot.Connection;
* import com.pulumi.azure.bot.ConnectionArgs;
* 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) {
* final var current = CoreFunctions.getClientConfig();
* var example = new ResourceGroup("example", ResourceGroupArgs.builder()
* .name("example-resources")
* .location("West Europe")
* .build());
* var exampleChannelsRegistration = new ChannelsRegistration("exampleChannelsRegistration", ChannelsRegistrationArgs.builder()
* .name("example")
* .location("global")
* .resourceGroupName(example.name())
* .sku("F0")
* .microsoftAppId(current.applyValue(getClientConfigResult -> getClientConfigResult.clientId()))
* .build());
* var exampleConnection = new Connection("exampleConnection", ConnectionArgs.builder()
* .name("example")
* .botName(exampleChannelsRegistration.name())
* .location(exampleChannelsRegistration.location())
* .resourceGroupName(example.name())
* .serviceProviderName("box")
* .clientId("exampleId")
* .clientSecret("exampleSecret")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleChannelsRegistration:
* type: azure:bot:ChannelsRegistration
* name: example
* properties:
* name: example
* location: global
* resourceGroupName: ${example.name}
* sku: F0
* microsoftAppId: ${current.clientId}
* exampleConnection:
* type: azure:bot:Connection
* name: example
* properties:
* name: example
* botName: ${exampleChannelsRegistration.name}
* location: ${exampleChannelsRegistration.location}
* resourceGroupName: ${example.name}
* serviceProviderName: box
* clientId: exampleId
* clientSecret: exampleSecret
* variables:
* current:
* fn::invoke:
* Function: azure:core:getClientConfig
* Arguments: {}
* ```
*
* ## Import
* Bot Connection can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:bot/connection:Connection example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.BotService/botServices/example/connections/example
* ```
*/
public class Connection internal constructor(
override val javaResource: com.pulumi.azure.bot.Connection,
) : KotlinCustomResource(javaResource, ConnectionMapper) {
/**
* The name of the Bot Resource this connection will be associated with. Changing this forces a new resource to be created.
*/
public val botName: Output
get() = javaResource.botName().applyValue({ args0 -> args0 })
/**
* The Client ID that will be used to authenticate with the service provider.
*/
public val clientId: Output
get() = javaResource.clientId().applyValue({ args0 -> args0 })
/**
* The Client Secret that will be used to authenticate with the service provider.
*/
public val clientSecret: Output
get() = javaResource.clientSecret().applyValue({ args0 -> args0 })
/**
* The supported Azure location where the resource exists. Changing this forces a new resource to be created.
*/
public val location: Output
get() = javaResource.location().applyValue({ args0 -> args0 })
/**
* Specifies the name of the Bot Connection. Changing this forces a new resource to be created. Must be globally unique.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* A map of additional parameters to apply to the connection.
*/
public val parameters: Output>?
get() = javaResource.parameters().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* The name of the resource group in which to create the Bot Connection. Changing this forces a new resource to be created.
*/
public val resourceGroupName: Output
get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })
/**
* The Scopes at which the connection should be applied.
*/
public val scopes: Output?
get() = javaResource.scopes().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The name of the service provider that will be associated with this connection. Changing this forces a new resource to be created.
*/
public val serviceProviderName: Output
get() = javaResource.serviceProviderName().applyValue({ args0 -> args0 })
/**
* A mapping of tags to assign to the resource.
* > **Note:** `tags` has been deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.
*/
@Deprecated(
message = """
This property has been deprecated as the API no longer supports tags and will be removed in
version 4.0 of the provider.
""",
)
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 ConnectionMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.bot.Connection::class == javaResource::class
override fun map(javaResource: Resource): Connection = Connection(
javaResource as
com.pulumi.azure.bot.Connection,
)
}
/**
* @see [Connection].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Connection].
*/
public suspend fun connection(name: String, block: suspend ConnectionResourceBuilder.() -> Unit): Connection {
val builder = ConnectionResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Connection].
* @param name The _unique_ name of the resulting resource.
*/
public fun connection(name: String): Connection {
val builder = ConnectionResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy