bots

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

Overview

Name	bots
Type	Resource
Id	azure.bot_service.bots

Fields

vw_bots

Name	Datatype	Description
id	text	Specifies the resource ID.
name	text	Specifies the name of the resource.
description	text	field from the properties object
all_settings	text	field from the properties object
app_password_hint	text	field from the properties object
cmek_encryption_status	text	field from the properties object
cmek_key_vault_url	text	field from the properties object
configured_channels	text	field from the properties object
developer_app_insight_key	text	field from the properties object
developer_app_insights_api_key	text	field from the properties object
developer_app_insights_application_id	text	field from the properties object
disable_local_auth	text	field from the properties object
display_name	text	field from the properties object
enabled_channels	text	field from the properties object
endpoint	text	field from the properties object
endpoint_version	text	field from the properties object
etag	text	Entity Tag.
icon_url	text	field from the properties object
is_cmek_enabled	text	field from the properties object
is_developer_app_insights_api_key_set	text	field from the properties object
is_streaming_supported	text	field from the properties object
kind	text	Indicates the type of bot service
location	text	Specifies the location of the resource.
luis_app_ids	text	field from the properties object
luis_key	text	field from the properties object
manifest_url	text	field from the properties object
migration_token	text	field from the properties object
msa_app_id	text	field from the properties object
msa_app_msi_resource_id	text	field from the properties object
msa_app_tenant_id	text	field from the properties object
msa_app_type	text	field from the properties object
network_security_perimeter_configurations	text	field from the properties object
open_with_hint	text	field from the properties object
parameters	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
publishing_credentials	text	field from the properties object
resourceGroupName	text	field from the properties object
resourceName	text	field from the properties object
schema_transformation_version	text	field from the properties object
sku	text	The SKU of the cognitive services account.
storage_resource_id	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Contains resource tags defined as key/value pairs.
tenant_id	text	field from the properties object
type	text	Specifies the type of the resource.
zones	text	Entity zones

bots

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
etag	string	Entity Tag.
kind	string	Indicates the type of bot service
location	string	Specifies the location of the resource.
properties	object	The parameters to provide for the Bot.
sku	object	The SKU of the cognitive services account.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.
zones	array	Entity zones

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, resourceName, subscriptionId	Returns a BotService specified by the parameters.
list	SELECT	subscriptionId	Returns all the resources of a particular type belonging to a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Returns all the resources of a particular type belonging to a resource group
create	INSERT	resourceGroupName, resourceName, subscriptionId	Creates a Bot Service. Bot Service is a resource group wide resource type.
delete	DELETE	resourceGroupName, resourceName, subscriptionId	Deletes a Bot Service from the resource group.
update	UPDATE	resourceGroupName, resourceName, subscriptionId	Updates a Bot Service

SELECT examples

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

vw_bots

SELECT
id,
name,
description,
all_settings,
app_password_hint,
cmek_encryption_status,
cmek_key_vault_url,
configured_channels,
developer_app_insight_key,
developer_app_insights_api_key,
developer_app_insights_application_id,
disable_local_auth,
display_name,
enabled_channels,
endpoint,
endpoint_version,
etag,
icon_url,
is_cmek_enabled,
is_developer_app_insights_api_key_set,
is_streaming_supported,
kind,
location,
luis_app_ids,
luis_key,
manifest_url,
migration_token,
msa_app_id,
msa_app_msi_resource_id,
msa_app_tenant_id,
msa_app_type,
network_security_perimeter_configurations,
open_with_hint,
parameters,
private_endpoint_connections,
provisioning_state,
public_network_access,
publishing_credentials,
resourceGroupName,
resourceName,
schema_transformation_version,
sku,
storage_resource_id,
subscriptionId,
tags,
tenant_id,
type,
zones
FROM azure.bot_service.vw_bots
WHERE subscriptionId = '{{ subscriptionId }}';

bots

SELECT
id,
name,
etag,
kind,
location,
properties,
sku,
tags,
type,
zones
FROM azure.bot_service.bots
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new bots resource.

All Properties

