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

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.
etag	string	Resource Etag.
isRegex	boolean	If the pattern is a regex pattern.
pattern	string	Pattern to match against.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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.
etag	string	Resource Etag.
isRegex	boolean	If the pattern is a regex pattern.
pattern	string	Pattern to match against.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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_blocklist_name, rai_blocklist_item_name, subscription_id		Gets the specified custom blocklist Item associated with the custom blocklist.
list	select	resource_group_name, account_name, rai_blocklist_name, subscription_id		Gets the blocklist items associated with the custom blocklist.
create_or_update	insert	resource_group_name, account_name, rai_blocklist_name, rai_blocklist_item_name, subscription_id		Update the state of specified blocklist item associated with the Azure OpenAI account.
create_or_update	replace	resource_group_name, account_name, rai_blocklist_name, rai_blocklist_item_name, subscription_id		Update the state of specified blocklist item associated with the Azure OpenAI account.
delete	delete	resource_group_name, account_name, rai_blocklist_name, rai_blocklist_item_name, subscription_id		Deletes the specified blocklist Item associated with the custom blocklist.
batch_add	exec	resource_group_name, account_name, rai_blocklist_name, subscription_id		Batch operation to add blocklist items.
batch_delete	exec	resource_group_name, account_name, rai_blocklist_name, subscription_id		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
account_name	string	The name of Cognitive Services account. Required.
rai_blocklist_item_name	string	The name of the RaiBlocklist Item associated with the custom blocklist. Required.
rai_blocklist_name	string	The name of the RaiBlocklist 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 blocklist Item associated with the custom blocklist.

SELECT
id,
name,
etag,
isRegex,
pattern,
systemData,
tags,
type
FROM azure.cognitive_services.rai_blocklist_items
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND rai_blocklist_name = '{{ rai_blocklist_name }}' -- required
AND rai_blocklist_item_name = '{{ rai_blocklist_item_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the blocklist items associated with the custom blocklist.

SELECT
id,
name,
etag,
isRegex,
pattern,
systemData,
tags,
type
FROM azure.cognitive_services.rai_blocklist_items
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND rai_blocklist_name = '{{ rai_blocklist_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
properties,
tags,
resource_group_name,
account_name,
rai_blocklist_name,
rai_blocklist_item_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ rai_blocklist_name }}',
'{{ rai_blocklist_item_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: rai_blocklist_items
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the rai_blocklist_items resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the rai_blocklist_items resource.
  - name: rai_blocklist_name
    value: "{{ rai_blocklist_name }}"
    description: Required parameter for the rai_blocklist_items resource.
  - name: rai_blocklist_item_name
    value: "{{ rai_blocklist_item_name }}"
    description: Required parameter for the rai_blocklist_items resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the rai_blocklist_items resource.
  - name: properties
    description: |
      Properties of Cognitive Services RaiBlocklist Item.
    value:
      pattern: "{{ pattern }}"
      isRegex: {{ isRegex }}
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.

REPLACE examples

create_or_update

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

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

DELETE examples

delete

Deletes the specified blocklist Item associated with the custom blocklist.

DELETE FROM azure.cognitive_services.rai_blocklist_items
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND rai_blocklist_name = '{{ rai_blocklist_name }}' --required
AND rai_blocklist_item_name = '{{ rai_blocklist_item_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

batch_add

Batch operation to add blocklist items.

EXEC azure.cognitive_services.rai_blocklist_items.batch_add 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@rai_blocklist_name='{{ rai_blocklist_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}", 
"properties": "{{ properties }}"
}'
;

batch_delete

Batch operation to delete blocklist items.

EXEC azure.cognitive_services.rai_blocklist_items.batch_delete 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@rai_blocklist_name='{{ rai_blocklist_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;