rai_topics

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

Overview

Name	rai_topics
Type	Resource
Id	azure.cognitive_services.rai_topics

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.
createdAt	string (date-time)	Creation time of the custom topic.
description	string	Description of the custom topic.
etag	string	Resource Etag.
failedReason	string	Failed reason if the status is Failed.
lastModifiedAt	string (date-time)	Last modified time of the custom topic.
sampleBlobUrl	string	Sample blob url for the custom topic.
status	string	Status of the custom topic.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
topicId	string	The unique identifier of the custom topic.
topicName	string	The name of the custom topic.
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.
createdAt	string (date-time)	Creation time of the custom topic.
description	string	Description of the custom topic.
etag	string	Resource Etag.
failedReason	string	Failed reason if the status is Failed.
lastModifiedAt	string (date-time)	Last modified time of the custom topic.
sampleBlobUrl	string	Sample blob url for the custom topic.
status	string	Status of the custom topic.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
topicId	string	The unique identifier of the custom topic.
topicName	string	The name of the custom topic.
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, account_name, rai_topic_name, subscription_id		Gets the specified custom topic associated with the Azure OpenAI account.
list	select	resource_group_name, account_name, subscription_id		Gets the custom topics associated with the Azure OpenAI account.
create_or_update	insert	resource_group_name, account_name, rai_topic_name, subscription_id		Create the rai topic associated with the Azure OpenAI account.
create_or_update	replace	resource_group_name, account_name, rai_topic_name, subscription_id		Create the rai topic associated with the Azure OpenAI account.
delete	delete	resource_group_name, account_name, rai_topic_name, subscription_id		Deletes the specified custom topic associated with the Azure OpenAI account.

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
account_name	string	The name of Cognitive Services account. Required.
rai_topic_name	string	The name of the Rai Topic associated with the Cognitive Services Account. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified custom topic associated with the Azure OpenAI account.

SELECT
id,
name,
createdAt,
description,
etag,
failedReason,
lastModifiedAt,
sampleBlobUrl,
status,
systemData,
tags,
topicId,
topicName,
type
FROM azure.cognitive_services.rai_topics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND rai_topic_name = '{{ rai_topic_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the custom topics associated with the Azure OpenAI account.

SELECT
id,
name,
createdAt,
description,
etag,
failedReason,
lastModifiedAt,
sampleBlobUrl,
status,
systemData,
tags,
topicId,
topicName,
type
FROM azure.cognitive_services.rai_topics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create the rai topic associated with the Azure OpenAI account.

INSERT INTO azure.cognitive_services.rai_topics (
properties,
tags,
resource_group_name,
account_name,
rai_topic_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ rai_topic_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: rai_topics
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the rai_topics resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the rai_topics resource.
  - name: rai_topic_name
    value: "{{ rai_topic_name }}"
    description: Required parameter for the rai_topics resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the rai_topics resource.
  - name: properties
    description: |
      Properties of Cognitive Services Rai Topic.
    value:
      topicId: "{{ topicId }}"
      topicName: "{{ topicName }}"
      description: "{{ description }}"
      sampleBlobUrl: "{{ sampleBlobUrl }}"
      status: "{{ status }}"
      failedReason: "{{ failedReason }}"
      createdAt: "{{ createdAt }}"
      lastModifiedAt: "{{ lastModifiedAt }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.

REPLACE examples

create_or_update

Create the rai topic associated with the Azure OpenAI account.

REPLACE azure.cognitive_services.rai_topics
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND rai_topic_name = '{{ rai_topic_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified custom topic associated with the Azure OpenAI account.

DELETE FROM azure.cognitive_services.rai_topics
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND rai_topic_name = '{{ rai_topic_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;