@azure/arm-selfhelp 2.0.0-beta.2 → 2.0.0-beta.3

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 (167) hide show
  1. package/CHANGELOG.md +120 -0
  2. package/LICENSE +1 -1
  3. package/README.md +3 -2
  4. package/dist/index.js +1589 -861
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.min.js +1 -1
  7. package/dist/index.min.js.map +1 -1
  8. package/dist-esm/samples-dev/checkNameAvailabilityPostSample.js +7 -7
  9. package/dist-esm/samples-dev/checkNameAvailabilityPostSample.js.map +1 -1
  10. package/dist-esm/samples-dev/diagnosticsCreateSample.js +4 -13
  11. package/dist-esm/samples-dev/diagnosticsCreateSample.js.map +1 -1
  12. package/dist-esm/samples-dev/diagnosticsGetSample.js +1 -1
  13. package/dist-esm/samples-dev/discoverySolutionListSample.js +6 -41
  14. package/dist-esm/samples-dev/discoverySolutionListSample.js.map +1 -1
  15. package/dist-esm/samples-dev/discoverySolutionNlpSubscriptionScopePostSample.d.ts +2 -0
  16. package/dist-esm/samples-dev/discoverySolutionNlpSubscriptionScopePostSample.d.ts.map +1 -0
  17. package/dist-esm/samples-dev/discoverySolutionNlpSubscriptionScopePostSample.js +45 -0
  18. package/dist-esm/samples-dev/discoverySolutionNlpSubscriptionScopePostSample.js.map +1 -0
  19. package/dist-esm/samples-dev/discoverySolutionNlpTenantScopePostSample.d.ts +2 -0
  20. package/dist-esm/samples-dev/discoverySolutionNlpTenantScopePostSample.d.ts.map +1 -0
  21. package/dist-esm/samples-dev/discoverySolutionNlpTenantScopePostSample.js +43 -0
  22. package/dist-esm/samples-dev/discoverySolutionNlpTenantScopePostSample.js.map +1 -0
  23. package/dist-esm/samples-dev/operationsListSample.js +5 -3
  24. package/dist-esm/samples-dev/operationsListSample.js.map +1 -1
  25. package/dist-esm/samples-dev/simplifiedSolutionsCreateSample.d.ts +2 -0
  26. package/dist-esm/samples-dev/simplifiedSolutionsCreateSample.d.ts.map +1 -0
  27. package/dist-esm/samples-dev/simplifiedSolutionsCreateSample.js +46 -0
  28. package/dist-esm/samples-dev/simplifiedSolutionsCreateSample.js.map +1 -0
  29. package/dist-esm/samples-dev/simplifiedSolutionsGetSample.d.ts +2 -0
  30. package/dist-esm/samples-dev/simplifiedSolutionsGetSample.d.ts.map +1 -0
  31. package/dist-esm/samples-dev/simplifiedSolutionsGetSample.js +37 -0
  32. package/dist-esm/samples-dev/simplifiedSolutionsGetSample.js.map +1 -0
  33. package/dist-esm/samples-dev/solutionCreateSample.js +8 -5
  34. package/dist-esm/samples-dev/solutionCreateSample.js.map +1 -1
  35. package/dist-esm/samples-dev/solutionGetSample.js +1 -1
  36. package/dist-esm/samples-dev/solutionSelfHelpGetSample.d.ts +2 -0
  37. package/dist-esm/samples-dev/solutionSelfHelpGetSample.d.ts.map +1 -0
  38. package/dist-esm/samples-dev/solutionSelfHelpGetSample.js +36 -0
  39. package/dist-esm/samples-dev/solutionSelfHelpGetSample.js.map +1 -0
  40. package/dist-esm/samples-dev/solutionUpdateSample.js +2 -11
  41. package/dist-esm/samples-dev/solutionUpdateSample.js.map +1 -1
  42. package/dist-esm/samples-dev/solutionWarmUpSample.d.ts +2 -0
  43. package/dist-esm/samples-dev/solutionWarmUpSample.d.ts.map +1 -0
  44. package/dist-esm/samples-dev/solutionWarmUpSample.js +37 -0
  45. package/dist-esm/samples-dev/solutionWarmUpSample.js.map +1 -0
  46. package/dist-esm/samples-dev/troubleshootersContinueSample.js +6 -6
  47. package/dist-esm/samples-dev/troubleshootersContinueSample.js.map +1 -1
  48. package/dist-esm/samples-dev/troubleshootersCreateSample.js +5 -5
  49. package/dist-esm/samples-dev/troubleshootersCreateSample.js.map +1 -1
  50. package/dist-esm/samples-dev/troubleshootersEndSample.js +1 -1
  51. package/dist-esm/samples-dev/troubleshootersGetSample.js +1 -1
  52. package/dist-esm/samples-dev/troubleshootersRestartSample.js +1 -1
  53. package/dist-esm/src/helpRP.d.ts +8 -1
  54. package/dist-esm/src/helpRP.d.ts.map +1 -1
  55. package/dist-esm/src/helpRP.js +25 -15
  56. package/dist-esm/src/helpRP.js.map +1 -1
  57. package/dist-esm/src/lroImpl.js +1 -1
  58. package/dist-esm/src/models/index.d.ts +227 -7
  59. package/dist-esm/src/models/index.d.ts.map +1 -1
  60. package/dist-esm/src/models/index.js +24 -0
  61. package/dist-esm/src/models/index.js.map +1 -1
  62. package/dist-esm/src/models/mappers.d.ts +9 -0
  63. package/dist-esm/src/models/mappers.d.ts.map +1 -1
  64. package/dist-esm/src/models/mappers.js +860 -523
  65. package/dist-esm/src/models/mappers.js.map +1 -1
  66. package/dist-esm/src/models/parameters.d.ts +6 -0
  67. package/dist-esm/src/models/parameters.d.ts.map +1 -1
  68. package/dist-esm/src/models/parameters.js +95 -44
  69. package/dist-esm/src/models/parameters.js.map +1 -1
  70. package/dist-esm/src/operations/checkNameAvailability.js +4 -4
  71. package/dist-esm/src/operations/diagnostics.d.ts +6 -10
  72. package/dist-esm/src/operations/diagnostics.d.ts.map +1 -1
  73. package/dist-esm/src/operations/diagnostics.js +24 -28
  74. package/dist-esm/src/operations/diagnostics.js.map +1 -1
  75. package/dist-esm/src/operations/discoverySolution.d.ts +3 -12
  76. package/dist-esm/src/operations/discoverySolution.d.ts.map +1 -1
  77. package/dist-esm/src/operations/discoverySolution.js +27 -36
  78. package/dist-esm/src/operations/discoverySolution.js.map +1 -1
  79. package/dist-esm/src/operations/discoverySolutionNLPSubscriptionScope.d.ts +19 -0
  80. package/dist-esm/src/operations/discoverySolutionNLPSubscriptionScope.d.ts.map +1 -0
  81. package/dist-esm/src/operations/discoverySolutionNLPSubscriptionScope.js +49 -0
  82. package/dist-esm/src/operations/discoverySolutionNLPSubscriptionScope.js.map +1 -0
  83. package/dist-esm/src/operations/discoverySolutionNLPTenantScope.d.ts +19 -0
  84. package/dist-esm/src/operations/discoverySolutionNLPTenantScope.d.ts.map +1 -0
  85. package/dist-esm/src/operations/discoverySolutionNLPTenantScope.js +49 -0
  86. package/dist-esm/src/operations/discoverySolutionNLPTenantScope.js.map +1 -0
  87. package/dist-esm/src/operations/index.d.ts +4 -0
  88. package/dist-esm/src/operations/index.d.ts.map +1 -1
  89. package/dist-esm/src/operations/index.js +4 -0
  90. package/dist-esm/src/operations/index.js.map +1 -1
  91. package/dist-esm/src/operations/operations.js +9 -9
  92. package/dist-esm/src/operations/operations.js.map +1 -1
  93. package/dist-esm/src/operations/simplifiedSolutions.d.ts +52 -0
  94. package/dist-esm/src/operations/simplifiedSolutions.d.ts.map +1 -0
  95. package/dist-esm/src/operations/simplifiedSolutions.js +159 -0
  96. package/dist-esm/src/operations/simplifiedSolutions.js.map +1 -0
  97. package/dist-esm/src/operations/solution.d.ts +20 -25
  98. package/dist-esm/src/operations/solution.d.ts.map +1 -1
  99. package/dist-esm/src/operations/solution.js +71 -54
  100. package/dist-esm/src/operations/solution.js.map +1 -1
  101. package/dist-esm/src/operations/solutionSelfHelp.d.ts +23 -0
  102. package/dist-esm/src/operations/solutionSelfHelp.d.ts.map +1 -0
  103. package/dist-esm/src/operations/solutionSelfHelp.js +51 -0
  104. package/dist-esm/src/operations/solutionSelfHelp.js.map +1 -0
  105. package/dist-esm/src/operations/troubleshooters.js +26 -26
  106. package/dist-esm/src/operations/troubleshooters.js.map +1 -1
  107. package/dist-esm/src/operationsInterfaces/diagnostics.d.ts +6 -10
  108. package/dist-esm/src/operationsInterfaces/diagnostics.d.ts.map +1 -1
  109. package/dist-esm/src/operationsInterfaces/discoverySolution.d.ts +2 -5
  110. package/dist-esm/src/operationsInterfaces/discoverySolution.d.ts.map +1 -1
  111. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.d.ts +11 -0
  112. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.d.ts.map +1 -0
  113. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.js +9 -0
  114. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.js.map +1 -0
  115. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPTenantScope.d.ts +11 -0
  116. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPTenantScope.d.ts.map +1 -0
  117. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPTenantScope.js +9 -0
  118. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPTenantScope.js.map +1 -0
  119. package/dist-esm/src/operationsInterfaces/index.d.ts +4 -0
  120. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -1
  121. package/dist-esm/src/operationsInterfaces/index.js +4 -0
  122. package/dist-esm/src/operationsInterfaces/index.js.map +1 -1
  123. package/dist-esm/src/operationsInterfaces/simplifiedSolutions.d.ts +44 -0
  124. package/dist-esm/src/operationsInterfaces/simplifiedSolutions.d.ts.map +1 -0
  125. package/dist-esm/src/operationsInterfaces/simplifiedSolutions.js +9 -0
  126. package/dist-esm/src/operationsInterfaces/simplifiedSolutions.js.map +1 -0
  127. package/dist-esm/src/operationsInterfaces/solution.d.ts +20 -25
  128. package/dist-esm/src/operationsInterfaces/solution.d.ts.map +1 -1
  129. package/dist-esm/src/operationsInterfaces/solutionSelfHelp.d.ts +15 -0
  130. package/dist-esm/src/operationsInterfaces/solutionSelfHelp.d.ts.map +1 -0
  131. package/dist-esm/src/operationsInterfaces/solutionSelfHelp.js +9 -0
  132. package/dist-esm/src/operationsInterfaces/solutionSelfHelp.js.map +1 -0
  133. package/dist-esm/src/pagingHelper.js.map +1 -1
  134. package/dist-esm/test/selfhelp_operations_test.spec.js +2 -2
  135. package/dist-esm/test/selfhelp_operations_test.spec.js.map +1 -1
  136. package/package.json +8 -10
  137. package/review/arm-selfhelp.api.md +177 -2
  138. package/src/helpRP.ts +58 -17
  139. package/src/lroImpl.ts +3 -3
  140. package/src/models/index.ts +263 -22
  141. package/src/models/mappers.ts +898 -529
  142. package/src/models/parameters.ts +105 -45
  143. package/src/operations/checkNameAvailability.ts +7 -7
  144. package/src/operations/diagnostics.ts +39 -46
  145. package/src/operations/discoverySolution.ts +29 -46
  146. package/src/operations/discoverySolutionNLPSubscriptionScope.ts +64 -0
  147. package/src/operations/discoverySolutionNLPTenantScope.ts +64 -0
  148. package/src/operations/index.ts +4 -0
  149. package/src/operations/operations.ts +16 -16
  150. package/src/operations/simplifiedSolutions.ts +216 -0
  151. package/src/operations/solution.ts +101 -77
  152. package/src/operations/solutionSelfHelp.ts +68 -0
  153. package/src/operations/troubleshooters.ts +42 -47
  154. package/src/operationsInterfaces/checkNameAvailability.ts +2 -2
  155. package/src/operationsInterfaces/diagnostics.ts +10 -14
  156. package/src/operationsInterfaces/discoverySolution.ts +3 -7
  157. package/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.ts +24 -0
  158. package/src/operationsInterfaces/discoverySolutionNLPTenantScope.ts +24 -0
  159. package/src/operationsInterfaces/index.ts +4 -0
  160. package/src/operationsInterfaces/operations.ts +1 -1
  161. package/src/operationsInterfaces/simplifiedSolutions.ts +74 -0
  162. package/src/operationsInterfaces/solution.ts +30 -30
  163. package/src/operationsInterfaces/solutionSelfHelp.ts +29 -0
  164. package/src/operationsInterfaces/troubleshooters.ts +6 -6
  165. package/src/pagingHelper.ts +1 -1
  166. package/types/arm-selfhelp.d.ts +359 -46
  167. package/types/tsdoc-metadata.json +1 -1
