com.pulumi.azure.bot.ChannelsRegistration 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.ChannelsRegistrationArgs;
import com.pulumi.azure.bot.inputs.ChannelsRegistrationState;
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.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Manages a Bot Channels Registration.
*
* > **Note:** Bot Channels Registration has been [deprecated by Azure](https://learn.microsoft.com/en-us/azure/bot-service/bot-service-resources-faq-azure?view=azure-bot-service-4.0#why-are-web-app-bot-and-bot-channel-registration-being-deprecated). New implementations should use the `azure.bot.ServiceAzureBot` resource.
*
* ## 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 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());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Bot Channels Registration can be imported using the `resource id`, e.g.
*
* ```sh
* $ pulumi import azure:bot/channelsRegistration:ChannelsRegistration example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.BotService/botServices/example
* ```
*
*/
@ResourceType(type="azure:bot/channelsRegistration:ChannelsRegistration")
public class ChannelsRegistration extends com.pulumi.resources.CustomResource {
/**
* The CMK Key Vault Key URL to encrypt the Bot Channels Registration with the Customer Managed Encryption Key.
*
* > **Note:** It has to add the Key Vault Access Policy for the `Bot Service CMEK Prod` Service Principal and the `soft_delete_enabled` and the `purge_protection_enabled` is enabled on the `azure.keyvault.KeyVault` resource while using `cmk_key_vault_url`.
*
* > **Note:** It has to turn off the CMK feature before revoking Key Vault Access Policy. For more information, please refer to [Revoke access to customer-managed keys](https://docs.microsoft.com/azure/bot-service/bot-service-encryption?view=azure-bot-service-4.0&WT.mc_id=Portal-Microsoft_Azure_BotService#revoke-access-to-customer-managed-keys).
*
*/
@Export(name="cmkKeyVaultUrl", refs={String.class}, tree="[0]")
private Output cmkKeyVaultUrl;
/**
* @return The CMK Key Vault Key URL to encrypt the Bot Channels Registration with the Customer Managed Encryption Key.
*
* > **Note:** It has to add the Key Vault Access Policy for the `Bot Service CMEK Prod` Service Principal and the `soft_delete_enabled` and the `purge_protection_enabled` is enabled on the `azure.keyvault.KeyVault` resource while using `cmk_key_vault_url`.
*
* > **Note:** It has to turn off the CMK feature before revoking Key Vault Access Policy. For more information, please refer to [Revoke access to customer-managed keys](https://docs.microsoft.com/azure/bot-service/bot-service-encryption?view=azure-bot-service-4.0&WT.mc_id=Portal-Microsoft_Azure_BotService#revoke-access-to-customer-managed-keys).
*
*/
public Output> cmkKeyVaultUrl() {
return Codegen.optional(this.cmkKeyVaultUrl);
}
/**
* The description of the Bot Channels Registration.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return The description of the Bot Channels Registration.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* The Application Insights API Key to associate with the Bot Channels Registration.
*
*/
@Export(name="developerAppInsightsApiKey", refs={String.class}, tree="[0]")
private Output developerAppInsightsApiKey;
/**
* @return The Application Insights API Key to associate with the Bot Channels Registration.
*
*/
public Output> developerAppInsightsApiKey() {
return Codegen.optional(this.developerAppInsightsApiKey);
}
/**
* The Application Insights Application ID to associate with the Bot Channels Registration.
*
*/
@Export(name="developerAppInsightsApplicationId", refs={String.class}, tree="[0]")
private Output developerAppInsightsApplicationId;
/**
* @return The Application Insights Application ID to associate with the Bot Channels Registration.
*
*/
public Output> developerAppInsightsApplicationId() {
return Codegen.optional(this.developerAppInsightsApplicationId);
}
/**
* The Application Insights Key to associate with the Bot Channels Registration.
*
*/
@Export(name="developerAppInsightsKey", refs={String.class}, tree="[0]")
private Output developerAppInsightsKey;
/**
* @return The Application Insights Key to associate with the Bot Channels Registration.
*
*/
public Output> developerAppInsightsKey() {
return Codegen.optional(this.developerAppInsightsKey);
}
/**
* The name of the Bot Channels Registration will be displayed as. This defaults to `name` if not specified.
*
*/
@Export(name="displayName", refs={String.class}, tree="[0]")
private Output displayName;
/**
* @return The name of the Bot Channels Registration will be displayed as. This defaults to `name` if not specified.
*
*/
public Output displayName() {
return this.displayName;
}
/**
* The Bot Channels Registration endpoint.
*
*/
@Export(name="endpoint", refs={String.class}, tree="[0]")
private Output endpoint;
/**
* @return The Bot Channels Registration endpoint.
*
*/
public Output> endpoint() {
return Codegen.optional(this.endpoint);
}
/**
* The icon URL to visually identify the Bot Channels Registration. Defaults to `https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png`.
*
*/
@Export(name="iconUrl", refs={String.class}, tree="[0]")
private Output iconUrl;
/**
* @return The icon URL to visually identify the Bot Channels Registration. Defaults to `https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png`.
*
*/
public Output> iconUrl() {
return Codegen.optional(this.iconUrl);
}
/**
* 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 The supported Azure location where the resource exists. Changing this forces a new resource to be created.
*
*/
public Output location() {
return this.location;
}
/**
* The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
*
*/
@Export(name="microsoftAppId", refs={String.class}, tree="[0]")
private Output microsoftAppId;
/**
* @return The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
*
*/
public Output microsoftAppId() {
return this.microsoftAppId;
}
/**
* Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
*
*/
public Output name() {
return this.name;
}
/**
* Is the Bot Channels Registration in an isolated network?
*
*/
@Export(name="publicNetworkAccessEnabled", refs={Boolean.class}, tree="[0]")
private Output publicNetworkAccessEnabled;
/**
* @return Is the Bot Channels Registration in an isolated network?
*
*/
public Output> publicNetworkAccessEnabled() {
return Codegen.optional(this.publicNetworkAccessEnabled);
}
/**
* The name of the resource group in which to create the Bot Channels Registration. 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 in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
* The SKU of the Bot Channels Registration. Valid values include `F0` or `S1`. Changing this forces a new resource to be created.
*
*/
@Export(name="sku", refs={String.class}, tree="[0]")
private Output sku;
/**
* @return The SKU of the Bot Channels Registration. Valid values include `F0` or `S1`. Changing this forces a new resource to be created.
*
*/
public Output sku() {
return this.sku;
}
/**
* Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to `false`.
*
*/
@Export(name="streamingEndpointEnabled", refs={Boolean.class}, tree="[0]")
private Output streamingEndpointEnabled;
/**
* @return Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to `false`.
*
*/
public Output> streamingEndpointEnabled() {
return Codegen.optional(this.streamingEndpointEnabled);
}
/**
* A mapping of tags to assign to the resource.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return A mapping of tags to assign to the resource.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public ChannelsRegistration(java.lang.String name) {
this(name, ChannelsRegistrationArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public ChannelsRegistration(java.lang.String name, ChannelsRegistrationArgs 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 ChannelsRegistration(java.lang.String name, ChannelsRegistrationArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:bot/channelsRegistration:ChannelsRegistration", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private ChannelsRegistration(java.lang.String name, Output id, @Nullable ChannelsRegistrationState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:bot/channelsRegistration:ChannelsRegistration", name, state, makeResourceOptions(options, id), false);
}
private static ChannelsRegistrationArgs makeArgs(ChannelsRegistrationArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? ChannelsRegistrationArgs.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(
"developerAppInsightsApiKey"
))
.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 ChannelsRegistration get(java.lang.String name, Output id, @Nullable ChannelsRegistrationState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new ChannelsRegistration(name, id, state, options);
}
}