Docs Packages
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. botservice
  5. getBot
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.botservice.getBot

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Returns a BotService specified by the parameters. API Version: 2021-03-01.

    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:

    ResourceGroupName string
    The name of the Bot resource group in the user subscription.
    ResourceName string
    The name of the Bot resource.
    ResourceGroupName string
    The name of the Bot resource group in the user subscription.
    ResourceName string
    The name of the Bot resource.
    resourceGroupName String
    The name of the Bot resource group in the user subscription.
    resourceName String
    The name of the Bot resource.
    resourceGroupName string
    The name of the Bot resource group in the user subscription.
    resourceName string
    The name of the Bot resource.
    resource_group_name str
    The name of the Bot resource group in the user subscription.
    resource_name str
    The name of the Bot resource.
    resourceGroupName String
    The name of the Bot resource group in the user subscription.
    resourceName 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.AzureNative.BotService.Outputs.BotPropertiesResponse
    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.AzureNative.BotService.Outputs.SkuResponse
    Gets or sets the SKU of the resource.
    Tags 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 BotPropertiesResponse
    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 SkuResponse
    Gets or sets the SKU of the resource.
    Tags 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 BotPropertiesResponse
    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 SkuResponse
    Gets or sets the SKU of the resource.
    tags 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 BotPropertiesResponse
    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 SkuResponse
    Gets or sets the SKU of the resource.
    tags {[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 BotPropertiesResponse
    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 SkuResponse
    Gets or sets the SKU of the resource.
    tags 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.
    tags Map<String>
    Contains resource tags defined as key/value pairs.

    Supporting Types

    BotPropertiesResponse

    CmekEncryptionStatus string
    The CMK encryption status
    ConfiguredChannels List<string>
    Collection of channels for which the bot is configured
    DisplayName string
    The Name of the bot
    EnabledChannels List<string>
    Collection of channels for which the bot is enabled
    Endpoint string
    The bot's endpoint
    EndpointVersion string
    The bot's endpoint version
    IsDeveloperAppInsightsApiKeySet bool
    Whether the bot is developerAppInsightsApiKey set
    MigrationToken string
    Token used to migrate non Azure bot to azure subscription
    MsaAppId string
    Microsoft App Id for the bot
    ProvisioningState string
    Provisioning state of the resource
    AllSettings Dictionary<string, string>
    Contains resource all settings defined as key/value pairs.
    AppPasswordHint string
    The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
    CmekKeyVaultUrl string
    The CMK Url
    Description string
    The description of the bot
    DeveloperAppInsightKey string
    The Application Insights key
    DeveloperAppInsightsApiKey string
    The Application Insights Api Key
    DeveloperAppInsightsApplicationId string
    The Application Insights App Id
    DisableLocalAuth bool
    Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
    IconUrl string
    The Icon Url of the bot
    IsCmekEnabled bool
    Whether Cmek is enabled
    IsStreamingSupported bool
    Whether the bot is streaming supported
    LuisAppIds List<string>
    Collection of LUIS App Ids
    LuisKey string
    The LUIS Key
    ManifestUrl string
    The bot's manifest url
    MsaAppMSIResourceId string
    Microsoft App Managed Identity Resource Id for the bot
    MsaAppTenantId string
    Microsoft App Tenant Id for the bot
    MsaAppType string
    Microsoft App Type for the bot
    OpenWithHint string
    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.
    PublicNetworkAccess string
    Whether the bot is in an isolated network
    PublishingCredentials string
    Publishing credentials of the resource
    SchemaTransformationVersion string
    The channel schema transformation version for the bot
    StorageResourceId string
    The storage resourceId for the bot
    TenantId string
    The Tenant Id for the bot
    CmekEncryptionStatus string
    The CMK encryption status
    ConfiguredChannels []string
    Collection of channels for which the bot is configured
    DisplayName string
    The Name of the bot
    EnabledChannels []string
    Collection of channels for which the bot is enabled
    Endpoint string
    The bot's endpoint
    EndpointVersion string
    The bot's endpoint version
    IsDeveloperAppInsightsApiKeySet bool
    Whether the bot is developerAppInsightsApiKey set
    MigrationToken string
    Token used to migrate non Azure bot to azure subscription
    MsaAppId string
    Microsoft App Id for the bot
    ProvisioningState string
    Provisioning state of the resource
    AllSettings map[string]string
    Contains resource all settings defined as key/value pairs.
    AppPasswordHint string
    The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
    CmekKeyVaultUrl string
    The CMK Url
    Description string
    The description of the bot
    DeveloperAppInsightKey string
    The Application Insights key
    DeveloperAppInsightsApiKey string
    The Application Insights Api Key
    DeveloperAppInsightsApplicationId string
    The Application Insights App Id
    DisableLocalAuth bool
    Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
    IconUrl string
    The Icon Url of the bot
    IsCmekEnabled bool
    Whether Cmek is enabled
    IsStreamingSupported bool
    Whether the bot is streaming supported
    LuisAppIds []string
    Collection of LUIS App Ids
    LuisKey string
    The LUIS Key
    ManifestUrl string
    The bot's manifest url
    MsaAppMSIResourceId string
    Microsoft App Managed Identity Resource Id for the bot
    MsaAppTenantId string
    Microsoft App Tenant Id for the bot
    MsaAppType string
    Microsoft App Type for the bot
    OpenWithHint string
    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.
    PublicNetworkAccess string
    Whether the bot is in an isolated network
    PublishingCredentials string
    Publishing credentials of the resource
    SchemaTransformationVersion string
    The channel schema transformation version for the bot
    StorageResourceId string
    The storage resourceId for the bot
    TenantId string
    The Tenant Id for the bot
    cmekEncryptionStatus String
    The CMK encryption status
    configuredChannels List<String>
    Collection of channels for which the bot is configured
    displayName String
    The Name of the bot
    enabledChannels List<String>
    Collection of channels for which the bot is enabled
    endpoint String
    The bot's endpoint
    endpointVersion String
    The bot's endpoint version
    isDeveloperAppInsightsApiKeySet Boolean
    Whether the bot is developerAppInsightsApiKey set
    migrationToken String
    Token used to migrate non Azure bot to azure subscription
    msaAppId String
    Microsoft App Id for the bot
    provisioningState String
    Provisioning state of the resource
    allSettings Map<String,String>
    Contains resource all settings defined as key/value pairs.
    appPasswordHint String
    The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
    cmekKeyVaultUrl String
    The CMK Url
    description String
    The description of the bot
    developerAppInsightKey String
    The Application Insights key
    developerAppInsightsApiKey String
    The Application Insights Api Key
    developerAppInsightsApplicationId String
    The Application Insights App Id
    disableLocalAuth Boolean
    Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
    iconUrl String
    The Icon Url of the bot
    isCmekEnabled Boolean
    Whether Cmek is enabled
    isStreamingSupported Boolean
    Whether the bot is streaming supported
    luisAppIds List<String>
    Collection of LUIS App Ids
    luisKey String
    The LUIS Key
    manifestUrl String
    The bot's manifest url
    msaAppMSIResourceId String
    Microsoft App Managed Identity Resource Id for the bot
    msaAppTenantId String
    Microsoft App Tenant Id for the bot
    msaAppType String
    Microsoft App Type for the bot
    openWithHint String
    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.
    publicNetworkAccess String
    Whether the bot is in an isolated network
    publishingCredentials String
    Publishing credentials of the resource
    schemaTransformationVersion String
    The channel schema transformation version for the bot
    storageResourceId String
    The storage resourceId for the bot
    tenantId String
    The Tenant Id for the bot
    cmekEncryptionStatus string
    The CMK encryption status
    configuredChannels string[]
    Collection of channels for which the bot is configured
    displayName string
    The Name of the bot
    enabledChannels string[]
    Collection of channels for which the bot is enabled
    endpoint string
    The bot's endpoint
    endpointVersion string
    The bot's endpoint version
    isDeveloperAppInsightsApiKeySet boolean
    Whether the bot is developerAppInsightsApiKey set
    migrationToken string
    Token used to migrate non Azure bot to azure subscription
    msaAppId string
    Microsoft App Id for the bot
    provisioningState string
    Provisioning state of the resource
    allSettings {[key: string]: string}
    Contains resource all settings defined as key/value pairs.
    appPasswordHint string
    The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
    cmekKeyVaultUrl string
    The CMK Url
    description string
    The description of the bot
    developerAppInsightKey string
    The Application Insights key
    developerAppInsightsApiKey string
    The Application Insights Api Key
    developerAppInsightsApplicationId string
    The Application Insights App Id
    disableLocalAuth boolean
    Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
    iconUrl string
    The Icon Url of the bot
    isCmekEnabled boolean
    Whether Cmek is enabled
    isStreamingSupported boolean
    Whether the bot is streaming supported
    luisAppIds string[]
    Collection of LUIS App Ids
    luisKey string
    The LUIS Key
    manifestUrl string
    The bot's manifest url
    msaAppMSIResourceId string
    Microsoft App Managed Identity Resource Id for the bot
    msaAppTenantId string
    Microsoft App Tenant Id for the bot
    msaAppType string
    Microsoft App Type for the bot
    openWithHint string
    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.
    publicNetworkAccess string
    Whether the bot is in an isolated network
    publishingCredentials string
    Publishing credentials of the resource
    schemaTransformationVersion string
    The channel schema transformation version for the bot
    storageResourceId string
    The storage resourceId for the bot
    tenantId string
    The Tenant Id for the bot
    cmek_encryption_status str
    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_app_insights_api_key_set bool
    Whether the bot is developerAppInsightsApiKey set
    migration_token str
    Token used to migrate non Azure bot to azure subscription
    msa_app_id str
    Microsoft App Id 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_hint str
    The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
    cmek_key_vault_url str
    The CMK Url
    description str
    The description of the bot
    developer_app_insight_key str
    The Application Insights key
    developer_app_insights_api_key str
    The Application Insights Api Key
    developer_app_insights_application_id str
    The Application Insights App Id
    disable_local_auth bool
    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_enabled bool
    Whether Cmek is enabled
    is_streaming_supported bool
    Whether the bot is streaming supported
    luis_app_ids Sequence[str]
    Collection of LUIS App Ids
    luis_key str
    The LUIS Key
    manifest_url str
    The bot's manifest url
    msa_app_msi_resource_id str
    Microsoft App Managed Identity Resource Id for the bot
    msa_app_tenant_id str
    Microsoft App Tenant Id for the bot
    msa_app_type str
    Microsoft App Type for the bot
    open_with_hint str
    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_access str
    Whether the bot is in an isolated network
    publishing_credentials str
    Publishing credentials of the resource
    schema_transformation_version str
    The channel schema transformation version for the bot
    storage_resource_id str
    The storage resourceId for the bot
    tenant_id str
    The Tenant Id for the bot
    cmekEncryptionStatus String
    The CMK encryption status
    configuredChannels List<String>
    Collection of channels for which the bot is configured
    displayName String
    The Name of the bot
    enabledChannels List<String>
    Collection of channels for which the bot is enabled
    endpoint String
    The bot's endpoint
    endpointVersion String
    The bot's endpoint version
    isDeveloperAppInsightsApiKeySet Boolean
    Whether the bot is developerAppInsightsApiKey set
    migrationToken String
    Token used to migrate non Azure bot to azure subscription
    msaAppId String
    Microsoft App Id for the bot
    provisioningState String
    Provisioning state of the resource
    allSettings Map<String>
    Contains resource all settings defined as key/value pairs.
    appPasswordHint String
    The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
    cmekKeyVaultUrl String
    The CMK Url
    description String
    The description of the bot
    developerAppInsightKey String
    The Application Insights key
    developerAppInsightsApiKey String
    The Application Insights Api Key
    developerAppInsightsApplicationId String
    The Application Insights App Id
    disableLocalAuth Boolean
    Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
    iconUrl String
    The Icon Url of the bot
    isCmekEnabled Boolean
    Whether Cmek is enabled
    isStreamingSupported Boolean
    Whether the bot is streaming supported
    luisAppIds List<String>
    Collection of LUIS App Ids
    luisKey String
    The LUIS Key
    manifestUrl String
    The bot's manifest url
    msaAppMSIResourceId String
    Microsoft App Managed Identity Resource Id for the bot
    msaAppTenantId String
    Microsoft App Tenant Id for the bot
    msaAppType String
    Microsoft App Type for the bot
    openWithHint String
    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.
    publicNetworkAccess String
    Whether the bot is in an isolated network
    publishingCredentials String
    Publishing credentials of the resource
    schemaTransformationVersion String
    The channel schema transformation version for the bot
    storageResourceId String
    The storage resourceId for the bot
    tenantId String
    The Tenant Id for the bot

    SkuResponse

    Name string
    The sku name
    Tier string
    Gets the sku tier. This is based on the SKU name.
    Name string
    The sku name
    Tier string
    Gets the sku tier. This is based on the SKU name.
    name String
    The sku name
    tier String
    Gets the sku tier. This is based on the SKU name.
    name string
    The sku name
    tier string
    Gets the sku tier. This is based on the SKU name.
    name str
    The sku name
    tier str
    Gets the sku tier. This is based on the SKU name.
    name String
    The sku name
    tier String
    Gets the sku tier. This is based on the SKU name.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native