forked from Azure/azure-powershell
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[SelfHelp] Add new API version 2024-03-01-preview support for AzSelfH…
…elp cmdlets for Help Resource Provider (Azure#24547) * initial commit for SelfHelp new version * Adding files generated by build-module powershell file * Updating Test files * Added unit tests * Adding examples * Updating DiscoverySolutions examples * Updating examples * Added LiveOnly tag to tests
- Loading branch information
1 parent
eaf2ecf
commit 7937b38
Showing
80 changed files
with
3,509 additions
and
950 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
src/SelfHelp/SelfHelp.Autorest/UX/Microsoft.Help/diagnostics.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
src/SelfHelp/SelfHelp.Autorest/UX/Microsoft.Help/selfHelp.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| { | ||
| "resourceType": "selfHelp", | ||
| "apiVersion": "2024-03-01-preview", | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.selfhelp" | ||
| }, | ||
| "commands": [ | ||
| { | ||
| "name": "Get-AzSelfHelpSolutionSelfHelp", | ||
| "description": "Finds and Executes a Self Help Solution based on the Solution Id.\nThese are static self help content to help users troubleshoot their issues.", | ||
| "path": "/providers/Microsoft.Help/selfHelp/{solutionId}", | ||
| "help": { | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.selfhelp/get-azselfhelpsolutionselfhelp" | ||
| }, | ||
| "parameterSets": [ | ||
| { | ||
| "parameters": [ | ||
| "-SolutionId <String>" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "examples": [ | ||
| { | ||
| "description": "Finds and Executes a Self Help Solution based on the Solution Id. These are static self help content to help users troubleshoot their issues.", | ||
| "parameters": [ | ||
| { | ||
| "name": "-SolutionId", | ||
| "value": "[Path.solutionId]" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
42 changes: 42 additions & 0 deletions
42
src/SelfHelp/SelfHelp.Autorest/UX/Microsoft.Help/simplifiedSolutions.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| { | ||
| "resourceType": "simplifiedSolutions", | ||
| "apiVersion": "2024-03-01-preview", | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.selfhelp" | ||
| }, | ||
| "commands": [ | ||
| { | ||
| "name": "Get-AzSelfHelpSimplifiedSolution", | ||
| "description": "Get the simplified Solutions using the applicable solutionResourceName while creating the simplified Solutions.", | ||
| "path": "/{scope}/providers/Microsoft.Help/simplifiedSolutions/{simplifiedSolutionsResourceName}", | ||
| "help": { | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.selfhelp/get-azselfhelpsimplifiedsolution" | ||
| }, | ||
| "parameterSets": [ | ||
| { | ||
| "parameters": [ | ||
| "-SResourceName <String>", | ||
| "-Scope <String>" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "examples": [ | ||
| { | ||
| "description": "Get the simplified Solutions using the applicable solutionResourceName while creating the simplified Solutions.", | ||
| "parameters": [ | ||
| { | ||
| "name": "-SResourceName", | ||
| "value": "[Path.simplifiedSolutionsResourceName]" | ||
| }, | ||
| { | ||
| "name": "-Scope", | ||
| "value": "[Path.scope]" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
75 changes: 75 additions & 0 deletions
75
src/SelfHelp/SelfHelp.Autorest/UX/Microsoft.Help/solutions.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| { | ||
| "resourceType": "solutions", | ||
| "apiVersion": "2024-03-01-preview", | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.selfhelp" | ||
| }, | ||
| "commands": [ | ||
| { | ||
| "name": "Get-AzSelfHelpSolution", | ||
| "description": "Get the solution using the applicable solutionResourceName while creating the solution.", | ||
| "path": "/{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}", | ||
| "help": { | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.selfhelp/get-azselfhelpsolution" | ||
| }, | ||
| "parameterSets": [ | ||
| { | ||
| "parameters": [ | ||
| "-ResourceName <String>", | ||
| "-Scope <String>" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "examples": [ | ||
| { | ||
| "description": "Get the solution using the applicable solutionResourceName while creating the solution.", | ||
| "parameters": [ | ||
| { | ||
| "name": "-ResourceName", | ||
| "value": "[Path.solutionResourceName]" | ||
| }, | ||
| { | ||
| "name": "-Scope", | ||
| "value": "[Path.scope]" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "Invoke-AzSelfHelpWarmSolutionUp", | ||
| "description": "Warm up the solution resource by preloading asynchronous diagnostics results into cache", | ||
| "path": "/{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}/warmup", | ||
| "help": { | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.selfhelp/invoke-azselfhelpwarmsolutionup" | ||
| }, | ||
| "parameterSets": [ | ||
| { | ||
| "parameters": [ | ||
| "-Scope <String>", | ||
| "-SolutionResourceName <String>" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "examples": [ | ||
| { | ||
| "description": "Warm up the solution resource by preloading asynchronous diagnostics results into cache", | ||
| "parameters": [ | ||
| { | ||
| "name": "-Scope", | ||
| "value": "[Path.scope]" | ||
| }, | ||
| { | ||
| "name": "-SolutionResourceName", | ||
| "value": "[Path.solutionResourceName]" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
141 changes: 141 additions & 0 deletions
141
src/SelfHelp/SelfHelp.Autorest/UX/Microsoft.Help/troubleshooters.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| { | ||
| "resourceType": "troubleshooters", | ||
| "apiVersion": "2024-03-01-preview", | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.selfhelp" | ||
| }, | ||
| "commands": [ | ||
| { | ||
| "name": "Get-AzSelfHelpTroubleshooter", | ||
| "description": "Gets troubleshooter instance result which includes the step status/result of the troubleshooter resource name that is being executed.<br/> Get API is used to retrieve the result of a Troubleshooter instance, which includes the status and result of each step in the Troubleshooter workflow.\nThis API requires the Troubleshooter resource name that was created using the Create API.", | ||
| "path": "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}", | ||
| "help": { | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.selfhelp/get-azselfhelptroubleshooter" | ||
| }, | ||
| "parameterSets": [ | ||
| { | ||
| "parameters": [ | ||
| "-Name <String>", | ||
| "-Scope <String>" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "examples": [ | ||
| { | ||
| "description": "Gets troubleshooter instance result which includes the step status/result of the troubleshooter resource name that is being executed.<br/> Get API is used to retrieve the result of a Troubleshooter instance, which includes the status and result of each step in the Troubleshooter workflow. This API requires the Troubleshooter resource name that was created using the Create API.", | ||
| "parameters": [ | ||
| { | ||
| "name": "-Name", | ||
| "value": "[Path.troubleshooterName]" | ||
| }, | ||
| { | ||
| "name": "-Scope", | ||
| "value": "[Path.scope]" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "Invoke-AzSelfHelpContinueTroubleshooter", | ||
| "description": "Uses ‘stepId’ and ‘responses’ as the trigger to continue the troubleshooting steps for the respective troubleshooter resource name.\n<br/>Continue API is used to provide inputs that are required for the specific troubleshooter to progress into the next step in the process.\nThis API is used after the Troubleshooter has been created using the Create API.", | ||
| "path": "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/continue", | ||
| "help": { | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.selfhelp/invoke-azselfhelpcontinuetroubleshooter" | ||
| }, | ||
| "parameterSets": [ | ||
| { | ||
| "parameters": [ | ||
| "-Scope <String>", | ||
| "-TroubleshooterName <String>" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "examples": [ | ||
| { | ||
| "description": "Uses ‘stepId’ and ‘responses’ as the trigger to continue the troubleshooting steps for the respective troubleshooter resource name. <br/>Continue API is used to provide inputs that are required for the specific troubleshooter to progress into the next step in the process. This API is used after the Troubleshooter has been created using the Create API.", | ||
| "parameters": [ | ||
| { | ||
| "name": "-Scope", | ||
| "value": "[Path.scope]" | ||
| }, | ||
| { | ||
| "name": "-TroubleshooterName", | ||
| "value": "[Path.troubleshooterName]" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "Restart-AzSelfHelpTroubleshooter", | ||
| "description": "Restarts the troubleshooter API using applicable troubleshooter resource name as the input.<br/> It returns new resource name which should be used in subsequent request.\nThe old resource name is obsolete after this API is invoked.", | ||
| "path": "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/restart", | ||
| "help": { | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.selfhelp/restart-azselfhelptroubleshooter" | ||
| }, | ||
| "parameterSets": [ | ||
| { | ||
| "parameters": [ | ||
| "-Name <String>", | ||
| "-Scope <String>" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "examples": [ | ||
| { | ||
| "description": "Restarts the troubleshooter API using applicable troubleshooter resource name as the input.<br/> It returns new resource name which should be used in subsequent request. The old resource name is obsolete after this API is invoked.", | ||
| "parameters": [ | ||
| { | ||
| "name": "-Name", | ||
| "value": "[Path.troubleshooterName]" | ||
| }, | ||
| { | ||
| "name": "-Scope", | ||
| "value": "[Path.scope]" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "Stop-AzSelfHelpTroubleshooter", | ||
| "description": "Ends the troubleshooter action", | ||
| "path": "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/end", | ||
| "help": { | ||
| "learnMore": { | ||
| "url": "https://learn.microsoft.com/powershell/module/az.selfhelp/stop-azselfhelptroubleshooter" | ||
| }, | ||
| "parameterSets": [ | ||
| { | ||
| "parameters": [ | ||
| "-Name <String>", | ||
| "-Scope <String>" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "examples": [ | ||
| { | ||
| "description": "Ends the troubleshooter action", | ||
| "parameters": [ | ||
| { | ||
| "name": "-Name", | ||
| "value": "[Path.troubleshooterName]" | ||
| }, | ||
| { | ||
| "name": "-Scope", | ||
| "value": "[Path.scope]" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.