We recommend using Azure Native.
azure.bot.ChannelsRegistration
Explore with Pulumi AI
Manages a Bot Channels Registration.
Note: Bot Channels Registration has been deprecated by Azure. New implementations should use the
azure.bot.ServiceAzureBot
resource.
Example Usage
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),
});
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)
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
}
_, 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
}
return nil
})
}
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),
});
});
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());
}
}
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}
variables:
current:
fn::invoke:
Function: azure:core:getClientConfig
Arguments: {}
Create ChannelsRegistration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ChannelsRegistration(name: string, args: ChannelsRegistrationArgs, opts?: CustomResourceOptions);
@overload
def ChannelsRegistration(resource_name: str,
args: ChannelsRegistrationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ChannelsRegistration(resource_name: str,
opts: Optional[ResourceOptions] = None,
microsoft_app_id: Optional[str] = None,
sku: Optional[str] = None,
resource_group_name: Optional[str] = None,
isolated_network_enabled: Optional[bool] = None,
developer_app_insights_application_id: Optional[str] = None,
display_name: Optional[str] = None,
endpoint: Optional[str] = None,
icon_url: Optional[str] = None,
cmk_key_vault_url: Optional[str] = None,
location: Optional[str] = None,
developer_app_insights_key: Optional[str] = None,
name: Optional[str] = None,
public_network_access_enabled: Optional[bool] = None,
developer_app_insights_api_key: Optional[str] = None,
description: Optional[str] = None,
streaming_endpoint_enabled: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None)
func NewChannelsRegistration(ctx *Context, name string, args ChannelsRegistrationArgs, opts ...ResourceOption) (*ChannelsRegistration, error)
public ChannelsRegistration(string name, ChannelsRegistrationArgs args, CustomResourceOptions? opts = null)
public ChannelsRegistration(String name, ChannelsRegistrationArgs args)
public ChannelsRegistration(String name, ChannelsRegistrationArgs args, CustomResourceOptions options)
type: azure:bot:ChannelsRegistration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ChannelsRegistrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ChannelsRegistrationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ChannelsRegistrationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ChannelsRegistrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ChannelsRegistrationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var channelsRegistrationResource = new Azure.Bot.ChannelsRegistration("channelsRegistrationResource", new()
{
MicrosoftAppId = "string",
Sku = "string",
ResourceGroupName = "string",
DeveloperAppInsightsApplicationId = "string",
DisplayName = "string",
Endpoint = "string",
IconUrl = "string",
CmkKeyVaultUrl = "string",
Location = "string",
DeveloperAppInsightsKey = "string",
Name = "string",
PublicNetworkAccessEnabled = false,
DeveloperAppInsightsApiKey = "string",
Description = "string",
StreamingEndpointEnabled = false,
Tags =
{
{ "string", "string" },
},
});
example, err := bot.NewChannelsRegistration(ctx, "channelsRegistrationResource", &bot.ChannelsRegistrationArgs{
MicrosoftAppId: pulumi.String("string"),
Sku: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
DeveloperAppInsightsApplicationId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Endpoint: pulumi.String("string"),
IconUrl: pulumi.String("string"),
CmkKeyVaultUrl: pulumi.String("string"),
Location: pulumi.String("string"),
DeveloperAppInsightsKey: pulumi.String("string"),
Name: pulumi.String("string"),
PublicNetworkAccessEnabled: pulumi.Bool(false),
DeveloperAppInsightsApiKey: pulumi.String("string"),
Description: pulumi.String("string"),
StreamingEndpointEnabled: pulumi.Bool(false),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var channelsRegistrationResource = new ChannelsRegistration("channelsRegistrationResource", ChannelsRegistrationArgs.builder()
.microsoftAppId("string")
.sku("string")
.resourceGroupName("string")
.developerAppInsightsApplicationId("string")
.displayName("string")
.endpoint("string")
.iconUrl("string")
.cmkKeyVaultUrl("string")
.location("string")
.developerAppInsightsKey("string")
.name("string")
.publicNetworkAccessEnabled(false)
.developerAppInsightsApiKey("string")
.description("string")
.streamingEndpointEnabled(false)
.tags(Map.of("string", "string"))
.build());
channels_registration_resource = azure.bot.ChannelsRegistration("channelsRegistrationResource",
microsoft_app_id="string",
sku="string",
resource_group_name="string",
developer_app_insights_application_id="string",
display_name="string",
endpoint="string",
icon_url="string",
cmk_key_vault_url="string",
location="string",
developer_app_insights_key="string",
name="string",
public_network_access_enabled=False,
developer_app_insights_api_key="string",
description="string",
streaming_endpoint_enabled=False,
tags={
"string": "string",
})
const channelsRegistrationResource = new azure.bot.ChannelsRegistration("channelsRegistrationResource", {
microsoftAppId: "string",
sku: "string",
resourceGroupName: "string",
developerAppInsightsApplicationId: "string",
displayName: "string",
endpoint: "string",
iconUrl: "string",
cmkKeyVaultUrl: "string",
location: "string",
developerAppInsightsKey: "string",
name: "string",
publicNetworkAccessEnabled: false,
developerAppInsightsApiKey: "string",
description: "string",
streamingEndpointEnabled: false,
tags: {
string: "string",
},
});
type: azure:bot:ChannelsRegistration
properties:
cmkKeyVaultUrl: string
description: string
developerAppInsightsApiKey: string
developerAppInsightsApplicationId: string
developerAppInsightsKey: string
displayName: string
endpoint: string
iconUrl: string
location: string
microsoftAppId: string
name: string
publicNetworkAccessEnabled: false
resourceGroupName: string
sku: string
streamingEndpointEnabled: false
tags:
string: string
ChannelsRegistration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ChannelsRegistration resource accepts the following input properties:
- Microsoft
App stringId - The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
- Sku string
- The SKU of the Bot Channels Registration. Valid values include
F0
orS1
. Changing this forces a new resource to be created. - Cmk
Key stringVault Url 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 thesoft_delete_enabled
and thepurge_protection_enabled
is enabled on theazure.keyvault.KeyVault
resource while usingcmk_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.
- Description string
- The description of the Bot Channels Registration.
- Developer
App stringInsights Api Key - The Application Insights API Key to associate with the Bot Channels Registration.
- Developer
App stringInsights Application Id - The Application Insights Application ID to associate with the Bot Channels Registration.
- Developer
App stringInsights Key - The Application Insights Key to associate with the Bot Channels Registration.
- Display
Name string - The name of the Bot Channels Registration will be displayed as. This defaults to
name
if not specified. - Endpoint string
- The Bot Channels Registration endpoint.
- Icon
Url string - The icon URL to visually identify the Bot Channels Registration.
- Isolated
Network boolEnabled Is the Bot Channels Registration in an isolated network?
NOTE:
isolated_network_enabled
is deprecated and will be removed in favour of the propertypublic_network_access_enabled
in version 4.0 of the AzureRM Provider.- Location string
- The supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
- Public
Network boolAccess Enabled - Is the Bot Channels Registration in an isolated network?
- Streaming
Endpoint boolEnabled - Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to
false
. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Microsoft
App stringId - The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
- Sku string
- The SKU of the Bot Channels Registration. Valid values include
F0
orS1
. Changing this forces a new resource to be created. - Cmk
Key stringVault Url 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 thesoft_delete_enabled
and thepurge_protection_enabled
is enabled on theazure.keyvault.KeyVault
resource while usingcmk_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.
- Description string
- The description of the Bot Channels Registration.
- Developer
App stringInsights Api Key - The Application Insights API Key to associate with the Bot Channels Registration.
- Developer
App stringInsights Application Id - The Application Insights Application ID to associate with the Bot Channels Registration.
- Developer
App stringInsights Key - The Application Insights Key to associate with the Bot Channels Registration.
- Display
Name string - The name of the Bot Channels Registration will be displayed as. This defaults to
name
if not specified. - Endpoint string
- The Bot Channels Registration endpoint.
- Icon
Url string - The icon URL to visually identify the Bot Channels Registration.
- Isolated
Network boolEnabled Is the Bot Channels Registration in an isolated network?
NOTE:
isolated_network_enabled
is deprecated and will be removed in favour of the propertypublic_network_access_enabled
in version 4.0 of the AzureRM Provider.- Location string
- The supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
- Public
Network boolAccess Enabled - Is the Bot Channels Registration in an isolated network?
- Streaming
Endpoint boolEnabled - Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to
false
. - map[string]string
- A mapping of tags to assign to the resource.
- microsoft
App StringId - The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
- sku String
- The SKU of the Bot Channels Registration. Valid values include
F0
orS1
. Changing this forces a new resource to be created. - cmk
Key StringVault Url 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 thesoft_delete_enabled
and thepurge_protection_enabled
is enabled on theazure.keyvault.KeyVault
resource while usingcmk_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.
- description String
- The description of the Bot Channels Registration.
- developer
App StringInsights Api Key - The Application Insights API Key to associate with the Bot Channels Registration.
- developer
App StringInsights Application Id - The Application Insights Application ID to associate with the Bot Channels Registration.
- developer
App StringInsights Key - The Application Insights Key to associate with the Bot Channels Registration.
- display
Name String - The name of the Bot Channels Registration will be displayed as. This defaults to
name
if not specified. - endpoint String
- The Bot Channels Registration endpoint.
- icon
Url String - The icon URL to visually identify the Bot Channels Registration.
- isolated
Network BooleanEnabled Is the Bot Channels Registration in an isolated network?
NOTE:
isolated_network_enabled
is deprecated and will be removed in favour of the propertypublic_network_access_enabled
in version 4.0 of the AzureRM Provider.- location String
- The supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
- Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
- public
Network BooleanAccess Enabled - Is the Bot Channels Registration in an isolated network?
- streaming
Endpoint BooleanEnabled - Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to
false
. - Map<String,String>
- A mapping of tags to assign to the resource.
- microsoft
App stringId - The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
- resource
Group stringName - The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
- sku string
- The SKU of the Bot Channels Registration. Valid values include
F0
orS1
. Changing this forces a new resource to be created. - cmk
Key stringVault Url 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 thesoft_delete_enabled
and thepurge_protection_enabled
is enabled on theazure.keyvault.KeyVault
resource while usingcmk_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.
- description string
- The description of the Bot Channels Registration.
- developer
App stringInsights Api Key - The Application Insights API Key to associate with the Bot Channels Registration.
- developer
App stringInsights Application Id - The Application Insights Application ID to associate with the Bot Channels Registration.
- developer
App stringInsights Key - The Application Insights Key to associate with the Bot Channels Registration.
- display
Name string - The name of the Bot Channels Registration will be displayed as. This defaults to
name
if not specified. - endpoint string
- The Bot Channels Registration endpoint.
- icon
Url string - The icon URL to visually identify the Bot Channels Registration.
- isolated
Network booleanEnabled Is the Bot Channels Registration in an isolated network?
NOTE:
isolated_network_enabled
is deprecated and will be removed in favour of the propertypublic_network_access_enabled
in version 4.0 of the AzureRM Provider.- location string
- The supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name string
- Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
- public
Network booleanAccess Enabled - Is the Bot Channels Registration in an isolated network?
- streaming
Endpoint booleanEnabled - Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to
false
. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- microsoft_
app_ strid - The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
- resource_
group_ strname - The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
- sku str
- The SKU of the Bot Channels Registration. Valid values include
F0
orS1
. Changing this forces a new resource to be created. - cmk_
key_ strvault_ url 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 thesoft_delete_enabled
and thepurge_protection_enabled
is enabled on theazure.keyvault.KeyVault
resource while usingcmk_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.
- description str
- The description of the Bot Channels Registration.
- developer_
app_ strinsights_ api_ key - The Application Insights API Key to associate with the Bot Channels Registration.
- developer_
app_ strinsights_ application_ id - The Application Insights Application ID to associate with the Bot Channels Registration.
- developer_
app_ strinsights_ key - The Application Insights Key to associate with the Bot Channels Registration.
- display_
name str - The name of the Bot Channels Registration will be displayed as. This defaults to
name
if not specified. - endpoint str
- The Bot Channels Registration endpoint.
- icon_
url str - The icon URL to visually identify the Bot Channels Registration.
- isolated_
network_ boolenabled Is the Bot Channels Registration in an isolated network?
NOTE:
isolated_network_enabled
is deprecated and will be removed in favour of the propertypublic_network_access_enabled
in version 4.0 of the AzureRM Provider.- location str
- The supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name str
- Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
- public_
network_ boolaccess_ enabled - Is the Bot Channels Registration in an isolated network?
- streaming_
endpoint_ boolenabled - Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to
false
. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- microsoft
App StringId - The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
- sku String
- The SKU of the Bot Channels Registration. Valid values include
F0
orS1
. Changing this forces a new resource to be created. - cmk
Key StringVault Url 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 thesoft_delete_enabled
and thepurge_protection_enabled
is enabled on theazure.keyvault.KeyVault
resource while usingcmk_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.
- description String
- The description of the Bot Channels Registration.
- developer
App StringInsights Api Key - The Application Insights API Key to associate with the Bot Channels Registration.
- developer
App StringInsights Application Id - The Application Insights Application ID to associate with the Bot Channels Registration.
- developer
App StringInsights Key - The Application Insights Key to associate with the Bot Channels Registration.
- display
Name String - The name of the Bot Channels Registration will be displayed as. This defaults to
name
if not specified. - endpoint String
- The Bot Channels Registration endpoint.
- icon
Url String - The icon URL to visually identify the Bot Channels Registration.
- isolated
Network BooleanEnabled Is the Bot Channels Registration in an isolated network?
NOTE:
isolated_network_enabled
is deprecated and will be removed in favour of the propertypublic_network_access_enabled
in version 4.0 of the AzureRM Provider.- location String
- The supported Azure location where the resource exists. Changing this forces a new resource to be created.
- name String
- Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
- public
Network BooleanAccess Enabled - Is the Bot Channels Registration in an isolated network?
- streaming
Endpoint BooleanEnabled - Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to
false
. - Map<String>
- A mapping of tags to assign to the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the ChannelsRegistration resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ChannelsRegistration Resource
Get an existing ChannelsRegistration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ChannelsRegistrationState, opts?: CustomResourceOptions): ChannelsRegistration
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cmk_key_vault_url: Optional[str] = None,
description: Optional[str] = None,
developer_app_insights_api_key: Optional[str] = None,
developer_app_insights_application_id: Optional[str] = None,
developer_app_insights_key: Optional[str] = None,
display_name: Optional[str] = None,
endpoint: Optional[str] = None,
icon_url: Optional[str] = None,
isolated_network_enabled: Optional[bool] = None,
location: Optional[str] = None,
microsoft_app_id: Optional[str] = None,
name: Optional[str] = None,
public_network_access_enabled: Optional[bool] = None,
resource_group_name: Optional[str] = None,
sku: Optional[str] = None,
streaming_endpoint_enabled: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None) -> ChannelsRegistration
func GetChannelsRegistration(ctx *Context, name string, id IDInput, state *ChannelsRegistrationState, opts ...ResourceOption) (*ChannelsRegistration, error)
public static ChannelsRegistration Get(string name, Input<string> id, ChannelsRegistrationState? state, CustomResourceOptions? opts = null)
public static ChannelsRegistration get(String name, Output<String> id, ChannelsRegistrationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cmk
Key stringVault Url 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 thesoft_delete_enabled
and thepurge_protection_enabled
is enabled on theazure.keyvault.KeyVault
resource while usingcmk_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.
- Description string
- The description of the Bot Channels Registration.
- Developer
App stringInsights Api Key - The Application Insights API Key to associate with the Bot Channels Registration.
- Developer
App stringInsights Application Id - The Application Insights Application ID to associate with the Bot Channels Registration.
- Developer
App stringInsights Key - The Application Insights Key to associate with the Bot Channels Registration.
- Display
Name string - The name of the Bot Channels Registration will be displayed as. This defaults to
name
if not specified. - Endpoint string
- The Bot Channels Registration endpoint.
- Icon
Url string - The icon URL to visually identify the Bot Channels Registration.
- Isolated
Network boolEnabled Is the Bot Channels Registration in an isolated network?
NOTE:
isolated_network_enabled
is deprecated and will be removed in favour of the propertypublic_network_access_enabled
in version 4.0 of the AzureRM Provider.- Location string
- The supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Microsoft
App stringId - The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
- Public
Network boolAccess Enabled - Is the Bot Channels Registration in an isolated network?
- Resource
Group stringName - The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
- Sku string
- The SKU of the Bot Channels Registration. Valid values include
F0
orS1
. Changing this forces a new resource to be created. - Streaming
Endpoint boolEnabled - Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to
false
. - Dictionary<string, string>
- A mapping of tags to assign to the resource.
- Cmk
Key stringVault Url 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 thesoft_delete_enabled
and thepurge_protection_enabled
is enabled on theazure.keyvault.KeyVault
resource while usingcmk_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.
- Description string
- The description of the Bot Channels Registration.
- Developer
App stringInsights Api Key - The Application Insights API Key to associate with the Bot Channels Registration.
- Developer
App stringInsights Application Id - The Application Insights Application ID to associate with the Bot Channels Registration.
- Developer
App stringInsights Key - The Application Insights Key to associate with the Bot Channels Registration.
- Display
Name string - The name of the Bot Channels Registration will be displayed as. This defaults to
name
if not specified. - Endpoint string
- The Bot Channels Registration endpoint.
- Icon
Url string - The icon URL to visually identify the Bot Channels Registration.
- Isolated
Network boolEnabled Is the Bot Channels Registration in an isolated network?
NOTE:
isolated_network_enabled
is deprecated and will be removed in favour of the propertypublic_network_access_enabled
in version 4.0 of the AzureRM Provider.- Location string
- The supported Azure location where the resource exists. Changing this forces a new resource to be created.
- Microsoft
App stringId - The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
- Public
Network boolAccess Enabled - Is the Bot Channels Registration in an isolated network?
- Resource
Group stringName - The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
- Sku string
- The SKU of the Bot Channels Registration. Valid values include
F0
orS1
. Changing this forces a new resource to be created. - Streaming
Endpoint boolEnabled - Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to
false
. - map[string]string
- A mapping of tags to assign to the resource.
- cmk
Key StringVault Url 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 thesoft_delete_enabled
and thepurge_protection_enabled
is enabled on theazure.keyvault.KeyVault
resource while usingcmk_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.
- description String
- The description of the Bot Channels Registration.
- developer
App StringInsights Api Key - The Application Insights API Key to associate with the Bot Channels Registration.
- developer
App StringInsights Application Id - The Application Insights Application ID to associate with the Bot Channels Registration.
- developer
App StringInsights Key - The Application Insights Key to associate with the Bot Channels Registration.
- display
Name String - The name of the Bot Channels Registration will be displayed as. This defaults to
name
if not specified. - endpoint String
- The Bot Channels Registration endpoint.
- icon
Url String - The icon URL to visually identify the Bot Channels Registration.
- isolated
Network BooleanEnabled Is the Bot Channels Registration in an isolated network?
NOTE:
isolated_network_enabled
is deprecated and will be removed in favour of the propertypublic_network_access_enabled
in version 4.0 of the AzureRM Provider.- location String
- The supported Azure location where the resource exists. Changing this forces a new resource to be created.
- microsoft
App StringId - The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
- name String
- Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
- public
Network BooleanAccess Enabled - Is the Bot Channels Registration in an isolated network?
- resource
Group StringName - The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
- sku String
- The SKU of the Bot Channels Registration. Valid values include
F0
orS1
. Changing this forces a new resource to be created. - streaming
Endpoint BooleanEnabled - Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to
false
. - Map<String,String>
- A mapping of tags to assign to the resource.
- cmk
Key stringVault Url 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 thesoft_delete_enabled
and thepurge_protection_enabled
is enabled on theazure.keyvault.KeyVault
resource while usingcmk_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.
- description string
- The description of the Bot Channels Registration.
- developer
App stringInsights Api Key - The Application Insights API Key to associate with the Bot Channels Registration.
- developer
App stringInsights Application Id - The Application Insights Application ID to associate with the Bot Channels Registration.
- developer
App stringInsights Key - The Application Insights Key to associate with the Bot Channels Registration.
- display
Name string - The name of the Bot Channels Registration will be displayed as. This defaults to
name
if not specified. - endpoint string
- The Bot Channels Registration endpoint.
- icon
Url string - The icon URL to visually identify the Bot Channels Registration.
- isolated
Network booleanEnabled Is the Bot Channels Registration in an isolated network?
NOTE:
isolated_network_enabled
is deprecated and will be removed in favour of the propertypublic_network_access_enabled
in version 4.0 of the AzureRM Provider.- location string
- The supported Azure location where the resource exists. Changing this forces a new resource to be created.
- microsoft
App stringId - The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
- name string
- Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
- public
Network booleanAccess Enabled - Is the Bot Channels Registration in an isolated network?
- resource
Group stringName - The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
- sku string
- The SKU of the Bot Channels Registration. Valid values include
F0
orS1
. Changing this forces a new resource to be created. - streaming
Endpoint booleanEnabled - Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to
false
. - {[key: string]: string}
- A mapping of tags to assign to the resource.
- cmk_
key_ strvault_ url 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 thesoft_delete_enabled
and thepurge_protection_enabled
is enabled on theazure.keyvault.KeyVault
resource while usingcmk_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.
- description str
- The description of the Bot Channels Registration.
- developer_
app_ strinsights_ api_ key - The Application Insights API Key to associate with the Bot Channels Registration.
- developer_
app_ strinsights_ application_ id - The Application Insights Application ID to associate with the Bot Channels Registration.
- developer_
app_ strinsights_ key - The Application Insights Key to associate with the Bot Channels Registration.
- display_
name str - The name of the Bot Channels Registration will be displayed as. This defaults to
name
if not specified. - endpoint str
- The Bot Channels Registration endpoint.
- icon_
url str - The icon URL to visually identify the Bot Channels Registration.
- isolated_
network_ boolenabled Is the Bot Channels Registration in an isolated network?
NOTE:
isolated_network_enabled
is deprecated and will be removed in favour of the propertypublic_network_access_enabled
in version 4.0 of the AzureRM Provider.- location str
- The supported Azure location where the resource exists. Changing this forces a new resource to be created.
- microsoft_
app_ strid - The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
- name str
- Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
- public_
network_ boolaccess_ enabled - Is the Bot Channels Registration in an isolated network?
- resource_
group_ strname - The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
- sku str
- The SKU of the Bot Channels Registration. Valid values include
F0
orS1
. Changing this forces a new resource to be created. - streaming_
endpoint_ boolenabled - Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to
false
. - Mapping[str, str]
- A mapping of tags to assign to the resource.
- cmk
Key StringVault Url 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 thesoft_delete_enabled
and thepurge_protection_enabled
is enabled on theazure.keyvault.KeyVault
resource while usingcmk_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.
- description String
- The description of the Bot Channels Registration.
- developer
App StringInsights Api Key - The Application Insights API Key to associate with the Bot Channels Registration.
- developer
App StringInsights Application Id - The Application Insights Application ID to associate with the Bot Channels Registration.
- developer
App StringInsights Key - The Application Insights Key to associate with the Bot Channels Registration.
- display
Name String - The name of the Bot Channels Registration will be displayed as. This defaults to
name
if not specified. - endpoint String
- The Bot Channels Registration endpoint.
- icon
Url String - The icon URL to visually identify the Bot Channels Registration.
- isolated
Network BooleanEnabled Is the Bot Channels Registration in an isolated network?
NOTE:
isolated_network_enabled
is deprecated and will be removed in favour of the propertypublic_network_access_enabled
in version 4.0 of the AzureRM Provider.- location String
- The supported Azure location where the resource exists. Changing this forces a new resource to be created.
- microsoft
App StringId - The Microsoft Application ID for the Bot Channels Registration. Changing this forces a new resource to be created.
- name String
- Specifies the name of the Bot Channels Registration. Changing this forces a new resource to be created. Must be globally unique.
- public
Network BooleanAccess Enabled - Is the Bot Channels Registration in an isolated network?
- resource
Group StringName - The name of the resource group in which to create the Bot Channels Registration. Changing this forces a new resource to be created.
- sku String
- The SKU of the Bot Channels Registration. Valid values include
F0
orS1
. Changing this forces a new resource to be created. - streaming
Endpoint BooleanEnabled - Is the streaming endpoint enabled for the Bot Channels Registration. Defaults to
false
. - Map<String>
- A mapping of tags to assign to the resource.
Import
Bot Channels Registration can be imported using the resource id
, e.g.
$ pulumi import azure:bot/channelsRegistration:ChannelsRegistration example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.BotService/botServices/example
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.