beta_red_teams

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

Overview

Name	beta_red_teams
Type	Resource
Id	azure.ai_projects.beta_red_teams

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Identifier of the red team run. Required.
applicationScenario	string	Application scenario for the red team operation, to generate scenario specific attacks.
attackStrategies	array	List of attack strategies or nested lists of attack strategies.
displayName	string	Name of the red-team run.
numTurns	integer	Number of simulation rounds.
properties	object	Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
riskCategories	array	List of risk categories to generate attack objectives for.
simulationOnly	boolean	Simulation-only or Simulation + Evaluation. If true the scan outputs conversation not evaluation result. The service defaults to false if a value is not specified by the caller.
status	string	Status of the red-team. It is set by service and is read-only.
tags	object	Red team's tags. Unlike properties, tags are fully mutable.
target	object	Target configuration for the red-team run. Required.

list

Name	Datatype	Description
id	string	Identifier of the red team run. Required.
applicationScenario	string	Application scenario for the red team operation, to generate scenario specific attacks.
attackStrategies	array	List of attack strategies or nested lists of attack strategies.
displayName	string	Name of the red-team run.
numTurns	integer	Number of simulation rounds.
properties	object	Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
riskCategories	array	List of risk categories to generate attack objectives for.
simulationOnly	boolean	Simulation-only or Simulation + Evaluation. If true the scan outputs conversation not evaluation result. The service defaults to false if a value is not specified by the caller.
status	string	Status of the red-team. It is set by service and is read-only.
tags	object	Red team's tags. Unlike properties, tags are fully mutable.
target	object	Target configuration for the red-team run. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, endpoint		Get a redteam. Retrieves the specified redteam and its configuration.
list	select	endpoint		List redteams. Returns the redteams available in the current project.
create	insert	endpoint, target		Create a redteam run. Submits a new redteam run for execution with the provided configuration.

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
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
name	string	Identifier of the red team run. Required.

SELECT examples

get

Get a redteam. Retrieves the specified redteam and its configuration.

SELECT
id,
applicationScenario,
attackStrategies,
displayName,
numTurns,
properties,
riskCategories,
simulationOnly,
status,
tags,
target
FROM azure.ai_projects.beta_red_teams
WHERE name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List redteams. Returns the redteams available in the current project.

SELECT
id,
applicationScenario,
attackStrategies,
displayName,
numTurns,
properties,
riskCategories,
simulationOnly,
status,
tags,
target
FROM azure.ai_projects.beta_red_teams
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create

Create a redteam run. Submits a new redteam run for execution with the provided configuration.

INSERT INTO azure.ai_projects.beta_red_teams (
displayName,
numTurns,
attackStrategies,
simulationOnly,
riskCategories,
applicationScenario,
tags,
properties,
target,
endpoint
)
SELECT 
'{{ displayName }}',
{{ numTurns }},
'{{ attackStrategies }}',
{{ simulationOnly }},
'{{ riskCategories }}',
'{{ applicationScenario }}',
'{{ tags }}',
'{{ properties }}',
'{{ target }}' /* required */,
'{{ endpoint }}'
RETURNING
id,
applicationScenario,
attackStrategies,
displayName,
numTurns,
properties,
riskCategories,
simulationOnly,
status,
tags,
target
;

Manifest

# Description fields are for documentation purposes
- name: beta_red_teams
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the beta_red_teams resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Name of the red-team run.
  - name: numTurns
    value: {{ numTurns }}
    description: |
      Number of simulation rounds.
  - name: attackStrategies
    value:
      - "{{ attackStrategies }}"
    description: |
      List of attack strategies or nested lists of attack strategies.
  - name: simulationOnly
    value: {{ simulationOnly }}
    description: |
      Simulation-only or Simulation + Evaluation. If `true` the scan outputs conversation not evaluation result. The service defaults to `false` if a value is not specified by the caller.
  - name: riskCategories
    value:
      - "{{ riskCategories }}"
    description: |
      List of risk categories to generate attack objectives for.
  - name: applicationScenario
    value: "{{ applicationScenario }}"
    description: |
      Application scenario for the red team operation, to generate scenario specific attacks.
  - name: tags
    value: "{{ tags }}"
    description: |
      Red team's tags. Unlike properties, tags are fully mutable.
  - name: properties
    value: "{{ properties }}"
    description: |
      Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
  - name: target
    description: |
      Target configuration for the red-team run. Required.
    value:
      type: "{{ type }}"