bot_connection

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

Overview

Name	bot_connection
Type	Resource
Id	azure.bot_service.bot_connection

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.
clientId	string	Client Id associated with the Connection Setting.
clientSecret	string	Client Secret associated with the Connection Setting.
etag	string	Entity Tag.
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.
parameters	array	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.
sku	object	Gets or sets the SKU of the resource.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.
zones	array	Entity zones.

list_by_bot_service

Name	Datatype	Description
id	string	Specifies the resource ID.
name	string	Specifies the name of the resource.
clientId	string	Client Id associated with the Connection Setting.
clientSecret	string	Client Secret associated with the Connection Setting.
etag	string	Entity Tag.
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.
parameters	array	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.
sku	object	Gets or sets the SKU of the resource.
tags	object	Contains resource tags defined as key/value pairs.
type	string	Specifies the type of the resource.
zones	array	Entity zones.

list_service_providers

Name	Datatype	Description
id	string	Id for Service Provider.
devPortalUrl	string	URL of Dev Portal.
displayName	string	Display Name of the Service Provider.
iconUrl	string	The URL of icon.
parameters	array	The list of parameters for the Service Provider.
serviceProviderName	string	Name of the Service Provider.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, connection_name, subscription_id		Get a Connection Setting registration for a Bot Service.
list_by_bot_service	select	resource_group_name, resource_name, subscription_id		Returns all the Connection Settings registered to a particular BotService resource.
list_service_providers	select	subscription_id		Lists the available Service Providers for creating Connection Settings.
create	insert	resource_group_name, resource_name, connection_name, subscription_id		Register a new Auth Connection for a Bot Service.
update	update	resource_group_name, resource_name, connection_name, subscription_id		Updates a Connection Setting registration for a Bot Service.
delete	delete	resource_group_name, resource_name, connection_name, subscription_id		Deletes a Connection Setting registration for a Bot Service.
list_with_secrets	exec	resource_group_name, resource_name, connection_name, subscription_id		Get a Connection Setting registration for a Bot 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
connection_name	string	The name of the Bot Service Connection Setting resource. Required.
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

Get a Connection Setting registration for a Bot Service.

SELECT
id,
name,
clientId,
clientSecret,
etag,
kind,
location,
parameters,
provisioningState,
scopes,
serviceProviderDisplayName,
serviceProviderId,
settingId,
sku,
tags,
type,
zones
FROM azure.bot_service.bot_connection
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND connection_name = '{{ connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_bot_service

Returns all the Connection Settings registered to a particular BotService resource.

SELECT
id,
name,
clientId,
clientSecret,
etag,
kind,
location,
parameters,
provisioningState,
scopes,
serviceProviderDisplayName,
serviceProviderId,
settingId,
sku,
tags,
type,
zones
FROM azure.bot_service.bot_connection
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_service_providers

Lists the available Service Providers for creating Connection Settings.

SELECT
id,
devPortalUrl,
displayName,
iconUrl,
parameters,
serviceProviderName
FROM azure.bot_service.bot_connection
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Register a new Auth Connection for a Bot Service.

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

Manifest

# Description fields are for documentation purposes
- name: bot_connection
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the bot_connection resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the bot_connection resource.
  - name: connection_name
    value: "{{ connection_name }}"
    description: Required parameter for the bot_connection resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the bot_connection 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 channel resource.
    value:
      clientId: "{{ clientId }}"
      settingId: "{{ settingId }}"
      clientSecret: "{{ clientSecret }}"
      scopes: "{{ scopes }}"
      serviceProviderId: "{{ serviceProviderId }}"
      serviceProviderDisplayName: "{{ serviceProviderDisplayName }}"
      parameters:
        - key: "{{ key }}"
          value: "{{ value }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates a Connection Setting registration for a Bot Service.

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

DELETE examples

delete

Deletes a Connection Setting registration for a Bot Service.

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

Lifecycle Methods

list_with_secrets

Get a Connection Setting registration for a Bot Service.

EXEC azure.bot_service.bot_connection.list_with_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@connection_name='{{ connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;