bots

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

Overview

Name	bots
Type	Resource
Id	azure.bot_service.bots

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
allSettings	object	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.
cmekEncryptionStatus	string	The CMK encryption status.
cmekKeyVaultUrl	string	The CMK Url.
configuredChannels	array	Collection of channels for which the bot is configured.
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.
displayName	string	The Name of the bot. Required.
enabledChannels	array	Collection of channels for which the bot is enabled.
endpoint	string	The bot's endpoint. Required.
endpointVersion	string	The bot's endpoint version.
etag	string	Entity Tag.
iconUrl	string	The Icon Url of the bot.
isCmekEnabled	boolean	Whether Cmek is enabled.
isDeveloperAppInsightsApiKeySet	boolean	Whether the bot is developerAppInsightsApiKey set.
isStreamingSupported	boolean	Whether the bot is streaming supported.
kind	string	Required. Gets or sets the Kind of the resource. Known values are: "sdk", "designer", "bot", "function", and "azurebot".
location	string	Specifies the location of the resource.
luisAppIds	array	Collection of LUIS App Ids.
luisKey	string	The LUIS Key.
manifestUrl	string	The bot's manifest url.
migrationToken	string	Token used to migrate non Azure bot to azure subscription.
msaAppId	string	Microsoft App Id for the bot. Required.
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. Known values are: "UserAssignedMSI", "SingleTenant", and "MultiTenant".
openWithHint	string	The hint to browser (e.g. protocol handler) on how to open the bot for authoring.
parameters	object	Contains resource parameters defined as key/value pairs.
privateEndpointConnections	array	List of Private Endpoint Connections configured for the bot.
provisioningState	string	Provisioning state of the resource.
publicNetworkAccess	string	Whether the bot is in an isolated network. Known values are: "Enabled" and "Disabled".
publishingCredentials	string	Publishing credentials of the resource.
schemaTransformationVersion	string	The channel schema transformation version for the bot.
sku	object	Gets or sets the SKU of the resource.
storageResourceId	string	The storage resourceId for the bot.
tags	object	Contains resource tags defined as key/value pairs.
tenantId	string	The Tenant Id for the bot.
type	string	Specifies the type of the resource.
zones	array	Entity zones.

list_by_resource_group

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
allSettings	object	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.
cmekEncryptionStatus	string	The CMK encryption status.
cmekKeyVaultUrl	string	The CMK Url.
configuredChannels	array	Collection of channels for which the bot is configured.
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.
displayName	string	The Name of the bot. Required.
enabledChannels	array	Collection of channels for which the bot is enabled.
endpoint	string	The bot's endpoint. Required.
endpointVersion	string	The bot's endpoint version.
etag	string	Entity Tag.
iconUrl	string	The Icon Url of the bot.
isCmekEnabled	boolean	Whether Cmek is enabled.
isDeveloperAppInsightsApiKeySet	boolean	Whether the bot is developerAppInsightsApiKey set.
isStreamingSupported	boolean	Whether the bot is streaming supported.
kind	string	Required. Gets or sets the Kind of the resource. Known values are: "sdk", "designer", "bot", "function", and "azurebot".
location	string	Specifies the location of the resource.
luisAppIds	array	Collection of LUIS App Ids.
luisKey	string	The LUIS Key.
manifestUrl	string	The bot's manifest url.
migrationToken	string	Token used to migrate non Azure bot to azure subscription.
msaAppId	string	Microsoft App Id for the bot. Required.
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. Known values are: "UserAssignedMSI", "SingleTenant", and "MultiTenant".
openWithHint	string	The hint to browser (e.g. protocol handler) on how to open the bot for authoring.
parameters	object	Contains resource parameters defined as key/value pairs.
privateEndpointConnections	array	List of Private Endpoint Connections configured for the bot.
provisioningState	string	Provisioning state of the resource.
publicNetworkAccess	string	Whether the bot is in an isolated network. Known values are: "Enabled" and "Disabled".
publishingCredentials	string	Publishing credentials of the resource.
schemaTransformationVersion	string	The channel schema transformation version for the bot.
sku	object	Gets or sets the SKU of the resource.
storageResourceId	string	The storage resourceId for the bot.
tags	object	Contains resource tags defined as key/value pairs.
tenantId	string	The Tenant Id for the bot.
type	string	Specifies the type of the resource.
zones	array	Entity zones.

