bot_connections

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

Overview

Name	bot_connections
Type	Resource
Id	azure.bot_service.bot_connections

Fields

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	Properties for a Connection Setting Item
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	connectionName, resourceGroupName, resourceName, subscriptionId	Get a Connection Setting registration for a Bot Service
list_by_bot_service	SELECT	resourceGroupName, resourceName, subscriptionId	Returns all the Connection Settings registered to a particular BotService resource
list_with_secrets	SELECT	connectionName, resourceGroupName, resourceName, subscriptionId	Get a Connection Setting registration for a Bot Service
create	INSERT	connectionName, resourceGroupName, resourceName, subscriptionId	Register a new Auth Connection for a Bot Service
delete	DELETE	connectionName, resourceGroupName, resourceName, subscriptionId	Deletes a Connection Setting registration for a Bot Service
update	UPDATE	connectionName, resourceGroupName, resourceName, subscriptionId	Updates a Connection Setting registration for a Bot Service

SELECT examples

Returns all the Connection Settings registered to a particular BotService resource

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.bot_service.bot_connections (
connectionName,
resourceGroupName,
resourceName,
subscriptionId,
location,
tags,
sku,
kind,
etag,
properties
)
SELECT 
'{{ connectionName }}',
'{{ 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: id
          value: string
        - name: name
          value: string
        - name: clientId
          value: string
        - name: settingId
          value: string
        - name: clientSecret
          value: string
        - name: scopes
          value: string
        - name: serviceProviderId
          value: string
        - name: serviceProviderDisplayName
          value: string
        - name: parameters
          value:
            - - name: key
                value: string
              - name: value
                value: string
        - name: provisioningState
          value: string

UPDATE example

Updates a bot_connections resource.

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

DELETE example

Deletes the specified bot_connections resource.

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