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

If resource is got successfully, the service should return 200.

Name	Datatype	Description
identity	object	The identity of the Azure Health Bot.
location	string	The geo-location where the resource lives
properties	object	The set of properties specific to Azure Health Bot resource. (title: HealthBotProperties)
sku	object	SKU of the Azure Health Bot.
tags	object	Resource tags.

list_by_resource_group

The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.
The nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, not empty string) for future compatibility.
The nextLink should be implemented using following query parameters:
· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.
· top: the optional client query parameter which defines the maximum number of records to be returned by the server.
Implementation details:
· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query.
· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response.
Clients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.

Name	Datatype	Description
identity	object	The identity of the Azure Health Bot.
location	string	The geo-location where the resource lives
properties	object	The set of properties specific to Azure Health Bot resource. (title: HealthBotProperties)
sku	object	SKU of the Azure Health Bot.
tags	object	Resource tags.

list

The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.
The nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.
For a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section.

Name	Datatype	Description
identity	object	The identity of the Azure Health Bot.
location	string	The geo-location where the resource lives
properties	object	The set of properties specific to Azure Health Bot resource. (title: HealthBotProperties)
sku	object	SKU of the Azure Health Bot.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, botName		Get a HealthBot.
list_by_resource_group	select	resourceGroupName, subscriptionId		Returns all the resources of a particular type belonging to a resource group
list	select	subscriptionId		Returns all the resources of a particular type belonging to a subscription.
create	insert	subscriptionId, resourceGroupName, botName, data__sku		Create a new Azure Health Bot.
update	update	subscriptionId, resourceGroupName, botName		Patch a HealthBot.
delete	delete	subscriptionId, resourceGroupName, botName		Delete a HealthBot.
regenerate_api_jwt_secret	exec	subscriptionId, resourceGroupName, botName		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
botName	string	The name of the Bot resource.
resourceGroupName	string	The name of the Bot resource group in the user subscription.
subscriptionId	string	Azure Subscription ID.

SELECT examples

get

Get a HealthBot.

SELECT
identity,
location,
properties,
sku,
tags
FROM azure_extras.health_bot.bots
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND botName = '{{ botName }}' -- required
;

list_by_resource_group

Returns all the resources of a particular type belonging to a resource group

SELECT
identity,
location,
properties,
sku,
tags
FROM azure_extras.health_bot.bots
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

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

SELECT
identity,
location,
properties,
sku,
tags
FROM azure_extras.health_bot.bots
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Create a new Azure Health Bot.

INSERT INTO azure_extras.health_bot.bots (
data__tags,
data__location,
data__sku,
data__identity,
data__properties,
subscriptionId,
resourceGroupName,
botName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ sku }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ botName }}'
RETURNING
identity,
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: bots
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the bots resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the bots resource.
    - name: botName
      value: string
      description: Required parameter for the bots resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: sku
      value: object
      description: |
        SKU of the Azure Health Bot.
    - name: identity
      value: object
      description: |
        The identity of the Azure Health Bot.
    - name: properties
      value: object
      description: |
        The set of properties specific to Azure Health Bot resource.

UPDATE examples

update

Patch a HealthBot.

UPDATE azure_extras.health_bot.bots
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}',
data__sku = '{{ sku }}',
data__identity = '{{ identity }}',
data__location = '{{ location }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND botName = '{{ botName }}' --required
RETURNING
identity,
location,
properties,
sku,
tags;

DELETE examples

delete

Delete a HealthBot.

DELETE FROM azure_extras.health_bot.bots
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND botName = '{{ botName }}' --required
;

Lifecycle Methods

regenerate_api_jwt_secret

Regenerate the API JWT Secret of a HealthBot.

EXEC azure_extras.health_bot.bots.regenerate_api_jwt_secret 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@botName='{{ botName }}' --required
;