list

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
allSettings	object	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.
cmekEncryptionStatus	string	The CMK encryption status.
cmekKeyVaultUrl	string	The CMK Url.
configuredChannels	array	Collection of channels for which the bot is configured.
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.
displayName	string	The Name of the bot. Required.
enabledChannels	array	Collection of channels for which the bot is enabled.
endpoint	string	The bot's endpoint. Required.
endpointVersion	string	The bot's endpoint version.
etag	string	Entity Tag.
iconUrl	string	The Icon Url of the bot.
isCmekEnabled	boolean	Whether Cmek is enabled.
isDeveloperAppInsightsApiKeySet	boolean	Whether the bot is developerAppInsightsApiKey set.
isStreamingSupported	boolean	Whether the bot is streaming supported.
kind	string	Required. Gets or sets the Kind of the resource. Known values are: "sdk", "designer", "bot", "function", and "azurebot".
location	string	Specifies the location of the resource.
luisAppIds	array	Collection of LUIS App Ids.
luisKey	string	The LUIS Key.
manifestUrl	string	The bot's manifest url.
migrationToken	string	Token used to migrate non Azure bot to azure subscription.
msaAppId	string	Microsoft App Id for the bot. Required.
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. Known values are: "UserAssignedMSI", "SingleTenant", and "MultiTenant".
openWithHint	string	The hint to browser (e.g. protocol handler) on how to open the bot for authoring.
parameters	object	Contains resource parameters defined as key/value pairs.
privateEndpointConnections	array	List of Private Endpoint Connections configured for the bot.
provisioningState	string	Provisioning state of the resource.
publicNetworkAccess	string	Whether the bot is in an isolated network. Known values are: "Enabled" and "Disabled".
publishingCredentials	string	Publishing credentials of the resource.
schemaTransformationVersion	string	The channel schema transformation version for the bot.
sku	object	Gets or sets the SKU of the resource.
storageResourceId	string	The storage resourceId for the bot.
tags	object	Contains resource tags defined as key/value pairs.
tenantId	string	The Tenant Id for the bot.
type	string	Specifies the type of the resource.
zones	array	Entity zones.

get_check_name_availability

Name	Datatype	Description
absCode	string	response code from ABS.
message	string	additional message from the bot management api showing why a bot name is not available.
valid	boolean	indicates if the bot name is valid.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, subscription_id		Returns a BotService specified by the parameters.
list_by_resource_group	select	resource_group_name, subscription_id		Returns all the resources of a particular type belonging to a resource group.
list	select	subscription_id		Returns all the resources of a particular type belonging to a subscription.
get_check_name_availability	select			Check whether a bot name is available.
create	insert	resource_group_name, resource_name, subscription_id		Creates a Bot Service. Bot Service is a resource group wide resource type.
update	update	resource_group_name, resource_name, subscription_id, name		Updates a Bot Service.
delete	delete	resource_group_name, resource_name, subscription_id		Deletes a Bot Service from the resource group.

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
resource_group_name	string	The name of the Bot resource group in the user subscription. Required.
resource_name	string	The name of the Bot resource. Required.
subscription_id	string

SELECT examples

get

Returns a BotService specified by the parameters.

SELECT
id,
name,
allSettings,
appPasswordHint,
cmekEncryptionStatus,
cmekKeyVaultUrl,
configuredChannels,
description,
developerAppInsightKey,
developerAppInsightsApiKey,
developerAppInsightsApplicationId,
disableLocalAuth,
displayName,
enabledChannels,
endpoint,
endpointVersion,
etag,
iconUrl,
isCmekEnabled,
isDeveloperAppInsightsApiKeySet,
isStreamingSupported,
kind,
location,
luisAppIds,
luisKey,
manifestUrl,
migrationToken,
msaAppId,
msaAppMSIResourceId,
msaAppTenantId,
msaAppType,
openWithHint,
parameters,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
publishingCredentials,
schemaTransformationVersion,
sku,
storageResourceId,
tags,
tenantId,
type,
zones
FROM azure.bot_service.bots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Returns all the resources of a particular type belonging to a resource group.

SELECT
id,
name,
allSettings,
appPasswordHint,
cmekEncryptionStatus,
cmekKeyVaultUrl,
configuredChannels,
description,
developerAppInsightKey,
developerAppInsightsApiKey,
developerAppInsightsApplicationId,
disableLocalAuth,
displayName,
enabledChannels,
endpoint,
endpointVersion,
etag,
iconUrl,
isCmekEnabled,
isDeveloperAppInsightsApiKeySet,
isStreamingSupported,
kind,
location,
luisAppIds,
luisKey,
manifestUrl,
migrationToken,
msaAppId,
msaAppMSIResourceId,
msaAppTenantId,
msaAppType,
openWithHint,
parameters,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
publishingCredentials,
schemaTransformationVersion,
sku,
storageResourceId,
tags,
tenantId,
type,
zones
FROM azure.bot_service.bots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns all the resources of a particular type belonging to a subscription.

