bots

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

Overview

Name	bots
Type	Resource
Id	azure_extras.health_bot.bots

Fields

vw_bots

Name	Datatype	Description
botName	text	field from the properties object
bot_management_portal_link	text	field from the properties object
identity	text	Identity for the resource.
key_vault_properties	text	field from the properties object
location	text	The geo-location where the resource lives
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	The resource model definition representing SKU
subscriptionId	text	field from the properties object
tags	text	Resource tags.

bots

Name	Datatype	Description
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives
properties	object	The properties of a Azure Health Bot. The Health Bot Service is a cloud platform that empowers developers in Healthcare organizations to build and deploy their compliant, AI-powered virtual health assistants and health bots, that help them improve processes and reduce costs.
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	botName, resourceGroupName, subscriptionId	Get a HealthBot.
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	botName, resourceGroupName, subscriptionId, data__sku	Create a new Azure Health Bot.
delete	DELETE	botName, resourceGroupName, subscriptionId	Delete a HealthBot.
update	UPDATE	botName, resourceGroupName, subscriptionId	Patch a HealthBot.
regenerate_api_jwt_secret	EXEC	botName, resourceGroupName, subscriptionId	Regenerate the API JWT Secret of a HealthBot.

SELECT examples

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

vw_bots

SELECT
botName,
bot_management_portal_link,
identity,
key_vault_properties,
location,
provisioning_state,
resourceGroupName,
sku,
subscriptionId,
tags
FROM azure_extras.health_bot.vw_bots
WHERE subscriptionId = '{{ subscriptionId }}';

bots

SELECT
identity,
location,
properties,
sku,
tags
FROM azure_extras.health_bot.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_extras.health_bot.bots (
botName,
resourceGroupName,
subscriptionId,
data__sku,
tags,
location,
sku,
identity,
properties
)
SELECT 
'{{ botName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__sku }}',
'{{ tags }}',
'{{ location }}',
'{{ sku }}',
'{{ identity }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: sku
      value:
        - name: name
          value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: []
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: botManagementPortalLink
          value: string
        - name: keyVaultProperties
          value:
            - name: keyName
              value: string
            - name: keyVersion
              value: string
            - name: keyVaultUri
              value: string
            - name: userIdentity
              value: string

UPDATE example

Updates a bots resource.

/*+ update */
UPDATE azure_extras.health_bot.bots
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
sku = '{{ sku }}',
identity = '{{ identity }}',
location = '{{ location }}'
WHERE 
botName = '{{ botName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified bots resource.

/*+ delete */
DELETE FROM azure_extras.health_bot.bots
WHERE botName = '{{ botName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';