Microsoft.Chaos (preview:2023-09-01)

2025/09/05 • 18 new, 18 deleted methods

CapabilityTypes_List (new)
Description :  Get a list of Capability Type resources for given Target Type and location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}/capabilityTypes
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
locationName:
{
Description: String that represents a Location resource name. ,
Required: True ,
}
string ,
targetTypeName:
{
Description: String that represents a Target Type resource name. ,
Required: True ,
}
string ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Capability Type resources. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata properties of the capability type resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the Capability Type resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the capability type resource. ,
Required: False ,
}
{
publisher:
{
Description: String of the Publisher that this Capability Type extends. ,
Required: False ,
}
string ,
targetType:
{
Description: String of the Target Type that this Capability Type extends. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized string of the display name. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
parametersSchema:
{
Description: URL to retrieve JSON schema of the Capability Type parameters. ,
Required: False ,
}
string ,
urn:
{
Description: String of the URN for this Capability Type. ,
Required: False ,
}
string ,
kind:
{
Description: String of the kind of this Capability Type. ,
Required: False ,
}
string ,
azureRbacActions:
{
Description: Control plane actions necessary to execute capability type. ,
Required: False ,
}
[
string ,
]
,
azureRbacDataActions:
{
Description: Data plane actions necessary to execute capability type. ,
Required: False ,
}
[
string ,
]
,
runtimeProperties:
{
Description: Runtime properties of this Capability Type. ,
Required: False ,
}
{
kind:
{
Description: String of the kind of the resource's action type (continuous or discrete). ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve the next page of Capability Type resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CapabilityTypes_Get (new)
Description :  Get a Capability Type resource for given Target Type and location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}/capabilityTypes/{capabilityTypeName}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
locationName:
{
Description: String that represents a Location resource name. ,
Required: True ,
}
string ,
targetTypeName:
{
Description: String that represents a Target Type resource name. ,
Required: True ,
}
string ,
capabilityTypeName:
{
Description: String that represents a Capability Type resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata properties of the capability type resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the Capability Type resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the capability type resource. ,
Required: False ,
}
{
publisher:
{
Description: String of the Publisher that this Capability Type extends. ,
Required: False ,
}
string ,
targetType:
{
Description: String of the Target Type that this Capability Type extends. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized string of the display name. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
parametersSchema:
{
Description: URL to retrieve JSON schema of the Capability Type parameters. ,
Required: False ,
}
string ,
urn:
{
Description: String of the URN for this Capability Type. ,
Required: False ,
}
string ,
kind:
{
Description: String of the kind of this Capability Type. ,
Required: False ,
}
string ,
azureRbacActions:
{
Description: Control plane actions necessary to execute capability type. ,
Required: False ,
}
[
string ,
]
,
azureRbacDataActions:
{
Description: Data plane actions necessary to execute capability type. ,
Required: False ,
}
[
string ,
]
,
runtimeProperties:
{
Description: Runtime properties of this Capability Type. ,
Required: False ,
}
{
kind:
{
Description: String of the kind of the resource's action type (continuous or discrete). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_ListAll (new)
Description :  Get a list of Experiment resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/experiments
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
running:
{
Description: Optional value that indicates whether to filter results based on if the Experiment is currently running. If null, then the results will not be filtered. ,
Required: False ,
}
boolean ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Experiment resources. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata of the experiment resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
steps:
{
Description: List of steps. ,
Required: True ,
}
[
{
name:
{
Description: String of the step name. ,
Required: True ,
}
string ,
branches:
{
Description: List of branches. ,
Required: True ,
}
[
{
name:
{
Description: String of the branch name. ,
Required: True ,
}
string ,
actions:
{
Description: List of actions. ,
Required: True ,
}
[
{
type:
{
Description: Enum that discriminates between action models. ,
Required: True ,
}
string ,
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
type:
{
Description: Enum of the selector type. ,
Enum:
{
List: No description available. ,
Query: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Enum that discriminates between filter types. Currently only `Simple` type is supported. ,
Enum:
{
Simple: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve the next page of Experiment resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_List (new)
Description :  Get a list of Experiment resources in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
running:
{
Description: Optional value that indicates whether to filter results based on if the Experiment is currently running. If null, then the results will not be filtered. ,
Required: False ,
}
boolean ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Experiment resources. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata of the experiment resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
steps:
{
Description: List of steps. ,
Required: True ,
}
[
{
name:
{
Description: String of the step name. ,
Required: True ,
}
string ,
branches:
{
Description: List of branches. ,
Required: True ,
}
[
{
name:
{
Description: String of the branch name. ,
Required: True ,
}
string ,
actions:
{
Description: List of actions. ,
Required: True ,
}
[
{
type:
{
Description: Enum that discriminates between action models. ,
Required: True ,
}
string ,
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
type:
{
Description: Enum of the selector type. ,
Enum:
{
List: No description available. ,
Query: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Enum that discriminates between filter types. Currently only `Simple` type is supported. ,
Enum:
{
Simple: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve the next page of Experiment resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_Delete (new)
Description :  Delete a Experiment resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_Get (new)
Description :  Get a Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata of the experiment resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
steps:
{
Description: List of steps. ,
Required: True ,
}
[
{
name:
{
Description: String of the step name. ,
Required: True ,
}
string ,
branches:
{
Description: List of branches. ,
Required: True ,
}
[
{
name:
{
Description: String of the branch name. ,
Required: True ,
}
string ,
actions:
{
Description: List of actions. ,
Required: True ,
}
[
{
type:
{
Description: Enum that discriminates between action models. ,
Required: True ,
}
string ,
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
type:
{
Description: Enum of the selector type. ,
Enum:
{
List: No description available. ,
Query: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Enum that discriminates between filter types. Currently only `Simple` type is supported. ,
Enum:
{
Simple: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_CreateOrUpdate (new)
Description :  Create or update a Experiment resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
experiment:
{
Description: Experiment resource to be created or updated. ,
Required: True ,
}
{
systemData:
{
Description: The system metadata of the experiment resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
steps:
{
Description: List of steps. ,
Required: True ,
}
[
{
name:
{
Description: String of the step name. ,
Required: True ,
}
string ,
branches:
{
Description: List of branches. ,
Required: True ,
}
[
{
name:
{
Description: String of the branch name. ,
Required: True ,
}
string ,
actions:
{
Description: List of actions. ,
Required: True ,
}
[
{
type:
{
Description: Enum that discriminates between action models. ,
Required: True ,
}
string ,
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
type:
{
Description: Enum of the selector type. ,
Enum:
{
List: No description available. ,
Query: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Enum that discriminates between filter types. Currently only `Simple` type is supported. ,
Enum:
{
Simple: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: The system metadata of the experiment resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
steps:
{
Description: List of steps. ,
Required: True ,
}
[
{
name:
{
Description: String of the step name. ,
Required: True ,
}
string ,
branches:
{
Description: List of branches. ,
Required: True ,
}
[
{
name:
{
Description: String of the branch name. ,
Required: True ,
}
string ,
actions:
{
Description: List of actions. ,
Required: True ,
}
[
{
type:
{
Description: Enum that discriminates between action models. ,
Required: True ,
}
string ,
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
type:
{
Description: Enum of the selector type. ,
Enum:
{
List: No description available. ,
Query: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Enum that discriminates between filter types. Currently only `Simple` type is supported. ,
Enum:
{
Simple: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_Update (new)
Description :  The operation to update an experiment.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
experiment:
{
Description: Parameters supplied to the Update experiment operation. ,
Required: True ,
}
{
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: The system metadata of the experiment resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
steps:
{
Description: List of steps. ,
Required: True ,
}
[
{
name:
{
Description: String of the step name. ,
Required: True ,
}
string ,
branches:
{
Description: List of branches. ,
Required: True ,
}
[
{
name:
{
Description: String of the branch name. ,
Required: True ,
}
string ,
actions:
{
Description: List of actions. ,
Required: True ,
}
[
{
type:
{
Description: Enum that discriminates between action models. ,
Required: True ,
}
string ,
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
type:
{
Description: Enum of the selector type. ,
Enum:
{
List: No description available. ,
Query: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Enum that discriminates between filter types. Currently only `Simple` type is supported. ,
Enum:
{
Simple: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_Cancel (new)
Description :  Cancel a running Experiment resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/cancel
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_Start (new)
Description :  Start a Experiment resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/start
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_ListAllStatuses (new)
Description :  Get a list of statuses of a Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/statuses
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Experiment statuses. ,
Required: False ,
}
[
{
type:
{
Description: String of the resource type. ,
Required: False ,
}
string ,
id:
{
Description: String of the fully qualified resource ID. ,
Required: False ,
}
string ,
name:
{
Description: String of the resource name. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of experiment execution status. ,
Required: False ,
}
{
status:
{
Description: String that represents the status of a Experiment. ,
Required: False ,
}
string ,
createdDateUtc:
{
Description: String that represents the created date time of a Experiment. ,
Format: date-time ,
Required: False ,
}
string ,
endDateUtc:
{
Description: String that represents the end date time of a Experiment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve the next page of Experiment statuses. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_GetStatus (new)
Description :  Get a status of a Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/statuses/{statusId}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
statusId:
{
Description: GUID that represents a Experiment status. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: String of the resource type. ,
Required: False ,
}
string ,
id:
{
Description: String of the fully qualified resource ID. ,
Required: False ,
}
string ,
name:
{
Description: String of the resource name. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of experiment execution status. ,
Required: False ,
}
{
status:
{
Description: String that represents the status of a Experiment. ,
Required: False ,
}
string ,
createdDateUtc:
{
Description: String that represents the created date time of a Experiment. ,
Format: date-time ,
Required: False ,
}
string ,
endDateUtc:
{
Description: String that represents the end date time of a Experiment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_ListExecutionDetails (new)
Description :  Get a list of execution details of a Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executionDetails
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Experiment execution details. ,
Required: False ,
}
[
{
type:
{
Description: String of the resource type. ,
Required: False ,
}
string ,
id:
{
Description: String of the fully qualified resource ID. ,
Required: False ,
}
string ,
name:
{
Description: String of the resource name. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the experiment execution details. ,
Required: False ,
}
{
experimentId:
{
Description: The id of the experiment. ,
Required: False ,
}
string ,
status:
{
Description: The value of the status of the experiment execution. ,
Required: False ,
}
string ,
failureReason:
{
Description: The reason why the execution failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: String that represents the created date time. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: String that represents the last action date time. ,
Format: date-time ,
Required: False ,
}
string ,
startDateTime:
{
Description: String that represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
stopDateTime:
{
Description: String that represents the stop date time. ,
Format: date-time ,
Required: False ,
}
string ,
runInformation:
{
Description: The information of the experiment run. ,
Required: False ,
}
{
steps:
{
Description: The steps of the experiment run. ,
Required: False ,
}
[
{
stepName:
{
Description: The name of the step. ,
Required: False ,
}
string ,
stepId:
{
Description: The id of the step. ,
Required: False ,
}
string ,
status:
{
Description: The value of the status of the step. ,
Required: False ,
}
string ,
branches:
{
Description: The array of branches. ,
Required: False ,
}
[
{
branchName:
{
Description: The name of the branch status. ,
Required: False ,
}
string ,
branchId:
{
Description: The id of the branch status. ,
Required: False ,
}
string ,
status:
{
Description: The status of the branch. ,
Required: False ,
}
string ,
actions:
{
Description: The array of actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The name of the action status. ,
Required: False ,
}
string ,
actionId:
{
Description: The id of the action status. ,
Required: False ,
}
string ,
status:
{
Description: The status of the action. ,
Required: False ,
}
string ,
startTime:
{
Description: String that represents the start time of the action. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: String that represents the end time of the action. ,
Format: date-time ,
Required: False ,
}
string ,
targets:
{
Description: The array of targets. ,
Required: False ,
}
[
{
status:
{
Description: The status of the execution. ,
Required: False ,
}
string ,
target:
{
Description: The target for the action. ,
Required: False ,
}
string ,
targetFailedTime:
{
Description: String that represents the failed date time. ,
Format: date-time ,
Required: False ,
}
string ,
targetCompletedTime:
{
Description: String that represents the completed date time. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error of the action. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve the next page of Experiment execution details. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_GetExecutionDetails (new)
Description :  Get an execution detail of a Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executionDetails/{executionDetailsId}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
executionDetailsId:
{
Description: GUID that represents a Experiment execution detail. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: String of the resource type. ,
Required: False ,
}
string ,
id:
{
Description: String of the fully qualified resource ID. ,
Required: False ,
}
string ,
name:
{
Description: String of the resource name. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the experiment execution details. ,
Required: False ,
}
{
experimentId:
{
Description: The id of the experiment. ,
Required: False ,
}
string ,
status:
{
Description: The value of the status of the experiment execution. ,
Required: False ,
}
string ,
failureReason:
{
Description: The reason why the execution failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: String that represents the created date time. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: String that represents the last action date time. ,
Format: date-time ,
Required: False ,
}
string ,
startDateTime:
{
Description: String that represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
stopDateTime:
{
Description: String that represents the stop date time. ,
Format: date-time ,
Required: False ,
}
string ,
runInformation:
{
Description: The information of the experiment run. ,
Required: False ,
}
{
steps:
{
Description: The steps of the experiment run. ,
Required: False ,
}
[
{
stepName:
{
Description: The name of the step. ,
Required: False ,
}
string ,
stepId:
{
Description: The id of the step. ,
Required: False ,
}
string ,
status:
{
Description: The value of the status of the step. ,
Required: False ,
}
string ,
branches:
{
Description: The array of branches. ,
Required: False ,
}
[
{
branchName:
{
Description: The name of the branch status. ,
Required: False ,
}
string ,
branchId:
{
Description: The id of the branch status. ,
Required: False ,
}
string ,
status:
{
Description: The status of the branch. ,
Required: False ,
}
string ,
actions:
{
Description: The array of actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The name of the action status. ,
Required: False ,
}
string ,
actionId:
{
Description: The id of the action status. ,
Required: False ,
}
string ,
status:
{
Description: The status of the action. ,
Required: False ,
}
string ,
startTime:
{
Description: String that represents the start time of the action. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: String that represents the end time of the action. ,
Format: date-time ,
Required: False ,
}
string ,
targets:
{
Description: The array of targets. ,
Required: False ,
}
[
{
status:
{
Description: The status of the execution. ,
Required: False ,
}
string ,
target:
{
Description: The target for the action. ,
Required: False ,
}
string ,
targetFailedTime:
{
Description: String that represents the failed date time. ,
Format: date-time ,
Required: False ,
}
string ,
targetCompletedTime:
{
Description: String that represents the completed date time. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error of the action. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationStatuses_Get (new)
Description :  Get the status of a long running azure asynchronous operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/operationsStatuses/{asyncOperationId}
{
location:
{
Description: The region name of operation. ,
Required: True ,
}
string ,
asyncOperationId:
{
Description: The operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The operation Id. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_ListAll (new)
Description :  Get a list all available Operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Chaos/operations
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TargetTypes_List (new)
Description :  Get a list of Target Type resources for given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
locationName:
{
Description: String that represents a Location resource name. ,
Required: True ,
}
string ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Target Type resources. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata properties of the target type resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the Target Type resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the target type resource. ,
Required: True ,
}
{
displayName:
{
Description: Localized string of the display name. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
propertiesSchema:
{
Description: URL to retrieve JSON schema of the Target Type properties. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: List of resource types this Target Type can extend. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve the next page of Target Type resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TargetTypes_Get (new)
Description :  Get a Target Type resources for given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
locationName:
{
Description: String that represents a Location resource name. ,
Required: True ,
}
string ,
targetTypeName:
{
Description: String that represents a Target Type resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata properties of the target type resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the Target Type resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the target type resource. ,
Required: True ,
}
{
displayName:
{
Description: Localized string of the display name. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
propertiesSchema:
{
Description: URL to retrieve JSON schema of the Target Type properties. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: List of resource types this Target Type can extend. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CapabilityTypes_List (removed)
Description :  Get a list of Capability Type resources for given Target Type and location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}/capabilityTypes
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
locationName:
{
Description: String that represents a Location resource name. ,
Required: True ,
}
string ,
targetTypeName:
{
Description: String that represents a Target Type resource name. ,
Required: True ,
}
string ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Capability Type resources. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata properties of the capability type resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the Capability Type resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the capability type resource. ,
Required: False ,
}
{
publisher:
{
Description: String of the Publisher that this Capability Type extends. ,
Required: False ,
}
string ,
targetType:
{
Description: String of the Target Type that this Capability Type extends. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized string of the display name. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
parametersSchema:
{
Description: URL to retrieve JSON schema of the Capability Type parameters. ,
Required: False ,
}
string ,
urn:
{
Description: String of the URN for this Capability Type. ,
Required: False ,
}
string ,
kind:
{
Description: String of the kind of this Capability Type. ,
Required: False ,
}
string ,
azureRbacActions:
{
Description: Control plane actions necessary to execute capability type. ,
Required: False ,
}
[
string ,
]
,
azureRbacDataActions:
{
Description: Data plane actions necessary to execute capability type. ,
Required: False ,
}
[
string ,
]
,
runtimeProperties:
{
Description: Runtime properties of this Capability Type. ,
Required: False ,
}
{
kind:
{
Description: String of the kind of the resource's action type (continuous or discrete). ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve the next page of Capability Type resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CapabilityTypes_Get (removed)
Description :  Get a Capability Type resource for given Target Type and location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}/capabilityTypes/{capabilityTypeName}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
locationName:
{
Description: String that represents a Location resource name. ,
Required: True ,
}
string ,
targetTypeName:
{
Description: String that represents a Target Type resource name. ,
Required: True ,
}
string ,
capabilityTypeName:
{
Description: String that represents a Capability Type resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata properties of the capability type resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the Capability Type resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the capability type resource. ,
Required: False ,
}
{
publisher:
{
Description: String of the Publisher that this Capability Type extends. ,
Required: False ,
}
string ,
targetType:
{
Description: String of the Target Type that this Capability Type extends. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized string of the display name. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
parametersSchema:
{
Description: URL to retrieve JSON schema of the Capability Type parameters. ,
Required: False ,
}
string ,
urn:
{
Description: String of the URN for this Capability Type. ,
Required: False ,
}
string ,
kind:
{
Description: String of the kind of this Capability Type. ,
Required: False ,
}
string ,
azureRbacActions:
{
Description: Control plane actions necessary to execute capability type. ,
Required: False ,
}
[
string ,
]
,
azureRbacDataActions:
{
Description: Data plane actions necessary to execute capability type. ,
Required: False ,
}
[
string ,
]
,
runtimeProperties:
{
Description: Runtime properties of this Capability Type. ,
Required: False ,
}
{
kind:
{
Description: String of the kind of the resource's action type (continuous or discrete). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_ListAll (removed)
Description :  Get a list of Experiment resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/experiments
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
running:
{
Description: Optional value that indicates whether to filter results based on if the Experiment is currently running. If null, then the results will not be filtered. ,
Required: False ,
}
boolean ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Experiment resources. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata of the experiment resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
steps:
{
Description: List of steps. ,
Required: True ,
}
[
{
name:
{
Description: String of the step name. ,
Required: True ,
}
string ,
branches:
{
Description: List of branches. ,
Required: True ,
}
[
{
name:
{
Description: String of the branch name. ,
Required: True ,
}
string ,
actions:
{
Description: List of actions. ,
Required: True ,
}
[
{
type:
{
Description: Enum that discriminates between action models. ,
Required: True ,
}
string ,
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
type:
{
Description: Enum of the selector type. ,
Enum:
{
List: No description available. ,
Query: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Enum that discriminates between filter types. Currently only `Simple` type is supported. ,
Enum:
{
Simple: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve the next page of Experiment resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_List (removed)
Description :  Get a list of Experiment resources in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
running:
{
Description: Optional value that indicates whether to filter results based on if the Experiment is currently running. If null, then the results will not be filtered. ,
Required: False ,
}
boolean ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Experiment resources. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata of the experiment resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
steps:
{
Description: List of steps. ,
Required: True ,
}
[
{
name:
{
Description: String of the step name. ,
Required: True ,
}
string ,
branches:
{
Description: List of branches. ,
Required: True ,
}
[
{
name:
{
Description: String of the branch name. ,
Required: True ,
}
string ,
actions:
{
Description: List of actions. ,
Required: True ,
}
[
{
type:
{
Description: Enum that discriminates between action models. ,
Required: True ,
}
string ,
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
type:
{
Description: Enum of the selector type. ,
Enum:
{
List: No description available. ,
Query: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Enum that discriminates between filter types. Currently only `Simple` type is supported. ,
Enum:
{
Simple: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve the next page of Experiment resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_Delete (removed)
Description :  Delete a Experiment resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_Get (removed)
Description :  Get a Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata of the experiment resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
steps:
{
Description: List of steps. ,
Required: True ,
}
[
{
name:
{
Description: String of the step name. ,
Required: True ,
}
string ,
branches:
{
Description: List of branches. ,
Required: True ,
}
[
{
name:
{
Description: String of the branch name. ,
Required: True ,
}
string ,
actions:
{
Description: List of actions. ,
Required: True ,
}
[
{
type:
{
Description: Enum that discriminates between action models. ,
Required: True ,
}
string ,
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
type:
{
Description: Enum of the selector type. ,
Enum:
{
List: No description available. ,
Query: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Enum that discriminates between filter types. Currently only `Simple` type is supported. ,
Enum:
{
Simple: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_CreateOrUpdate (removed)
Description :  Create or update a Experiment resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
experiment:
{
Description: Experiment resource to be created or updated. ,
Required: True ,
}
{
systemData:
{
Description: The system metadata of the experiment resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
steps:
{
Description: List of steps. ,
Required: True ,
}
[
{
name:
{
Description: String of the step name. ,
Required: True ,
}
string ,
branches:
{
Description: List of branches. ,
Required: True ,
}
[
{
name:
{
Description: String of the branch name. ,
Required: True ,
}
string ,
actions:
{
Description: List of actions. ,
Required: True ,
}
[
{
type:
{
Description: Enum that discriminates between action models. ,
Required: True ,
}
string ,
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
type:
{
Description: Enum of the selector type. ,
Enum:
{
List: No description available. ,
Query: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Enum that discriminates between filter types. Currently only `Simple` type is supported. ,
Enum:
{
Simple: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
systemData:
{
Description: The system metadata of the experiment resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
steps:
{
Description: List of steps. ,
Required: True ,
}
[
{
name:
{
Description: String of the step name. ,
Required: True ,
}
string ,
branches:
{
Description: List of branches. ,
Required: True ,
}
[
{
name:
{
Description: String of the branch name. ,
Required: True ,
}
string ,
actions:
{
Description: List of actions. ,
Required: True ,
}
[
{
type:
{
Description: Enum that discriminates between action models. ,
Required: True ,
}
string ,
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
type:
{
Description: Enum of the selector type. ,
Enum:
{
List: No description available. ,
Query: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Enum that discriminates between filter types. Currently only `Simple` type is supported. ,
Enum:
{
Simple: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_Update (removed)
Description :  The operation to update an experiment.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
experiment:
{
Description: Parameters supplied to the Update experiment operation. ,
Required: True ,
}
{
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
systemData:
{
Description: The system metadata of the experiment resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity of the experiment resource. ,
Required: False ,
}
{
type:
{
Description: String of the resource identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
principalId:
{
Description: GUID that represents the principal ID of this resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: GUID that represents the tenant ID of this resource identity. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
steps:
{
Description: List of steps. ,
Required: True ,
}
[
{
name:
{
Description: String of the step name. ,
Required: True ,
}
string ,
branches:
{
Description: List of branches. ,
Required: True ,
}
[
{
name:
{
Description: String of the branch name. ,
Required: True ,
}
string ,
actions:
{
Description: List of actions. ,
Required: True ,
}
[
{
type:
{
Description: Enum that discriminates between action models. ,
Required: True ,
}
string ,
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
type:
{
Description: Enum of the selector type. ,
Enum:
{
List: No description available. ,
Query: No description available. ,
}
,
Required: True ,
}
enum ,
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Enum that discriminates between filter types. Currently only `Simple` type is supported. ,
Enum:
{
Simple: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_Cancel (removed)
Description :  Cancel a running Experiment resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/cancel
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_Start (removed)
Description :  Start a Experiment resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/start
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_ListAllStatuses (removed)
Description :  Get a list of statuses of a Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/statuses
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Experiment statuses. ,
Required: False ,
}
[
{
type:
{
Description: String of the resource type. ,
Required: False ,
}
string ,
id:
{
Description: String of the fully qualified resource ID. ,
Required: False ,
}
string ,
name:
{
Description: String of the resource name. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of experiment execution status. ,
Required: False ,
}
{
status:
{
Description: String that represents the status of a Experiment. ,
Required: False ,
}
string ,
createdDateUtc:
{
Description: String that represents the created date time of a Experiment. ,
Format: date-time ,
Required: False ,
}
string ,
endDateUtc:
{
Description: String that represents the end date time of a Experiment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve the next page of Experiment statuses. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_GetStatus (removed)
Description :  Get a status of a Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/statuses/{statusId}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
statusId:
{
Description: GUID that represents a Experiment status. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: String of the resource type. ,
Required: False ,
}
string ,
id:
{
Description: String of the fully qualified resource ID. ,
Required: False ,
}
string ,
name:
{
Description: String of the resource name. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of experiment execution status. ,
Required: False ,
}
{
status:
{
Description: String that represents the status of a Experiment. ,
Required: False ,
}
string ,
createdDateUtc:
{
Description: String that represents the created date time of a Experiment. ,
Format: date-time ,
Required: False ,
}
string ,
endDateUtc:
{
Description: String that represents the end date time of a Experiment. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_ListExecutionDetails (removed)
Description :  Get a list of execution details of a Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executionDetails
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Experiment execution details. ,
Required: False ,
}
[
{
type:
{
Description: String of the resource type. ,
Required: False ,
}
string ,
id:
{
Description: String of the fully qualified resource ID. ,
Required: False ,
}
string ,
name:
{
Description: String of the resource name. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the experiment execution details. ,
Required: False ,
}
{
experimentId:
{
Description: The id of the experiment. ,
Required: False ,
}
string ,
status:
{
Description: The value of the status of the experiment execution. ,
Required: False ,
}
string ,
failureReason:
{
Description: The reason why the execution failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: String that represents the created date time. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: String that represents the last action date time. ,
Format: date-time ,
Required: False ,
}
string ,
startDateTime:
{
Description: String that represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
stopDateTime:
{
Description: String that represents the stop date time. ,
Format: date-time ,
Required: False ,
}
string ,
runInformation:
{
Description: The information of the experiment run. ,
Required: False ,
}
{
steps:
{
Description: The steps of the experiment run. ,
Required: False ,
}
[
{
stepName:
{
Description: The name of the step. ,
Required: False ,
}
string ,
stepId:
{
Description: The id of the step. ,
Required: False ,
}
string ,
status:
{
Description: The value of the status of the step. ,
Required: False ,
}
string ,
branches:
{
Description: The array of branches. ,
Required: False ,
}
[
{
branchName:
{
Description: The name of the branch status. ,
Required: False ,
}
string ,
branchId:
{
Description: The id of the branch status. ,
Required: False ,
}
string ,
status:
{
Description: The status of the branch. ,
Required: False ,
}
string ,
actions:
{
Description: The array of actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The name of the action status. ,
Required: False ,
}
string ,
actionId:
{
Description: The id of the action status. ,
Required: False ,
}
string ,
status:
{
Description: The status of the action. ,
Required: False ,
}
string ,
startTime:
{
Description: String that represents the start time of the action. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: String that represents the end time of the action. ,
Format: date-time ,
Required: False ,
}
string ,
targets:
{
Description: The array of targets. ,
Required: False ,
}
[
{
status:
{
Description: The status of the execution. ,
Required: False ,
}
string ,
target:
{
Description: The target for the action. ,
Required: False ,
}
string ,
targetFailedTime:
{
Description: String that represents the failed date time. ,
Format: date-time ,
Required: False ,
}
string ,
targetCompletedTime:
{
Description: String that represents the completed date time. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error of the action. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve the next page of Experiment execution details. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Experiments_GetExecutionDetails (removed)
Description :  Get an execution detail of a Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executionDetails/{executionDetailsId}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: String that represents an Azure resource group. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
executionDetailsId:
{
Description: GUID that represents a Experiment execution detail. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: String of the resource type. ,
Required: False ,
}
string ,
id:
{
Description: String of the fully qualified resource ID. ,
Required: False ,
}
string ,
name:
{
Description: String of the resource name. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the experiment execution details. ,
Required: False ,
}
{
experimentId:
{
Description: The id of the experiment. ,
Required: False ,
}
string ,
status:
{
Description: The value of the status of the experiment execution. ,
Required: False ,
}
string ,
failureReason:
{
Description: The reason why the execution failed. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: String that represents the created date time. ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: String that represents the last action date time. ,
Format: date-time ,
Required: False ,
}
string ,
startDateTime:
{
Description: String that represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
stopDateTime:
{
Description: String that represents the stop date time. ,
Format: date-time ,
Required: False ,
}
string ,
runInformation:
{
Description: The information of the experiment run. ,
Required: False ,
}
{
steps:
{
Description: The steps of the experiment run. ,
Required: False ,
}
[
{
stepName:
{
Description: The name of the step. ,
Required: False ,
}
string ,
stepId:
{
Description: The id of the step. ,
Required: False ,
}
string ,
status:
{
Description: The value of the status of the step. ,
Required: False ,
}
string ,
branches:
{
Description: The array of branches. ,
Required: False ,
}
[
{
branchName:
{
Description: The name of the branch status. ,
Required: False ,
}
string ,
branchId:
{
Description: The id of the branch status. ,
Required: False ,
}
string ,
status:
{
Description: The status of the branch. ,
Required: False ,
}
string ,
actions:
{
Description: The array of actions. ,
Required: False ,
}
[
{
actionName:
{
Description: The name of the action status. ,
Required: False ,
}
string ,
actionId:
{
Description: The id of the action status. ,
Required: False ,
}
string ,
status:
{
Description: The status of the action. ,
Required: False ,
}
string ,
startTime:
{
Description: String that represents the start time of the action. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: String that represents the end time of the action. ,
Format: date-time ,
Required: False ,
}
string ,
targets:
{
Description: The array of targets. ,
Required: False ,
}
[
{
status:
{
Description: The status of the execution. ,
Required: False ,
}
string ,
target:
{
Description: The target for the action. ,
Required: False ,
}
string ,
targetFailedTime:
{
Description: String that represents the failed date time. ,
Format: date-time ,
Required: False ,
}
string ,
targetCompletedTime:
{
Description: String that represents the completed date time. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error of the action. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationStatuses_Get (removed)
Description :  Get the status of a long running azure asynchronous operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/operationsStatuses/{asyncOperationId}
{
location:
{
Description: The region name of operation. ,
Required: True ,
}
string ,
asyncOperationId:
{
Description: The operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The operation Id. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_ListAll (removed)
Description :  Get a list all available Operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Chaos/operations
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TargetTypes_List (removed)
Description :  Get a list of Target Type resources for given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
locationName:
{
Description: String that represents a Location resource name. ,
Required: True ,
}
string ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Target Type resources. ,
Required: False ,
}
[
{
systemData:
{
Description: The system metadata properties of the target type resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the Target Type resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the target type resource. ,
Required: True ,
}
{
displayName:
{
Description: Localized string of the display name. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
propertiesSchema:
{
Description: URL to retrieve JSON schema of the Target Type properties. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: List of resource types this Target Type can extend. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve the next page of Target Type resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TargetTypes_Get (removed)
Description :  Get a Target Type resources for given location.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{locationName}/targetTypes/{targetTypeName}
{
api-version:
{
Description: String that sets the API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: GUID that represents an Azure subscription ID. ,
Required: True ,
}
string ,
locationName:
{
Description: String that represents a Location resource name. ,
Required: True ,
}
string ,
targetTypeName:
{
Description: String that represents a Target Type resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
systemData:
{
Description: The system metadata properties of the target type resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
location:
{
Description: Location of the Target Type resource. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the target type resource. ,
Required: True ,
}
{
displayName:
{
Description: Localized string of the display name. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
propertiesSchema:
{
Description: URL to retrieve JSON schema of the Target Type properties. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: List of resource types this Target Type can extend. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}