@azure/arm-selfhelp 2.0.0-alpha.20231211.1 → 2.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/CHANGELOG.md +91 -8
  2. package/dist/index.js +250 -208
  3. package/dist/index.js.map +1 -1
  4. package/dist/index.min.js +1 -1
  5. package/dist/index.min.js.map +1 -1
  6. package/dist-esm/samples-dev/diagnosticsCreateSample.js +12 -3
  7. package/dist-esm/samples-dev/diagnosticsCreateSample.js.map +1 -1
  8. package/dist-esm/samples-dev/discoverySolutionListSample.js +4 -4
  9. package/dist-esm/samples-dev/solutionCreateSample.js +3 -8
  10. package/dist-esm/samples-dev/solutionCreateSample.js.map +1 -1
  11. package/dist-esm/samples-dev/solutionUpdateSample.js +10 -1
  12. package/dist-esm/samples-dev/solutionUpdateSample.js.map +1 -1
  13. package/dist-esm/samples-dev/troubleshootersCreateSample.js +2 -2
  14. package/dist-esm/src/models/index.d.ts +126 -85
  15. package/dist-esm/src/models/index.d.ts.map +1 -1
  16. package/dist-esm/src/models/index.js +25 -19
  17. package/dist-esm/src/models/index.js.map +1 -1
  18. package/dist-esm/src/models/mappers.d.ts +1 -2
  19. package/dist-esm/src/models/mappers.d.ts.map +1 -1
  20. package/dist-esm/src/models/mappers.js +129 -109
  21. package/dist-esm/src/models/mappers.js.map +1 -1
  22. package/dist-esm/src/operations/checkNameAvailability.d.ts +3 -2
  23. package/dist-esm/src/operations/checkNameAvailability.d.ts.map +1 -1
  24. package/dist-esm/src/operations/checkNameAvailability.js +3 -2
  25. package/dist-esm/src/operations/checkNameAvailability.js.map +1 -1
  26. package/dist-esm/src/operations/diagnostics.d.ts +17 -14
  27. package/dist-esm/src/operations/diagnostics.d.ts.map +1 -1
  28. package/dist-esm/src/operations/diagnostics.js +17 -14
  29. package/dist-esm/src/operations/diagnostics.js.map +1 -1
  30. package/dist-esm/src/operations/discoverySolution.d.ts +11 -10
  31. package/dist-esm/src/operations/discoverySolution.d.ts.map +1 -1
  32. package/dist-esm/src/operations/discoverySolution.js +11 -10
  33. package/dist-esm/src/operations/discoverySolution.js.map +1 -1
  34. package/dist-esm/src/operations/solution.d.ts +43 -34
  35. package/dist-esm/src/operations/solution.d.ts.map +1 -1
  36. package/dist-esm/src/operations/solution.js +43 -34
  37. package/dist-esm/src/operations/solution.js.map +1 -1
  38. package/dist-esm/src/operations/troubleshooters.d.ts +22 -19
  39. package/dist-esm/src/operations/troubleshooters.d.ts.map +1 -1
  40. package/dist-esm/src/operations/troubleshooters.js +22 -19
  41. package/dist-esm/src/operations/troubleshooters.js.map +1 -1
  42. package/dist-esm/src/operationsInterfaces/checkNameAvailability.d.ts +3 -2
  43. package/dist-esm/src/operationsInterfaces/checkNameAvailability.d.ts.map +1 -1
  44. package/dist-esm/src/operationsInterfaces/diagnostics.d.ts +17 -14
  45. package/dist-esm/src/operationsInterfaces/diagnostics.d.ts.map +1 -1
  46. package/dist-esm/src/operationsInterfaces/discoverySolution.d.ts +4 -4
  47. package/dist-esm/src/operationsInterfaces/solution.d.ts +43 -34
  48. package/dist-esm/src/operationsInterfaces/solution.d.ts.map +1 -1
  49. package/dist-esm/src/operationsInterfaces/troubleshooters.d.ts +22 -19
  50. package/dist-esm/src/operationsInterfaces/troubleshooters.d.ts.map +1 -1
  51. package/package.json +5 -3
  52. package/review/arm-selfhelp.api.md +21 -17
  53. package/src/models/index.ts +125 -87
  54. package/src/models/mappers.ts +140 -111
  55. package/src/operations/checkNameAvailability.ts +3 -2
  56. package/src/operations/diagnostics.ts +17 -14
  57. package/src/operations/discoverySolution.ts +11 -10
  58. package/src/operations/solution.ts +43 -34
  59. package/src/operations/troubleshooters.ts +22 -19
  60. package/src/operationsInterfaces/checkNameAvailability.ts +3 -2
  61. package/src/operationsInterfaces/diagnostics.ts +17 -14
  62. package/src/operationsInterfaces/discoverySolution.ts +4 -4
  63. package/src/operationsInterfaces/solution.ts +43 -34
  64. package/src/operationsInterfaces/troubleshooters.ts +22 -19
  65. package/types/arm-selfhelp.d.ts +182 -126
