Skip to content

[Chaos] Re-target Az.Chaos to Microsoft.Chaos 2026-05-01-preview (V2) #29866

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kekivelez wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

[Chaos] Re-target Az.Chaos to Microsoft.Chaos 2026-05-01-preview (V2) #29866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8f56996
Re-target Az.Chaos driver to Microsoft.Chaos 2026-05-01-preview (V2)
Jul 21, 2026
4e5aaca
PS4: Author examples, regenerate help, and record ChangeLog entries
Jul 21, 2026
4863441
PS5: Add StaticAnalysis exceptions and finalize V2 porcelain for pull…
Jul 21, 2026
dddd6a4
fix: remove untraceable SENTRECURSIVE swagger directive from Chaos PS…
Jul 21, 2026
d3d0cd1
Fix Az.Chaos V2 regeneration trigger and wrapper manifest exports
Jul 22, 2026
561b608
Fix Az.Chaos model-cmdlet generation for the physicalZones description
Jul 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
232 changes: 90 additions & 142 deletions src/Chaos/Chaos.Autorest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,11 @@ For information on how to develop for `Az.Chaos`, see [how-to.md](how-to.md).
> see https://aka.ms/autorest

``` yaml
commit: 907b79c0a6a660826e54dc1f16ea14b831b201d2
commit: f228b86c72657cd366e26c77420bfbd436938821
require:
- $(this-folder)/../../readme.azure.noprofile.md
input-file:
- $(repo)/specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/capabilities.json
- $(repo)/specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/capabilityTypes.json
- $(repo)/specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/experiments.json
- $(repo)/specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/operationStatuses.json
- $(repo)/specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/operations.json
- $(repo)/specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/targetTypes.json
- $(repo)/specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/targets.json
- $(repo)/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/preview/2026-05-01-preview/openapi.json

title: Chaos
module-version: 0.1.0
Expand All @@ -46,158 +40,112 @@ subject-prefix: $(service-name)
identity-correction-for-post: true

directive:
- from: swagger-document
where: $.definitions.TrackedResource.properties.location
transform: >-
return {
"type": "string",
"x-ms-mutability": [
"read",
"create",
"update"
],
"description": "The geo-location where the resource lives"
}

- from: swagger-document
where: $.definitions.target
transform: >-
return {
"type": "object",
"description": "Model that represents a Target resource.",
"allOf": [
{
"$ref": "https://github.com/Azure/azure-rest-api-specs/blob/907b79c0a6a660826e54dc1f16ea14b831b201d2/specification/common-types/resource-management/v2/types.json#/definitions/Resource"
}
],
"properties": {
"systemData": {
"description": "The system metadata of the target resource.",
"$ref": "https://github.com/Azure/azure-rest-api-specs/blob/907b79c0a6a660826e54dc1f16ea14b831b201d2/specification/common-types/resource-management/v2/types.json#/definitions/systemData",
"readOnly": true
},
"location": {
"type": "string",
"description": "Location of the target resource."
},
"properties": {
"description": "The properties of the target resource.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/targetProperties"
}
}
}

- from: swagger-document
where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}"].delete.responses
transform: >-
return {
"200": {
"description": "OK"
},
"202": {
"description": "Asynchronous delete operation."
},
"default": {
"description": "Error response returned if request was unsuccessful.",
"schema": {
"$ref": "https://github.com/Azure/azure-rest-api-specs/blob/907b79c0a6a660826e54dc1f16ea14b831b201d2/specification/common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
}

- from: swagger-document
where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}"].patch.responses
transform: >-
return {
"200": {
"description": "Long running replace experiment operation.",
"schema": {
"$ref": "./types/experiments.json#/definitions/experiment"
}
},
"202": {
"description": "Long running update operation.",
"schema": {
"$ref": "./types/experiments.json#/definitions/experiment"
}
},
"default": {
"description": "Error response returned if request was unsuccessful.",
"schema": {
"$ref": "https://github.com/Azure/azure-rest-api-specs/blob/907b79c0a6a660826e54dc1f16ea14b831b201d2/specification/common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
}

- from: swagger-document
where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/start"].post.responses
transform: >-
return {
"200": {
"description": "Ok.",
"schema": {
"$ref": "./types/experiments.json#/definitions/experiment"
}
},
"202": {
"description": "Long running start experiment operation."
},
"default": {
"description": "Error response returned if request was unsuccessful.",
"schema": {
"$ref": "https://github.com/Azure/azure-rest-api-specs/blob/907b79c0a6a660826e54dc1f16ea14b831b201d2/specification/common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
}

# --- Sanitize the ConfigurationFilters.physicalZones description at the swagger
# source. The generator escapes a double quote as a backtick-quote pair but
# emits the source description's own backticks verbatim. The source text
# contains a backtick immediately before a quote, so the generated
# double-quoted HelpMessage string terminates early and the model-cmdlet
# proxy fails to parse. Restate the description without that sequence. The
# sibling zones description contains quotes but no backtick before a quote,
# so it generates valid PowerShell and needs no transform. ---
- from: swagger-document
where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/cancel"].post.responses
where: $..physicalZones
transform: >-
return {
"200": {
"description": "Ok.",
"schema": {
"$ref": "./types/experiments.json#/definitions/experiment"
}
},
"202": {
"description": "Long running start experiment operation."
},
"default": {
"description": "Error response returned if request was unsuccessful.",
"schema": {
"$ref": "https://github.com/Azure/azure-rest-api-specs/blob/907b79c0a6a660826e54dc1f16ea14b831b201d2/specification/common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
}
$.description = "Array of physical availability zone identifiers in '{region}-az{N}' format (for example, 'westus2-az1'). Only resources in the corresponding logical zone for each subscription are included. At execution time, each physical zone is resolved to per-subscription logical zones via the Azure locations API. The resolved mapping is surfaced on the scenario run response. Null or omitted means physical zone targeting is not used. Only one physical zone is supported in preview. Mutually exclusive with the zones filter; set one or the other, not both."

# --- Prune the retired V1 experiment-era nouns (PR2). The V2 openapi.json still
# carries the V1 surface, so directives remove every non-V2 noun. ---
- where:
subject: ^.*Experiment.*$
remove: true
- where:
subject: Capability
remove: true
- where:
verb: New
subject: Experiment
variant: ^CreateViaIdentityExpanded$|^CreateExpanded$
subject: CapabilityType
remove: true
- where:
subject: ^Target.*$
remove: true
- where:
subject: ^PrivateAccess.*$
remove: true
- where:
subject: ^PrivateEndpointConnection.*$
remove: true
- where:
subject: ^PrivateLinkResource.*$
remove: true
- where:
subject: ^OperationStatus.*$
remove: true
# --- Prune the action-catalog and operation-metadata nouns; they are not part
# of the V2 plumbing surface. ---
- where:
subject: ^Action.*$
remove: true
- where:
subject: Operation
remove: true

# --- V2 shaping: keep only the Expanded, JsonFilePath, and JsonString
# create/update variants; remove every other create/update variant. ---
- where:
variant: ^(Create|Update).*(?<!Expanded|JsonFilePath|JsonString)$
remove: true

- where:
variant: ^CreateViaIdentity$|^CreateViaIdentityExpanded$
remove: true
# --- CreateOrUpdate produces New-* only; remove the auto-generated Set-*. ---
- where:
verb: Set
remove: true

# --- Scenario and ScenarioConfiguration have no PATCH operation. Their PUT
# CreateOrUpdate must produce New-* only; remove the auto-generated Update-*.
# Only Workspaces_Update (PATCH) keeps an Update-* cmdlet. ---
- where:
subject: OperationStatuses
verb: Update
subject: Scenario
remove: true
- where:
verb: Update
subject: ScenarioConfiguration
remove: true

# --- Verb-noun renames to approved pairs. Validate->Test (DD2), Cancel->Stop
# (DD3), and Refresh->Update (DD5) are applied by the generator's native verb
# mapping. Execute and FixResourcePermissions need explicit renames. ---
# Execute keeps the Invoke verb; rename the subject to the Execution noun (DD7).
- where:
verb: Invoke
subject: ExecuteScenarioConfiguration
set:
subject: ScenarioConfigurationExecution
# FixResourcePermissions maps to the approved Repair verb (DD4).
- where:
verb: Invoke
subject: FixScenarioConfigurationResourcePermission
set:
verb: Repair
subject: ScenarioConfigurationResourcePermission

# --- Expose the server-side whatIf field under -WhatIfMode so it cannot collide
# with the common -WhatIf switch (DD4, DD8). ---
- where:
verb: Repair
subject: ScenarioConfigurationResourcePermission
parameter-name: WhatIf
set:
verb: Get
parameter-name: WhatIfMode

# --- V2 model helpers: the nested request-body models a user builds to call the
# V2 create cmdlets. ---
- model-cmdlet:
- model-name: Selector
- model-name: Step
- model-name: Branch
- model-name: Action
- model-name: ScenarioAction
- model-name: ScenarioParameter
- model-name: RunAfter
- model-name: ExternalResource
- model-name: KeyValuePair
- model-name: ConfigurationFilters
- model-name: ConfigurationExclusions
```
Loading