defender_for_ai_settings

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

Overview

Name	defender_for_ai_settings
Type	Resource
Id	azure.cognitive_services.defender_for_ai_settings

Fields

The following fields are returned by SELECT queries:

get

OK -- Get the defender setting name successfully.

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	The Defender for AI resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list

OK -- List the defender setting name successfully.

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	The Defender for AI resource properties.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, accountName, subscriptionId, defenderForAISettingName		Gets the specified Defender for AI setting by name.
list	select	resourceGroupName, accountName, subscriptionId		Lists the Defender for AI settings.
create_or_update	insert	resourceGroupName, accountName, subscriptionId, defenderForAISettingName		Creates or Updates the specified Defender for AI setting.
update	update	resourceGroupName, accountName, subscriptionId, defenderForAISettingName		Updates the specified Defender for AI setting.

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
accountName	string	The name of Cognitive Services account.
defenderForAISettingName	string	The name of the defender for AI setting.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the specified Defender for AI setting by name.

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

list

Lists the Defender for AI settings.

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

INSERT examples

create_or_update

Creates or Updates the specified Defender for AI setting.

INSERT INTO azure.cognitive_services.defender_for_ai_settings (
data__tags,
data__properties,
resourceGroupName,
accountName,
subscriptionId,
defenderForAISettingName
)
SELECT 
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ subscriptionId }}',
'{{ defenderForAISettingName }}'
RETURNING
etag,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: defender_for_ai_settings
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the defender_for_ai_settings resource.
    - name: accountName
      value: string
      description: Required parameter for the defender_for_ai_settings resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the defender_for_ai_settings resource.
    - name: defenderForAISettingName
      value: string
      description: Required parameter for the defender_for_ai_settings resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: properties
      value: object
      description: |
        The Defender for AI resource properties.

UPDATE examples

update

Updates the specified Defender for AI setting.

UPDATE azure.cognitive_services.defender_for_ai_settings
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND defenderForAISettingName = '{{ defenderForAISettingName }}' --required
RETURNING
etag,
properties,
systemData,
tags;