BetaRedTeamsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:red_teams> attribute.
Constructor
BetaRedTeamsOperations(*args, **kwargs)Methods
| create |
Create a redteam run. Submits a new redteam run for execution with the provided configuration. |
| get |
Get a redteam. Retrieves the specified redteam and its configuration. |
| list |
List redteams. Returns the redteams available in the current project. |
create
Create a redteam run.
Submits a new redteam run for execution with the provided configuration.
create(red_team: _models.RedTeam, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RedTeamParameters
| Name | Description |
|---|---|
|
red_team
Required
|
Redteam to be run. Is one of the following types: RedTeam, JSON, IO[bytes] Required. |
Returns
| Type | Description |
|---|---|
|
RedTeam. The RedTeam is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
get
Get a redteam.
Retrieves the specified redteam and its configuration.
get(name: str, **kwargs: Any) -> RedTeamParameters
| Name | Description |
|---|---|
|
name
Required
|
Identifier of the red team run. Required. |
Returns
| Type | Description |
|---|---|
|
RedTeam. The RedTeam is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
list
List redteams.
Returns the redteams available in the current project.
list(**kwargs: Any) -> ItemPaged[RedTeam]Returns
| Type | Description |
|---|---|
|
An iterator like instance of RedTeam |
Exceptions
| Type | Description |
|---|---|