package/dist/index.js CHANGED
@@ -91,6 +91,8 @@ exports.KnownDiagnosticProvisioningState = void 0;
91
91
  KnownDiagnosticProvisioningState["PartialComplete"] = "PartialComplete";
92
92
  /** All Diagnostics failed to run. */
93
93
  KnownDiagnosticProvisioningState["Failed"] = "Failed";
94
+ /** All Diagnostics are still running. */
95
+ KnownDiagnosticProvisioningState["Running"] = "Running";
94
96
  /** When Diagnostic request gets canceled. */
95
97
  KnownDiagnosticProvisioningState["Canceled"] = "Canceled";
96
98
  })(exports.KnownDiagnosticProvisioningState || (exports.KnownDiagnosticProvisioningState = {}));
@@ -151,11 +153,15 @@ exports.KnownName = void 0;
151
153
  /** Known values of {@link SolutionProvisioningState} that the service accepts. */
152
154
  exports.KnownSolutionProvisioningState = void 0;
153
155
  (function (KnownSolutionProvisioningState) {
154
- /** Succeeded */
156
+ /** All Solutions in the Batch succeeded. */
155
157
  KnownSolutionProvisioningState["Succeeded"] = "Succeeded";
156
- /** Failed */
158
+ /** Some Solutions are still running or failed. */
159
+ KnownSolutionProvisioningState["PartialComplete"] = "PartialComplete";
160
+ /** All Solutions failed to run. */
157
161
  KnownSolutionProvisioningState["Failed"] = "Failed";
158
- /** Canceled */
162
+ /** All Solutions are still running. */
163
+ KnownSolutionProvisioningState["Running"] = "Running";
164
+ /** When Solutions request gets canceled. */
159
165
  KnownSolutionProvisioningState["Canceled"] = "Canceled";
160
166
  })(exports.KnownSolutionProvisioningState || (exports.KnownSolutionProvisioningState = {}));
161
167
  /** Known values of {@link Confidence} that the service accepts. */
@@ -207,13 +213,13 @@ exports.KnownTroubleshooterProvisioningState = void 0;
207
213
  /** Known values of {@link ExecutionStatus} that the service accepts. */
208
214
  exports.KnownExecutionStatus = void 0;
209
215
  (function (KnownExecutionStatus) {
210
- /** Success */
216
+ /** Step execution succeeded. */
211
217
  KnownExecutionStatus["Success"] = "Success";
212
- /** Running */
218
+ /** Step execution running */
213
219
  KnownExecutionStatus["Running"] = "Running";
214
- /** Failed */
220
+ /** Step execution failed */
215
221
  KnownExecutionStatus["Failed"] = "Failed";
216
- /** Warning */
222
+ /** Step execution warning */
217
223
  KnownExecutionStatus["Warning"] = "Warning";
218
224
  })(exports.KnownExecutionStatus || (exports.KnownExecutionStatus = {}));
219
225
  /** Known values of {@link Type} that the service accepts. */
@@ -228,6 +234,18 @@ exports.KnownType = void 0;
228
234
  /** AutomatedCheck */
229
235
  KnownType["AutomatedCheck"] = "AutomatedCheck";
230
236
  })(exports.KnownType || (exports.KnownType = {}));
