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

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.
description	string	Description of the block list.
etag	string	Resource Etag.
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.
description	string	Description of the block list.
etag	string	Resource Etag.
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, subscription_id		Gets the specified custom blocklist associated with the Azure OpenAI account.
list	select	resource_group_name, account_name, subscription_id		Gets the custom blocklists associated with the Azure OpenAI account.
create_or_update	insert	resource_group_name, account_name, rai_blocklist_name, subscription_id		Update the state of specified blocklist associated with the Azure OpenAI account.
create_or_update	replace	resource_group_name, account_name, rai_blocklist_name, subscription_id		Update the state of specified blocklist associated with the Azure OpenAI account.
delete	delete	resource_group_name, account_name, rai_blocklist_name, subscription_id		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
account_name	string	The name of Cognitive Services account. 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 associated with the Azure OpenAI account.

SELECT
id,
name,
description,
etag,
systemData,
tags,
type
FROM azure.cognitive_services.rai_blocklists
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
;

list

Gets the custom blocklists associated with the Azure OpenAI account.

SELECT
id,
name,
description,
etag,
systemData,
tags,
type
FROM azure.cognitive_services.rai_blocklists
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

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

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

Manifest

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

REPLACE examples

create_or_update

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

REPLACE azure.cognitive_services.rai_blocklists
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
tags,
type;

DELETE examples

delete

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

DELETE FROM azure.cognitive_services.rai_blocklists
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
;