Skip to content

Commit 7f7d547

Browse files
authored
Documentation for autorest v4 features (#27494)
1 parent 94a12c8 commit 7f7d547

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Autorest PowerShell V4 Features from the End Users' Perspective
2+
3+
## 1. Support for piping parent object:
4+
This allows users to pipe parent objects into cmdlets, simplifying commands.
5+
6+
## 2. Progress bar for long running operations:
7+
Users will see a visual indicator during long operations. Important to note it's just visual, no impact on functionality.
8+
9+
## 3. Auto completer for enum parameters:
10+
Enums are now strings with tab completion. Users can still tab through possible values, which is more flexible.
11+
12+
## 4. Switch between table and list views:
13+
Automatically changes based on the number of results. Single result shows detailed list, multiple show concise table.
14+
15+
## 5. ExternalDocs in help:
16+
Adds links to external documentation directly in the cmdlet help. Helps users find more info easily.
17+
18+
## 6. Non-fixed size arrays:
19+
Now lists instead of fixed arrays, making it easier to add elements. Simplifies scripting.
20+
21+
## 7. Removal of API version from namespace:
22+
More consistent naming in generated code, but users probably won't notice unless they work with the code directly.
23+
24+
## 8. JSON import for resources:
25+
Users can create resources via JSON files or strings. Provides flexibility, especially for complex configurations.
26+
27+
## 9. x-ms-mutability support:
28+
Better handling of create vs update operations based on HTTP methods. Helps ensure correct cmdlet usage.
29+
30+
## 10. Managed Identity alignment:
31+
Changes parameter types for identity settings. Users need to adjust to new parameter names and types (switch parameters for enabling, string arrays for identities).
32+
33+
## 11. Retry policies:
34+
Automatically retries on certain errors. Users benefit from increased reliability. Can configure via environment variables.
35+
36+
## 12. Update via GET and PUT:
37+
For resources without PATCH, updates use GET then PUT. Might affect performance but ensures compatibility. Conflicts possible, so mention the disable option.
38+
39+
## 13. Discriminator parameter hidden:
40+
Removes redundant parameters in model cmdlets, making them cleaner. Users won't have to input fixed values.

0 commit comments

Comments
 (0)