Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
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
15 changes: 14 additions & 1 deletion Commands/self-help/_check-name-availability.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# [Command] _self-help check-name-availability_

This API is used to check the uniqueness of a resource name used for a diagnostic check.
This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions

## Versions

Expand All @@ -14,3 +14,16 @@ This API is used to check the uniqueness of a resource name used for a diagnosti
```bash
self-help check-name-availability --scope subscriptionId/{subId} --name {diagnostic-name} --type 'Microsoft.Help/diagnostics'
```

### [2023-09-01-preview](/Resources/mgmt-plane/L3tzY29wZX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oZWxwL2NoZWNrbmFtZWF2YWlsYWJpbGl0eQ==/2023-09-01-preview.xml) **Preview**

<!-- mgmt-plane /{scope}/providers/microsoft.help/checknameavailability 2023-09-01-preview -->

#### examples

- Check Resource Uniqueness
```bash
self-help check-name-availability --scope subscriptions/00000000-0000-0000-0000-000000000000 --name diagnostic-name --type 'Microsoft.Help/diagnostics'
self-help check-name-availability --scope subscriptions/00000000-0000-0000-0000-000000000000 --name solution-name --type 'Microsoft.Help/solutions'
self-help check-name-availability --scope subscriptions/00000000-0000-0000-0000-000000000000 --name 12345678-BBBb-cCCCC-0000-123456789012 --type 'Microsoft.Help/troubleshooters'
```
11 changes: 11 additions & 0 deletions Commands/self-help/diagnostic/_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Creates a diagnostics that will help you troubleshoot an issue with your azure r
```bash
self-help diagnostic create --diagnostic-name {diagnostic-name} --insights [{solutionId:Demo2InsightV2}] --scope {scope}
```

### [2023-09-01-preview](/Resources/mgmt-plane/L3tzY29wZX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oZWxwL2RpYWdub3N0aWNzL3t9/2023-09-01-preview.xml) **Preview**

<!-- mgmt-plane /{scope}/providers/microsoft.help/diagnostics/{} 2023-09-01-preview -->

#### examples

- Create Diagnostic at Resource Level
```bash
self-help diagnostic create --diagnostic-name diagnostic-name --insights [{solutionId:Demo2InsightV2}] --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```
11 changes: 11 additions & 0 deletions Commands/self-help/diagnostic/_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,14 @@ Get the diagnostics using the 'diagnosticsResourceName' you chose while creating
```bash
self-help diagnostic show --diagnostic-name {diagnostic-name} --scope {scope}
```

### [2023-09-01-preview](/Resources/mgmt-plane/L3tzY29wZX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oZWxwL2RpYWdub3N0aWNzL3t9/2023-09-01-preview.xml) **Preview**

<!-- mgmt-plane /{scope}/providers/microsoft.help/diagnostics/{} 2023-09-01-preview -->

#### examples

- Show Diagnostic at Resource Level
```bash
self-help diagnostic show --diagnostic-name diagnostic-name --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```
13 changes: 12 additions & 1 deletion Commands/self-help/discovery-solution/_list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# [Command] _self-help discovery-solution list_

list the existing available solutions for the problemClassificationId or the resourceUri for the Azure resource.
List the relevant Azure diagnostics and solutions using problemClassificationId API AND resourceUri or resourceType.

## Versions

Expand All @@ -14,3 +14,14 @@ list the existing available solutions for the problemClassificationId or the res
```bash
self-help discovery-solution list --scope {scope}
```

### [2023-09-01-preview](/Resources/mgmt-plane/L3tzY29wZX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oZWxwL2Rpc2NvdmVyeXNvbHV0aW9ucw==/2023-09-01-preview.xml) **Preview**

<!-- mgmt-plane /{scope}/providers/microsoft.help/discoverysolutions 2023-09-01-preview -->

#### examples

- List DiscoverySolution results for a resource
```bash
self-help discovery-solution list --filter "ProblemClassificationId eq '00000000-0000-0000-0000-000000000000'" --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```
2 changes: 1 addition & 1 deletion Commands/self-help/discovery-solution/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ discovery-solution command will help you discover available solutions based on y
## Commands

