azure-native.botservice.getBot
Explore with Pulumi AI
Returns a BotService specified by the parameters. Azure REST API version: 2022-09-15.
Using getBot
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getBot(args: GetBotArgs, opts?: InvokeOptions): Promise<GetBotResult>
function getBotOutput(args: GetBotOutputArgs, opts?: InvokeOptions): Output<GetBotResult>
def get_bot(resource_group_name: Optional[str] = None,
resource_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBotResult
def get_bot_output(resource_group_name: Optional[pulumi.Input[str]] = None,
resource_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBotResult]
func LookupBot(ctx *Context, args *LookupBotArgs, opts ...InvokeOption) (*LookupBotResult, error)
func LookupBotOutput(ctx *Context, args *LookupBotOutputArgs, opts ...InvokeOption) LookupBotResultOutput
> Note: This function is named LookupBot
in the Go SDK.
public static class GetBot
{
public static Task<GetBotResult> InvokeAsync(GetBotArgs args, InvokeOptions? opts = null)
public static Output<GetBotResult> Invoke(GetBotInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBotResult> getBot(GetBotArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:botservice:getBot
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName The name of the Bot resource group in the user subscription.
- Resource
Name string The name of the Bot resource.
- Resource
Group stringName The name of the Bot resource group in the user subscription.
- Resource
Name string The name of the Bot resource.
- resource
Group StringName The name of the Bot resource group in the user subscription.
- resource
Name String The name of the Bot resource.
- resource
Group stringName The name of the Bot resource group in the user subscription.
- resource
Name string The name of the Bot resource.
- resource_
group_ strname The name of the Bot resource group in the user subscription.
- resource_
name str The name of the Bot resource.
- resource
Group StringName The name of the Bot resource group in the user subscription.
- resource
Name String The name of the Bot resource.
getBot Result
The following output properties are available:
- Id string
Specifies the resource ID.
- Name string
Specifies the name of the resource.
- Properties
Pulumi.
Azure Native. Bot Service. Outputs. Bot Properties Response The set of properties specific to bot resource
- Type string
Specifies the type of the resource.
- Zones List<string>
Entity zones
- Etag string
Entity Tag.
- Kind string
Required. Gets or sets the Kind of the resource.
- Location string
Specifies the location of the resource.
- Sku
Pulumi.
Azure Native. Bot Service. Outputs. Sku Response Gets or sets the SKU of the resource.
- Dictionary<string, string>
Contains resource tags defined as key/value pairs.
- Id string
Specifies the resource ID.
- Name string
Specifies the name of the resource.
- Properties
Bot
Properties Response The set of properties specific to bot resource
- Type string
Specifies the type of the resource.
- Zones []string
Entity zones
- Etag string
Entity Tag.
- Kind string
Required. Gets or sets the Kind of the resource.
- Location string
Specifies the location of the resource.
- Sku
Sku
Response Gets or sets the SKU of the resource.
- map[string]string
Contains resource tags defined as key/value pairs.
- id String
Specifies the resource ID.
- name String
Specifies the name of the resource.
- properties
Bot
Properties Response The set of properties specific to bot resource
- type String
Specifies the type of the resource.
- zones List<String>
Entity zones
- etag String
Entity Tag.
- kind String
Required. Gets or sets the Kind of the resource.
- location String
Specifies the location of the resource.
- sku
Sku
Response Gets or sets the SKU of the resource.
- Map<String,String>
Contains resource tags defined as key/value pairs.
- id string
Specifies the resource ID.
- name string
Specifies the name of the resource.
- properties
Bot
Properties Response The set of properties specific to bot resource
- type string
Specifies the type of the resource.
- zones string[]
Entity zones
- etag string
Entity Tag.
- kind string
Required. Gets or sets the Kind of the resource.
- location string
Specifies the location of the resource.
- sku
Sku
Response Gets or sets the SKU of the resource.
- {[key: string]: string}
Contains resource tags defined as key/value pairs.
- id str
Specifies the resource ID.
- name str
Specifies the name of the resource.
- properties
Bot
Properties Response The set of properties specific to bot resource
- type str
Specifies the type of the resource.
- zones Sequence[str]
Entity zones
- etag str
Entity Tag.
- kind str
Required. Gets or sets the Kind of the resource.
- location str
Specifies the location of the resource.
- sku
Sku
Response Gets or sets the SKU of the resource.
- Mapping[str, str]
Contains resource tags defined as key/value pairs.
- id String
Specifies the resource ID.
- name String
Specifies the name of the resource.
- properties Property Map
The set of properties specific to bot resource
- type String
Specifies the type of the resource.
- zones List<String>
Entity zones
- etag String
Entity Tag.
- kind String
Required. Gets or sets the Kind of the resource.
- location String
Specifies the location of the resource.
- sku Property Map
Gets or sets the SKU of the resource.
- Map<String>
Contains resource tags defined as key/value pairs.
Supporting Types
BotPropertiesResponse
- Cmek
Encryption stringStatus The CMK encryption status
- Configured
Channels List<string> Collection of channels for which the bot is configured
- Display
Name string The Name of the bot
- Enabled
Channels List<string> Collection of channels for which the bot is enabled
- Endpoint string
The bot's endpoint
- Endpoint
Version string The bot's endpoint version
- Is
Developer boolApp Insights Api Key Set Whether the bot is developerAppInsightsApiKey set
- Migration
Token string Token used to migrate non Azure bot to azure subscription
- Msa
App stringId Microsoft App Id for the bot
- Private
Endpoint List<Pulumi.Connections Azure Native. Bot Service. Inputs. Private Endpoint Connection Response> List of Private Endpoint Connections configured for the bot
- Provisioning
State string Provisioning state of the resource
- All
Settings Dictionary<string, string> Contains resource all settings defined as key/value pairs.
- App
Password stringHint The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
- Cmek
Key stringVault Url The CMK Url
- Description string
The description of the bot
- Developer
App stringInsight Key The Application Insights key
- Developer
App stringInsights Api Key The Application Insights Api Key
- Developer
App stringInsights Application Id The Application Insights App Id
- Disable
Local boolAuth Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
- Icon
Url string The Icon Url of the bot
- Is
Cmek boolEnabled Whether Cmek is enabled
- Is
Streaming boolSupported Whether the bot is streaming supported
- Luis
App List<string>Ids Collection of LUIS App Ids
- Luis
Key string The LUIS Key
- Manifest
Url string The bot's manifest url
- Msa
App stringMSIResource Id Microsoft App Managed Identity Resource Id for the bot
- Msa
App stringTenant Id Microsoft App Tenant Id for the bot
- Msa
App stringType Microsoft App Type for the bot
- Open
With stringHint The hint to browser (e.g. protocol handler) on how to open the bot for authoring
- Parameters Dictionary<string, string>
Contains resource parameters defined as key/value pairs.
- Public
Network stringAccess Whether the bot is in an isolated network
- Publishing
Credentials string Publishing credentials of the resource
- Schema
Transformation stringVersion The channel schema transformation version for the bot
- Storage
Resource stringId The storage resourceId for the bot
- Tenant
Id string The Tenant Id for the bot
- Cmek
Encryption stringStatus The CMK encryption status
- Configured
Channels []string Collection of channels for which the bot is configured
- Display
Name string The Name of the bot
- Enabled
Channels []string Collection of channels for which the bot is enabled
- Endpoint string
The bot's endpoint
- Endpoint
Version string The bot's endpoint version
- Is
Developer boolApp Insights Api Key Set Whether the bot is developerAppInsightsApiKey set
- Migration
Token string Token used to migrate non Azure bot to azure subscription
- Msa
App stringId Microsoft App Id for the bot
- Private
Endpoint []PrivateConnections Endpoint Connection Response List of Private Endpoint Connections configured for the bot
- Provisioning
State string Provisioning state of the resource
- All
Settings map[string]string Contains resource all settings defined as key/value pairs.
- App
Password stringHint The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
- Cmek
Key stringVault Url The CMK Url
- Description string
The description of the bot
- Developer
App stringInsight Key The Application Insights key
- Developer
App stringInsights Api Key The Application Insights Api Key
- Developer
App stringInsights Application Id The Application Insights App Id
- Disable
Local boolAuth Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
- Icon
Url string The Icon Url of the bot
- Is
Cmek boolEnabled Whether Cmek is enabled
- Is
Streaming boolSupported Whether the bot is streaming supported
- Luis
App []stringIds Collection of LUIS App Ids
- Luis
Key string The LUIS Key
- Manifest
Url string The bot's manifest url
- Msa
App stringMSIResource Id Microsoft App Managed Identity Resource Id for the bot
- Msa
App stringTenant Id Microsoft App Tenant Id for the bot
- Msa
App stringType Microsoft App Type for the bot
- Open
With stringHint The hint to browser (e.g. protocol handler) on how to open the bot for authoring
- Parameters map[string]string
Contains resource parameters defined as key/value pairs.
- Public
Network stringAccess Whether the bot is in an isolated network
- Publishing
Credentials string Publishing credentials of the resource
- Schema
Transformation stringVersion The channel schema transformation version for the bot
- Storage
Resource stringId The storage resourceId for the bot
- Tenant
Id string The Tenant Id for the bot
- cmek
Encryption StringStatus The CMK encryption status
- configured
Channels List<String> Collection of channels for which the bot is configured
- display
Name String The Name of the bot
- enabled
Channels List<String> Collection of channels for which the bot is enabled
- endpoint String
The bot's endpoint
- endpoint
Version String The bot's endpoint version
- is
Developer BooleanApp Insights Api Key Set Whether the bot is developerAppInsightsApiKey set
- migration
Token String Token used to migrate non Azure bot to azure subscription
- msa
App StringId Microsoft App Id for the bot
- private
Endpoint List<PrivateConnections Endpoint Connection Response> List of Private Endpoint Connections configured for the bot
- provisioning
State String Provisioning state of the resource
- all
Settings Map<String,String> Contains resource all settings defined as key/value pairs.
- app
Password StringHint The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
- cmek
Key StringVault Url The CMK Url
- description String
The description of the bot
- developer
App StringInsight Key The Application Insights key
- developer
App StringInsights Api Key The Application Insights Api Key
- developer
App StringInsights Application Id The Application Insights App Id
- disable
Local BooleanAuth Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
- icon
Url String The Icon Url of the bot
- is
Cmek BooleanEnabled Whether Cmek is enabled
- is
Streaming BooleanSupported Whether the bot is streaming supported
- luis
App List<String>Ids Collection of LUIS App Ids
- luis
Key String The LUIS Key
- manifest
Url String The bot's manifest url
- msa
App StringMSIResource Id Microsoft App Managed Identity Resource Id for the bot
- msa
App StringTenant Id Microsoft App Tenant Id for the bot
- msa
App StringType Microsoft App Type for the bot
- open
With StringHint The hint to browser (e.g. protocol handler) on how to open the bot for authoring
- parameters Map<String,String>
Contains resource parameters defined as key/value pairs.
- public
Network StringAccess Whether the bot is in an isolated network
- publishing
Credentials String Publishing credentials of the resource
- schema
Transformation StringVersion The channel schema transformation version for the bot
- storage
Resource StringId The storage resourceId for the bot
- tenant
Id String The Tenant Id for the bot
- cmek
Encryption stringStatus The CMK encryption status
- configured
Channels string[] Collection of channels for which the bot is configured
- display
Name string The Name of the bot
- enabled
Channels string[] Collection of channels for which the bot is enabled
- endpoint string
The bot's endpoint
- endpoint
Version string The bot's endpoint version
- is
Developer booleanApp Insights Api Key Set Whether the bot is developerAppInsightsApiKey set
- migration
Token string Token used to migrate non Azure bot to azure subscription
- msa
App stringId Microsoft App Id for the bot
- private
Endpoint PrivateConnections Endpoint Connection Response[] List of Private Endpoint Connections configured for the bot
- provisioning
State string Provisioning state of the resource
- all
Settings {[key: string]: string} Contains resource all settings defined as key/value pairs.
- app
Password stringHint The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
- cmek
Key stringVault Url The CMK Url
- description string
The description of the bot
- developer
App stringInsight Key The Application Insights key
- developer
App stringInsights Api Key The Application Insights Api Key
- developer
App stringInsights Application Id The Application Insights App Id
- disable
Local booleanAuth Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
- icon
Url string The Icon Url of the bot
- is
Cmek booleanEnabled Whether Cmek is enabled
- is
Streaming booleanSupported Whether the bot is streaming supported
- luis
App string[]Ids Collection of LUIS App Ids
- luis
Key string The LUIS Key
- manifest
Url string The bot's manifest url
- msa
App stringMSIResource Id Microsoft App Managed Identity Resource Id for the bot
- msa
App stringTenant Id Microsoft App Tenant Id for the bot
- msa
App stringType Microsoft App Type for the bot
- open
With stringHint The hint to browser (e.g. protocol handler) on how to open the bot for authoring
- parameters {[key: string]: string}
Contains resource parameters defined as key/value pairs.
- public
Network stringAccess Whether the bot is in an isolated network
- publishing
Credentials string Publishing credentials of the resource
- schema
Transformation stringVersion The channel schema transformation version for the bot
- storage
Resource stringId The storage resourceId for the bot
- tenant
Id string The Tenant Id for the bot
- cmek_
encryption_ strstatus The CMK encryption status
- configured_
channels Sequence[str] Collection of channels for which the bot is configured
- display_
name str The Name of the bot
- enabled_
channels Sequence[str] Collection of channels for which the bot is enabled
- endpoint str
The bot's endpoint
- endpoint_
version str The bot's endpoint version
- is_
developer_ boolapp_ insights_ api_ key_ set Whether the bot is developerAppInsightsApiKey set
- migration_
token str Token used to migrate non Azure bot to azure subscription
- msa_
app_ strid Microsoft App Id for the bot
- private_
endpoint_ Sequence[Privateconnections Endpoint Connection Response] List of Private Endpoint Connections configured for the bot
- provisioning_
state str Provisioning state of the resource
- all_
settings Mapping[str, str] Contains resource all settings defined as key/value pairs.
- app_
password_ strhint The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
- cmek_
key_ strvault_ url The CMK Url
- description str
The description of the bot
- developer_
app_ strinsight_ key The Application Insights key
- developer_
app_ strinsights_ api_ key The Application Insights Api Key
- developer_
app_ strinsights_ application_ id The Application Insights App Id
- disable_
local_ boolauth Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
- icon_
url str The Icon Url of the bot
- is_
cmek_ boolenabled Whether Cmek is enabled
- is_
streaming_ boolsupported Whether the bot is streaming supported
- luis_
app_ Sequence[str]ids Collection of LUIS App Ids
- luis_
key str The LUIS Key
- manifest_
url str The bot's manifest url
- msa_
app_ strmsi_ resource_ id Microsoft App Managed Identity Resource Id for the bot
- msa_
app_ strtenant_ id Microsoft App Tenant Id for the bot
- msa_
app_ strtype Microsoft App Type for the bot
- open_
with_ strhint The hint to browser (e.g. protocol handler) on how to open the bot for authoring
- parameters Mapping[str, str]
Contains resource parameters defined as key/value pairs.
- public_
network_ straccess Whether the bot is in an isolated network
- publishing_
credentials str Publishing credentials of the resource
- schema_
transformation_ strversion The channel schema transformation version for the bot
- storage_
resource_ strid The storage resourceId for the bot
- tenant_
id str The Tenant Id for the bot
- cmek
Encryption StringStatus The CMK encryption status
- configured
Channels List<String> Collection of channels for which the bot is configured
- display
Name String The Name of the bot
- enabled
Channels List<String> Collection of channels for which the bot is enabled
- endpoint String
The bot's endpoint
- endpoint
Version String The bot's endpoint version
- is
Developer BooleanApp Insights Api Key Set Whether the bot is developerAppInsightsApiKey set
- migration
Token String Token used to migrate non Azure bot to azure subscription
- msa
App StringId Microsoft App Id for the bot
- private
Endpoint List<Property Map>Connections List of Private Endpoint Connections configured for the bot
- provisioning
State String Provisioning state of the resource
- all
Settings Map<String> Contains resource all settings defined as key/value pairs.
- app
Password StringHint The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
- cmek
Key StringVault Url The CMK Url
- description String
The description of the bot
- developer
App StringInsight Key The Application Insights key
- developer
App StringInsights Api Key The Application Insights Api Key
- developer
App StringInsights Application Id The Application Insights App Id
- disable
Local BooleanAuth Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
- icon
Url String The Icon Url of the bot
- is
Cmek BooleanEnabled Whether Cmek is enabled
- is
Streaming BooleanSupported Whether the bot is streaming supported
- luis
App List<String>Ids Collection of LUIS App Ids
- luis
Key String The LUIS Key
- manifest
Url String The bot's manifest url
- msa
App StringMSIResource Id Microsoft App Managed Identity Resource Id for the bot
- msa
App StringTenant Id Microsoft App Tenant Id for the bot
- msa
App StringType Microsoft App Type for the bot
- open
With StringHint The hint to browser (e.g. protocol handler) on how to open the bot for authoring
- parameters Map<String>
Contains resource parameters defined as key/value pairs.
- public
Network StringAccess Whether the bot is in an isolated network
- publishing
Credentials String Publishing credentials of the resource
- schema
Transformation StringVersion The channel schema transformation version for the bot
- storage
Resource StringId The storage resourceId for the bot
- tenant
Id String The Tenant Id for the bot
PrivateEndpointConnectionResponse
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Name string
The name of the resource
- Private
Link Pulumi.Service Connection State Azure Native. Bot Service. Inputs. Private Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State string The provisioning state of the private endpoint connection resource.
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Group
Ids List<string> Group ids
- Private
Endpoint Pulumi.Azure Native. Bot Service. Inputs. Private Endpoint Response The resource of private end point.
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Name string
The name of the resource
- Private
Link PrivateService Connection State Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State string The provisioning state of the private endpoint connection resource.
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Group
Ids []string Group ids
- Private
Endpoint PrivateEndpoint Response The resource of private end point.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name String
The name of the resource
- private
Link PrivateService Connection State Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- provisioning
State String The provisioning state of the private endpoint connection resource.
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- group
Ids List<String> Group ids
- private
Endpoint PrivateEndpoint Response The resource of private end point.
- id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name string
The name of the resource
- private
Link PrivateService Connection State Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- provisioning
State string The provisioning state of the private endpoint connection resource.
- type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- group
Ids string[] Group ids
- private
Endpoint PrivateEndpoint Response The resource of private end point.
- id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name str
The name of the resource
- private_
link_ Privateservice_ connection_ state Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- provisioning_
state str The provisioning state of the private endpoint connection resource.
- type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- group_
ids Sequence[str] Group ids
- private_
endpoint PrivateEndpoint Response The resource of private end point.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name String
The name of the resource
- private
Link Property MapService Connection State A collection of information about the state of the connection between service consumer and provider.
- provisioning
State String The provisioning state of the private endpoint connection resource.
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- group
Ids List<String> Group ids
- private
Endpoint Property Map The resource of private end point.
PrivateEndpointResponse
- Id string
The ARM identifier for Private Endpoint
- Id string
The ARM identifier for Private Endpoint
- id String
The ARM identifier for Private Endpoint
- id string
The ARM identifier for Private Endpoint
- id str
The ARM identifier for Private Endpoint
- id String
The ARM identifier for Private Endpoint
PrivateLinkServiceConnectionStateResponse
- Actions
Required string A message indicating if changes on the service provider require any updates on the consumer.
- Description string
The reason for approval/rejection of the connection.
- Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- Actions
Required string A message indicating if changes on the service provider require any updates on the consumer.
- Description string
The reason for approval/rejection of the connection.
- Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String A message indicating if changes on the service provider require any updates on the consumer.
- description String
The reason for approval/rejection of the connection.
- status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required string A message indicating if changes on the service provider require any updates on the consumer.
- description string
The reason for approval/rejection of the connection.
- status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions_
required str A message indicating if changes on the service provider require any updates on the consumer.
- description str
The reason for approval/rejection of the connection.
- status str
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String A message indicating if changes on the service provider require any updates on the consumer.
- description String
The reason for approval/rejection of the connection.
- status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
SkuResponse
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0