host_settings

Creates, updates, deletes, gets or lists a host_settings resource.

Overview

Name	host_settings
Type	Resource
Id	azure.bot_service.host_settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
BotOpenIdMetadata	string	Same as toBotFromChannelOpenIdMetadataUrl, used by SDK < v4.12.
OAuthUrl	string	For in-conversation bot user authentication.
ToBotFromChannelOpenIdMetadataUrl	string	For verifying incoming tokens from the channels.
ToBotFromChannelTokenIssuer	string	For verifying incoming tokens from the channels.
ToBotFromEmulatorOpenIdMetadataUrl	string	For verifying incoming tokens from bot emulator.
ToChannelFromBotLoginUrl	string	For getting access token to channels from bot host.
ToChannelFromBotOAuthScope	string	For getting access token to channels from bot host.
ValidateAuthority	boolean	Per cloud OAuth setting on whether authority is validated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscription_id		Get per subscription settings needed to host bot in compute resource such as Azure App Service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subscription_id	string

SELECT examples

get

Get per subscription settings needed to host bot in compute resource such as Azure App Service.

SELECT
BotOpenIdMetadata,
OAuthUrl,
ToBotFromChannelOpenIdMetadataUrl,
ToBotFromChannelTokenIssuer,
ToBotFromEmulatorOpenIdMetadataUrl,
ToChannelFromBotLoginUrl,
ToChannelFromBotOAuthScope,
ValidateAuthority
FROM azure.bot_service.host_settings
WHERE subscription_id = '{{ subscription_id }}' -- required
;