rai_tool_labels

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

Overview

Name	rai_tool_labels
Type	Resource
Id	azure.cognitive_services.rai_tool_labels

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.
accountScope	object	Account-level tool label definition.
etag	string	Resource Etag.
projectScopes	array	List of project-level tool label definitions.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
toolConnectionName	string	The unique tool connection name, e.g., 'Web_Search'. Required.
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.
accountScope	object	Account-level tool label definition.
etag	string	Resource Etag.
projectScopes	array	List of project-level tool label definitions.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
toolConnectionName	string	The unique tool connection name, e.g., 'Web_Search'. Required.
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_tool_connection_name, subscription_id		Gets the specified RAI Tool Label associated with the Azure OpenAI account.
list	select	resource_group_name, account_name, subscription_id		Lists all RAI Tool Labels associated with the Azure OpenAI account.
create_or_update	insert	resource_group_name, account_name, rai_tool_connection_name, subscription_id		Creates the RAI Tool Label associated with the Azure OpenAI account.
create_or_update	replace	resource_group_name, account_name, rai_tool_connection_name, subscription_id		Creates the RAI Tool Label associated with the Azure OpenAI account.
delete	delete	resource_group_name, account_name, rai_tool_connection_name, subscription_id		Deletes the specified RAI Tool Label 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_tool_connection_name	string	The name of the Rai Tool Label. 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 RAI Tool Label associated with the Azure OpenAI account.

SELECT
id,
name,
accountScope,
etag,
projectScopes,
systemData,
tags,
toolConnectionName,
type
FROM azure.cognitive_services.rai_tool_labels
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND rai_tool_connection_name = '{{ rai_tool_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all RAI Tool Labels associated with the Azure OpenAI account.

SELECT
id,
name,
accountScope,
etag,
projectScopes,
systemData,
tags,
toolConnectionName,
type
FROM azure.cognitive_services.rai_tool_labels
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

Creates the RAI Tool Label associated with the Azure OpenAI account.

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

Manifest

# Description fields are for documentation purposes
- name: rai_tool_labels
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the rai_tool_labels resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the rai_tool_labels resource.
  - name: rai_tool_connection_name
    value: "{{ rai_tool_connection_name }}"
    description: Required parameter for the rai_tool_labels resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the rai_tool_labels resource.
  - name: properties
    description: |
      Properties of the RAI Tool Label.
    value:
      toolConnectionName: "{{ toolConnectionName }}"
      accountScope:
        labelValues: "{{ labelValues }}"
      projectScopes:
        - project: "{{ project }}"
          labelValues: "{{ labelValues }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.

REPLACE examples

create_or_update

Creates the RAI Tool Label associated with the Azure OpenAI account.

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

DELETE examples

delete

Deletes the specified RAI Tool Label associated with the Azure OpenAI account.

DELETE FROM azure.cognitive_services.rai_tool_labels
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND rai_tool_connection_name = '{{ rai_tool_connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;