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

vw_rai_blocklists

Name	Datatype	Description
description	text	field from the properties object
accountName	text	field from the properties object
etag	text	Resource Etag.
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_blocklists

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	RAI Custom Blocklist 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, raiBlocklistName, resourceGroupName, subscriptionId	Gets the specified custom blocklist associated with the Azure OpenAI account.
list	SELECT	accountName, resourceGroupName, subscriptionId	Gets the custom blocklists associated with the Azure OpenAI account.
create_or_update	INSERT	accountName, raiBlocklistName, resourceGroupName, subscriptionId	Update the state of specified blocklist associated with the Azure OpenAI account.
delete	DELETE	accountName, raiBlocklistName, resourceGroupName, subscriptionId	Deletes the specified custom blocklist associated with the Azure OpenAI account.

SELECT examples

Gets the custom blocklists associated with the Azure OpenAI account.

vw_rai_blocklists

SELECT
description,
accountName,
etag,
raiBlocklistName,
resourceGroupName,
subscriptionId,
system_data,
tags
FROM azure.cognitive_services.vw_rai_blocklists
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

rai_blocklists

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.cognitive_services.rai_blocklists (
accountName,
raiBlocklistName,
resourceGroupName,
subscriptionId,
tags,
properties
)
SELECT 
'{{ accountName }}',
'{{ 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: description
          value: string

DELETE example

Deletes the specified rai_blocklists resource.

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