connection_rai_policies

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

Overview

Name	connection_rai_policies
Type	Resource
Id	azure.ml_services.connection_rai_policies

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

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
properties	object	Azure OpenAI Content Filters properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

The request was successful; the request was well-formed and received properly.

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
properties	object	Azure OpenAI Content Filters properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
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	subscriptionId, resourceGroupName, workspaceName, connectionName, raiPolicyName
list	select	subscriptionId, resourceGroupName, workspaceName, connectionName
create	insert	subscriptionId, resourceGroupName, workspaceName, connectionName, raiPolicyName, data__properties
delete	delete	subscriptionId, resourceGroupName, workspaceName, connectionName, raiPolicyName

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
connectionName	string	Friendly name of the workspace connection
raiPolicyName	string	Name of the Rai Policy.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	Azure Machine Learning Workspace Name

SELECT examples

get

The request was successful; the request was well-formed and received properly.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.ml_services.connection_rai_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND connectionName = '{{ connectionName }}' -- required
AND raiPolicyName = '{{ raiPolicyName }}' -- required
;

list

The request was successful; the request was well-formed and received properly.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.ml_services.connection_rai_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND connectionName = '{{ connectionName }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO azure.ml_services.connection_rai_policies (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
connectionName,
raiPolicyName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ connectionName }}',
'{{ raiPolicyName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: connection_rai_policies
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the connection_rai_policies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the connection_rai_policies resource.
    - name: workspaceName
      value: string
      description: Required parameter for the connection_rai_policies resource.
    - name: connectionName
      value: string
      description: Required parameter for the connection_rai_policies resource.
    - name: raiPolicyName
      value: string
      description: Required parameter for the connection_rai_policies resource.
    - name: properties
      value: object
      description: |
        Azure OpenAI Content Filters properties.

DELETE examples

delete

No description available.

DELETE FROM azure.ml_services.connection_rai_policies
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND connectionName = '{{ connectionName }}' --required
AND raiPolicyName = '{{ raiPolicyName }}' --required
;