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

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.
etag	string	Resource Etag.
state	string	Defender for AI state on the AI resource. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
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".

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.
etag	string	Resource Etag.
state	string	Defender for AI state on the AI resource. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, defender_for_ai_setting_name, subscription_id		Gets the specified Defender for AI setting by name.
list	select	resource_group_name, account_name, subscription_id		Lists the Defender for AI settings.
create_or_update	insert	resource_group_name, account_name, defender_for_ai_setting_name, subscription_id		Creates or Updates the specified Defender for AI setting.
update	update	resource_group_name, account_name, defender_for_ai_setting_name, subscription_id		Updates the specified Defender for AI setting.
create_or_update	replace	resource_group_name, account_name, defender_for_ai_setting_name, subscription_id		Creates or 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
account_name	string	The name of Cognitive Services account. Required.
defender_for_ai_setting_name	string	The name of the defender for AI setting. 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 Defender for AI setting by name.

SELECT
id,
name,
etag,
state,
systemData,
tags,
type
FROM azure.cognitive_services.defender_for_ai_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND defender_for_ai_setting_name = '{{ defender_for_ai_setting_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the Defender for AI settings.

SELECT
id,
name,
etag,
state,
systemData,
tags,
type
FROM azure.cognitive_services.defender_for_ai_settings
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 or Updates the specified Defender for AI setting.

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

Manifest

# Description fields are for documentation purposes
- name: defender_for_ai_settings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the defender_for_ai_settings resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the defender_for_ai_settings resource.
  - name: defender_for_ai_setting_name
    value: "{{ defender_for_ai_setting_name }}"
    description: Required parameter for the defender_for_ai_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the defender_for_ai_settings resource.
  - name: properties
    description: |
      The Defender for AI resource properties.
    value:
      state: "{{ state }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.

UPDATE examples

update

Updates the specified Defender for AI setting.

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

REPLACE examples

create_or_update

Creates or Updates the specified Defender for AI setting.

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