Microsoft.Chaos (preview:2024-11-01)

2025/01/08 • 35 new methods

Operations_ListAll (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Chaos/operations
{
api-version:
{
Description: The API version to use for this operation. ,
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). ,
Format: uri ,
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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: The Experiment items on this page ,
Required: True ,
}
[
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
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 ,
}
[
{
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
type:
{
Description: Chaos experiment action discriminator type ,
Enum:
{
delay: No description available. ,
discrete: No description available. ,
continuous: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
type:
{
Description: Chaos target selector discriminator type ,
Enum:
{
List: List selector type. ,
Query: Query selector type. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Chaos target filter discriminator type ,
Enum:
{
Simple: Simple filter type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
customerDataStorage:
{
Description: Optional customer-managed Storage account where Experiment schema will be stored. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: ARM Resource ID of the Storage account to use for Customer Data storage. ,
Format: arm-id ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Name of the Azure Blob Storage container to use or create. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 :  Returns the current status of an async operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/operationStatuses/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
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 ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
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 ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
string ,
]
,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}
,
]
,
error:
{
Description: If present, details of the operation error. ,
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 ,
}
,
]
,
}
,
}

⚐ 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/{location}/targetTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The TargetType items on this page ,
Required: True ,
}
[
{
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: The link to the next page of items ,
Format: uri ,
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/{location}/targetTypes/{targetTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
targetTypeName:
{
Description: String that represents a Target Type resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 (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/{location}/targetTypes/{targetTypeName}/capabilityTypes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
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: The CapabilityType items on this page ,
Required: True ,
}
[
{
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: The link to the next page of items ,
Format: uri ,
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/{location}/targetTypes/{targetTypeName}/capabilityTypes/{capabilityTypeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
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)

{
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 ,
}
,
]
,
}
,
}
PrivateAccesses_ListAll (new)
Description :  Get a list of private access resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Chaos/privateAccesses
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateAccess items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given privateAccess resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connection. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Pending status. ,
Approved: Approved status. ,
Rejected: Rejected status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public Network Access Control for PrivateAccess resource. ,
Enum:
{
Enabled: Enabled access. ,
Disabled: Disabled access. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Targets_List (new)
Description :  Get a list of Target resources that extend a tracked regional resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
parentProviderNamespace:
{
Description: The parent resource provider namespace. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The parent resource type. ,
Required: True ,
}
string ,
parentResourceName:
{
Description: The parent resource name. ,
Required: True ,
}
string ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Target items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of the target resource. ,
Required: False ,
}
object ,
location:
{
Description: Azure resource location. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Targets_Get (new)
Description :  Get a Target resource that extends a tracked regional resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
parentProviderNamespace:
{
Description: The parent resource provider namespace. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The parent resource type. ,
Required: True ,
}
string ,
parentResourceName:
{
Description: The parent resource name. ,
Required: True ,
}
string ,
targetName:
{
Description: String that represents a Target resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the target resource. ,
Required: False ,
}
object ,
location:
{
Description: Azure resource location. ,
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 ,
}
,
]
,
}
,
}
Targets_CreateOrUpdate (new)
Description :  Create or update a Target resource that extends a tracked regional resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
parentProviderNamespace:
{
Description: The parent resource provider namespace. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The parent resource type. ,
Required: True ,
}
string ,
parentResourceName:
{
Description: The parent resource name. ,
Required: True ,
}
string ,
targetName:
{
Description: String that represents a Target resource name. ,
Required: True ,
}
string ,
resource:
{
Description: Target resource to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of the target resource. ,
Required: False ,
}
object ,
location:
{
Description: Azure resource location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the target resource. ,
Required: False ,
}
object ,
location:
{
Description: Azure resource location. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the target resource. ,
Required: False ,
}
object ,
location:
{
Description: Azure resource location. ,
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 ,
}
,
]
,
}
,
}
Targets_Delete (new)
Description :  Delete a Target resource that extends a tracked regional resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
parentProviderNamespace:
{
Description: The parent resource provider namespace. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The parent resource type. ,
Required: True ,
}
string ,
parentResourceName:
{
Description: The parent resource name. ,
Required: True ,
}
string ,
targetName:
{
Description: String that represents a Target resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Capabilities_List (new)
Description :  Get a list of Capability resources that extend a Target resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
parentProviderNamespace:
{
Description: The parent resource provider namespace. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The parent resource type. ,
Required: True ,
}
string ,
parentResourceName:
{
Description: The parent resource name. ,
Required: True ,
}
string ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
targetName:
{
Description: String that represents a Target resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Capability items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of a capability resource. ,
Required: False ,
}
{
publisher:
{
Description: String of the Publisher that this Capability extends. ,
Required: False ,
}
string ,
targetType:
{
Description: String of the Target Type that this Capability extends. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
parametersSchema:
{
Description: URL to retrieve JSON schema of the Capability parameters. ,
Required: False ,
}
string ,
urn:
{
Description: String of the URN for this Capability Type. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. Not currently in use because resource is created synchronously. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
Capabilities_Get (new)
Description :  Get a Capability resource that extends a Target resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities/{capabilityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
parentProviderNamespace:
{
Description: The parent resource provider namespace. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The parent resource type. ,
Required: True ,
}
string ,
parentResourceName:
{
Description: The parent resource name. ,
Required: True ,
}
string ,
targetName:
{
Description: String that represents a Target resource name. ,
Required: True ,
}
string ,
capabilityName:
{
Description: String that represents a Capability resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a capability resource. ,
Required: False ,
}
{
publisher:
{
Description: String of the Publisher that this Capability extends. ,
Required: False ,
}
string ,
targetType:
{
Description: String of the Target Type that this Capability extends. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
parametersSchema:
{
Description: URL to retrieve JSON schema of the Capability parameters. ,
Required: False ,
}
string ,
urn:
{
Description: String of the URN for this Capability Type. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. Not currently in use because resource is created synchronously. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Capabilities_CreateOrUpdate (new)
Description :  Create or update a Capability resource that extends a Target resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities/{capabilityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
parentProviderNamespace:
{
Description: The parent resource provider namespace. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The parent resource type. ,
Required: True ,
}
string ,
parentResourceName:
{
Description: The parent resource name. ,
Required: True ,
}
string ,
targetName:
{
Description: String that represents a Target resource name. ,
Required: True ,
}
string ,
capabilityName:
{
Description: String that represents a Capability resource name. ,
Required: True ,
}
string ,
resource:
{
Description: Capability resource to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of a capability resource. ,
Required: False ,
}
{
publisher:
{
Description: String of the Publisher that this Capability extends. ,
Required: False ,
}
string ,
targetType:
{
Description: String of the Target Type that this Capability extends. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
parametersSchema:
{
Description: URL to retrieve JSON schema of the Capability parameters. ,
Required: False ,
}
string ,
urn:
{
Description: String of the URN for this Capability Type. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. Not currently in use because resource is created synchronously. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a capability resource. ,
Required: False ,
}
{
publisher:
{
Description: String of the Publisher that this Capability extends. ,
Required: False ,
}
string ,
targetType:
{
Description: String of the Target Type that this Capability extends. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
parametersSchema:
{
Description: URL to retrieve JSON schema of the Capability parameters. ,
Required: False ,
}
string ,
urn:
{
Description: String of the URN for this Capability Type. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. Not currently in use because resource is created synchronously. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a capability resource. ,
Required: False ,
}
{
publisher:
{
Description: String of the Publisher that this Capability extends. ,
Required: False ,
}
string ,
targetType:
{
Description: String of the Target Type that this Capability extends. ,
Required: False ,
}
string ,
description:
{
Description: Localized string of the description. ,
Required: False ,
}
string ,
parametersSchema:
{
Description: URL to retrieve JSON schema of the Capability parameters. ,
Required: False ,
}
string ,
urn:
{
Description: String of the URN for this Capability Type. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. Not currently in use because resource is created synchronously. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
Capabilities_Delete (new)
Description :  Delete a Capability that extends a Target resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities/{capabilityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
parentProviderNamespace:
{
Description: The parent resource provider namespace. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The parent resource type. ,
Required: True ,
}
string ,
parentResourceName:
{
Description: The parent resource name. ,
Required: True ,
}
string ,
targetName:
{
Description: String that represents a Target resource name. ,
Required: True ,
}
string ,
capabilityName:
{
Description: String that represents a Capability resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
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: The Experiment items on this page ,
Required: True ,
}
[
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
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 ,
}
[
{
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
type:
{
Description: Chaos experiment action discriminator type ,
Enum:
{
delay: No description available. ,
discrete: No description available. ,
continuous: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
type:
{
Description: Chaos target selector discriminator type ,
Enum:
{
List: List selector type. ,
Query: Query selector type. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Chaos target filter discriminator type ,
Enum:
{
Simple: Simple filter type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
customerDataStorage:
{
Description: Optional customer-managed Storage account where Experiment schema will be stored. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: ARM Resource ID of the Storage account to use for Customer Data storage. ,
Format: arm-id ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Name of the Azure Blob Storage container to use or create. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_Get (new)
Description :  Get a Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
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 ,
}
[
{
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
type:
{
Description: Chaos experiment action discriminator type ,
Enum:
{
delay: No description available. ,
discrete: No description available. ,
continuous: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
type:
{
Description: Chaos target selector discriminator type ,
Enum:
{
List: List selector type. ,
Query: Query selector type. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Chaos target filter discriminator type ,
Enum:
{
Simple: Simple filter type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
customerDataStorage:
{
Description: Optional customer-managed Storage account where Experiment schema will be stored. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: ARM Resource ID of the Storage account to use for Customer Data storage. ,
Format: arm-id ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Name of the Azure Blob Storage container to use or create. ,
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_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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
resource:
{
Description: Experiment resource to be created or updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
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 ,
}
[
{
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
type:
{
Description: Chaos experiment action discriminator type ,
Enum:
{
delay: No description available. ,
discrete: No description available. ,
continuous: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
type:
{
Description: Chaos target selector discriminator type ,
Enum:
{
List: List selector type. ,
Query: Query selector type. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Chaos target filter discriminator type ,
Enum:
{
Simple: Simple filter type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
customerDataStorage:
{
Description: Optional customer-managed Storage account where Experiment schema will be stored. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: ARM Resource ID of the Storage account to use for Customer Data storage. ,
Format: arm-id ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Name of the Azure Blob Storage container to use or create. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
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 ,
}
[
{
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
type:
{
Description: Chaos experiment action discriminator type ,
Enum:
{
delay: No description available. ,
discrete: No description available. ,
continuous: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
type:
{
Description: Chaos target selector discriminator type ,
Enum:
{
List: List selector type. ,
Query: Query selector type. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Chaos target filter discriminator type ,
Enum:
{
Simple: Simple filter type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
customerDataStorage:
{
Description: Optional customer-managed Storage account where Experiment schema will be stored. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: ARM Resource ID of the Storage account to use for Customer Data storage. ,
Format: arm-id ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Name of the Azure Blob Storage container to use or create. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Model that represents a Experiment resource. ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
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 ,
}
[
{
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
type:
{
Description: Chaos experiment action discriminator type ,
Enum:
{
delay: No description available. ,
discrete: No description available. ,
continuous: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
type:
{
Description: Chaos target selector discriminator type ,
Enum:
{
List: List selector type. ,
Query: Query selector type. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Chaos target filter discriminator type ,
Enum:
{
Simple: Simple filter type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
customerDataStorage:
{
Description: Optional customer-managed Storage account where Experiment schema will be stored. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: ARM Resource ID of the Storage account to use for Customer Data storage. ,
Format: arm-id ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Name of the Azure Blob Storage container to use or create. ,
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_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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
properties:
{
Description: Parameters supplied to the Update experiment operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of the experiment resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given experiment resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
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 ,
}
[
{
name:
{
Description: String that represents a Capability URN. ,
Required: True ,
}
string ,
type:
{
Description: Chaos experiment action discriminator type ,
Enum:
{
delay: No description available. ,
discrete: No description available. ,
continuous: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
selectors:
{
Description: List of selectors. ,
Required: True ,
}
[
{
id:
{
Description: String of the selector ID. ,
Required: True ,
}
string ,
type:
{
Description: Chaos target selector discriminator type ,
Enum:
{
List: List selector type. ,
Query: Query selector type. ,
}
,
Required: True ,
}
enum ,
filter:
{
Description: Model that represents available filter types that can be applied to a targets list. ,
Required: False ,
}
{
type:
{
Description: Chaos target filter discriminator type ,
Enum:
{
Simple: Simple filter type. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
customerDataStorage:
{
Description: Optional customer-managed Storage account where Experiment schema will be stored. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: ARM Resource ID of the Storage account to use for Customer Data storage. ,
Format: arm-id ,
Required: False ,
}
string ,
blobContainerName:
{
Description: Name of the Azure Blob Storage container to use or create. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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_ListAllExecutions (new)
Description :  Get a list of executions of an Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ExperimentExecution items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The properties of experiment execution status. ,
Required: False ,
}
{
status:
{
Description: The status of the execution. ,
Required: False ,
}
string ,
startedAt:
{
Description: String that represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
stoppedAt:
{
Description: String that represents the stop date time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. Not currently in use for executions. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_GetExecution (new)
Description :  Get an execution of an Experiment resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executions/{executionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
executionId:
{
Description: GUID that represents a Experiment execution detail. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of experiment execution status. ,
Required: False ,
}
{
status:
{
Description: The status of the execution. ,
Required: False ,
}
string ,
startedAt:
{
Description: String that represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
stoppedAt:
{
Description: String that represents the stop date time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. Not currently in use for executions. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
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_ExecutionDetails (new)
Description :  Execution details of an experiment resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executions/{executionId}/getExecutionDetails
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
executionId:
{
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 ,
}
{
status:
{
Description: The status of the execution. ,
Required: False ,
}
string ,
startedAt:
{
Description: String that represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
stoppedAt:
{
Description: String that represents the stop date time. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Resource provisioning state. Not currently in use for executions. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: The reason why the execution failed. ,
Required: False ,
}
string ,
lastActionAt:
{
Description: String that represents the last action 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 ,
}
,
]
,
}
,
}
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: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
experimentName:
{
Description: String that represents a Experiment resource name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateAccesses_List (new)
Description :  Get a list of private access resources in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/privateAccesses
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
continuationToken:
{
Description: String that sets the continuation token. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateAccess items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given privateAccess resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connection. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Pending status. ,
Approved: Approved status. ,
Rejected: Rejected status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public Network Access Control for PrivateAccess resource. ,
Enum:
{
Enabled: Enabled access. ,
Disabled: Disabled access. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
PrivateAccesses_Get (new)
Description :  Get a private access resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/privateAccesses/{privateAccessName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateAccessName:
{
Description: The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given privateAccess resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connection. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Pending status. ,
Approved: Approved status. ,
Rejected: Rejected status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public Network Access Control for PrivateAccess resource. ,
Enum:
{
Enabled: Enabled access. ,
Disabled: Disabled access. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
PrivateAccesses_CreateOrUpdate (new)
Description :  Create or update a private access
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/privateAccesses/{privateAccessName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateAccessName:
{
Description: The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
resource:
{
Description: private access resource to be created or updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given privateAccess resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connection. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Pending status. ,
Approved: Approved status. ,
Rejected: Rejected status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public Network Access Control for PrivateAccess resource. ,
Enum:
{
Enabled: Enabled access. ,
Disabled: Disabled access. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given privateAccess resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connection. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Pending status. ,
Approved: Approved status. ,
Rejected: Rejected status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public Network Access Control for PrivateAccess resource. ,
Enum:
{
Enabled: Enabled access. ,
Disabled: Disabled access. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: PrivateAccesses tracked resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given privateAccess resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connection. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Pending status. ,
Approved: Approved status. ,
Rejected: Rejected status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public Network Access Control for PrivateAccess resource. ,
Enum:
{
Enabled: Enabled access. ,
Disabled: Disabled access. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
PrivateAccesses_Update (new)
Description :  Patch a private access tags
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/privateAccesses/{privateAccessName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateAccessName:
{
Description: The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
properties:
{
Description: private access resource's tags to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: True ,
}
{
provisioningState:
{
Description: Most recent provisioning state for the given privateAccess resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: A readonly collection of private endpoint connection. Currently only one endpoint connection is supported. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Pending status. ,
Approved: Approved status. ,
Rejected: Rejected status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Public Network Access Control for PrivateAccess resource. ,
Enum:
{
Enabled: Enabled access. ,
Disabled: Disabled access. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateAccesses_Delete (new)
Description :  Delete a private access
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/privateAccesses/{privateAccessName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateAccessName:
{
Description: The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateAccesses_ListPrivateEndpointConnections (new)
Description :  List information about private endpoint connections under a private access resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/privateAccesses/{privateAccessName}/privateEndpointConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateAccessName:
{
Description: The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateEndpointConnection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Pending status. ,
Approved: Approved status. ,
Rejected: Rejected status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}
PrivateAccesses_GetAPrivateEndpointConnection (new)
Description :  Gets information about a private endpoint connection under a private access resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/privateAccesses/{privateAccessName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateAccessName:
{
Description: The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: Pending status. ,
Approved: Approved status. ,
Rejected: Rejected status. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
PrivateAccesses_DeleteAPrivateEndpointConnection (new)
Description :  Deletes a private endpoint connection under a private access resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/privateAccesses/{privateAccessName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateAccessName:
{
Description: The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateAccesses_GetPrivateLinkResources (new)
Description :  Gets the private link resources possible under private access resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/privateAccesses/{privateAccessName}/privateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateAccessName:
{
Description: The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateLinkResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: True ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Resource provisioning state. Not currently in use. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Creating: Initial creation in progress. ,
Updating: Update in progress. ,
Deleting: Deletion in progress. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
}
,
]
,
}
,
}