com.pulumi.azure.bot.ChannelSms Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.bot;
import com.pulumi.azure.Utilities;
import com.pulumi.azure.bot.ChannelSmsArgs;
import com.pulumi.azure.bot.inputs.ChannelSmsState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import javax.annotation.Nullable;
/**
* Manages a SMS integration for a Bot Channel
*
* > **Note** A bot can only have a single SMS Channel associated with it.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## 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
* ```
*
*/
@ResourceType(type="azure:bot/channelSms:ChannelSms")
public class ChannelSms extends com.pulumi.resources.CustomResource {
/**
* The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
*
*/
@Export(name="botName", refs={String.class}, tree="[0]")
private Output botName;
/**
* @return The name of the Bot Resource this channel will be associated with. Changing this forces a new resource to be created.
*
*/
public Output botName() {
return this.botName;
}
/**
* Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
*
*/
@Export(name="location", refs={String.class}, tree="[0]")
private Output location;
/**
* @return Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
*
*/
public Output location() {
return this.location;
}
/**
* The phone number for the SMS Channel.
*
*/
@Export(name="phoneNumber", refs={String.class}, tree="[0]")
private Output phoneNumber;
/**
* @return The phone number for the SMS Channel.
*
*/
public Output phoneNumber() {
return this.phoneNumber;
}
/**
* The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
*
*/
@Export(name="resourceGroupName", refs={String.class}, tree="[0]")
private Output resourceGroupName;
/**
* @return The name of the resource group where the SMS Channel should be created. Changing this forces a new resource to be created.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
* The account security identifier (SID) for the SMS Channel.
*
*/
@Export(name="smsChannelAccountSecurityId", refs={String.class}, tree="[0]")
private Output smsChannelAccountSecurityId;
/**
* @return The account security identifier (SID) for the SMS Channel.
*
*/
public Output smsChannelAccountSecurityId() {
return this.smsChannelAccountSecurityId;
}
/**
* The authorization token for the SMS Channel.
*
*/
@Export(name="smsChannelAuthToken", refs={String.class}, tree="[0]")
private Output smsChannelAuthToken;
/**
* @return The authorization token for the SMS Channel.
*
*/
public Output smsChannelAuthToken() {
return this.smsChannelAuthToken;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public ChannelSms(java.lang.String name) {
this(name, ChannelSmsArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public ChannelSms(java.lang.String name, ChannelSmsArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public ChannelSms(java.lang.String name, ChannelSmsArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:bot/channelSms:ChannelSms", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private ChannelSms(java.lang.String name, Output id, @Nullable ChannelSmsState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:bot/channelSms:ChannelSms", name, state, makeResourceOptions(options, id), false);
}
private static ChannelSmsArgs makeArgs(ChannelSmsArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? ChannelSmsArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.additionalSecretOutputs(List.of(
"smsChannelAuthToken"
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static ChannelSms get(java.lang.String name, Output id, @Nullable ChannelSmsState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new ChannelSms(name, id, state, options);
}
}