rai_blocklists

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

Overview

Name	rai_blocklists
Type	Resource
Id	azure.cognitive_services.rai_blocklists

Fields

The following fields are returned by SELECT queries:

get

OK -- Get the custom blocklist successfully.

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

list

Successfully retrieved blocklists.

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	Properties of Cognitive Services RaiBlocklist.
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, raiBlocklistName		Gets the specified custom blocklist associated with the Azure OpenAI account.
list	select	resourceGroupName, accountName, subscriptionId		Gets the custom blocklists associated with the Azure OpenAI account.
create_or_update	insert	resourceGroupName, accountName, subscriptionId, raiBlocklistName		Update the state of specified blocklist associated with the Azure OpenAI account.
delete	delete	resourceGroupName, accountName, subscriptionId, raiBlocklistName		Deletes the specified custom blocklist 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.
raiBlocklistName	string	The name of the RaiBlocklist 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 custom blocklist associated with the Azure OpenAI account.

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

list

Gets the custom blocklists associated with the Azure OpenAI account.

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

INSERT examples

create_or_update

Update the state of specified blocklist associated with the Azure OpenAI account.

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

Manifest

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

DELETE examples

delete

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

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