text_blocklists

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

Overview

Name	text_blocklists
Type	Resource
Id	azure.ai_content_safety.text_blocklists

Fields

The following fields are returned by SELECT queries:

get_text_blocklist

Name	Datatype	Description
blocklistName	string	Text blocklist name. Required.
description	string	Text blocklist description.

list_text_blocklists

Name	Datatype	Description
blocklistName	string	Text blocklist name. Required.
description	string	Text blocklist description.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_text_blocklist	select	blocklist_name, endpoint		Get Text Blocklist By blocklistName. Returns text blocklist details.
list_text_blocklists	select	endpoint		Get All Text Blocklists. Get all text blocklists details.
create_or_update_text_blocklist	insert	blocklist_name, endpoint, blocklistName		Create Or Update Text Blocklist. Updates a text blocklist. If the blocklistName does not exist, a new blocklist will be created.
create_or_update_text_blocklist	replace	blocklist_name, endpoint, blocklistName		Create Or Update Text Blocklist. Updates a text blocklist. If the blocklistName does not exist, a new blocklist will be created.
delete_text_blocklist	delete	blocklist_name, endpoint		Delete Text Blocklist By blocklistName. Deletes a text blocklist.

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
blocklist_name	string	Text blocklist name. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )

SELECT examples

get_text_blocklist

Get Text Blocklist By blocklistName. Returns text blocklist details.

SELECT
blocklistName,
description
FROM azure.ai_content_safety.text_blocklists
WHERE blocklist_name = '{{ blocklist_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_text_blocklists

Get All Text Blocklists. Get all text blocklists details.

SELECT
blocklistName,
description
FROM azure.ai_content_safety.text_blocklists
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update_text_blocklist

Create Or Update Text Blocklist. Updates a text blocklist. If the blocklistName does not exist, a new blocklist will be created.

INSERT INTO azure.ai_content_safety.text_blocklists (
blocklistName,
description,
blocklist_name,
endpoint
)
SELECT 
'{{ blocklistName }}' /* required */,
'{{ description }}',
'{{ blocklist_name }}',
'{{ endpoint }}'
RETURNING
blocklistName,
description
;

Manifest

# Description fields are for documentation purposes
- name: text_blocklists
props:
  - name: blocklist_name
    value: "{{ blocklist_name }}"
    description: Required parameter for the text_blocklists resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the text_blocklists resource.
  - name: blocklistName
    value: "{{ blocklistName }}"
    description: |
      Text blocklist name. Required.
  - name: description
    value: "{{ description }}"
    description: |
      Text blocklist description.

REPLACE examples

create_or_update_text_blocklist

Create Or Update Text Blocklist. Updates a text blocklist. If the blocklistName does not exist, a new blocklist will be created.

REPLACE azure.ai_content_safety.text_blocklists
SET 
blocklistName = '{{ blocklistName }}',
description = '{{ description }}'
WHERE 
blocklist_name = '{{ blocklist_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND blocklistName = '{{ blocklistName }}' --required
RETURNING
blocklistName,
description;

DELETE examples

delete_text_blocklist

Delete Text Blocklist By blocklistName. Deletes a text blocklist.

DELETE FROM azure.ai_content_safety.text_blocklists
WHERE blocklist_name = '{{ blocklist_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;