import * as pulumi from "@pulumi/pulumi"; /** * 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 * * ```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), * microsoftAppType: "SingleTenant", * microsoftAppTenantId: current.then(current => current.tenantId), * }); * ``` * * ## 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 * ``` */ export declare class ChannelsRegistration extends pulumi.CustomResource { /** * Get an existing ChannelsRegistration 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 Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: ChannelsRegistrationState, opts?: pulumi.CustomResourceOptions): ChannelsRegistration; /** * Returns true if the given object is an instance of ChannelsRegistration. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is ChannelsRegistration; /** * 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 `softDeleteEnabled` and the `purgeProtectionEnabled` is enabled on the `azure.keyvault.KeyVault` resource while using `cmkKeyVaultUrl`. * * > **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). */ readonly cmkKeyVaultUrl: pulumi.Output; /** * The description of the Bot Channels Registration. */ readonly description: pulumi.Output; /** * The Application Insights API Key to associate with the Bot Channels Registration. */ readonly developerAppInsightsApiKey: pulumi.Output; /** * The Application Insights Application ID to associate with the Bot Channels Registration. */ readonly developerAppInsightsApplicationId: pulumi.Output; /** * The Application Insights Key to associate with the Bot Channels Registration. */ readonly developerAppInsightsKey: pulumi.Output; /** * The name of the Bot Channels Registration will be displayed as. This defaults to `name` if not specified. */ readonly displayName: pulumi.Output; /** * The Bot Channels Registration endpoint. */ readonly endpoint: pulumi.Output; /** * The icon URL to visually identify the Bot Channels Registration. Defaults to `https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png`. */ readonly iconUrl: pulumi.Output; /** * The supported Azure location where the resource exists. Changing this forces a new resource to be created. */ readonly location: pulumi.Output; /** * The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created. */ readonly microsoftAppId: pulumi.Output; /** * The Microsoft Application Tenant ID for the Bot Channels Registration. Changing this forces a new resource to be created. */ readonly microsoftAppTenantId: pulumi.Output; /** * The Microsoft Application Type for the Bot Channels Registration. Possible values are `MultiTenant`, `SingleTenant` and `UserAssignedMSI`. Changing this forces a new resource to be created. * * > **Note:** Creation of `azure.bot.ChannelsRegistration` resources using the `MultiTenant` type is no longer supported by Azure, existing resources can continue using this type. */ readonly microsoftAppType: pulumi.Output; /** * The ID of Microsoft Application User Assigned Identity for the Bot Channels Registration. Changing this forces a new resource to be created. */ readonly microsoftAppUserAssignedIdentityId: pulumi.Output; /** * Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique. */ readonly name: pulumi.Output; /** * Is the Bot Channels Registration in an isolated network? */ readonly publicNetworkAccessEnabled: pulumi.Output; /** * The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * The SKU of the Bot Channels Registration. Valid values include `F0` or `S1`. Changing this forces a new resource to be created. */ readonly sku: pulumi.Output; /** * Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to `false`. */ readonly streamingEndpointEnabled: pulumi.Output; /** * A mapping of tags to assign to the resource. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Create a ChannelsRegistration resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ChannelsRegistrationArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ChannelsRegistration resources. */ export interface ChannelsRegistrationState { /** * 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 `softDeleteEnabled` and the `purgeProtectionEnabled` is enabled on the `azure.keyvault.KeyVault` resource while using `cmkKeyVaultUrl`. * * > **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). */ cmkKeyVaultUrl?: pulumi.Input; /** * The description of the Bot Channels Registration. */ description?: pulumi.Input; /** * The Application Insights API Key to associate with the Bot Channels Registration. */ developerAppInsightsApiKey?: pulumi.Input; /** * The Application Insights Application ID to associate with the Bot Channels Registration. */ developerAppInsightsApplicationId?: pulumi.Input; /** * The Application Insights Key to associate with the Bot Channels Registration. */ developerAppInsightsKey?: pulumi.Input; /** * The name of the Bot Channels Registration will be displayed as. This defaults to `name` if not specified. */ displayName?: pulumi.Input; /** * The Bot Channels Registration endpoint. */ endpoint?: pulumi.Input; /** * The icon URL to visually identify the Bot Channels Registration. Defaults to `https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png`. */ iconUrl?: pulumi.Input; /** * The supported Azure location where the resource exists. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created. */ microsoftAppId?: pulumi.Input; /** * The Microsoft Application Tenant ID for the Bot Channels Registration. Changing this forces a new resource to be created. */ microsoftAppTenantId?: pulumi.Input; /** * The Microsoft Application Type for the Bot Channels Registration. Possible values are `MultiTenant`, `SingleTenant` and `UserAssignedMSI`. Changing this forces a new resource to be created. * * > **Note:** Creation of `azure.bot.ChannelsRegistration` resources using the `MultiTenant` type is no longer supported by Azure, existing resources can continue using this type. */ microsoftAppType?: pulumi.Input; /** * The ID of Microsoft Application User Assigned Identity for the Bot Channels Registration. Changing this forces a new resource to be created. */ microsoftAppUserAssignedIdentityId?: pulumi.Input; /** * Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique. */ name?: pulumi.Input; /** * Is the Bot Channels Registration in an isolated network? */ publicNetworkAccessEnabled?: pulumi.Input; /** * The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * The SKU of the Bot Channels Registration. Valid values include `F0` or `S1`. Changing this forces a new resource to be created. */ sku?: pulumi.Input; /** * Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to `false`. */ streamingEndpointEnabled?: pulumi.Input; /** * A mapping of tags to assign to the resource. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; } /** * The set of arguments for constructing a ChannelsRegistration resource. */ export interface ChannelsRegistrationArgs { /** * 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 `softDeleteEnabled` and the `purgeProtectionEnabled` is enabled on the `azure.keyvault.KeyVault` resource while using `cmkKeyVaultUrl`. * * > **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). */ cmkKeyVaultUrl?: pulumi.Input; /** * The description of the Bot Channels Registration. */ description?: pulumi.Input; /** * The Application Insights API Key to associate with the Bot Channels Registration. */ developerAppInsightsApiKey?: pulumi.Input; /** * The Application Insights Application ID to associate with the Bot Channels Registration. */ developerAppInsightsApplicationId?: pulumi.Input; /** * The Application Insights Key to associate with the Bot Channels Registration. */ developerAppInsightsKey?: pulumi.Input; /** * The name of the Bot Channels Registration will be displayed as. This defaults to `name` if not specified. */ displayName?: pulumi.Input; /** * The Bot Channels Registration endpoint. */ endpoint?: pulumi.Input; /** * The icon URL to visually identify the Bot Channels Registration. Defaults to `https://docs.botframework.com/static/devportal/client/images/bot-framework-default.png`. */ iconUrl?: pulumi.Input; /** * The supported Azure location where the resource exists. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created. */ microsoftAppId: pulumi.Input; /** * The Microsoft Application Tenant ID for the Bot Channels Registration. Changing this forces a new resource to be created. */ microsoftAppTenantId?: pulumi.Input; /** * The Microsoft Application Type for the Bot Channels Registration. Possible values are `MultiTenant`, `SingleTenant` and `UserAssignedMSI`. Changing this forces a new resource to be created. * * > **Note:** Creation of `azure.bot.ChannelsRegistration` resources using the `MultiTenant` type is no longer supported by Azure, existing resources can continue using this type. */ microsoftAppType?: pulumi.Input; /** * The ID of Microsoft Application User Assigned Identity for the Bot Channels Registration. Changing this forces a new resource to be created. */ microsoftAppUserAssignedIdentityId?: pulumi.Input; /** * Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique. */ name?: pulumi.Input; /** * Is the Bot Channels Registration in an isolated network? */ publicNetworkAccessEnabled?: pulumi.Input; /** * The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * The SKU of the Bot Channels Registration. Valid values include `F0` or `S1`. Changing this forces a new resource to be created. */ sku: pulumi.Input; /** * Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to `false`. */ streamingEndpointEnabled?: pulumi.Input; /** * A mapping of tags to assign to the resource. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; }