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

vw_rai_blocklist_items

Name	Datatype	Description
accountName	text	field from the properties object
etag	text	Resource Etag.
is_regex	text	field from the properties object
pattern	text	field from the properties object
raiBlocklistItemName	text	field from the properties object
raiBlocklistName	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.

rai_blocklist_items

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	RAI Custom Blocklist Item properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	accountName, raiBlocklistItemName, raiBlocklistName, resourceGroupName, subscriptionId	Gets the specified custom blocklist Item associated with the custom blocklist.
list	SELECT	accountName, raiBlocklistName, resourceGroupName, subscriptionId	Gets the blocklist items associated with the custom blocklist.
create_or_update	INSERT	accountName, raiBlocklistItemName, raiBlocklistName, resourceGroupName, subscriptionId	Update the state of specified blocklist item associated with the Azure OpenAI account.
delete	DELETE	accountName, raiBlocklistItemName, raiBlocklistName, resourceGroupName, subscriptionId	Deletes the specified blocklist Item associated with the custom blocklist.
batch_add	EXEC	accountName, raiBlocklistName, resourceGroupName, subscriptionId	Batch operation to add blocklist items.
batch_delete	EXEC	accountName, raiBlocklistName, resourceGroupName, subscriptionId	Batch operation to delete blocklist items.

SELECT examples

Gets the blocklist items associated with the custom blocklist.

vw_rai_blocklist_items

SELECT
accountName,
etag,
is_regex,
pattern,
raiBlocklistItemName,
raiBlocklistName,
resourceGroupName,
subscriptionId,
system_data,
tags
FROM azure.cognitive_services.vw_rai_blocklist_items
WHERE accountName = '{{ accountName }}'
AND raiBlocklistName = '{{ raiBlocklistName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

rai_blocklist_items

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

INSERT example

Use the following StackQL query and manifest file to create a new rai_blocklist_items resource.

All Properties

/*+ create */
INSERT INTO azure.cognitive_services.rai_blocklist_items (
accountName,
raiBlocklistItemName,
raiBlocklistName,
resourceGroupName,
subscriptionId,
tags,
properties
)
SELECT 
'{{ accountName }}',
'{{ raiBlocklistItemName }}',
'{{ raiBlocklistName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: etag
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: pattern
          value: string
        - name: isRegex
          value: boolean

DELETE example

Deletes the specified rai_blocklist_items resource.

/*+ delete */
DELETE FROM azure.cognitive_services.rai_blocklist_items
WHERE accountName = '{{ accountName }}'
AND raiBlocklistItemName = '{{ raiBlocklistItemName }}'
AND raiBlocklistName = '{{ raiBlocklistName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';