@@ -28,6 +28,10 @@ export declare type AggregationType = string;
28
28
 
29
29
  /** Only for AutomatedStep type */
30
30
  export declare interface AutomatedCheckResult {
31
+ /** Version for automated check result */
32
+ version?: string;
33
+ /** Status for automated check result */
34
+ status?: string;
31
35
  /** Insight Article Content */
32
36
  result?: string;
33
37
  /** Type of Result. */
@@ -86,6 +90,22 @@ export declare interface CheckNameAvailabilityResponse {
86
90
  message?: string;
87
91
  }
88
92
 
93
+ /** Service Classification result object. */
94
+ export declare interface ClassificationService {
95
+ /**
96
+ * Azure resource Id of the service.
97
+ * NOTE: This property will not be serialized. It can only be populated by the server.
98
+ */
99
+ readonly serviceId?: string;
100
+ /**
101
+ * Localized name of the azure service.
102
+ * NOTE: This property will not be serialized. It can only be populated by the server.
103
+ */
104
+ readonly displayName?: string;
105
+ /** List of applicable ARM resource types for this service. */
106
+ resourceTypes?: string[];
107
+ }
108
+
89
109
  /**
90
110
  * Defines values for Confidence. \
91
111
  * {@link KnownConfidence} can be used interchangeably with Confidence,
@@ -179,11 +199,9 @@ export declare interface DiagnosticResource extends ProxyResource {
179
199
  /** Interface representing a Diagnostics. */
180
200
  export declare interface Diagnostics {
181
201
  /**
182
- * Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
183
- * solutions. <br/>Diagnostics are powerful solutions that access product resources or other relevant
184
- * data and provide the root cause of the issue and the steps to address the issue.<br/><br/> <b>Note:
185
- * </b> ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as
186
- * an input to Diagnostics API.
202
+ * Creates a diagnostic for the specific resource using solutionId from discovery solutions.
203
+ * <br/>Diagnostics are powerful solutions that access product resources or other relevant data and
204
+ * provide the root cause of the issue and the steps to address the issue.<br/><br/>
187
205
  * @param scope scope = resourceUri of affected resource.<br/> For example:
188
206
  * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
189
207
  *
@@ -192,11 +210,9 @@ export declare interface Diagnostics {
192
210
  */
193
211
  beginCreate(scope: string, diagnosticsResourceName: string, options?: DiagnosticsCreateOptionalParams): Promise<SimplePollerLike<OperationState<DiagnosticsCreateResponse>, DiagnosticsCreateResponse>>;
194
212
  /**
195
- * Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
196
- * solutions. <br/>Diagnostics are powerful solutions that access product resources or other relevant
197
- * data and provide the root cause of the issue and the steps to address the issue.<br/><br/> <b>Note:
198
- * </b> ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as
199
- * an input to Diagnostics API.
213
+ * Creates a diagnostic for the specific resource using solutionId from discovery solutions.
214
+ * <br/>Diagnostics are powerful solutions that access product resources or other relevant data and
215
+ * provide the root cause of the issue and the steps to address the issue.<br/><br/>
200
216
  * @param scope scope = resourceUri of affected resource.<br/> For example:
201
217
  * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
202
218
  *
@@ -235,6 +251,24 @@ export declare interface DiagnosticsGetOptionalParams extends coreClient.Operati
235
251
  /** Contains response data for the get operation. */
236
252
  export declare type DiagnosticsGetResponse = DiagnosticResource;
237
253
 
254
+ /** Discover NLP request. */
255
+ export declare interface DiscoveryNlpRequest {
256
+ /** Natural language description of the issue. */
257
+ issueSummary: string;
258
+ /** ARM resource Id of the resource that is having the issue. */
259
+ resourceId?: string;
260
+ /** ARM service Id of the service that is having the issue. For more information on service Id see https://learn.microsoft.com/rest/api/support/services/list?tabs=HTTP. */
261
+ serviceId?: string;
262
+ /** Additional information in the form of a string. */
263
+ additionalContext?: string;
264
+ }
265
+
266
+ /** Successfully fetched list of solution metadata. */
267
+ export declare interface DiscoveryNlpResponse {
268
+ /** The list of solution metadata. */
269
+ value?: SolutionNlpMetadataResource[];
270
+ }
271
+
238
272
  /** Discovery response. */
239
273
  export declare interface DiscoveryResponse {
240
274
  /** The list of metadata. */
@@ -246,7 +280,7 @@ export declare interface DiscoveryResponse {
246
280
  /** Interface representing a DiscoverySolution. */
247
281
  export declare interface DiscoverySolution {
248
282
  /**
249
- * Lists the relevant Azure diagnostics and solutions using [problemClassification
283
+ * Lists the relevant Azure Diagnostics, Solutions and Troubleshooters using [problemClassification
250
284
  * API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND
251
285
  * resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API,
252
286
  * which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input :
@@ -255,12 +289,9 @@ export declare interface DiscoverySolution {
255
289
  * <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from
256
290
  * Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics
257
291
  * and Solutions API.
258
- * @param scope scope = resourceUri of affected resource.<br/> For example:
259
- * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
260
- *
261
292
  * @param options The options parameters.
262
293
  */
263
- list(scope: string, options?: DiscoverySolutionListOptionalParams): PagedAsyncIterableIterator<SolutionMetadataResource>;
294
+ list(options?: DiscoverySolutionListOptionalParams): PagedAsyncIterableIterator<SolutionMetadataResource>;
264
295
  }
265
296
 
266
297
  /** Optional parameters. */
@@ -281,6 +312,44 @@ export declare interface DiscoverySolutionListOptionalParams extends coreClient.
281
312
  /** Contains response data for the list operation. */
282
313
  export declare type DiscoverySolutionListResponse = DiscoveryResponse;
283
314
 
315
+ /** Interface representing a DiscoverySolutionNLPSubscriptionScope. */
316
+ export declare interface DiscoverySolutionNLPSubscriptionScope {
317
+ /**
318
+ * Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue
319
+ * summary and subscription.
320
+ * @param options The options parameters.
321
+ */
322
+ post(options?: DiscoverySolutionNLPSubscriptionScopePostOptionalParams): Promise<DiscoverySolutionNLPSubscriptionScopePostResponse>;
323
+ }
324
+
325
+ /** Optional parameters. */
326
+ export declare interface DiscoverySolutionNLPSubscriptionScopePostOptionalParams extends coreClient.OperationOptions {
327
+ /** Request body for discovering solutions using NLP. */
328
+ discoverSolutionRequest?: DiscoveryNlpRequest;
329
+ }
330
+
331
+ /** Contains response data for the post operation. */
332
+ export declare type DiscoverySolutionNLPSubscriptionScopePostResponse = DiscoveryNlpResponse;
333
+
334
+ /** Interface representing a DiscoverySolutionNLPTenantScope. */
335
+ export declare interface DiscoverySolutionNLPTenantScope {
336
+ /**
337
+ * Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue
338
+ * summary.
339
+ * @param options The options parameters.
340
+ */
341
+ post(options?: DiscoverySolutionNLPTenantScopePostOptionalParams): Promise<DiscoverySolutionNLPTenantScopePostResponse>;
342
+ }
343
+
344
+ /** Optional parameters. */
345
+ export declare interface DiscoverySolutionNLPTenantScopePostOptionalParams extends coreClient.OperationOptions {
346
+ /** Request body for discovering solutions using NLP. */
347
+ discoverSolutionRequest?: DiscoveryNlpRequest;
348
+ }
349
+
350
+ /** Contains response data for the post operation. */
351
+ export declare type DiscoverySolutionNLPTenantScopePostResponse = DiscoveryNlpResponse;
352
+
284
353
  /** The resource management error additional info. */
285
354
  export declare interface ErrorAdditionalInfo {
286
355
  /**
@@ -391,11 +460,14 @@ export declare function getContinuationToken(page: unknown): string | undefined;
391
460
  export declare class HelpRP extends coreClient.ServiceClient {
392
461
  $host: string;
393
462
  apiVersion: string;
463
+ subscriptionId?: string;
394
464
  /**
395
465
  * Initializes a new instance of the HelpRP class.
396
466
  * @param credentials Subscription credentials which uniquely identify client subscription.
467
+ * @param subscriptionId The ID of the target subscription. The value must be an UUID.
397
468
  * @param options The parameter options
398
469
  */
470
+ constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: HelpRPOptionalParams);
399
471
  constructor(credentials: coreAuth.TokenCredential, options?: HelpRPOptionalParams);
400
472
  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
401
473
  private addCustomApiVersionPolicy;
@@ -404,7 +476,11 @@ export declare class HelpRP extends coreClient.ServiceClient {
404
476
  diagnostics: Diagnostics;
405
477
  discoverySolution: DiscoverySolution;
406
478
  solution: Solution;
479
+ simplifiedSolutions: SimplifiedSolutions;
407
480
  troubleshooters: Troubleshooters;
481
+ solutionSelfHelp: SolutionSelfHelp;
482
+ discoverySolutionNLPTenantScope: DiscoverySolutionNLPTenantScope;
483
+ discoverySolutionNLPSubscriptionScope: DiscoverySolutionNLPSubscriptionScope;
408
484
  }
409
485
 
410
486
  /** Optional parameters. */
@@ -569,7 +645,11 @@ export declare enum KnownQuestionType {
569
645
  /** Text Input */
570
646
  TextInput = "TextInput",
571
647
  /** MultiLineInfoBox */
572
- MultiLineInfoBox = "MultiLineInfoBox"
648
+ MultiLineInfoBox = "MultiLineInfoBox",
649
+ /** DateTime Picker */
650
+ DateTimePicker = "DateTimePicker",
651
+ /** Multi Select */
652
+ MultiSelect = "MultiSelect"
573
653
  }
574
654
 
575
655
  /** Known values of {@link ResultType} that the service accepts. */
@@ -599,7 +679,11 @@ export declare enum KnownSolutionType {
599
679
  /** Diagnostics resource type. */
600
680
  Diagnostics = "Diagnostics",
601
681
  /** Solutions resource type. */
602
- Solutions = "Solutions"
682
+ Solutions = "Solutions",
683
+ /** Troubleshooters resource type. */
684
+ Troubleshooters = "Troubleshooters",
685
+ /** SelfHelp resource type. */
686
+ SelfHelp = "SelfHelp"
603
687
  }
604
688
 
605
689
  /** Known values of {@link Status} that the service accepts. */
@@ -639,7 +723,23 @@ export declare enum KnownType {
639
723
  /** Insight */
640
724
  Insight = "Insight",
641
725
  /** AutomatedCheck */
642
- AutomatedCheck = "AutomatedCheck"
726
+ AutomatedCheck = "AutomatedCheck",
727
+ /** Input */
728
+ Input = "Input"
729
+ }
730
+
731
+ /** Known values of {@link ValidationScope} that the service accepts. */
732
+ export declare enum KnownValidationScope {
733
+ /** None */
734
+ None = "None",
735
+ /** URLFormat */
736
+ URLFormat = "URLFormat",
737
+ /** GuidFormat */
738
+ GuidFormat = "GuidFormat",
739
+ /** IpAddressFormat */
740
+ IpAddressFormat = "IpAddressFormat",
741
+ /** NumberOnlyFormat */
742
+ NumberOnlyFormat = "NumberOnlyFormat"
643
743
  }
644
744
 
645
745
  /** Solutions metrics based chart */
@@ -790,7 +890,9 @@ export declare type QuestionContentType = string;
790
890
  * **RadioButton**: SingleChoice radio button \
791
891
  * **Dropdown**: SingleChoice dropdown. \
792
892
  * **TextInput**: Text Input \
793
- * **MultiLineInfoBox**: MultiLineInfoBox
893
+ * **MultiLineInfoBox**: MultiLineInfoBox \
894
+ * **DateTimePicker**: DateTime Picker \
895
+ * **MultiSelect**: Multi Select
794
896
  */
795
897
  export declare type QuestionType = string;
796
898
 
@@ -810,6 +912,16 @@ export declare interface ReplacementMaps {
810
912
  videoGroups?: VideoGroup[];
811
913
  }
812
914
 
915
+ /** Solution replacement maps. */
916
+ export declare interface ReplacementMapsSelfHelp {
917
+ /** Solution AzureKB results */
918
+ webResults?: WebResult[];
919
+ /** Video solutions, which have the power to engage the customer by stimulating their senses */
920
+ videos?: Video[];
921
+ /** Group of Videos */
922
+ videoGroups?: VideoGroup[];
923
+ }
924
+
813
925
  /** Common fields that are returned in the response for all Azure Resource Manager resources */
814
926
  export declare interface Resource {
815
927
  /**
@@ -846,6 +958,8 @@ export declare interface ResponseOption {
846
958
  export declare interface ResponseValidationProperties {
847
959
  /** Regex used for the input validation. */
848
960
  regex?: string;
961
+ /** Validation scope */
962
+ validationScope?: ValidationScope;
849
963
  /** Default True */
850
964
  isRequired?: boolean;
851
965
  /** Validation Error Message. */
@@ -903,24 +1017,121 @@ export declare interface Section {
903
1017
  replacementMaps?: ReplacementMaps;
904
1018
  }
905
1019
 
1020
+ /** Part of the solution and are dividers in the solution rendering. */
1021
+ export declare interface SectionSelfHelp {
1022
+ /** Solution sections title. */
1023
+ title?: string;
1024
+ /** Solution sections content. */
1025
+ content?: string;
1026
+ /** Solution replacement maps. */
1027
+ replacementMaps?: ReplacementMapsSelfHelp;
1028
+ }
1029
+
1030
+ /** Interface representing a SimplifiedSolutions. */
1031
+ export declare interface SimplifiedSolutions {
1032
+ /**
1033
+ * Creates Simplified Solutions for an Azure subscription using 'solutionId' from Discovery Solutions
1034
+ * as the input. <br/><br/> Simplified Solutions API makes the consumption of solutions APIs easier
1035
+ * while still providing access to the same powerful solutions rendered in Solutions API. With
1036
+ * Simplified Solutions, users don't have to worry about stitching together the article using
1037
+ * replacement maps and can use the content in the API response to directly render as HTML
1038
+ * content.<br/>
1039
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1040
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1041
+ *
1042
+ * @param simplifiedSolutionsResourceName Simplified Solutions Resource Name.
1043
+ * @param options The options parameters.
1044
+ */
1045
+ beginCreate(scope: string, simplifiedSolutionsResourceName: string, options?: SimplifiedSolutionsCreateOptionalParams): Promise<SimplePollerLike<OperationState<SimplifiedSolutionsCreateResponse>, SimplifiedSolutionsCreateResponse>>;
1046
+ /**
1047
+ * Creates Simplified Solutions for an Azure subscription using 'solutionId' from Discovery Solutions
1048
+ * as the input. <br/><br/> Simplified Solutions API makes the consumption of solutions APIs easier
1049
+ * while still providing access to the same powerful solutions rendered in Solutions API. With
1050
+ * Simplified Solutions, users don't have to worry about stitching together the article using
1051
+ * replacement maps and can use the content in the API response to directly render as HTML
1052
+ * content.<br/>
1053
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1054
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1055
+ *
1056
+ * @param simplifiedSolutionsResourceName Simplified Solutions Resource Name.
1057
+ * @param options The options parameters.
1058
+ */
1059
+ beginCreateAndWait(scope: string, simplifiedSolutionsResourceName: string, options?: SimplifiedSolutionsCreateOptionalParams): Promise<SimplifiedSolutionsCreateResponse>;
1060
+ /**
1061
+ * Get the simplified Solutions using the applicable solutionResourceName while creating the simplified
1062
+ * Solutions.
1063
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1064
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1065
+ *
1066
+ * @param simplifiedSolutionsResourceName Simplified Solutions Resource Name.
1067
+ * @param options The options parameters.
1068
+ */
1069
+ get(scope: string, simplifiedSolutionsResourceName: string, options?: SimplifiedSolutionsGetOptionalParams): Promise<SimplifiedSolutionsGetResponse>;
1070
+ }
1071
+
1072
+ /** Optional parameters. */
1073
+ export declare interface SimplifiedSolutionsCreateOptionalParams extends coreClient.OperationOptions {
1074
+ /** The required request body for simplified Solutions resource creation. */
1075
+ simplifiedSolutionsRequestBody?: SimplifiedSolutionsResource;
1076
+ /** Delay to wait until next poll, in milliseconds. */
1077
+ updateIntervalInMs?: number;
1078
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1079
+ resumeFrom?: string;
1080
+ }
1081
+
1082
+ /** Contains response data for the create operation. */
1083
+ export declare type SimplifiedSolutionsCreateResponse = SimplifiedSolutionsResource;
1084
+
1085
+ /** Optional parameters. */
1086
+ export declare interface SimplifiedSolutionsGetOptionalParams extends coreClient.OperationOptions {
1087
+ }
1088
+
1089
+ /** Contains response data for the get operation. */
1090
+ export declare type SimplifiedSolutionsGetResponse = SimplifiedSolutionsResource;
1091
+
1092
+ /** Simplified Solutions response. */
1093
+ export declare interface SimplifiedSolutionsResource extends ProxyResource {
1094
+ /** Solution Id to identify single Simplified Solution. */
1095
+ solutionId?: string;
1096
+ /** Client input parameters to run Simplified Solutions */
1097
+ parameters?: {
1098
+ [propertyName: string]: string;
1099
+ };
1100
+ /**
1101
+ * The title.
1102
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1103
+ */
1104
+ readonly title?: string;
1105
+ /**
1106
+ * Additional parameter response for Simplified Solutions
1107
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1108
+ */
1109
+ readonly appendix?: {
1110
+ [propertyName: string]: string;
1111
+ };
1112
+ /**
1113
+ * The HTML content that needs to be rendered and shown to customer.
1114
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1115
+ */
1116
+ readonly content?: string;
1117
+ /**
1118
+ * Status of Simplified Solution provisioning.
1119
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1120
+ */
1121
+ readonly provisioningState?: SolutionProvisioningState;
1122
+ }
1123
+
906
1124
  /** Interface representing a Solution. */
907
1125
  export declare interface Solution {
908
1126
  /**
909
1127
  * Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
910
1128
  * requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
911
1129
  * self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
912
- * resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware
913
- * diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
914
- * tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
915
- * troubleshooting instructions. All these components are seamlessly converged into unified solutions
916
- * tailored to address a specific support problem area. Each solution type may require one or more
917
- * ‘requiredParameters’ that are required to execute the individual solution component. In the absence
918
- * of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you
919
- * might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from Discovery
920
- * solutions response must be passed via ‘parameters’ in the request body of Solutions API. <br/>2.
921
- * ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the
922
- * request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
923
- * ‘properties.parameters’ in the request for Troubleshooters
1130
+ * resolving typical troubleshooting issues. These solutions encompass: <br/> (1.) Dynamic and
1131
+ * context-aware diagnostics, guided troubleshooting wizards, and data visualizations. <br/> (2.) Rich
1132
+ * instructional video tutorials and illustrative diagrams and images. <br/> (3.) Thoughtfully
1133
+ * assembled textual troubleshooting instructions. <br/> All these components are seamlessly converged
1134
+ * into unified solutions tailored to address a specific support problem area.
924
1135
  * @param scope scope = resourceUri of affected resource.<br/> For example:
925
1136
  * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
926
1137
  *
@@ -932,18 +1143,11 @@ export declare interface Solution {
932
1143
  * Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
933
1144
  * requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
934
1145
  * self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
935
- * resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware
936
- * diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
937
- * tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
938
- * troubleshooting instructions. All these components are seamlessly converged into unified solutions
939
- * tailored to address a specific support problem area. Each solution type may require one or more
940
- * ‘requiredParameters’ that are required to execute the individual solution component. In the absence
941
- * of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you
942
- * might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from Discovery
943
- * solutions response must be passed via ‘parameters’ in the request body of Solutions API. <br/>2.
944
- * ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the
945
- * request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
946
- * ‘properties.parameters’ in the request for Troubleshooters
1146
+ * resolving typical troubleshooting issues. These solutions encompass: <br/> (1.) Dynamic and
1147
+ * context-aware diagnostics, guided troubleshooting wizards, and data visualizations. <br/> (2.) Rich
1148
+ * instructional video tutorials and illustrative diagrams and images. <br/> (3.) Thoughtfully
1149
+ * assembled textual troubleshooting instructions. <br/> All these components are seamlessly converged
1150
+ * into unified solutions tailored to address a specific support problem area.
947
1151
  * @param scope scope = resourceUri of affected resource.<br/> For example:
948
1152
  * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
949
1153
  *
@@ -978,6 +1182,15 @@ export declare interface Solution {
978
1182
  * @param options The options parameters.
979
1183
  */
980
1184
  beginUpdateAndWait(scope: string, solutionResourceName: string, options?: SolutionUpdateOptionalParams): Promise<SolutionUpdateResponse>;
1185
+ /**
1186
+ * Warm up the solution resource by preloading asynchronous diagnostics results into cache
1187
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1188
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1189
+ *
1190
+ * @param solutionResourceName Solution resource Name.
1191
+ * @param options The options parameters.
1192
+ */
1193
+ warmUp(scope: string, solutionResourceName: string, options?: SolutionWarmUpOptionalParams): Promise<void>;
981
1194
  }
982
1195
 
983
1196
  /** Optional parameters. */
@@ -1027,7 +1240,23 @@ export declare interface SolutionMetadataResource extends ProxyResource {
1027
1240
  solutions?: SolutionMetadataProperties[];
1028
1241
  }
1029
1242
 
1030
- /** Solution response */
1243
+ /** Nlp Metadata resource */
1244
+ export declare interface SolutionNlpMetadataResource extends ProxyResource {
1245
+ /** Title of the problem classification. */
1246
+ problemTitle?: string;
1247
+ /** Description of the problem classification. */
1248
+ problemDescription?: string;
1249
+ /** Id of the service (https://learn.microsoft.com/en-us/rest/api/support/services?view=rest-support-2020-04-01) that may be used to create a support ticket. */
1250
+ serviceId?: string;
1251
+ /** Id of the ProblemClassification (https://learn.microsoft.com/en-us/rest/api/support/problem-classifications?view=rest-support-2020-04-01) that may be used to create a support ticket. */
1252
+ problemClassificationId?: string;
1253
+ /** The list of solution metadata. */
1254
+ solutions?: SolutionMetadataProperties[];
1255
+ /** The set of services that are most likely related to the request. If relatedServices is included in the response then solutions may not be discovered until the client calls a second time specifying one of the service Ids in the relatedServices object. */
1256
+ relatedServices?: ClassificationService[];
1257
+ }
1258
+
1259
+ /** Solution PatchRequest body */
1031
1260
  export declare interface SolutionPatchRequestBody {
1032
1261
  /** Solution request trigger criteria */
1033
1262
  triggerCriteria?: TriggerCriterion[];
@@ -1120,6 +1349,35 @@ export declare interface SolutionResource extends ProxyResource {
1120
1349
  readonly sections?: Section[];
1121
1350
  }
1122
1351
 
1352
+ /** Self Help Solution response. */
1353
+ export declare interface SolutionResourceSelfHelp extends ProxyResource {
1354
+ /**
1355
+ * SolutionId is a unique id to identify a solution. You can retrieve the solution id using the Discovery api - https://learn.microsoft.com/en-us/rest/api/help/discovery-solution/list?view=rest-help-2023-09-01-preview&tabs=HTTP
1356
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1357
+ */
1358
+ readonly solutionId?: string;
1359
+ /**
1360
+ * The title.
1361
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1362
+ */
1363
+ readonly title?: string;
1364
+ /**
1365
+ * The HTML content that needs to be rendered and shown to customer.
1366
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1367
+ */
1368
+ readonly content?: string;
1369
+ /**
1370
+ * Solution replacement maps.
1371
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1372
+ */
1373
+ readonly replacementMaps?: ReplacementMapsSelfHelp;
1374
+ /**
1375
+ * List of section object.
1376
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1377
+ */
1378
+ readonly sections?: SectionSelfHelp[];
1379
+ }
1380
+
1123
1381
  /** Solutions Diagnostic */
1124
1382
  export declare interface SolutionsDiagnostic {
1125
1383
  /** Solution Id to identify single Solutions Diagnostic */
@@ -1130,12 +1388,35 @@ export declare interface SolutionsDiagnostic {
1130
1388
  statusDetails?: string;
1131
1389
  /** Place holder used in HTML Content replace control with the content */
1132
1390
  replacementKey?: string;
1391
+ /** Diagnostics estimated completion time in minutes */
1392
+ estimatedCompletionTime?: string;
1133
1393
  /** Required parameters of this item */
1134
1394
  requiredParameters?: string[];
1135
1395
  /** Diagnostic insights */
1136
1396
  insights?: Insight[];
1137
1397
  }
1138
1398
 
1399
+ /** Interface representing a SolutionSelfHelp. */
1400
+ export declare interface SolutionSelfHelp {
1401
+ /**
1402
+ * Gets Self Help Solutions for a given solutionId. Self Help Solutions consist of rich instructional
1403
+ * video tutorials, links and guides to public documentation related to a specific problem that enables
1404
+ * users to troubleshoot Azure issues.
1405
+ * @param solutionId SolutionId is a unique id to identify a solution. You can retrieve the solution id
1406
+ * using the Discovery api -
1407
+ * https://learn.microsoft.com/en-us/rest/api/help/discovery-solution/list?view=rest-help-2023-09-01-preview&tabs=HTTP
1408
+ * @param options The options parameters.
1409
+ */
1410
+ get(solutionId: string, options?: SolutionSelfHelpGetOptionalParams): Promise<SolutionSelfHelpGetResponse>;
1411
+ }
1412
+
1413
+ /** Optional parameters. */
1414
+ export declare interface SolutionSelfHelpGetOptionalParams extends coreClient.OperationOptions {
1415
+ }
1416
+
1417
+ /** Contains response data for the get operation. */
1418
+ export declare type SolutionSelfHelpGetResponse = SolutionResourceSelfHelp;
1419
+
1139
1420
  /** Troubleshooters in Solutions */
1140
1421
  export declare interface SolutionsTroubleshooters {
1141
1422
  /** Solution Id to identify single Solutions Troubleshooter */
@@ -1152,7 +1433,9 @@ export declare interface SolutionsTroubleshooters {
1152
1433
  * this enum contains the known values that the service supports.
1153
1434
  * ### Known values supported by the service
1154
1435
  * **Diagnostics**: Diagnostics resource type. \
1155
- * **Solutions**: Solutions resource type.
1436
+ * **Solutions**: Solutions resource type. \
1437
+ * **Troubleshooters**: Troubleshooters resource type. \
1438
+ * **SelfHelp**: SelfHelp resource type.
1156
1439
  */
1157
1440
  export declare type SolutionType = string;
1158
1441
 
@@ -1174,6 +1457,20 @@ export declare interface SolutionUpdateOptionalParams extends coreClient.Operati
1174
1457
  /** Contains response data for the update operation. */
1175
1458
  export declare type SolutionUpdateResponse = SolutionUpdateHeaders & SolutionResource;
1176
1459
 
1460
+ /** Optional parameters. */
1461
+ export declare interface SolutionWarmUpOptionalParams extends coreClient.OperationOptions {
1462
+ /** The required request body for warming up a solution resource. */
1463
+ solutionWarmUpRequestBody?: SolutionWarmUpRequestBody;
1464
+ }
1465
+
1466
+ /** Solution WarmUpRequest body */
1467
+ export declare interface SolutionWarmUpRequestBody {
1468
+ /** Dictionary of <string> */
1469
+ parameters?: {
1470
+ [propertyName: string]: string;
1471
+ };
1472
+ }
1473
+
1177
1474
  /**
1178
1475
  * Defines values for Status. \
1179
1476
  * {@link KnownStatus} can be used interchangeably with Status,
@@ -1219,6 +1516,8 @@ export declare interface StepInput {
1219
1516
  questionId?: string;
1220
1517
  /** Type of Question */
1221
1518
  questionType?: QuestionType;
1519
+ /** Question title */
1520
+ questionTitle?: string;
1222
1521
  /** User question content. */
1223
1522
  questionContent?: string;
1224
1523
  /** Default is Text. */
@@ -1427,10 +1726,24 @@ export declare type TroubleshootersRestartResponse = TroubleshootersRestartHeade
1427
1726
  * **Decision** \
1428
1727
  * **Solution** \
1429
1728
  * **Insight** \
1430
- * **AutomatedCheck**
1729
+ * **AutomatedCheck** \
1730
+ * **Input**
1431
1731
  */
1432
1732
  export declare type Type = string;
1433
1733
 
1734
+ /**
1735
+ * Defines values for ValidationScope. \
1736
+ * {@link KnownValidationScope} can be used interchangeably with ValidationScope,
1737
+ * this enum contains the known values that the service supports.
1738
+ * ### Known values supported by the service
1739
+ * **None** \
1740
+ * **URLFormat** \
1741
+ * **GuidFormat** \
1742
+ * **IpAddressFormat** \
1743
+ * **NumberOnlyFormat**
1744
+ */
1745
+ export declare type ValidationScope = string;
1746
+
1434
1747
  /** Video detail */
1435
1748
  export declare interface Video extends VideoGroupVideo {
1436
1749
  /** Place holder used in HTML Content replace control with the insight content */
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.38.5"
8
+ "packageVersion": "7.43.1"
9
9
  }
10
10
  ]
11
11
  }