- [list](/Commands/self-help/discovery-solution/_list.md)
: list the existing available solutions for the problemClassificationId or the resourceUri for the Azure resource.
: List the relevant Azure diagnostics and solutions using problemClassificationId API AND resourceUri or resourceType.
8 changes: 7 additions & 1 deletion Commands/self-help/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ Azure SelfHelp will help you troubleshoot issues with Azure resources.
- [discovery-solution](/Commands/self-help/discovery-solution/readme.md)
: discovery-solution command will help you discover available solutions based on your resource type and problem classification Id.

- [solution](/Commands/self-help/solution/readme.md)
: solution command will help you create solutions for azure resources.

- [troubleshooter](/Commands/self-help/troubleshooter/readme.md)
: troubleshooter command will help you create troubleshooters for azure resources.

## Commands

- [check-name-availability](/Commands/self-help/_check-name-availability.md)
: This API is used to check the uniqueness of a resource name used for a diagnostic check.
: This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions
16 changes: 16 additions & 0 deletions Commands/self-help/solution/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _self-help solution create_

Create a solution for the specific Azure resource or subscription using the triggering criteria from discovery solutions.

## Versions

### [2023-09-01-preview](/Resources/mgmt-plane/L3tzY29wZX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oZWxwL3NvbHV0aW9ucy97fQ==/2023-09-01-preview.xml) **Preview**

<!-- mgmt-plane /{scope}/providers/microsoft.help/solutions/{} 2023-09-01-preview -->

#### examples

- Create Solution at Resource Level
```bash
self-help solution create --solution-name solution-name --trigger-criteria [{name:solutionid,value:Demo2InsightV2}] --parameters {} --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```
16 changes: 16 additions & 0 deletions Commands/self-help/solution/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _self-help solution show_

Get the solution using the applicable solutionResourceName while creating the solution.

## Versions

### [2023-09-01-preview](/Resources/mgmt-plane/L3tzY29wZX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oZWxwL3NvbHV0aW9ucy97fQ==/2023-09-01-preview.xml) **Preview**

<!-- mgmt-plane /{scope}/providers/microsoft.help/solutions/{} 2023-09-01-preview -->

#### examples

- Show Solution at Resource Level
```bash
self-help solution show --solution-name solution-name --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```
16 changes: 16 additions & 0 deletions Commands/self-help/solution/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _self-help solution update_

Update a solution for the specific Azure resource or subscription using the triggering criteria from discovery solutions.

## Versions

### [2023-09-01-preview](/Resources/mgmt-plane/L3tzY29wZX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oZWxwL3NvbHV0aW9ucy97fQ==/2023-09-01-preview.xml) **Preview**

<!-- mgmt-plane /{scope}/providers/microsoft.help/solutions/{} 2023-09-01-preview -->

#### examples

- Update Solution at Resource Level
```bash
self-help solution update --solution-name solution-name --trigger-criteria [{name:ReplacementKey,value:<!--56ee7509-92e1-4b9e-97c2-dda53065294c-->}] --parameters {SearchText:CanNotRDP,SymptomId:KeyVaultVaultNotFoundInsight} --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```
14 changes: 14 additions & 0 deletions Commands/self-help/solution/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# [Group] _self-help solution_

solution command will help you create solutions for azure resources.

## Commands

- [create](/Commands/self-help/solution/_create.md)
: Create a solution for the specific Azure resource or subscription using the triggering criteria from discovery solutions.

- [show](/Commands/self-help/solution/_show.md)
: Get the solution using the applicable solutionResourceName while creating the solution.

- [update](/Commands/self-help/solution/_update.md)
: Update a solution for the specific Azure resource or subscription using the triggering criteria from discovery solutions.
16 changes: 16 additions & 0 deletions Commands/self-help/troubleshooter/_continue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _self-help troubleshooter continue_

Uses stepId and responses as the trigger to continue the troubleshooting steps for the respective troubleshooter resource name.

## Versions

### [2023-09-01-preview](/Resources/mgmt-plane/L3tzY29wZX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oZWxwL3Ryb3VibGVzaG9vdGVycy97fS9jb250aW51ZQ==/2023-09-01-preview.xml) **Preview**

