Skip to content

Commit b19a2d3

Browse files
authored
Update breakingchange-for-autogen-module.md (#18933)
* Update breakingchange-for-autogen-module.md * Update breakingchange-for-autogen-module.md
1 parent f52066b commit b19a2d3

File tree

1 file changed

+53
-53
lines changed

1 file changed

+53
-53
lines changed

documentation/development-docs/breakingchange-for-autogen-module.md

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -13,95 +13,95 @@ Breaking changes and preview messages for auto gen cmdlets are added through dir
1313

1414
```yaml
1515
- where:
16-
verb: (.*)
17-
set:
18-
breaking-change:
19-
deprecated-by-version: 5.0.0
20-
change-effective-date: 2055/10/30
16+
verb: (.*)
17+
set:
18+
breaking-change:
19+
deprecated-by-version: 5.0.0
20+
change-effective-date: 2055/10/30
2121
```
2222
2323
## Case 2 — Breaking change for a cmdlet
2424
2525
```yaml
2626
- where:
27-
verb: New
28-
subject: VNetPeering
29-
set:
30-
breaking-change:
31-
replacement-cmdlet: New-AzNewVNetPeering
32-
deprecated-by-version: 5.0.0
33-
change-effective-date: 2022/05/30
27+
verb: New
28+
subject: VNetPeering
29+
set:
30+
breaking-change:
31+
replacement-cmdlet: New-AzNewVNetPeering
32+
deprecated-by-version: 5.0.0
33+
change-effective-date: 2022/05/30
3434
```
3535
3636
## Case 3 — Breaking change for multiple cmdlets
3737
3838
```yaml
3939
- where:
40-
subject: VNetPeering
41-
set:
42-
breaking-change:
43-
replacement-cmdlet: $.replace("VNetPeering", "VNewNetPeering")
44-
deprecated-by-version: 5.0.0
45-
change-effective-date: 2022/05/30
40+
subject: VNetPeering
41+
set:
42+
breaking-change:
43+
replacement-cmdlet: $.replace("VNetPeering", "VNewNetPeering")
44+
deprecated-by-version: 5.0.0
45+
change-effective-date: 2022/05/30
4646
```
4747
4848
## Case 4 — Breaking change for an output type
4949
5050
```yaml
5151
- where:
52-
verb: New
53-
subject: VNetPeering
54-
set:
55-
breaking-change:
56-
deprecated-cmdlet-output-type: oldtype
57-
replacement-cmdlet-output-type: newtype
58-
deprecated-output-properties:
59-
- propertyA
60-
- PropertyB
61-
new-output-properties:
62-
- PropertyC
63-
- PropertyD
64-
change-description: This is a custom message for the change.
65-
deprecated-by-version: 5.0.0
66-
change-effective-date: 2022/05/11
52+
verb: New
53+
subject: VNetPeering
54+
set:
55+
breaking-change:
56+
deprecated-cmdlet-output-type: oldtype
57+
replacement-cmdlet-output-type: newtype
58+
deprecated-output-properties:
59+
- propertyA
60+
- PropertyB
61+
new-output-properties:
62+
- PropertyC
63+
- PropertyD
64+
change-description: This is a custom message for the change.
65+
deprecated-by-version: 5.0.0
66+
change-effective-date: 2022/05/11
6767
```
6868
6969
## Case 5 — Breaking change for parameter sets(variants)
7070
7171
```yaml
7272
- where:
73-
verb: Remove
74-
subject: VNetPeering
75-
variant: Delete
76-
set:
77-
breaking-change:
78-
deprecated-by-version: 5.0.0
79-
change-efective-date: 2022/05/30
73+
verb: Remove
74+
subject: VNetPeering
75+
variant: Delete
76+
set:
77+
breaking-change:
78+
deprecated-by-version: 5.0.0
79+
change-effective-date: 2022/05/30
8080
```
8181
8282
## Case 6 — Breaking change for a parameter
8383
8484
```yaml
8585
- where:
86-
parameter-name: Sku
87-
set:
88-
breaking-change:
89-
old-parameter-type: int
90-
new-parameter-type: boolean
91-
become-mandatory: true
92-
change-description: This is a custom message for the change.
93-
deprecated-by-version: 5.0.0
94-
change-efective-date: 2022/05/30
86+
parameter-name: Sku
87+
set:
88+
breaking-change:
89+
old-parameter-type: int
90+
new-parameter-type: boolean
91+
become-mandatory: true
92+
change-description: This is a custom message for the change.
93+
deprecated-by-version: 5.0.0
94+
change-effective-date: 2022/05/30
9595
```
9696
9797
## Case 7 — Preview message
9898
9999
```yaml
100100
- where:
101-
verb: New
102-
subject: VNetPeering
103-
set:
104-
preview-message: This is a test preview message.
101+
verb: New
102+
subject: VNetPeering
103+
set:
104+
preview-message: This is a test preview message.
105105
```
106106
107107
# For customized cmdlets

0 commit comments

Comments
 (0)