SELECT
id,
name,
allSettings,
appPasswordHint,
cmekEncryptionStatus,
cmekKeyVaultUrl,
configuredChannels,
description,
developerAppInsightKey,
developerAppInsightsApiKey,
developerAppInsightsApplicationId,
disableLocalAuth,
displayName,
enabledChannels,
endpoint,
endpointVersion,
etag,
iconUrl,
isCmekEnabled,
isDeveloperAppInsightsApiKeySet,
isStreamingSupported,
kind,
location,
luisAppIds,
luisKey,
manifestUrl,
migrationToken,
msaAppId,
msaAppMSIResourceId,
msaAppTenantId,
msaAppType,
openWithHint,
parameters,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
publishingCredentials,
schemaTransformationVersion,
sku,
storageResourceId,
tags,
tenantId,
type,
zones
FROM azure.bot_service.bots
WHERE subscription_id = '{{ subscription_id }}' -- required
;

get_check_name_availability

Check whether a bot name is available.

SELECT
absCode,
message,
valid
FROM azure.bot_service.bots
;

INSERT examples

create

Creates a Bot Service. Bot Service is a resource group wide resource type.

INSERT INTO azure.bot_service.bots (
location,
tags,
sku,
kind,
etag,
properties,
resource_group_name,
resource_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ kind }}',
'{{ etag }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
kind,
location,
properties,
sku,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: bots
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the bots resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the bots resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the bots resource.
  - name: location
    value: "{{ location }}"
    description: |
      Specifies the location of the resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Contains resource tags defined as key/value pairs.
  - name: sku
    description: |
      Gets or sets the SKU of the resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      Required. Gets or sets the Kind of the resource. Known values are: "sdk", "designer", "bot", "function", and "azurebot".
  - name: etag
    value: "{{ etag }}"
    description: |
      Entity Tag.
  - name: properties
    description: |
      The set of properties specific to bot resource.
    value:
      displayName: "{{ displayName }}"
      description: "{{ description }}"
      iconUrl: "{{ iconUrl }}"
      endpoint: "{{ endpoint }}"
      endpointVersion: "{{ endpointVersion }}"
      allSettings: "{{ allSettings }}"
      parameters: "{{ parameters }}"
      manifestUrl: "{{ manifestUrl }}"
      msaAppType: "{{ msaAppType }}"
      msaAppId: "{{ msaAppId }}"
      msaAppTenantId: "{{ msaAppTenantId }}"
      msaAppMSIResourceId: "{{ msaAppMSIResourceId }}"
      configuredChannels:
        - "{{ configuredChannels }}"
      enabledChannels:
        - "{{ enabledChannels }}"
      developerAppInsightKey: "{{ developerAppInsightKey }}"
      developerAppInsightsApiKey: "{{ developerAppInsightsApiKey }}"
      developerAppInsightsApplicationId: "{{ developerAppInsightsApplicationId }}"
      luisAppIds:
        - "{{ luisAppIds }}"
      luisKey: "{{ luisKey }}"
      isCmekEnabled: {{ isCmekEnabled }}
      cmekKeyVaultUrl: "{{ cmekKeyVaultUrl }}"
      cmekEncryptionStatus: "{{ cmekEncryptionStatus }}"
      tenantId: "{{ tenantId }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      isStreamingSupported: {{ isStreamingSupported }}
      isDeveloperAppInsightsApiKeySet: {{ isDeveloperAppInsightsApiKeySet }}
      migrationToken: "{{ migrationToken }}"
      disableLocalAuth: {{ disableLocalAuth }}
      schemaTransformationVersion: "{{ schemaTransformationVersion }}"
      storageResourceId: "{{ storageResourceId }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
            groupIds:
              - "{{ groupIds }}"
      openWithHint: "{{ openWithHint }}"
      appPasswordHint: "{{ appPasswordHint }}"
      provisioningState: "{{ provisioningState }}"
      publishingCredentials: "{{ publishingCredentials }}"

UPDATE examples

update

Updates a Bot Service.

UPDATE azure.bot_service.bots
SET 
name = '{{ name }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND name = '{{ name }}' --required
RETURNING
id,
name,
etag,
kind,
location,
properties,
sku,
tags,
type,
zones;

DELETE examples

delete

Deletes a Bot Service from the resource group.

DELETE FROM azure.bot_service.bots
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;