rai_policies

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

Overview

Name	rai_policies
Type	Resource
Id	azure.cognitive_services.rai_policies

Fields

The following fields are returned by SELECT queries:

get

OK -- Get the Content Filters successfully.

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	Properties of Cognitive Services RaiPolicy.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list

Successfully retrieved Content Filters.

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	Properties of Cognitive Services RaiPolicy.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, accountName, subscriptionId, raiPolicyName		Gets the specified Content Filters associated with the Azure OpenAI account.
list	select	resourceGroupName, accountName, subscriptionId		Gets the content filters associated with the Azure OpenAI account.
create_or_update	insert	resourceGroupName, accountName, subscriptionId, raiPolicyName		Update the state of specified Content Filters associated with the Azure OpenAI account.
delete	delete	resourceGroupName, accountName, subscriptionId, raiPolicyName		Deletes the specified Content Filters 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
accountName	string	The name of Cognitive Services account.
raiPolicyName	string	The name of the RaiPolicy associated with the Cognitive Services Account
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the specified Content Filters associated with the Azure OpenAI account.

SELECT
etag,
properties,
systemData,
tags
FROM azure.cognitive_services.rai_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND raiPolicyName = '{{ raiPolicyName }}' -- required
;

list

Gets the content filters associated with the Azure OpenAI account.

SELECT
etag,
properties,
systemData,
tags
FROM azure.cognitive_services.rai_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Update the state of specified Content Filters associated with the Azure OpenAI account.

INSERT INTO azure.cognitive_services.rai_policies (
data__tags,
data__properties,
resourceGroupName,
accountName,
subscriptionId,
raiPolicyName
)
SELECT 
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ subscriptionId }}',
'{{ raiPolicyName }}'
RETURNING
etag,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: rai_policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the rai_policies resource.
    - name: accountName
      value: string
      description: Required parameter for the rai_policies resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the rai_policies resource.
    - name: raiPolicyName
      value: string
      description: Required parameter for the rai_policies resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: properties
      value: object
      description: |
        Properties of Cognitive Services RaiPolicy.

DELETE examples

delete

Deletes the specified Content Filters associated with the Azure OpenAI account.

DELETE FROM azure.cognitive_services.rai_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND raiPolicyName = '{{ raiPolicyName }}' --required
;