237
+ /** Known values of {@link QuestionType} that the service accepts. */
238
+ exports.KnownQuestionType = void 0;
239
+ (function (KnownQuestionType) {
240
+ /** SingleChoice radio button */
241
+ KnownQuestionType["RadioButton"] = "RadioButton";
242
+ /** SingleChoice dropdown. */
243
+ KnownQuestionType["Dropdown"] = "Dropdown";
244
+ /** Text Input */
245
+ KnownQuestionType["TextInput"] = "TextInput";
246
+ /** MultiLineInfoBox */
247
+ KnownQuestionType["MultiLineInfoBox"] = "MultiLineInfoBox";
248
+ })(exports.KnownQuestionType || (exports.KnownQuestionType = {}));
231
249
  /** Known values of {@link QuestionContentType} that the service accepts. */
232
250
  exports.KnownQuestionContentType = void 0;
233
251
  (function (KnownQuestionContentType) {
@@ -250,18 +268,6 @@ exports.KnownAutomatedCheckResultType = void 0;
250
268
  /** Information */
251
269
  KnownAutomatedCheckResultType["Information"] = "Information";
252
270
  })(exports.KnownAutomatedCheckResultType || (exports.KnownAutomatedCheckResultType = {}));
253
- /** Known values of {@link QuestionType} that the service accepts. */
254
- exports.KnownQuestionType = void 0;
255
- (function (KnownQuestionType) {
256
- /** SingleChoice radio button */
257
- KnownQuestionType["RadioButton"] = "RadioButton";
258
- /** SingleChoice dropdown. */
259
- KnownQuestionType["Dropdown"] = "Dropdown";
260
- /** Text Input */
261
- KnownQuestionType["TextInput"] = "TextInput";
262
- /** MultiLineInfoBox */
263
- KnownQuestionType["MultiLineInfoBox"] = "MultiLineInfoBox";
264
- })(exports.KnownQuestionType || (exports.KnownQuestionType = {}));
265
271
 
