1. Packages
  2. Azure Native
  3. API Docs
  4. healthbot
  5. getBot
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.healthbot.getBot

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

    Get a HealthBot. Azure REST API version: 2023-05-01.

    Other available API versions: 2020-12-08-preview.

    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(bot_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetBotResult
    def get_bot_output(bot_name: Optional[pulumi.Input[str]] = None,
                resource_group_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:healthbot:getBot
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BotName string
    The name of the Bot resource.
    ResourceGroupName string
    The name of the Bot resource group in the user subscription.
    BotName string
    The name of the Bot resource.
    ResourceGroupName string
    The name of the Bot resource group in the user subscription.
    botName String
    The name of the Bot resource.
    resourceGroupName String
    The name of the Bot resource group in the user subscription.
    botName string
    The name of the Bot resource.
    resourceGroupName string
    The name of the Bot resource group in the user subscription.
    bot_name str
    The name of the Bot resource.
    resource_group_name str
    The name of the Bot resource group in the user subscription.
    botName String
    The name of the Bot resource.
    resourceGroupName String
    The name of the Bot resource group in the user subscription.

    getBot Result

    The following output properties are available:

    Id string
    Fully qualified resource Id for the resource.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.HealthBot.Outputs.HealthBotPropertiesResponse
    The set of properties specific to Azure Health Bot resource.
    Sku Pulumi.AzureNative.HealthBot.Outputs.SkuResponse
    SKU of the Azure Health Bot.
    SystemData Pulumi.AzureNative.HealthBot.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource
    Type string
    The type of the resource.
    Identity Pulumi.AzureNative.HealthBot.Outputs.IdentityResponse
    The identity of the Azure Health Bot.
    Tags Dictionary<string, string>
    Resource tags.
    Id string
    Fully qualified resource Id for the resource.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties HealthBotPropertiesResponse
    The set of properties specific to Azure Health Bot resource.
    Sku SkuResponse
    SKU of the Azure Health Bot.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource
    Type string
    The type of the resource.
    Identity IdentityResponse
    The identity of the Azure Health Bot.
    Tags map[string]string
    Resource tags.
    id String
    Fully qualified resource Id for the resource.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties HealthBotPropertiesResponse
    The set of properties specific to Azure Health Bot resource.
    sku SkuResponse
    SKU of the Azure Health Bot.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource
    type String
    The type of the resource.
    identity IdentityResponse
    The identity of the Azure Health Bot.
    tags Map<String,String>
    Resource tags.
    id string
    Fully qualified resource Id for the resource.
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties HealthBotPropertiesResponse
    The set of properties specific to Azure Health Bot resource.
    sku SkuResponse
    SKU of the Azure Health Bot.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource
    type string
    The type of the resource.
    identity IdentityResponse
    The identity of the Azure Health Bot.
    tags {[key: string]: string}
    Resource tags.
    id str
    Fully qualified resource Id for the resource.
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties HealthBotPropertiesResponse
    The set of properties specific to Azure Health Bot resource.
    sku SkuResponse
    SKU of the Azure Health Bot.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource
    type str
    The type of the resource.
    identity IdentityResponse
    The identity of the Azure Health Bot.
    tags Mapping[str, str]
    Resource tags.
    id String
    Fully qualified resource Id for the resource.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    The set of properties specific to Azure Health Bot resource.
    sku Property Map
    SKU of the Azure Health Bot.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource
    type String
    The type of the resource.
    identity Property Map
    The identity of the Azure Health Bot.
    tags Map<String>
    Resource tags.

    Supporting Types

    HealthBotPropertiesResponse

    BotManagementPortalLink string
    The link.
    ProvisioningState string
    The provisioning state of the Azure Health Bot resource.
    KeyVaultProperties Pulumi.AzureNative.HealthBot.Inputs.KeyVaultPropertiesResponse
    KeyVault properties for the resource encryption.
    BotManagementPortalLink string
    The link.
    ProvisioningState string
    The provisioning state of the Azure Health Bot resource.
    KeyVaultProperties KeyVaultPropertiesResponse
    KeyVault properties for the resource encryption.
    botManagementPortalLink String
    The link.
    provisioningState String
    The provisioning state of the Azure Health Bot resource.
    keyVaultProperties KeyVaultPropertiesResponse
    KeyVault properties for the resource encryption.
    botManagementPortalLink string
    The link.
    provisioningState string
    The provisioning state of the Azure Health Bot resource.
    keyVaultProperties KeyVaultPropertiesResponse
    KeyVault properties for the resource encryption.
    bot_management_portal_link str
    The link.
    provisioning_state str
    The provisioning state of the Azure Health Bot resource.
    key_vault_properties KeyVaultPropertiesResponse
    KeyVault properties for the resource encryption.
    botManagementPortalLink String
    The link.
    provisioningState String
    The provisioning state of the Azure Health Bot resource.
    keyVaultProperties Property Map
    KeyVault properties for the resource encryption.

    IdentityResponse

    PrincipalId string
    The principal ID of resource identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of resource. This property will only be provided for a system assigned identity.
    Type string
    The identity type. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the Azure Health Bot
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.HealthBot.Inputs.UserAssignedIdentityResponse>
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    PrincipalId string
    The principal ID of resource identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of resource. This property will only be provided for a system assigned identity.
    Type string
    The identity type. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the Azure Health Bot
    UserAssignedIdentities map[string]UserAssignedIdentityResponse
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    principalId String
    The principal ID of resource identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of resource. This property will only be provided for a system assigned identity.
    type String
    The identity type. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the Azure Health Bot
    userAssignedIdentities Map<String,UserAssignedIdentityResponse>
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    principalId string
    The principal ID of resource identity. This property will only be provided for a system assigned identity.
    tenantId string
    The tenant ID of resource. This property will only be provided for a system assigned identity.
    type string
    The identity type. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the Azure Health Bot
    userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    principal_id str
    The principal ID of resource identity. This property will only be provided for a system assigned identity.
    tenant_id str
    The tenant ID of resource. This property will only be provided for a system assigned identity.
    type str
    The identity type. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the Azure Health Bot
    user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    principalId String
    The principal ID of resource identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of resource. This property will only be provided for a system assigned identity.
    type String
    The identity type. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the Azure Health Bot
    userAssignedIdentities Map<Property Map>
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

    KeyVaultPropertiesResponse

    KeyName string
    The name of the key vault key.
    KeyVaultUri string
    The Uri of the key vault.
    KeyVersion string
    The version of the key vault key.
    UserIdentity string
    The user assigned identity (ARM resource id) that has access to the key.
    KeyName string
    The name of the key vault key.
    KeyVaultUri string
    The Uri of the key vault.
    KeyVersion string
    The version of the key vault key.
    UserIdentity string
    The user assigned identity (ARM resource id) that has access to the key.
    keyName String
    The name of the key vault key.
    keyVaultUri String
    The Uri of the key vault.
    keyVersion String
    The version of the key vault key.
    userIdentity String
    The user assigned identity (ARM resource id) that has access to the key.
    keyName string
    The name of the key vault key.
    keyVaultUri string
    The Uri of the key vault.
    keyVersion string
    The version of the key vault key.
    userIdentity string
    The user assigned identity (ARM resource id) that has access to the key.
    key_name str
    The name of the key vault key.
    key_vault_uri str
    The Uri of the key vault.
    key_version str
    The version of the key vault key.
    user_identity str
    The user assigned identity (ARM resource id) that has access to the key.
    keyName String
    The name of the key vault key.
    keyVaultUri String
    The Uri of the key vault.
    keyVersion String
    The version of the key vault key.
    userIdentity String
    The user assigned identity (ARM resource id) that has access to the key.

    SkuResponse

    Name string
    The name of the Azure Health Bot SKU
    Name string
    The name of the Azure Health Bot SKU
    name String
    The name of the Azure Health Bot SKU
    name string
    The name of the Azure Health Bot SKU
    name str
    The name of the Azure Health Bot SKU
    name String
    The name of the Azure Health Bot SKU

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC)
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource
    CreatedAt string
    The timestamp of resource creation (UTC)
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource
    createdAt String
    The timestamp of resource creation (UTC)
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource
    createdAt string
    The timestamp of resource creation (UTC)
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource
    created_at str
    The timestamp of resource creation (UTC)
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource
    createdAt String
    The timestamp of resource creation (UTC)
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource

    UserAssignedIdentityResponse

    ClientId string
    The client ID of user assigned identity.
    PrincipalId string
    The principal ID of user assigned identity.
    ClientId string
    The client ID of user assigned identity.
    PrincipalId string
    The principal ID of user assigned identity.
    clientId String
    The client ID of user assigned identity.
    principalId String
    The principal ID of user assigned identity.
    clientId string
    The client ID of user assigned identity.
    principalId string
    The principal ID of user assigned identity.
    client_id str
    The client ID of user assigned identity.
    principal_id str
    The principal ID of user assigned identity.
    clientId String
    The client ID of user assigned identity.
    principalId String
    The principal ID of user assigned identity.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi