Updated example commands to be fake values as approver suggested.

This commit is contained in:
Arthur Wang 2023-10-20 11:00:31 -04:00
Родитель c0e268632d
Коммит 6f59112445
13 изменённых файлов: 28 добавлений и 28 удалений

Просмотреть файл

@ -23,7 +23,7 @@ This API is used to check the uniqueness of a resource name used for a diagnosti
- Check Resource Uniqueness
```bash
self-help check-name-availability --scope subscriptions/{subId} --name {diagnostic-name} --type 'Microsoft.Help/diagnostics'
self-help check-name-availability --scope subscriptions/{subId} --name {solution-name} --type 'Microsoft.Help/solutions'
self-help check-name-availability --scope subscriptions/{subId} --name {troubleshooter-name} --type 'Microsoft.Help/troubleshooters'
self-help check-name-availability --scope subscriptions/12345678-BBBb-cCCCC-0000-123456789012 --name diagnostic-name --type 'Microsoft.Help/diagnostics'
self-help check-name-availability --scope subscriptions/12345678-BBBb-cCCCC-0000-123456789012 --name solution-name --type 'Microsoft.Help/solutions'
self-help check-name-availability --scope subscriptions/12345678-BBBb-cCCCC-0000-123456789012 --name troubleshooter-name --type 'Microsoft.Help/troubleshooters'
```

Просмотреть файл

@ -23,5 +23,5 @@ Creates a diagnostics that will help you troubleshoot an issue with your azure r
- Create Diagnostic at Resource Level
```bash
self-help diagnostic create --diagnostic-name {diagnostic-name} --insights [{solutionId:Demo2InsightV2}] --scope {scope}
self-help diagnostic create --diagnostic-name diagnostic-name --insights [{solutionId:Demo2InsightV2}] --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```

Просмотреть файл

@ -23,5 +23,5 @@ Get the diagnostics using the 'diagnosticsResourceName' you chose while creating
- Show Diagnostic at Resource Level
```bash
self-help diagnostic show --diagnostic-name {diagnostic-name} --scope {scope}
self-help diagnostic show --diagnostic-name diagnostic-name --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```

Просмотреть файл

@ -23,5 +23,5 @@ List the relevant Azure diagnostics and solutions using problemClassificationId
- List DiscoverySolution results for a resource
```bash
self-help discovery-solution list --scope {scope}
self-help discovery-solution list --filter "ProblemClassificationId eq '00000000-0000-0000-0000-000000000000'" --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```

Просмотреть файл

@ -12,5 +12,5 @@ Create a solution for the specific Azure resource or subscription using the trig
- Create Solution at Resource Level
```bash
self-help solution create --solution-name {solution-name} --trigger-criteria {trigger-criteria} --parameters {parameters} --scope {scope}
self-help solution create --solution-name solution-name --trigger-criteria [{name:solutionid,value:Demo2InsightV2}] --parameters {} --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```

Просмотреть файл

@ -12,5 +12,5 @@ Get the solution using the applicable solutionResourceName while creating the so
- Show Solution at Resource Level
```bash
self-help solution show --solution-name {solution-name} --scope {scope}
self-help solution show --solution-name solution-name --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```

Просмотреть файл

@ -12,5 +12,5 @@ Update a solution for the specific Azure resource or subscription using the trig
- Update Solution at Resource Level
```bash
self-help solution update --solution-name {solution-name} --trigger-criteria {trigger-criteria} --parameters {parameters} --scope {scope}
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/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```

Просмотреть файл

@ -12,5 +12,5 @@ Uses stepId and responses as the trigger to continue the troubleshooting steps f
- Continue Troubleshooter at Resource Level
```bash
self-help troubleshooter continue --troubleshooter-name {troubleshooter-name} --step-id {step-id} --responses [] --scope {scope}
self-help troubleshooter continue --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --step-id step-id --responses [] --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```

Просмотреть файл

@ -12,5 +12,5 @@ Create the specific troubleshooter action under a resource or subscription.
- Create Troubleshooter at Resource Level
```bash
self-help troubleshooter create --troubleshooter-name {troubleshooter-name} --solution-id {solution-id} --parameters {parameters} --scope {scope}
self-help troubleshooter create --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --solution-id e104dbdf-9e14-4c9f-bc78-21ac90382231 --parameters {ResourceUri:'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'} --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```

Просмотреть файл

@ -12,5 +12,5 @@ Ends the troubleshooter action
- End Troubleshooter at Resource Level
```bash
self-help troubleshooter end --troubleshooter-name {troubleshooter-name} --scope {scope}
self-help troubleshooter end --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```

Просмотреть файл

@ -12,5 +12,5 @@ Restarts the troubleshooter API using applicable troubleshooter resource name as
- Restart Troubleshooter at Resource Level
```bash
self-help troubleshooter restart --troubleshooter-name {troubleshooter-name} --scope {scope}
self-help troubleshooter restart --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```

Просмотреть файл

