rai_blocklist_items

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

Overview

Name	rai_blocklist_items
Type	Resource
Id	azure.cognitive_services.rai_blocklist_items

Fields

The following fields are returned by SELECT queries:

get

OK -- Get the custom blocklist Item successfully.

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

list

Successfully retrieved blocklist items.

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	Properties of Cognitive Services RaiBlocklist Item.
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, raiBlocklistItemName		Gets the specified custom blocklist Item associated with the custom blocklist.
list	select	resourceGroupName, accountName, subscriptionId, raiBlocklistName		Gets the blocklist items associated with the custom blocklist.
create_or_update	insert	resourceGroupName, accountName, subscriptionId, raiBlocklistName, raiBlocklistItemName		Update the state of specified blocklist item associated with the Azure OpenAI account.
delete	delete	resourceGroupName, accountName, subscriptionId, raiBlocklistName, raiBlocklistItemName		Deletes the specified blocklist Item associated with the custom blocklist.
batch_add	exec	resourceGroupName, accountName, subscriptionId, raiBlocklistName		Batch operation to add blocklist items.
batch_delete	exec	resourceGroupName, accountName, subscriptionId, raiBlocklistName		Batch operation to delete blocklist items.

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.
raiBlocklistItemName	string	The name of the RaiBlocklist Item associated with the custom blocklist
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 Item associated with the custom blocklist.

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

list

Gets the blocklist items associated with the custom blocklist.

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

INSERT examples

create_or_update

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

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

Manifest

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

DELETE examples

delete

Deletes the specified blocklist Item associated with the custom blocklist.

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

Lifecycle Methods

batch_add

Batch operation to add blocklist items.

EXEC azure.cognitive_services.rai_blocklist_items.batch_add 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@raiBlocklistName='{{ raiBlocklistName }}' --required
;

batch_delete

Batch operation to delete blocklist items.

EXEC azure.cognitive_services.rai_blocklist_items.batch_delete 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@raiBlocklistName='{{ raiBlocklistName }}' --required
;