rai_external_safety_provider

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

Overview

Name	rai_external_safety_provider
Type	Resource
Id	azure.cognitive_services.rai_external_safety_provider

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.
createdAt	string (date-time)	Creation time of the safety provider.
etag	string	Resource Etag.
keyVaultUri	string	The Key Vault URI that contains the api key for safety provider urls.
lastModifiedAt	string (date-time)	Last modified time of the safety provider.
managedIdentity	string	The managed identity to access the Key Vault.
mode	string	Safety provider mode sync/async.
providerId	string	The unique identifier of the safety provider.
providerName	string	Name of the safety provider.
secretName	string	The name of the secret in Key Vault that contains the api key to access the webhook.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
url	string	Webhook URL for the safety provider.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	safety_provider_name, subscription_id		Gets the specified external safety provider associated with the Subscription.
create_or_update	insert	safety_provider_name, subscription_id		Create the rai safety provider associated with the subscription.
create_or_update	replace	safety_provider_name, subscription_id		Create the rai safety provider associated with the subscription.
delete	delete	safety_provider_name, subscription_id		Deletes the specified custom topic associated with the subscription.

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
safety_provider_name	string	The name of the Rai External Safety Provider associated with the Cognitive Services Account. Required.
subscription_id	string

SELECT examples

get

Gets the specified external safety provider associated with the Subscription.

SELECT
id,
name,
createdAt,
etag,
keyVaultUri,
lastModifiedAt,
managedIdentity,
mode,
providerId,
providerName,
secretName,
systemData,
tags,
type,
url
FROM azure.cognitive_services.rai_external_safety_provider
WHERE safety_provider_name = '{{ safety_provider_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create the rai safety provider associated with the subscription.

INSERT INTO azure.cognitive_services.rai_external_safety_provider (
properties,
safety_provider_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ safety_provider_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: rai_external_safety_provider
props:
  - name: safety_provider_name
    value: "{{ safety_provider_name }}"
    description: Required parameter for the rai_external_safety_provider resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the rai_external_safety_provider resource.
  - name: properties
    description: |
      Properties of Cognitive Services Rai External Safety provider.
    value:
      providerId: "{{ providerId }}"
      providerName: "{{ providerName }}"
      mode: "{{ mode }}"
      url: "{{ url }}"
      secretName: "{{ secretName }}"
      managedIdentity: "{{ managedIdentity }}"
      keyVaultUri: "{{ keyVaultUri }}"
      createdAt: "{{ createdAt }}"
      lastModifiedAt: "{{ lastModifiedAt }}"

REPLACE examples

create_or_update

Create the rai safety provider associated with the subscription.

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

DELETE examples

delete

Deletes the specified custom topic associated with the subscription.

DELETE FROM azure.cognitive_services.rai_external_safety_provider
WHERE safety_provider_name = '{{ safety_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;