266
272
  /*
267
273
  * Copyright (c) Microsoft Corporation.
@@ -795,112 +801,6 @@ const SolutionMetadataProperties = {
795
801
  }
796
802
  }
797
803
  };
798
- const SolutionResource = {
799
- type: {
800
- name: "Composite",
801
- className: "SolutionResource",
802
- modelProperties: {
803
- id: {
804
- serializedName: "id",
805
- readOnly: true,
806
- type: {
807
- name: "String"
808
- }
809
- },
810
- type: {
811
- serializedName: "type",
812
- readOnly: true,
813
- type: {
814
- name: "String"
815
- }
816
- },
817
- name: {
818
- serializedName: "name",
819
- readOnly: true,
820
- type: {
821
- name: "String"
822
- }
823
- },
824
- properties: {
825
- serializedName: "properties",
826
- type: {
827
- name: "Composite",
828
- className: "SolutionResourceProperties"
829
- }
830
- }
831
- }
832
- }
833
- };
834
- const SolutionResourceProperties = {
835
- type: {
836
- name: "Composite",
837
- className: "SolutionResourceProperties",
838
- modelProperties: {
839
- triggerCriteria: {
840
- serializedName: "triggerCriteria",
841
- type: {
842
- name: "Sequence",
843
- element: {
844
- type: {
845
- name: "Composite",
846
- className: "TriggerCriterion"
847
- }
848
- }
849
- }
850
- },
851
- parameters: {
852
- serializedName: "parameters",
853
- type: {
854
- name: "Dictionary",
855
- value: { type: { name: "String" } }
856
- }
857
- },
858
- solutionId: {
859
- serializedName: "solutionId",
860
- type: {
861
- name: "String"
862
- }
863
- },
864
- provisioningState: {
865
- serializedName: "provisioningState",
866
- type: {
867
- name: "String"
868
- }
869
- },
870
- title: {
871
- serializedName: "title",
872
- type: {
873
- name: "String"
874
- }
875
- },
876
- content: {
877
- serializedName: "content",
878
- type: {
879
- name: "String"
880
- }
881
- },
882
- replacementMaps: {
883
- serializedName: "replacementMaps",
884
- type: {
885
- name: "Composite",
886
- className: "ReplacementMaps"
887
- }
888
- },
889
- sections: {
890
- serializedName: "sections",
891
- type: {
892
- name: "Sequence",
893
- element: {
894
- type: {
895
- name: "Composite",
896
- className: "Section"
897
- }
898
- }
899
- }
900
- }
901
- }
902
- }
903
- };
904
804
  const TriggerCriterion = {
905
805
  type: {
906
806
  name: "Composite",
@@ -1333,11 +1233,71 @@ const SolutionPatchRequestBody = {
1333
1233
  name: "Composite",
1334
1234
  className: "SolutionPatchRequestBody",
1335
1235
  modelProperties: {
1336
- properties: {
1337
- serializedName: "properties",
1236
+ triggerCriteria: {
1237
+ serializedName: "properties.triggerCriteria",
1238
+ type: {
1239
+ name: "Sequence",
1240
+ element: {
1241
+ type: {
1242
+ name: "Composite",
1243
+ className: "TriggerCriterion"
1244
+ }
1245
+ }
1246
+ }
1247
+ },
1248
+ parameters: {
1249
+ serializedName: "properties.parameters",
1250
+ type: {
1251
+ name: "Dictionary",
1252
+ value: { type: { name: "String" } }
1253
+ }
1254
+ },
1255
+ solutionId: {
1256
+ serializedName: "properties.solutionId",
1257
+ readOnly: true,
1258
+ type: {
1259
+ name: "String"
1260
+ }
1261
+ },
1262
+ provisioningState: {
1263
+ serializedName: "properties.provisioningState",
1264
+ readOnly: true,
1265
+ type: {
1266
+ name: "String"
1267
+ }
1268
+ },
1269
+ title: {
1270
+ serializedName: "properties.title",
1271
+ readOnly: true,
1272
+ type: {
1273
+ name: "String"
1274
+ }
1275
+ },
1276
+ content: {
1277
+ serializedName: "properties.content",
1278
+ readOnly: true,
1279
+ type: {
1280
+ name: "String"
1281
+ }
1282
+ },
1283
+ replacementMaps: {
1284
+ serializedName: "properties.replacementMaps",
1338
1285
  type: {
1339
1286
  name: "Composite",
1340
- className: "SolutionResourceProperties"
1287
+ className: "ReplacementMaps"
1288
+ }
1289
+ },
1290
+ sections: {
1291
+ serializedName: "properties.sections",
1292
+ readOnly: true,
1293
+ type: {
1294
+ name: "Sequence",
1295
+ element: {
1296
+ type: {
1297
+ name: "Composite",
1298
+ className: "Section"
1299
+ }
1300
+ }
1341
1301
  }
1342
1302
  }
1343
1303
  }
@@ -1730,6 +1690,72 @@ const SolutionMetadataResource = {
1730
1690
  } })
1731
1691
  }
1732
1692
  };
1693
+ const SolutionResource = {
1694
+ type: {
1695
+ name: "Composite",
1696
+ className: "SolutionResource",
1697
+ modelProperties: Object.assign(Object.assign({}, ProxyResource.type.modelProperties), { triggerCriteria: {
1698
+ serializedName: "properties.triggerCriteria",
1699
+ type: {
1700
+ name: "Sequence",
1701
+ element: {
1702
+ type: {
1703
+ name: "Composite",
1704
+ className: "TriggerCriterion"
1705
+ }
1706
+ }
1707
+ }
1708
+ }, parameters: {
1709
+ serializedName: "properties.parameters",
1710
+ type: {
1711
+ name: "Dictionary",
1712
+ value: { type: { name: "String" } }
1713
+ }
1714
+ }, solutionId: {
1715
+ serializedName: "properties.solutionId",
1716
+ readOnly: true,
1717
+ type: {
1718
+ name: "String"
1719
+ }
1720
+ }, provisioningState: {
1721
+ serializedName: "properties.provisioningState",
1722
+ readOnly: true,
1723
+ type: {
1724
+ name: "String"
1725
+ }
1726
+ }, title: {
1727
+ serializedName: "properties.title",
1728
+ readOnly: true,
1729
+ type: {
1730
+ name: "String"
1731
+ }
1732
+ }, content: {
1733
+ serializedName: "properties.content",
1734
+ readOnly: true,
1735
+ type: {
1736
+ name: "String"
1737
+ }
1738
+ }, replacementMaps: {
1739
+ serializedName: "properties.replacementMaps",
1740
+ type: {
1741
+ name: "Composite",
1742
+ className: "ReplacementMaps"
1743
+ }
1744
+ }, sections: {
1745
+ serializedName: "properties.sections",
1746
+ readOnly: true,
1747
+ type: {
1748
+ name: "Sequence",
1749
+ element: {
1750
+ type: {
1751
+ name: "Composite",
1752
+ className: "Section"
1753
+ }
1754
+ }
1755
+ }
1756
+ } })
1757
+ }
1758
+ };
1733
1759
  const TroubleshooterResource = {
1734
1760
  type: {
1735
1761
  name: "Composite",
@@ -1856,7 +1882,6 @@ var Mappers = /*#__PURE__*/Object.freeze({
1856
1882
  SolutionMetadataResource: SolutionMetadataResource,
1857
1883
  SolutionPatchRequestBody: SolutionPatchRequestBody,
1858
1884
  SolutionResource: SolutionResource,
1859
- SolutionResourceProperties: SolutionResourceProperties,
1860
1885
  SolutionUpdateHeaders: SolutionUpdateHeaders,
1861
1886
  SolutionsDiagnostic: SolutionsDiagnostic,
1862
1887
  SolutionsTroubleshooters: SolutionsTroubleshooters,
@@ -2184,8 +2209,9 @@ class CheckNameAvailabilityImpl {
2184
2209
  /**
2185
2210
  * This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or
2186
2211
  * solutions
2187
- * @param scope This is an extension resource provider and only resource level extension is supported
2188
- * at the moment.
2212
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2213
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2214
+ *
2189
2215
  * @param options The options parameters.
2190
2216
  */
2191
2217
  post(scope, options) {
@@ -2251,12 +2277,13 @@ class DiagnosticsImpl {
2251
2277
  }
2252
2278
  /**
2253
2279
  * Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
2254
- * solutions. <br/>Diagnostics tells you precisely the root cause of the issue and the steps to address
2255
- * it. You can get diagnostics once you discover the relevant solution for your Azure issue. <br/><br/>
2256
- * <b>Note: </b> requiredInputs’ from Discovery solutions response must be passed via
2257
- * ‘additionalParameters’ as an input to Diagnostics API.
2258
- * @param scope This is an extension resource provider and only resource level extension is supported
2259
- * at the moment.
2280
+ * solutions. <br/>Diagnostics are powerful solutions that access product resources or other relevant
2281
+ * data and provide the root cause of the issue and the steps to address the issue.<br/><br/> <b>Note:
2282
+ * </b> requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as
2283
+ * an input to Diagnostics API.
2284
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2285
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2286
+ *
2260
2287
  * @param diagnosticsResourceName Unique resource name for insight resources
2261
2288
  * @param options The options parameters.
2262
2289
  */
@@ -2300,12 +2327,13 @@ class DiagnosticsImpl {
2300
2327
  }
2301
2328
  /**
2302
2329
  * Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
2303
- * solutions. <br/>Diagnostics tells you precisely the root cause of the issue and the steps to address
2304
- * it. You can get diagnostics once you discover the relevant solution for your Azure issue. <br/><br/>
2305
- * <b>Note: </b> requiredInputs’ from Discovery solutions response must be passed via
2306
- * ‘additionalParameters’ as an input to Diagnostics API.
2307
- * @param scope This is an extension resource provider and only resource level extension is supported
2308
- * at the moment.
2330
+ * solutions. <br/>Diagnostics are powerful solutions that access product resources or other relevant
2331
+ * data and provide the root cause of the issue and the steps to address the issue.<br/><br/> <b>Note:
2332
+ * </b> requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as
2333
+ * an input to Diagnostics API.
2334
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2335
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2336
+ *
2309
2337
  * @param diagnosticsResourceName Unique resource name for insight resources
2310
2338
  * @param options The options parameters.
2311
2339
  */
@@ -2317,8 +2345,9 @@ class DiagnosticsImpl {
2317
2345
  }
2318
2346
  /**
2319
2347
  * Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
2320
- * @param scope This is an extension resource provider and only resource level extension is supported
2321
- * at the moment.
2348
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2349
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2350
+ *
2322
2351
  * @param diagnosticsResourceName Unique resource name for insight resources
2323
2352
  * @param options The options parameters.
2324
2353
  */
@@ -2401,15 +2430,15 @@ class DiscoverySolutionImpl {
2401
2430
  * Lists the relevant Azure diagnostics and solutions using [problemClassification
2402
2431
  * API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND
2403
2432
  * resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API,
2404
- * which identifies relevant Azure diagnostics and solutions. We will do our best to return the most
2405
- * effective solutions based on the type of inputs, in the request URL <br/><br/> Mandatory input :
2433
+ * which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input :
2406
2434
  * problemClassificationId (Use the [problemClassification
2407
2435
  * API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
2408
2436
  * <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from
2409
2437
  * Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics
2410
2438
  * and Solutions API.
2411
- * @param scope This is an extension resource provider and only resource level extension is supported
2412
- * at the moment.
2439
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2440
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2441
+ *
2413
2442
  * @param options The options parameters.
2414
2443
  */
2415
2444
  list(scope, options) {
@@ -2473,15 +2502,15 @@ class DiscoverySolutionImpl {
2473
2502
  * Lists the relevant Azure diagnostics and solutions using [problemClassification
2474
2503
  * API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND
2475
2504
  * resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API,
2476
- * which identifies relevant Azure diagnostics and solutions. We will do our best to return the most
2477
- * effective solutions based on the type of inputs, in the request URL <br/><br/> Mandatory input :
2505
+ * which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input :
2478
2506
  * problemClassificationId (Use the [problemClassification
2479
2507
  * API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
2480
2508
  * <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from
2481
2509
  * Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics
2482
2510
  * and Solutions API.
2483
- * @param scope This is an extension resource provider and only resource level extension is supported
2484
- * at the moment.
2511
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2512
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2513
+ *
2485
2514
  * @param options The options parameters.
2486
2515
  */
2487
2516
  _list(scope, options) {
@@ -2489,8 +2518,9 @@ class DiscoverySolutionImpl {
2489
2518
  }
2490
2519
  /**
2491
2520
  * ListNext
2492
- * @param scope This is an extension resource provider and only resource level extension is supported
2493
- * at the moment.
2521
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2522
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2523
+ *
2494
2524
  * @param nextLink The nextLink from the previous successful call to the List method.
2495
2525
  * @param options The options parameters.
2496
2526
  */
@@ -2553,21 +2583,24 @@ class SolutionImpl {
2553
2583
  this.client = client;
2554
2584
  }
2555
2585
  /**
2556
- * Creates a solution for the specific Azure resource or subscription using the triggering criteria
2557
- * ‘solutionId and requiredInputs’ from discovery solutions.<br/> Solutions are a rich, insightful and
2558
- * a centralized self help experience that brings all the relevant content to troubleshoot an Azure
2559
- * issue into a unified experience. Solutions include the following components : Text, Diagnostics ,
2560
- * Troubleshooters, Images , Video tutorials, Tables , custom charts, images , AzureKB, etc, with
2561
- * capabilities to support new solutions types in the future. Each solution type may require one or
2562
- * more ‘requiredParameters’ that are required to execute the individual solution component. In the
2563
- * absence of the ‘requiredParameters’ it is likely that some of the solutions might fail execution,
2564
- * and you might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from
2565
- * Discovery solutions response must be passed via ‘parameters’ in the request body of Solutions API.
2566
- * <br/>2. ‘requiredParameters’ from the Solutions response is the same as additionalParametersin
2567
- * the request for diagnostics <br/>3.requiredParametersfrom the Solutions response is the same as
2586
+ * Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
2587
+ * requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
2588
+ * self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
2589
+ * resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware
2590
+ * diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
2591
+ * tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
2592
+ * troubleshooting instructions. All these components are seamlessly converged into unified solutions
2593
+ * tailored to address a specific support problem area. Each solution type may require one or more
2594
+ * ‘requiredParameters’ that are required to execute the individual solution component. In the absence
2595
+ * of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you
2596
+ * might see an empty response. <br/><br/> <b>Note:</b> <br/>1.requiredInputsfrom Discovery
2597
+ * solutions response must be passed via parametersin the request body of Solutions API. <br/>2.
2598
+ * ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the
2599
+ * request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
2568
2600
  * ‘properties.parameters’ in the request for Troubleshooters
2569
- * @param scope This is an extension resource provider and only resource level extension is supported
2570
- * at the moment.
2601
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2602
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2603
+ *
2571
2604
  * @param solutionResourceName Solution resource Name.
2572
2605
  * @param options The options parameters.
2573
2606
  */
@@ -2610,21 +2643,24 @@ class SolutionImpl {
2610
2643
  });
2611
2644
  }
2612
2645
  /**
2613
- * Creates a solution for the specific Azure resource or subscription using the triggering criteria
2614
- * ‘solutionId and requiredInputs’ from discovery solutions.<br/> Solutions are a rich, insightful and
2615
- * a centralized self help experience that brings all the relevant content to troubleshoot an Azure
2616
- * issue into a unified experience. Solutions include the following components : Text, Diagnostics ,
2617
- * Troubleshooters, Images , Video tutorials, Tables , custom charts, images , AzureKB, etc, with
2618
- * capabilities to support new solutions types in the future. Each solution type may require one or
2619
- * more ‘requiredParameters’ that are required to execute the individual solution component. In the
2620
- * absence of the ‘requiredParameters’ it is likely that some of the solutions might fail execution,
2621
- * and you might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from
2622
- * Discovery solutions response must be passed via ‘parameters’ in the request body of Solutions API.
2623
- * <br/>2. ‘requiredParameters’ from the Solutions response is the same as additionalParametersin
2624
- * the request for diagnostics <br/>3.requiredParametersfrom the Solutions response is the same as
2646
+ * Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
2647
+ * requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
2648
+ * self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
2649
+ * resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware
2650
+ * diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
2651
+ * tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
2652
+ * troubleshooting instructions. All these components are seamlessly converged into unified solutions
2653
+ * tailored to address a specific support problem area. Each solution type may require one or more
2654
+ * ‘requiredParameters’ that are required to execute the individual solution component. In the absence
2655
+ * of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you
2656
+ * might see an empty response. <br/><br/> <b>Note:</b> <br/>1.requiredInputsfrom Discovery
2657
+ * solutions response must be passed via parametersin the request body of Solutions API. <br/>2.
2658
+ * ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the
2659
+ * request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
2625
2660
  * ‘properties.parameters’ in the request for Troubleshooters
2626
- * @param scope This is an extension resource provider and only resource level extension is supported
2627
- * at the moment.
2661
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2662
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2663
+ *
2628
2664
  * @param solutionResourceName Solution resource Name.
2629
2665
  * @param options The options parameters.
2630
2666
  */
@@ -2636,8 +2672,9 @@ class SolutionImpl {
2636
2672
  }
2637
2673
  /**
2638
2674
  * Get the solution using the applicable solutionResourceName while creating the solution.
2639
- * @param scope This is an extension resource provider and only resource level extension is supported
2640
- * at the moment.
2675
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2676
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2677
+ *
2641
2678
  * @param solutionResourceName Solution resource Name.
2642
2679
  * @param options The options parameters.
2643
2680
  */
@@ -2646,8 +2683,9 @@ class SolutionImpl {
2646
2683
  }
2647
2684
  /**
2648
2685
  * Update the requiredInputs or additional information needed to execute the solution
2649
- * @param scope This is an extension resource provider and only resource level extension is supported
2650
- * at the moment.
2686
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2687
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2688
+ *
2651
2689
  * @param solutionResourceName Solution resource Name.
2652
2690
  * @param options The options parameters.
2653
2691
  */
@@ -2691,8 +2729,9 @@ class SolutionImpl {
2691
2729
  }
2692
2730
  /**
2693
2731
  * Update the requiredInputs or additional information needed to execute the solution
2694
- * @param scope This is an extension resource provider and only resource level extension is supported
2695
- * at the moment.
2732
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2733
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2734
+ *
2696
2735
  * @param solutionResourceName Solution resource Name.
2697
2736
  * @param options The options parameters.
2698
2737
  */
@@ -2810,17 +2849,16 @@ class TroubleshootersImpl {
2810
2849
  }
2811
2850
  /**
2812
2851
  * Creates the specific troubleshooter action under a resource or subscription using the ‘solutionId’
2813
- * and ‘properties.parameters’ as the trigger. <br/> Troubleshooters are step-by-step interactive
2814
- * guidance that scope the problem by collecting additional inputs from you in each stage while
2815
- * troubleshooting an Azure issue. You will be guided down decision tree style workflow and the best
2816
- * possible solution will be presented at the end of the workflow. <br/> Create API creates the
2817
- * Troubleshooter API using ‘parameters’ and ‘solutionId’ <br/> After creating the Troubleshooter
2818
- * instance, the following APIs can be used:<br/> CONTINUE API: to move to the next step in the flow
2819
- * <br/>GET API: to identify the next step after executing the CONTINUE API. <br/><br/> <b>Note:</b>
2820
- * ‘requiredParameters’ from solutions response must be passed via ‘properties. parameters’ in the
2821
- * request body of Troubleshooters API.
2822
- * @param scope This is an extension resource provider and only resource level extension is supported
2823
- * at the moment.
2852
+ * and ‘properties.parameters’ as the trigger. <br/> Azure Troubleshooters help with hard to classify
2853
+ * issues, reducing the gap between customer observed problems and solutions by guiding the user
2854
+ * effortlessly through the troubleshooting process. Each Troubleshooter flow represents a problem area
2855
+ * within Azure and has a complex tree-like structure that addresses many root causes. These flows are
2856
+ * prepared with the help of Subject Matter experts and customer support engineers by carefully
2857
+ * considering previous support requests raised by customers. Troubleshooters terminate at a well
2858
+ * curated solution based off of resource backend signals and customer manual selections.
2859
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2860
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2861
+ *
2824
2862
  * @param troubleshooterName Troubleshooter resource Name.
2825
2863
  * @param options The options parameters.
2826
2864
  */
@@ -2832,8 +2870,9 @@ class TroubleshootersImpl {
2832
2870
  * resource name that is being executed.<br/> Get API is used to retrieve the result of a
2833
2871
  * Troubleshooter instance, which includes the status and result of each step in the Troubleshooter
2834
2872
  * workflow. This API requires the Troubleshooter resource name that was created using the Create API.
2835
- * @param scope This is an extension resource provider and only resource level extension is supported
2836
- * at the moment.
2873
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2874
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2875
+ *
2837
2876
  * @param troubleshooterName Troubleshooter resource Name.
2838
2877
  * @param options The options parameters.
2839
2878
  */
@@ -2845,8 +2884,9 @@ class TroubleshootersImpl {
2845
2884
  * respective troubleshooter resource name. <br/>Continue API is used to provide inputs that are
2846
2885
  * required for the specific troubleshooter to progress into the next step in the process. This API is
2847
2886
  * used after the Troubleshooter has been created using the Create API.
2848
- * @param scope This is an extension resource provider and only resource level extension is supported
2849
- * at the moment.
2887
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2888
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2889
+ *
2850
2890
  * @param troubleshooterName Troubleshooter resource Name.
2851
2891
  * @param options The options parameters.
2852
2892
  */
@@ -2855,8 +2895,9 @@ class TroubleshootersImpl {
2855
2895
  }
2856
2896
  /**
2857
2897
  * Ends the troubleshooter action
2858
- * @param scope This is an extension resource provider and only resource level extension is supported
2859
- * at the moment.
2898
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2899
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2900
+ *
2860
2901
  * @param troubleshooterName Troubleshooter resource Name.
2861
2902
  * @param options The options parameters.
2862
2903
  */
@@ -2867,8 +2908,9 @@ class TroubleshootersImpl {
2867
2908
  * Restarts the troubleshooter API using applicable troubleshooter resource name as the input.<br/> It
2868
2909
  * returns new resource name which should be used in subsequent request. The old resource name is
2869
2910
  * obsolete after this API is invoked.
2870
- * @param scope This is an extension resource provider and only resource level extension is supported
2871
- * at the moment.
2911
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
2912
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
2913
+ *
2872
2914
  * @param troubleshooterName Troubleshooter resource Name.
2873
2915
  * @param options The options parameters.
2874
2916
  */