Redteams

Get a redteam

GET /redTeams/runs/{name}

Retrieves the specified redteam and its configuration.

Abfrageparameter

api-version string Erforderlich

The API version to use for this operation.

Pfadparameter

name string Erforderlich

Identifier of the red team run.

Headerparameter

Foundry-Features enum Erforderlich

A feature flag opt-in required when using preview operations or modifying persisted preview resources.

RedTeams=V1Preview

Antworten

The request has succeeded.

Text

Content-Type: application/json

id string Erforderlich

Identifier of the red team run.

displayName string

Name of the red-team run.

numTurns integer

Number of simulation rounds.

attackStrategies AttackStrategy[]

List of attack strategies or nested lists of attack strategies.

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.

riskCategories RiskCategory[]

List of risk categories to generate attack objectives for.

applicationScenario string

Application scenario for the red team operation, to generate scenario specific attacks.

tags object

Red team's tags. Unlike properties, tags are fully mutable.

[key: string] string

properties object

Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.

[key: string] string

status string

Status of the red-team. It is set by service and is read-only.

target AzureOpenAIModel Erforderlich

Abstract class for target configuration.

Eins der folgenden:

AzureOpenAIModel AzureOpenAIModelConfiguration

Azure OpenAI model configuration. The API version would be selected by the service for querying the model.

type enum Erforderlich

AzureOpenAIModel

modelDeploymentName string Erforderlich

Deployment name for AOAI model. Example: gpt-4o if in AIServices or connection based connection_name/deployment_name (e.g. my-aoai-connection/gpt-4o).