<!-- mgmt-plane /{scope}/providers/microsoft.help/troubleshooters/{}/continue 2023-09-01-preview -->

#### examples

- Continue Troubleshooter at Resource Level
```bash
self-help troubleshooter continue --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --step-id step-id --responses [] --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```
16 changes: 16 additions & 0 deletions Commands/self-help/troubleshooter/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _self-help troubleshooter create_

Create the specific troubleshooter action under a resource or subscription.

## Versions

### [2023-09-01-preview](/Resources/mgmt-plane/L3tzY29wZX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oZWxwL3Ryb3VibGVzaG9vdGVycy97fQ==/2023-09-01-preview.xml) **Preview**

<!-- mgmt-plane /{scope}/providers/microsoft.help/troubleshooters/{} 2023-09-01-preview -->

#### examples

- Create Troubleshooter at Resource Level
```bash
self-help troubleshooter create --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --solution-id e104dbdf-9e14-4c9f-bc78-21ac90382231 --parameters {ResourceUri:'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'} --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```
16 changes: 16 additions & 0 deletions Commands/self-help/troubleshooter/_end.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _self-help troubleshooter end_

Ends the troubleshooter action

## Versions

### [2023-09-01-preview](/Resources/mgmt-plane/L3tzY29wZX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oZWxwL3Ryb3VibGVzaG9vdGVycy97fS9lbmQ=/2023-09-01-preview.xml) **Preview**

<!-- mgmt-plane /{scope}/providers/microsoft.help/troubleshooters/{}/end 2023-09-01-preview -->

#### examples

- End Troubleshooter at Resource Level
```bash
self-help troubleshooter end --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```
16 changes: 16 additions & 0 deletions Commands/self-help/troubleshooter/_restart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _self-help troubleshooter restart_

Restarts the troubleshooter API using applicable troubleshooter resource name as the input.

## Versions

### [2023-09-01-preview](/Resources/mgmt-plane/L3tzY29wZX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oZWxwL3Ryb3VibGVzaG9vdGVycy97fS9yZXN0YXJ0/2023-09-01-preview.xml) **Preview**

<!-- mgmt-plane /{scope}/providers/microsoft.help/troubleshooters/{}/restart 2023-09-01-preview -->

#### examples

- Restart Troubleshooter at Resource Level
```bash
self-help troubleshooter restart --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```
16 changes: 16 additions & 0 deletions Commands/self-help/troubleshooter/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _self-help troubleshooter show_

Get troubleshooter instance result which includes the step status/result of the troubleshooter resource name that is being executed.

## Versions

### [2023-09-01-preview](/Resources/mgmt-plane/L3tzY29wZX0vcHJvdmlkZXJzL21pY3Jvc29mdC5oZWxwL3Ryb3VibGVzaG9vdGVycy97fQ==/2023-09-01-preview.xml) **Preview**

<!-- mgmt-plane /{scope}/providers/microsoft.help/troubleshooters/{} 2023-09-01-preview -->

#### examples

- Show Troubleshooter at Resource Level
```bash
self-help troubleshooter show --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --scope 'subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```
20 changes: 20 additions & 0 deletions Commands/self-help/troubleshooter/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# [Group] _self-help troubleshooter_

troubleshooter command will help you create troubleshooters for azure resources.

## Commands

- [continue](/Commands/self-help/troubleshooter/_continue.md)
: Uses stepId and responses as the trigger to continue the troubleshooting steps for the respective troubleshooter resource name.

- [create](/Commands/self-help/troubleshooter/_create.md)
: Create the specific troubleshooter action under a resource or subscription.

- [end](/Commands/self-help/troubleshooter/_end.md)
: Ends the troubleshooter action

- [restart](/Commands/self-help/troubleshooter/_restart.md)
: Restarts the troubleshooter API using applicable troubleshooter resource name as the input.

- [show](/Commands/self-help/troubleshooter/_show.md)
: Get troubleshooter instance result which includes the step status/result of the troubleshooter resource name that is being executed.
Loading