bots

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

Overview

Name	bots
Type	Resource
Id	azure_extras.health_bot.bots

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accessControlMethod	string	The access control method for the Azure Health Bot resource.
botManagementPortalLink	string	The link.
identity	object	The identity of the Azure Health Bot.
keyVaultProperties	object	KeyVault properties for the resource encryption.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Azure Health Bot resource.
sku	object	SKU of the Azure Health Bot. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accessControlMethod	string	The access control method for the Azure Health Bot resource.
botManagementPortalLink	string	The link.
identity	object	The identity of the Azure Health Bot.
keyVaultProperties	object	KeyVault properties for the resource encryption.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Azure Health Bot resource.
sku	object	SKU of the Azure Health Bot. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accessControlMethod	string	The access control method for the Azure Health Bot resource.
botManagementPortalLink	string	The link.
identity	object	The identity of the Azure Health Bot.
keyVaultProperties	object	KeyVault properties for the resource encryption.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Azure Health Bot resource.
sku	object	SKU of the Azure Health Bot. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, bot_name, subscription_id		Get a HealthBot.
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.
create	insert	resource_group_name, bot_name, subscription_id, location, sku		Create a new Azure Health Bot.
update	update	resource_group_name, bot_name, subscription_id		Patch a HealthBot.
delete	delete	resource_group_name, bot_name, subscription_id		Delete a HealthBot.
list_secrets	exec	resource_group_name, bot_name, subscription_id		List all secrets of a HealthBot.
regenerate_api_jwt_secret	exec	resource_group_name, bot_name, subscription_id		Regenerate the API JWT Secret of a HealthBot.

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
bot_name	string	The name of the Bot resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a HealthBot.

SELECT
id,
name,
accessControlMethod,
botManagementPortalLink,
identity,
keyVaultProperties,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure_extras.health_bot.bots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND bot_name = '{{ bot_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,
accessControlMethod,
botManagementPortalLink,
identity,
keyVaultProperties,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure_extras.health_bot.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,
accessControlMethod,
botManagementPortalLink,
identity,
keyVaultProperties,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure_extras.health_bot.bots
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a new Azure Health Bot.

INSERT INTO azure_extras.health_bot.bots (
tags,
location,
properties,
sku,
identity,
resource_group_name,
bot_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}' /* required */,
'{{ identity }}',
'{{ resource_group_name }}',
'{{ bot_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

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: bot_name
    value: "{{ bot_name }}"
    description: Required parameter for the bots resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the bots resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The set of properties specific to Azure Health Bot resource.
    value:
      provisioningState: "{{ provisioningState }}"
      botManagementPortalLink: "{{ botManagementPortalLink }}"
      keyVaultProperties:
        keyName: "{{ keyName }}"
        keyVersion: "{{ keyVersion }}"
        keyVaultUri: "{{ keyVaultUri }}"
        userIdentity: "{{ userIdentity }}"
      accessControlMethod: "{{ accessControlMethod }}"
  - name: sku
    description: |
      SKU of the Azure Health Bot. Required.
    value:
      name: "{{ name }}"
  - name: identity
    description: |
      The identity of the Azure Health Bot.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Patch a HealthBot.

UPDATE azure_extras.health_bot.bots
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
sku = '{{ sku }}',
identity = '{{ identity }}',
location = '{{ location }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND bot_name = '{{ bot_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Delete a HealthBot.

DELETE FROM azure_extras.health_bot.bots
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND bot_name = '{{ bot_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_secrets

List all secrets of a HealthBot.

EXEC azure_extras.health_bot.bots.list_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@bot_name='{{ bot_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_api_jwt_secret

Regenerate the API JWT Secret of a HealthBot.

EXEC azure_extras.health_bot.bots.regenerate_api_jwt_secret 
@resource_group_name='{{ resource_group_name }}' --required, 
@bot_name='{{ bot_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;