/*+ create */
INSERT INTO azure.bot_service.bots (
resourceGroupName,
resourceName,
subscriptionId,
location,
tags,
sku,
kind,
etag,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ location }}',
'{{ tags }}',
'{{ sku }}',
'{{ kind }}',
'{{ etag }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: location
      value: string
    - name: type
      value: string
    - name: tags
      value: object
    - name: sku
      value:
        - name: name
          value: []
        - name: tier
          value: string
    - name: kind
      value: []
    - name: etag
      value: string
    - name: zones
      value:
        - string
    - name: properties
      value:
        - name: displayName
          value: string
        - name: description
          value: string
        - name: iconUrl
          value: string
        - name: endpoint
          value: string
        - name: endpointVersion
          value: string
        - name: allSettings
          value: object
        - name: parameters
          value: object
        - name: manifestUrl
          value: string
        - name: msaAppType
          value: string
        - name: msaAppId
          value: string
        - name: msaAppTenantId
          value: string
        - name: msaAppMSIResourceId
          value: string
        - name: configuredChannels
          value:
            - string
        - name: enabledChannels
          value:
            - string
        - name: developerAppInsightKey
          value: string
        - name: developerAppInsightsApiKey
          value: string
        - name: developerAppInsightsApplicationId
          value: string
        - name: luisAppIds
          value:
            - string
        - name: luisKey
          value: string
        - name: isCmekEnabled
          value: boolean
        - name: cmekKeyVaultUrl
          value: string
        - name: cmekEncryptionStatus
          value: string
        - name: tenantId
          value: string
        - name: publicNetworkAccess
          value: string
        - name: isStreamingSupported
          value: boolean
        - name: isDeveloperAppInsightsApiKeySet
          value: boolean
        - name: migrationToken
          value: string
        - name: disableLocalAuth
          value: boolean
        - name: schemaTransformationVersion
          value: string
        - name: storageResourceId
          value: string
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: []
                  - name: groupIds
                    value:
                      - string
              - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
        - name: networkSecurityPerimeterConfigurations
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: properties
                value:
                  - name: provisioningState
                    value: string
                  - name: provisioningIssues
                    value:
                      - - name: name
                          value: string
                        - name: properties
                          value:
                            - name: issueType
                              value: string
                            - name: severity
                              value: string
                            - name: description
                              value: string
                            - name: suggestedResourceIds
                              value:
                                - string
                            - name: suggestedAccessRules
                              value:
                                - - name: name
                                    value: string
                                  - name: properties
                                    value:
                                      - name: direction
                                        value: string
                                      - name: addressPrefixes
                                        value:
                                          - string
                                      - name: subscriptions
                                        value:
                                          - - name: id
                                              value: string
                                      - name: networkSecurityPerimeters
                                        value:
                                          - - name: id
                                              value: string
                                            - name: perimeterGuid
                                              value: string
                                            - name: location
                                              value: string
                                      - name: fullyQualifiedDomainNames
                                        value:
                                          - string
                                      - name: emailAddresses
                                        value:
                                          - string
                                      - name: phoneNumbers
                                        value:
                                          - string
                  - name: networkSecurityPerimeter
                    value:
                      - name: id
                        value: string
                      - name: perimeterGuid
                        value: string
                      - name: location
                        value: string
                  - name: resourceAssociation
                    value:
                      - name: name
                        value: string
                      - name: accessMode
                        value: string
                  - name: profile
                    value:
                      - name: name
                        value: string
                      - name: accessRulesVersion
                        value: integer
                      - name: accessRules
                        value:
                          - - name: name
                              value: string
                            - name: properties
                              value:
                                - name: direction
                                  value: string
                                - name: addressPrefixes
                                  value:
                                    - string
                                - name: subscriptions
                                  value:
                                    - - name: id
                                        value: string
                                - name: networkSecurityPerimeters
                                  value:
                                    - - name: id
                                        value: string
                                      - name: perimeterGuid
                                        value: string
                                      - name: location
                                        value: string
                                - name: fullyQualifiedDomainNames
                                  value:
                                    - string
                                - name: emailAddresses
                                  value:
                                    - string
                                - name: phoneNumbers
                                  value:
                                    - string
                      - name: diagnosticSettingsVersion
                        value: integer
                      - name: enabledLogCategories
                        value:
                          - string
        - name: openWithHint
          value: string
        - name: appPasswordHint
          value: string
        - name: provisioningState
          value: string
        - name: publishingCredentials
          value: string

UPDATE example

Updates a bots resource.

/*+ update */
UPDATE azure.bot_service.bots
SET 
location = '{{ location }}',
tags = '{{ tags }}',
sku = '{{ sku }}',
kind = '{{ kind }}',
etag = '{{ etag }}',
properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified bots resource.

/*+ delete */
DELETE FROM azure.bot_service.bots
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';