1. Packages
  2. Azure Native
  3. API Docs
  4. botservice
  5. getBotConnection
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.botservice.getBotConnection

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Get a Connection Setting registration for a Bot Service Azure REST API version: 2022-09-15.

    Other available API versions: 2023-09-15-preview.

    Using getBotConnection

    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 getBotConnection(args: GetBotConnectionArgs, opts?: InvokeOptions): Promise<GetBotConnectionResult>
    function getBotConnectionOutput(args: GetBotConnectionOutputArgs, opts?: InvokeOptions): Output<GetBotConnectionResult>
    def get_bot_connection(connection_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           resource_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetBotConnectionResult
    def get_bot_connection_output(connection_name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           resource_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetBotConnectionResult]
    func LookupBotConnection(ctx *Context, args *LookupBotConnectionArgs, opts ...InvokeOption) (*LookupBotConnectionResult, error)
    func LookupBotConnectionOutput(ctx *Context, args *LookupBotConnectionOutputArgs, opts ...InvokeOption) LookupBotConnectionResultOutput

    > Note: This function is named LookupBotConnection in the Go SDK.

    public static class GetBotConnection 
    {
        public static Task<GetBotConnectionResult> InvokeAsync(GetBotConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetBotConnectionResult> Invoke(GetBotConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBotConnectionResult> getBotConnection(GetBotConnectionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:botservice:getBotConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ConnectionName string
    The name of the Bot Service Connection Setting resource.
    ResourceGroupName string
    The name of the Bot resource group in the user subscription.
    ResourceName string
    The name of the Bot resource.
    ConnectionName string
    The name of the Bot Service Connection Setting resource.
    ResourceGroupName string
    The name of the Bot resource group in the user subscription.
    ResourceName string
    The name of the Bot resource.
    connectionName String
    The name of the Bot Service Connection Setting resource.
    resourceGroupName String
    The name of the Bot resource group in the user subscription.
    resourceName String
    The name of the Bot resource.
    connectionName string
    The name of the Bot Service Connection Setting resource.
    resourceGroupName string
    The name of the Bot resource group in the user subscription.
    resourceName string
    The name of the Bot resource.
    connection_name str
    The name of the Bot Service Connection Setting 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.
    connectionName String
    The name of the Bot Service Connection Setting resource.
    resourceGroupName String
    The name of the Bot resource group in the user subscription.
    resourceName String
    The name of the Bot resource.

    getBotConnection 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.ConnectionSettingPropertiesResponse
    The set of properties specific to bot channel 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 ConnectionSettingPropertiesResponse
    The set of properties specific to bot channel 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 ConnectionSettingPropertiesResponse
    The set of properties specific to bot channel 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 ConnectionSettingPropertiesResponse
    The set of properties specific to bot channel 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 ConnectionSettingPropertiesResponse
    The set of properties specific to bot channel 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 channel 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

    ConnectionSettingParameterResponse

    Key string
    Key for the Connection Setting Parameter.
    Value string
    Value associated with the Connection Setting Parameter.
    Key string
    Key for the Connection Setting Parameter.
    Value string
    Value associated with the Connection Setting Parameter.
    key String
    Key for the Connection Setting Parameter.
    value String
    Value associated with the Connection Setting Parameter.
    key string
    Key for the Connection Setting Parameter.
    value string
    Value associated with the Connection Setting Parameter.
    key str
    Key for the Connection Setting Parameter.
    value str
    Value associated with the Connection Setting Parameter.
    key String
    Key for the Connection Setting Parameter.
    value String
    Value associated with the Connection Setting Parameter.

    ConnectionSettingPropertiesResponse

    SettingId string
    Setting Id set by the service for the Connection Setting.
    ClientId string
    Client Id associated with the Connection Setting.
    ClientSecret string
    Client Secret associated with the Connection Setting
    Id string
    Id of the Connection Setting.
    Name string
    Name of the Connection Setting.
    Parameters List<Pulumi.AzureNative.BotService.Inputs.ConnectionSettingParameterResponse>
    Service Provider Parameters associated with the Connection Setting
    ProvisioningState string
    Provisioning state of the resource
    Scopes string
    Scopes associated with the Connection Setting
    ServiceProviderDisplayName string
    Service Provider Display Name associated with the Connection Setting
    ServiceProviderId string
    Service Provider Id associated with the Connection Setting
    SettingId string
    Setting Id set by the service for the Connection Setting.
    ClientId string
    Client Id associated with the Connection Setting.
    ClientSecret string
    Client Secret associated with the Connection Setting
    Id string
    Id of the Connection Setting.
    Name string
    Name of the Connection Setting.
    Parameters []ConnectionSettingParameterResponse
    Service Provider Parameters associated with the Connection Setting
    ProvisioningState string
    Provisioning state of the resource
    Scopes string
    Scopes associated with the Connection Setting
    ServiceProviderDisplayName string
    Service Provider Display Name associated with the Connection Setting
    ServiceProviderId string
    Service Provider Id associated with the Connection Setting
    settingId String
    Setting Id set by the service for the Connection Setting.
    clientId String
    Client Id associated with the Connection Setting.
    clientSecret String
    Client Secret associated with the Connection Setting
    id String
    Id of the Connection Setting.
    name String
    Name of the Connection Setting.
    parameters List<ConnectionSettingParameterResponse>
    Service Provider Parameters associated with the Connection Setting
    provisioningState String
    Provisioning state of the resource
    scopes String
    Scopes associated with the Connection Setting
    serviceProviderDisplayName String
    Service Provider Display Name associated with the Connection Setting
    serviceProviderId String
    Service Provider Id associated with the Connection Setting
    settingId string
    Setting Id set by the service for the Connection Setting.
    clientId string
    Client Id associated with the Connection Setting.
    clientSecret string
    Client Secret associated with the Connection Setting
    id string
    Id of the Connection Setting.
    name string
    Name of the Connection Setting.
    parameters ConnectionSettingParameterResponse[]
    Service Provider Parameters associated with the Connection Setting
    provisioningState string
    Provisioning state of the resource
    scopes string
    Scopes associated with the Connection Setting
    serviceProviderDisplayName string
    Service Provider Display Name associated with the Connection Setting
    serviceProviderId string
    Service Provider Id associated with the Connection Setting
    setting_id str
    Setting Id set by the service for the Connection Setting.
    client_id str
    Client Id associated with the Connection Setting.
    client_secret str
    Client Secret associated with the Connection Setting
    id str
    Id of the Connection Setting.
    name str
    Name of the Connection Setting.
    parameters Sequence[ConnectionSettingParameterResponse]
    Service Provider Parameters associated with the Connection Setting
    provisioning_state str
    Provisioning state of the resource
    scopes str
    Scopes associated with the Connection Setting
    service_provider_display_name str
    Service Provider Display Name associated with the Connection Setting
    service_provider_id str
    Service Provider Id associated with the Connection Setting
    settingId String
    Setting Id set by the service for the Connection Setting.
    clientId String
    Client Id associated with the Connection Setting.
    clientSecret String
    Client Secret associated with the Connection Setting
    id String
    Id of the Connection Setting.
    name String
    Name of the Connection Setting.
    parameters List<Property Map>
    Service Provider Parameters associated with the Connection Setting
    provisioningState String
    Provisioning state of the resource
    scopes String
    Scopes associated with the Connection Setting
    serviceProviderDisplayName String
    Service Provider Display Name associated with the Connection Setting
    serviceProviderId String
    Service Provider Id associated with the Connection Setting

    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 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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi