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

com.pulumi.azure.bot.kotlin.ChannelSms.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: 6.14.0.0
Show newest version
@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

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

    public var args: ChannelSmsArgs = ChannelSmsArgs()

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

/**
 * Manages a SMS integration for a Bot Channel
 * > **Note** A bot can only have a single SMS Channel associated with it.
 * ## 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-bcr",
 *     location: "global",
 *     resourceGroupName: example.name,
 *     sku: "F0",
 *     microsoftAppId: current.then(current => current.clientId),
 * });
 * const exampleChannelSms = new azure.bot.ChannelSms("example", {
 *     botName: exampleChannelsRegistration.name,
 *     location: exampleChannelsRegistration.location,
 *     resourceGroupName: example.name,
 *     smsChannelAccountSecurityId: "BG61f7cf5157f439b084e98256409c2815",
 *     smsChannelAuthToken: "jh8980432610052ed4e29565c5e232f",
 *     phoneNumber: "+12313803556",
 * });
 * ```
 * ```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-bcr",
 *     location="global",
 *     resource_group_name=example.name,
 *     sku="F0",
 *     microsoft_app_id=current.client_id)
 * example_channel_sms = azure.bot.ChannelSms("example",
 *     bot_name=example_channels_registration.name,
 *     location=example_channels_registration.location,
 *     resource_group_name=example.name,
 *     sms_channel_account_security_id="BG61f7cf5157f439b084e98256409c2815",
 *     sms_channel_auth_token="jh8980432610052ed4e29565c5e232f",
 *     phone_number="+12313803556")
 * ```
 * ```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-bcr",
 *         Location = "global",
 *         ResourceGroupName = example.Name,
 *         Sku = "F0",
 *         MicrosoftAppId = current.Apply(getClientConfigResult => getClientConfigResult.ClientId),
 *     });
 *     var exampleChannelSms = new Azure.Bot.ChannelSms("example", new()
 *     {
 *         BotName = exampleChannelsRegistration.Name,
 *         Location = exampleChannelsRegistration.Location,
 *         ResourceGroupName = example.Name,
 *         SmsChannelAccountSecurityId = "BG61f7cf5157f439b084e98256409c2815",
 *         SmsChannelAuthToken = "jh8980432610052ed4e29565c5e232f",
 *         PhoneNumber = "+12313803556",
 *     });
 * });
 * ```
 * ```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-bcr"),
 * 			Location:          pulumi.String("global"),
 * 			ResourceGroupName: example.Name,
 * 			Sku:               pulumi.String("F0"),
 * 			MicrosoftAppId:    pulumi.String(current.ClientId),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = bot.NewChannelSms(ctx, "example", &bot.ChannelSmsArgs{
 * 			BotName:                     exampleChannelsRegistration.Name,
 * 			Location:                    exampleChannelsRegistration.Location,
 * 			ResourceGroupName:           example.Name,
 * 			SmsChannelAccountSecurityId: pulumi.String("BG61f7cf5157f439b084e98256409c2815"),
 * 			SmsChannelAuthToken:         pulumi.String("jh8980432610052ed4e29565c5e232f"),
 * 			PhoneNumber:                 pulumi.String("+12313803556"),
 * 		})
 * 		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.ChannelSms;
 * import com.pulumi.azure.bot.ChannelSmsArgs;
 * 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-bcr")
 *             .location("global")
 *             .resourceGroupName(example.name())
 *             .sku("F0")
 *             .microsoftAppId(current.applyValue(getClientConfigResult -> getClientConfigResult.clientId()))
 *             .build());
 *         var exampleChannelSms = new ChannelSms("exampleChannelSms", ChannelSmsArgs.builder()
 *             .botName(exampleChannelsRegistration.name())
 *             .location(exampleChannelsRegistration.location())
 *             .resourceGroupName(example.name())
 *             .smsChannelAccountSecurityId("BG61f7cf5157f439b084e98256409c2815")
 *             .smsChannelAuthToken("jh8980432610052ed4e29565c5e232f")
 *             .phoneNumber("+12313803556")
 *             .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-bcr
 *       location: global
 *       resourceGroupName: ${example.name}
 *       sku: F0
 *       microsoftAppId: ${current.clientId}
 *   exampleChannelSms:
 *     type: azure:bot:ChannelSms
 *     name: example
 *     properties:
 *       botName: ${exampleChannelsRegistration.name}
 *       location: ${exampleChannelsRegistration.location}
 *       resourceGroupName: ${example.name}
 *       smsChannelAccountSecurityId: BG61f7cf5157f439b084e98256409c2815
 *       smsChannelAuthToken: jh8980432610052ed4e29565c5e232f
 *       phoneNumber: '+12313803556'
 * variables:
 *   current:
 *     fn::invoke:
 *       Function: azure:core:getClientConfig
 *       Arguments: {}
 * ```
 * 
 * ## Import
 * The SMS Integration for a Bot Channel can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:bot/channelSms:ChannelSms example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.BotService/botServices/botService1/channels/SmsChannel
 * ```
 */
public class ChannelSms internal constructor(
    override val javaResource: com.pulumi.azure.bot.ChannelSms,
) : KotlinCustomResource(javaResource, ChannelSmsMapper) {
    /**
     * The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
     */
    public val botName: Output
        get() = javaResource.botName().applyValue({ args0 -> args0 })

    /**
     * Specifies 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 })

    /**
     * The phone number for the SMS Channel.
     */
    public val phoneNumber: Output
        get() = javaResource.phoneNumber().applyValue({ args0 -> args0 })

    /**
     * The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
     */
    public val resourceGroupName: Output
        get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })

    /**
     * The account security identifier (SID) for the SMS Channel.
     */
    public val smsChannelAccountSecurityId: Output
        get() = javaResource.smsChannelAccountSecurityId().applyValue({ args0 -> args0 })

    /**
     * The authorization token for the SMS Channel.
     */
    public val smsChannelAuthToken: Output
        get() = javaResource.smsChannelAuthToken().applyValue({ args0 -> args0 })
}

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

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

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

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




© 2015 - 2025 Weber Informatics LLC | Privacy Policy