@ -12,5 +12,5 @@ Get troubleshooter instance result which includes the step status/result of the
- Show Troubleshooter at Resource Level
```bash
self-help troubleshooter show --troubleshooter-name {troubleshooter-name} --scope {scope}
self-help troubleshooter show --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'
```

Просмотреть файл

@ -104805,7 +104805,7 @@
"examples": [
{
"commands": [
"self-help diagnostic create --diagnostic-name {diagnostic-name} --insights [{solutionId:Demo2InsightV2}] --scope {scope}"
"self-help diagnostic create --diagnostic-name diagnostic-name --insights [{solutionId:Demo2InsightV2}] --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'"
],
"name": "Create Diagnostic at Resource Level"
}
@ -104855,7 +104855,7 @@
"examples": [
{
"commands": [
"self-help diagnostic show --diagnostic-name {diagnostic-name} --scope {scope}"
"self-help diagnostic show --diagnostic-name diagnostic-name --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'"
],
"name": "Show Diagnostic at Resource Level"
}
@ -104916,7 +104916,7 @@
"examples": [
{
"commands": [
"self-help discovery-solution list --scope {scope}"
"self-help discovery-solution list --filter \"ProblemClassificationId eq '00000000-0000-0000-0000-000000000000'\" --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'"
],
"name": "List DiscoverySolution results for a resource"
}
@ -104958,7 +104958,7 @@
"examples": [
{
"commands": [
"self-help solution create --solution-name {solution-name} --trigger-criteria {trigger-criteria} --parameters {parameters} --scope {scope}"
"self-help solution create --solution-name solution-name --trigger-criteria [{name:solutionid,value:Demo2InsightV2}] --parameters {} --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'"
],
"name": "Create Solution at Resource Level"
}
@ -104989,7 +104989,7 @@
"examples": [
{
"commands": [
"self-help solution show --solution-name {solution-name} --scope {scope}"
"self-help solution show --solution-name solution-name --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'"
],
"name": "Show Solution at Resource Level"
}
@ -105020,7 +105020,7 @@
"examples": [
{
"commands": [
"self-help solution update --solution-name {solution-name} --trigger-criteria {trigger-criteria} --parameters {parameters} --scope {scope}"
"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/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'"
],
"name": "Update Solution at Resource Level"
}
@ -105062,7 +105062,7 @@
"examples": [
{
"commands": [
"self-help troubleshooter continue --troubleshooter-name {troubleshooter-name} --step-id {step-id} --responses [] --scope {scope}"
"self-help troubleshooter continue --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --step-id step-id --responses [] --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'"
],
"name": "Continue Troubleshooter at Resource Level"
}
@ -105093,7 +105093,7 @@
"examples": [
{
"commands": [
"self-help troubleshooter create --troubleshooter-name {troubleshooter-name} --solution-id {solution-id} --parameters {parameters} --scope {scope}"
"self-help troubleshooter create --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --solution-id e104dbdf-9e14-4c9f-bc78-21ac90382231 --parameters {ResourceUri:'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'} --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'"
],
"name": "Create Troubleshooter at Resource Level"
}
@ -105124,7 +105124,7 @@
"examples": [
{
"commands": [
"self-help troubleshooter end --troubleshooter-name {troubleshooter-name} --scope {scope}"
"self-help troubleshooter end --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'"
],
"name": "End Troubleshooter at Resource Level"
}
@ -105155,7 +105155,7 @@
"examples": [
{
"commands": [
"self-help troubleshooter restart --troubleshooter-name {troubleshooter-name} --scope {scope}"
"self-help troubleshooter restart --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'"
],
"name": "Restart Troubleshooter at Resource Level"
}
@ -105186,7 +105186,7 @@
"examples": [
{
"commands": [
"self-help troubleshooter show --troubleshooter-name {troubleshooter-name} --scope {scope}"
"self-help troubleshooter show --troubleshooter-name 12345678-BBBb-cCCCC-0000-123456789012 --scope 'subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read'"
],
"name": "Show Troubleshooter at Resource Level"
}
@ -105246,9 +105246,9 @@
"examples": [
{
"commands": [
"self-help check-name-availability --scope subscriptions/{subId} --name {diagnostic-name} --type 'Microsoft.Help/diagnostics'",
"self-help check-name-availability --scope subscriptions/{subId} --name {solution-name} --type 'Microsoft.Help/solutions'",
"self-help check-name-availability --scope subscriptions/{subId} --name {troubleshooter-name} --type 'Microsoft.Help/troubleshooters'"
"self-help check-name-availability --scope subscriptions/12345678-BBBb-cCCCC-0000-123456789012 --name diagnostic-name --type 'Microsoft.Help/diagnostics'",
"self-help check-name-availability --scope subscriptions/12345678-BBBb-cCCCC-0000-123456789012 --name solution-name --type 'Microsoft.Help/solutions'",
"self-help check-name-availability --scope subscriptions/12345678-BBBb-cCCCC-0000-123456789012 --name troubleshooter-name --type 'Microsoft.Help/troubleshooters'"
],
"name": "Check Resource Uniqueness"
}