@azure/arm-selfhelp 2.0.0-beta.1 → 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 (174) hide show
  1. package/CHANGELOG.md +214 -1
  2. package/LICENSE +1 -1
  3. package/README.md +3 -2
  4. package/dist/index.js +1679 -907
  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 +3 -3
  11. package/dist-esm/samples-dev/diagnosticsGetSample.js +1 -1
  12. package/dist-esm/samples-dev/discoverySolutionListSample.js +6 -41
  13. package/dist-esm/samples-dev/discoverySolutionListSample.js.map +1 -1
  14. package/dist-esm/samples-dev/discoverySolutionNlpSubscriptionScopePostSample.d.ts +2 -0
  15. package/dist-esm/samples-dev/discoverySolutionNlpSubscriptionScopePostSample.d.ts.map +1 -0
  16. package/dist-esm/samples-dev/discoverySolutionNlpSubscriptionScopePostSample.js +45 -0
  17. package/dist-esm/samples-dev/discoverySolutionNlpSubscriptionScopePostSample.js.map +1 -0
  18. package/dist-esm/samples-dev/discoverySolutionNlpTenantScopePostSample.d.ts +2 -0
  19. package/dist-esm/samples-dev/discoverySolutionNlpTenantScopePostSample.d.ts.map +1 -0
  20. package/dist-esm/samples-dev/discoverySolutionNlpTenantScopePostSample.js +43 -0
  21. package/dist-esm/samples-dev/discoverySolutionNlpTenantScopePostSample.js.map +1 -0
  22. package/dist-esm/samples-dev/operationsListSample.js +5 -3
  23. package/dist-esm/samples-dev/operationsListSample.js.map +1 -1
  24. package/dist-esm/samples-dev/simplifiedSolutionsCreateSample.d.ts +2 -0
  25. package/dist-esm/samples-dev/simplifiedSolutionsCreateSample.d.ts.map +1 -0
  26. package/dist-esm/samples-dev/simplifiedSolutionsCreateSample.js +46 -0
  27. package/dist-esm/samples-dev/simplifiedSolutionsCreateSample.js.map +1 -0
  28. package/dist-esm/samples-dev/simplifiedSolutionsGetSample.d.ts +2 -0
  29. package/dist-esm/samples-dev/simplifiedSolutionsGetSample.d.ts.map +1 -0
  30. package/dist-esm/samples-dev/simplifiedSolutionsGetSample.js +37 -0
  31. package/dist-esm/samples-dev/simplifiedSolutionsGetSample.js.map +1 -0
  32. package/dist-esm/samples-dev/solutionCreateSample.js +8 -10
  33. package/dist-esm/samples-dev/solutionCreateSample.js.map +1 -1
  34. package/dist-esm/samples-dev/solutionGetSample.js +1 -1
  35. package/dist-esm/samples-dev/solutionSelfHelpGetSample.d.ts +2 -0
  36. package/dist-esm/samples-dev/solutionSelfHelpGetSample.d.ts.map +1 -0
  37. package/dist-esm/samples-dev/solutionSelfHelpGetSample.js +36 -0
  38. package/dist-esm/samples-dev/solutionSelfHelpGetSample.js.map +1 -0
  39. package/dist-esm/samples-dev/solutionUpdateSample.js +1 -1
  40. package/dist-esm/samples-dev/solutionWarmUpSample.d.ts +2 -0
  41. package/dist-esm/samples-dev/solutionWarmUpSample.d.ts.map +1 -0
  42. package/dist-esm/samples-dev/solutionWarmUpSample.js +37 -0
  43. package/dist-esm/samples-dev/solutionWarmUpSample.js.map +1 -0
  44. package/dist-esm/samples-dev/troubleshootersContinueSample.js +6 -6
  45. package/dist-esm/samples-dev/troubleshootersContinueSample.js.map +1 -1
  46. package/dist-esm/samples-dev/troubleshootersCreateSample.js +7 -7
  47. package/dist-esm/samples-dev/troubleshootersCreateSample.js.map +1 -1
  48. package/dist-esm/samples-dev/troubleshootersEndSample.js +1 -1
  49. package/dist-esm/samples-dev/troubleshootersGetSample.js +1 -1
  50. package/dist-esm/samples-dev/troubleshootersRestartSample.js +1 -1
  51. package/dist-esm/src/helpRP.d.ts +8 -1
  52. package/dist-esm/src/helpRP.d.ts.map +1 -1
  53. package/dist-esm/src/helpRP.js +25 -15
  54. package/dist-esm/src/helpRP.js.map +1 -1
  55. package/dist-esm/src/lroImpl.js +1 -1
  56. package/dist-esm/src/models/index.d.ts +350 -89
  57. package/dist-esm/src/models/index.d.ts.map +1 -1
  58. package/dist-esm/src/models/index.js +49 -19
  59. package/dist-esm/src/models/index.js.map +1 -1
  60. package/dist-esm/src/models/mappers.d.ts +10 -2
  61. package/dist-esm/src/models/mappers.d.ts.map +1 -1
  62. package/dist-esm/src/models/mappers.js +947 -590
  63. package/dist-esm/src/models/mappers.js.map +1 -1
  64. package/dist-esm/src/models/parameters.d.ts +6 -0
  65. package/dist-esm/src/models/parameters.d.ts.map +1 -1
  66. package/dist-esm/src/models/parameters.js +95 -44
  67. package/dist-esm/src/models/parameters.js.map +1 -1
  68. package/dist-esm/src/operations/checkNameAvailability.d.ts +3 -2
  69. package/dist-esm/src/operations/checkNameAvailability.d.ts.map +1 -1
  70. package/dist-esm/src/operations/checkNameAvailability.js +7 -6
  71. package/dist-esm/src/operations/checkNameAvailability.js.map +1 -1
  72. package/dist-esm/src/operations/diagnostics.d.ts +15 -16
  73. package/dist-esm/src/operations/diagnostics.d.ts.map +1 -1
  74. package/dist-esm/src/operations/diagnostics.js +33 -34
  75. package/dist-esm/src/operations/diagnostics.js.map +1 -1
  76. package/dist-esm/src/operations/discoverySolution.d.ts +5 -13
  77. package/dist-esm/src/operations/discoverySolution.d.ts.map +1 -1
  78. package/dist-esm/src/operations/discoverySolution.js +29 -37
  79. package/dist-esm/src/operations/discoverySolution.js.map +1 -1
  80. package/dist-esm/src/operations/discoverySolutionNLPSubscriptionScope.d.ts +19 -0
  81. package/dist-esm/src/operations/discoverySolutionNLPSubscriptionScope.d.ts.map +1 -0
  82. package/dist-esm/src/operations/discoverySolutionNLPSubscriptionScope.js +49 -0
  83. package/dist-esm/src/operations/discoverySolutionNLPSubscriptionScope.js.map +1 -0
  84. package/dist-esm/src/operations/discoverySolutionNLPTenantScope.d.ts +19 -0
  85. package/dist-esm/src/operations/discoverySolutionNLPTenantScope.d.ts.map +1 -0
  86. package/dist-esm/src/operations/discoverySolutionNLPTenantScope.js +49 -0
  87. package/dist-esm/src/operations/discoverySolutionNLPTenantScope.js.map +1 -0
  88. package/dist-esm/src/operations/index.d.ts +4 -0
  89. package/dist-esm/src/operations/index.d.ts.map +1 -1
  90. package/dist-esm/src/operations/index.js +4 -0
  91. package/dist-esm/src/operations/index.js.map +1 -1
  92. package/dist-esm/src/operations/operations.js +9 -9
  93. package/dist-esm/src/operations/operations.js.map +1 -1
  94. package/dist-esm/src/operations/simplifiedSolutions.d.ts +52 -0
  95. package/dist-esm/src/operations/simplifiedSolutions.d.ts.map +1 -0
  96. package/dist-esm/src/operations/simplifiedSolutions.js +159 -0
  97. package/dist-esm/src/operations/simplifiedSolutions.js.map +1 -0
  98. package/dist-esm/src/operations/solution.d.ts +41 -37
  99. package/dist-esm/src/operations/solution.d.ts.map +1 -1
  100. package/dist-esm/src/operations/solution.js +92 -66
  101. package/dist-esm/src/operations/solution.js.map +1 -1
  102. package/dist-esm/src/operations/solutionSelfHelp.d.ts +23 -0
  103. package/dist-esm/src/operations/solutionSelfHelp.d.ts.map +1 -0
  104. package/dist-esm/src/operations/solutionSelfHelp.js +51 -0
  105. package/dist-esm/src/operations/solutionSelfHelp.js.map +1 -0
  106. package/dist-esm/src/operations/troubleshooters.d.ts +22 -19
  107. package/dist-esm/src/operations/troubleshooters.d.ts.map +1 -1
  108. package/dist-esm/src/operations/troubleshooters.js +48 -45
  109. package/dist-esm/src/operations/troubleshooters.js.map +1 -1
  110. package/dist-esm/src/operationsInterfaces/checkNameAvailability.d.ts +3 -2
  111. package/dist-esm/src/operationsInterfaces/checkNameAvailability.d.ts.map +1 -1
  112. package/dist-esm/src/operationsInterfaces/diagnostics.d.ts +15 -16
  113. package/dist-esm/src/operationsInterfaces/diagnostics.d.ts.map +1 -1
  114. package/dist-esm/src/operationsInterfaces/discoverySolution.d.ts +3 -6
  115. package/dist-esm/src/operationsInterfaces/discoverySolution.d.ts.map +1 -1
  116. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.d.ts +11 -0
  117. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.d.ts.map +1 -0
  118. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.js +9 -0
  119. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.js.map +1 -0
  120. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPTenantScope.d.ts +11 -0
  121. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPTenantScope.d.ts.map +1 -0
  122. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPTenantScope.js +9 -0
  123. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPTenantScope.js.map +1 -0
  124. package/dist-esm/src/operationsInterfaces/index.d.ts +4 -0
  125. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -1
  126. package/dist-esm/src/operationsInterfaces/index.js +4 -0
  127. package/dist-esm/src/operationsInterfaces/index.js.map +1 -1
  128. package/dist-esm/src/operationsInterfaces/simplifiedSolutions.d.ts +44 -0
  129. package/dist-esm/src/operationsInterfaces/simplifiedSolutions.d.ts.map +1 -0
  130. package/dist-esm/src/operationsInterfaces/simplifiedSolutions.js +9 -0
  131. package/dist-esm/src/operationsInterfaces/simplifiedSolutions.js.map +1 -0
  132. package/dist-esm/src/operationsInterfaces/solution.d.ts +41 -37
  133. package/dist-esm/src/operationsInterfaces/solution.d.ts.map +1 -1
  134. package/dist-esm/src/operationsInterfaces/solutionSelfHelp.d.ts +15 -0
  135. package/dist-esm/src/operationsInterfaces/solutionSelfHelp.d.ts.map +1 -0
  136. package/dist-esm/src/operationsInterfaces/solutionSelfHelp.js +9 -0
  137. package/dist-esm/src/operationsInterfaces/solutionSelfHelp.js.map +1 -0
  138. package/dist-esm/src/operationsInterfaces/troubleshooters.d.ts +22 -19
  139. package/dist-esm/src/operationsInterfaces/troubleshooters.d.ts.map +1 -1
  140. package/dist-esm/src/pagingHelper.js.map +1 -1
  141. package/dist-esm/test/selfhelp_operations_test.spec.js +2 -2
  142. package/dist-esm/test/selfhelp_operations_test.spec.js.map +1 -1
  143. package/package.json +11 -11
  144. package/review/arm-selfhelp.api.md +198 -19
  145. package/src/helpRP.ts +58 -17
  146. package/src/lroImpl.ts +3 -3
  147. package/src/models/index.ts +385 -106
  148. package/src/models/mappers.ts +995 -597
  149. package/src/models/parameters.ts +105 -45
  150. package/src/operations/checkNameAvailability.ts +10 -9
  151. package/src/operations/diagnostics.ts +48 -52
  152. package/src/operations/discoverySolution.ts +31 -47
  153. package/src/operations/discoverySolutionNLPSubscriptionScope.ts +64 -0
  154. package/src/operations/discoverySolutionNLPTenantScope.ts +64 -0
  155. package/src/operations/index.ts +4 -0
  156. package/src/operations/operations.ts +16 -16
  157. package/src/operations/simplifiedSolutions.ts +216 -0
  158. package/src/operations/solution.ts +122 -89
  159. package/src/operations/solutionSelfHelp.ts +68 -0
  160. package/src/operations/troubleshooters.ts +64 -66
  161. package/src/operationsInterfaces/checkNameAvailability.ts +5 -4
  162. package/src/operationsInterfaces/diagnostics.ts +19 -20
  163. package/src/operationsInterfaces/discoverySolution.ts +4 -8
  164. package/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.ts +24 -0
  165. package/src/operationsInterfaces/discoverySolutionNLPTenantScope.ts +24 -0
  166. package/src/operationsInterfaces/index.ts +4 -0
  167. package/src/operationsInterfaces/operations.ts +1 -1
  168. package/src/operationsInterfaces/simplifiedSolutions.ts +74 -0
  169. package/src/operationsInterfaces/solution.ts +51 -42
  170. package/src/operationsInterfaces/solutionSelfHelp.ts +29 -0
  171. package/src/operationsInterfaces/troubleshooters.ts +28 -25
  172. package/src/pagingHelper.ts +1 -1
  173. package/types/arm-selfhelp.d.ts +505 -136
  174. 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. */
@@ -51,8 +55,9 @@ export declare interface CheckNameAvailability {
51
55
  /**
52
56
  * This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or
53
57
  * solutions
54
- * @param scope This is an extension resource provider and only resource level extension is supported
55
- * at the moment.
58
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
59
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
60
+ *
56
61
  * @param options The options parameters.
57
62
  */
58
63
  post(scope: string, options?: CheckNameAvailabilityPostOptionalParams): Promise<CheckNameAvailabilityPostResponse>;
@@ -85,6 +90,22 @@ export declare interface CheckNameAvailabilityResponse {
85
90
  message?: string;
86
91
  }
87
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
+
88
109
  /**
89
110
  * Defines values for Confidence. \
90
111
  * {@link KnownConfidence} can be used interchangeably with Confidence,
@@ -145,13 +166,14 @@ export declare interface DiagnosticInvocation {
145
166
  * **Succeeded**: All Diagnostics in the Batch succeeded. \
146
167
  * **PartialComplete**: Some Diagnostics are still running or failed. \
147
168
  * **Failed**: All Diagnostics failed to run. \
169
+ * **Running**: All Diagnostics are still running. \
148
170
  * **Canceled**: When Diagnostic request gets canceled.
149
171
  */
150
172
  export declare type DiagnosticProvisioningState = string;
151
173
 
152
174
  /** Diagnostic resource */
153
175
  export declare interface DiagnosticResource extends ProxyResource {
154
- /** Global parameters that can be passed to all solutionIds. */
176
+ /** Global parameters is an optional map which can be used to add key and value to request body to improve the diagnostics results */
155
177
  globalParameters?: {
156
178
  [propertyName: string]: string;
157
179
  };
@@ -177,33 +199,32 @@ export declare interface DiagnosticResource extends ProxyResource {
177
199
  /** Interface representing a Diagnostics. */
178
200
  export declare interface Diagnostics {
179
201
  /**
180
- * Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
181
- * solutions. <br/>Diagnostics tells you precisely the root cause of the issue and the steps to address
182
- * it. You can get diagnostics once you discover the relevant solution for your Azure issue. <br/><br/>
183
- * <b>Note: </b> requiredInputs’ from Discovery solutions response must be passed via
184
- * ‘additionalParameters’ as an input to Diagnostics API.
185
- * @param scope This is an extension resource provider and only resource level extension is supported
186
- * at the moment.
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/>
205
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
206
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
207
+ *
187
208
  * @param diagnosticsResourceName Unique resource name for insight resources
188
209
  * @param options The options parameters.
189
210
  */
190
211
  beginCreate(scope: string, diagnosticsResourceName: string, options?: DiagnosticsCreateOptionalParams): Promise<SimplePollerLike<OperationState<DiagnosticsCreateResponse>, DiagnosticsCreateResponse>>;
191
212
  /**
192
- * Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
193
- * solutions. <br/>Diagnostics tells you precisely the root cause of the issue and the steps to address
194
- * it. You can get diagnostics once you discover the relevant solution for your Azure issue. <br/><br/>
195
- * <b>Note: </b> requiredInputs’ from Discovery solutions response must be passed via
196
- * ‘additionalParameters’ as an input to Diagnostics API.
197
- * @param scope This is an extension resource provider and only resource level extension is supported
198
- * at the moment.
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/>
216
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
217
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
218
+ *
199
219
  * @param diagnosticsResourceName Unique resource name for insight resources
200
220
  * @param options The options parameters.
201
221
  */
202
222
  beginCreateAndWait(scope: string, diagnosticsResourceName: string, options?: DiagnosticsCreateOptionalParams): Promise<DiagnosticsCreateResponse>;
203
223
  /**
204
224
  * Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
205
- * @param scope This is an extension resource provider and only resource level extension is supported
206
- * at the moment.
225
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
226
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
227
+ *
207
228
  * @param diagnosticsResourceName Unique resource name for insight resources
208
229
  * @param options The options parameters.
209
230
  */
@@ -230,6 +251,24 @@ export declare interface DiagnosticsGetOptionalParams extends coreClient.Operati
230
251
  /** Contains response data for the get operation. */
231
252
  export declare type DiagnosticsGetResponse = DiagnosticResource;
232
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
+
233
272
  /** Discovery response. */
234
273
  export declare interface DiscoveryResponse {
235
274
  /** The list of metadata. */
@@ -241,21 +280,18 @@ export declare interface DiscoveryResponse {
241
280
  /** Interface representing a DiscoverySolution. */
242
281
  export declare interface DiscoverySolution {
243
282
  /**
244
- * Lists the relevant Azure diagnostics and solutions using [problemClassification
283
+ * Lists the relevant Azure Diagnostics, Solutions and Troubleshooters using [problemClassification
245
284
  * API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND
246
285
  * resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API,
247
- * which identifies relevant Azure diagnostics and solutions. We will do our best to return the most
248
- * effective solutions based on the type of inputs, in the request URL <br/><br/> Mandatory input :
286
+ * which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input :
249
287
  * problemClassificationId (Use the [problemClassification
250
288
  * API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
251
289
  * <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from
252
290
  * Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics
253
291
  * and Solutions API.
254
- * @param scope This is an extension resource provider and only resource level extension is supported
255
- * at the moment.
256
292
  * @param options The options parameters.
257
293
  */
258
- list(scope: string, options?: DiscoverySolutionListOptionalParams): PagedAsyncIterableIterator<SolutionMetadataResource>;
294
+ list(options?: DiscoverySolutionListOptionalParams): PagedAsyncIterableIterator<SolutionMetadataResource>;
259
295
  }
260
296
 
261
297
  /** Optional parameters. */
@@ -267,7 +303,7 @@ export declare type DiscoverySolutionListNextResponse = DiscoveryResponse;
267
303
 
268
304
  /** Optional parameters. */
269
305
  export declare interface DiscoverySolutionListOptionalParams extends coreClient.OperationOptions {
270
- /** 'ProblemClassificationId' or 'Id' is a mandatory filter to get solutions ids. It also supports optional 'ResourceType' and 'SolutionType' filters. The filter supports only 'and', 'or' and 'eq' operators. Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' */
306
+ /** 'ProblemClassificationId' is a mandatory filter to get solutions ids. It also supports optional 'ResourceType' and 'SolutionType' filters. The [$filter](https://learn.microsoft.com/en-us/odata/webapi/first-odata-api#filter) supports only 'and', 'or' and 'eq' operators. Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' */
271
307
  filter?: string;
272
308
  /** Skiptoken is only used if a previous operation returned a partial result. */
273
309
  skiptoken?: string;
@@ -276,6 +312,44 @@ export declare interface DiscoverySolutionListOptionalParams extends coreClient.
276
312
  /** Contains response data for the list operation. */
277
313
  export declare type DiscoverySolutionListResponse = DiscoveryResponse;
278
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
+
279
353
  /** The resource management error additional info. */
280
354
  export declare interface ErrorAdditionalInfo {
281
355
  /**
@@ -351,10 +425,10 @@ export declare interface ErrorResponse {
351
425
  * {@link KnownExecutionStatus} can be used interchangeably with ExecutionStatus,
352
426
  * this enum contains the known values that the service supports.
353
427
  * ### Known values supported by the service
354
- * **Success** \
355
- * **Running** \
356
- * **Failed** \
357
- * **Warning**
428
+ * **Success**: Step execution succeeded. \
429
+ * **Running**: Step execution running \
430
+ * **Failed**: Step execution failed \
431
+ * **Warning**: Step execution warning
358
432
  */
359
433
  export declare type ExecutionStatus = string;
360
434
 
@@ -386,11 +460,14 @@ export declare function getContinuationToken(page: unknown): string | undefined;
386
460
  export declare class HelpRP extends coreClient.ServiceClient {
387
461
  $host: string;
388
462
  apiVersion: string;
463
+ subscriptionId?: string;
389
464
  /**
390
465
  * Initializes a new instance of the HelpRP class.
391
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.
392
468
  * @param options The parameter options
393
469
  */
470
+ constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: HelpRPOptionalParams);
394
471
  constructor(credentials: coreAuth.TokenCredential, options?: HelpRPOptionalParams);
395
472
  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
396
473
  private addCustomApiVersionPolicy;
@@ -399,7 +476,11 @@ export declare class HelpRP extends coreClient.ServiceClient {
399
476
  diagnostics: Diagnostics;
400
477
  discoverySolution: DiscoverySolution;
401
478
  solution: Solution;
479
+ simplifiedSolutions: SimplifiedSolutions;
402
480
  troubleshooters: Troubleshooters;
481
+ solutionSelfHelp: SolutionSelfHelp;
482
+ discoverySolutionNLPTenantScope: DiscoverySolutionNLPTenantScope;
483
+ discoverySolutionNLPSubscriptionScope: DiscoverySolutionNLPSubscriptionScope;
403
484
  }
404
485
 
405
486
  /** Optional parameters. */
@@ -497,19 +578,21 @@ export declare enum KnownDiagnosticProvisioningState {
497
578
  PartialComplete = "PartialComplete",
498
579
  /** All Diagnostics failed to run. */
499
580
  Failed = "Failed",
581
+ /** All Diagnostics are still running. */
582
+ Running = "Running",
500
583
  /** When Diagnostic request gets canceled. */
501
584
  Canceled = "Canceled"
502
585
  }
503
586
 
504
587
  /** Known values of {@link ExecutionStatus} that the service accepts. */
505
588
  export declare enum KnownExecutionStatus {
506
- /** Success */
589
+ /** Step execution succeeded. */
507
590
  Success = "Success",
508
- /** Running */
591
+ /** Step execution running */
509
592
  Running = "Running",
510
- /** Failed */
593
+ /** Step execution failed */
511
594
  Failed = "Failed",
512
- /** Warning */
595
+ /** Step execution warning */
513
596
  Warning = "Warning"
514
597
  }
515
598
 
@@ -562,7 +645,11 @@ export declare enum KnownQuestionType {
562
645
  /** Text Input */
563
646
  TextInput = "TextInput",
564
647
  /** MultiLineInfoBox */
565
- MultiLineInfoBox = "MultiLineInfoBox"
648
+ MultiLineInfoBox = "MultiLineInfoBox",
649
+ /** DateTime Picker */
650
+ DateTimePicker = "DateTimePicker",
651
+ /** Multi Select */
652
+ MultiSelect = "MultiSelect"
566
653
  }
567
654
 
568
655
  /** Known values of {@link ResultType} that the service accepts. */
@@ -575,11 +662,15 @@ export declare enum KnownResultType {
575
662
 
576
663
  /** Known values of {@link SolutionProvisioningState} that the service accepts. */
577
664
  export declare enum KnownSolutionProvisioningState {
578
- /** Succeeded */
665
+ /** All Solutions in the Batch succeeded. */
579
666
  Succeeded = "Succeeded",
580
- /** Failed */
667
+ /** Some Solutions are still running or failed. */
668
+ PartialComplete = "PartialComplete",
669
+ /** All Solutions failed to run. */
581
670
  Failed = "Failed",
582
- /** Canceled */
671
+ /** All Solutions are still running. */
672
+ Running = "Running",
673
+ /** When Solutions request gets canceled. */
583
674
  Canceled = "Canceled"
584
675
  }
585
676
 
@@ -588,7 +679,11 @@ export declare enum KnownSolutionType {
588
679
  /** Diagnostics resource type. */
589
680
  Diagnostics = "Diagnostics",
590
681
  /** Solutions resource type. */
591
- Solutions = "Solutions"
682
+ Solutions = "Solutions",
683
+ /** Troubleshooters resource type. */
684
+ Troubleshooters = "Troubleshooters",
685
+ /** SelfHelp resource type. */
686
+ SelfHelp = "SelfHelp"
592
687
  }
593
688
 
594
689
  /** Known values of {@link Status} that the service accepts. */
@@ -628,7 +723,23 @@ export declare enum KnownType {
628
723
  /** Insight */
629
724
  Insight = "Insight",
630
725
  /** AutomatedCheck */
631
- 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"
632
743
  }
633
744
 
634
745
  /** Solutions metrics based chart */
@@ -779,7 +890,9 @@ export declare type QuestionContentType = string;
779
890
  * **RadioButton**: SingleChoice radio button \
780
891
  * **Dropdown**: SingleChoice dropdown. \
781
892
  * **TextInput**: Text Input \
782
- * **MultiLineInfoBox**: MultiLineInfoBox
893
+ * **MultiLineInfoBox**: MultiLineInfoBox \
894
+ * **DateTimePicker**: DateTime Picker \
895
+ * **MultiSelect**: Multi Select
783
896
  */
784
897
  export declare type QuestionType = string;
785
898
 
@@ -799,6 +912,16 @@ export declare interface ReplacementMaps {
799
912
  videoGroups?: VideoGroup[];
800
913
  }
801
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
+
802
925
  /** Common fields that are returned in the response for all Azure Resource Manager resources */
803
926
  export declare interface Resource {
804
927
  /**
@@ -835,6 +958,8 @@ export declare interface ResponseOption {
835
958
  export declare interface ResponseValidationProperties {
836
959
  /** Regex used for the input validation. */
837
960
  regex?: string;
961
+ /** Validation scope */
962
+ validationScope?: ValidationScope;
838
963
  /** Default True */
839
964
  isRequired?: boolean;
840
965
  /** Validation Error Message. */
@@ -892,72 +1017,180 @@ export declare interface Section {
892
1017
  replacementMaps?: ReplacementMaps;
893
1018
  }
894
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
+
895
1124
  /** Interface representing a Solution. */
896
1125
  export declare interface Solution {
897
1126
  /**
898
- * Creates a solution for the specific Azure resource or subscription using the triggering criteria
899
- * ‘solutionId and requiredInputs’ from discovery solutions.<br/> Solutions are a rich, insightful and
900
- * a centralized self help experience that brings all the relevant content to troubleshoot an Azure
901
- * issue into a unified experience. Solutions include the following components : Text, Diagnostics ,
902
- * Troubleshooters, Images , Video tutorials, Tables , custom charts, images , AzureKB, etc, with
903
- * capabilities to support new solutions types in the future. Each solution type may require one or
904
- * more ‘requiredParameters’ that are required to execute the individual solution component. In the
905
- * absence of the ‘requiredParameters’ it is likely that some of the solutions might fail execution,
906
- * and you might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from
907
- * Discovery solutions response must be passed via ‘parameters’ in the request body of Solutions API.
908
- * <br/>2. ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in
909
- * the request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
910
- * ‘properties.parameters’ in the request for Troubleshooters
911
- * @param scope This is an extension resource provider and only resource level extension is supported
912
- * at the moment.
1127
+ * Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
1128
+ * requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
1129
+ * self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
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.
1135
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1136
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1137
+ *
913
1138
  * @param solutionResourceName Solution resource Name.
914
1139
  * @param options The options parameters.
915
1140
  */
916
1141
  beginCreate(scope: string, solutionResourceName: string, options?: SolutionCreateOptionalParams): Promise<SimplePollerLike<OperationState<SolutionCreateResponse>, SolutionCreateResponse>>;
917
1142
  /**
918
- * Creates a solution for the specific Azure resource or subscription using the triggering criteria
919
- * ‘solutionId and requiredInputs’ from discovery solutions.<br/> Solutions are a rich, insightful and
920
- * a centralized self help experience that brings all the relevant content to troubleshoot an Azure
921
- * issue into a unified experience. Solutions include the following components : Text, Diagnostics ,
922
- * Troubleshooters, Images , Video tutorials, Tables , custom charts, images , AzureKB, etc, with
923
- * capabilities to support new solutions types in the future. Each solution type may require one or
924
- * more ‘requiredParameters’ that are required to execute the individual solution component. In the
925
- * absence of the ‘requiredParameters’ it is likely that some of the solutions might fail execution,
926
- * and you might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from
927
- * Discovery solutions response must be passed via ‘parameters’ in the request body of Solutions API.
928
- * <br/>2. ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in
929
- * the request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
930
- * ‘properties.parameters’ in the request for Troubleshooters
931
- * @param scope This is an extension resource provider and only resource level extension is supported
932
- * at the moment.
1143
+ * Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
1144
+ * requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
1145
+ * self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
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.
1151
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1152
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1153
+ *
933
1154
  * @param solutionResourceName Solution resource Name.
934
1155
  * @param options The options parameters.
935
1156
  */
936
1157
  beginCreateAndWait(scope: string, solutionResourceName: string, options?: SolutionCreateOptionalParams): Promise<SolutionCreateResponse>;
937
1158
  /**
938
1159
  * Get the solution using the applicable solutionResourceName while creating the solution.
939
- * @param scope This is an extension resource provider and only resource level extension is supported
940
- * at the moment.
1160
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1161
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1162
+ *
941
1163
  * @param solutionResourceName Solution resource Name.
942
1164
  * @param options The options parameters.
943
1165
  */
944
1166
  get(scope: string, solutionResourceName: string, options?: SolutionGetOptionalParams): Promise<SolutionGetResponse>;
945
1167
  /**
946
1168
  * Update the requiredInputs or additional information needed to execute the solution
947
- * @param scope This is an extension resource provider and only resource level extension is supported
948
- * at the moment.
1169
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1170
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1171
+ *
949
1172
  * @param solutionResourceName Solution resource Name.
950
1173
  * @param options The options parameters.
951
1174
  */
952
1175
  beginUpdate(scope: string, solutionResourceName: string, options?: SolutionUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SolutionUpdateResponse>, SolutionUpdateResponse>>;
953
1176
  /**
954
1177
  * Update the requiredInputs or additional information needed to execute the solution
955
- * @param scope This is an extension resource provider and only resource level extension is supported
956
- * at the moment.
1178
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1179
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1180
+ *
957
1181
  * @param solutionResourceName Solution resource Name.
958
1182
  * @param options The options parameters.
959
1183
  */
960
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>;
961
1194
  }
962
1195
 
963
1196
  /** Optional parameters. */
@@ -1007,10 +1240,60 @@ export declare interface SolutionMetadataResource extends ProxyResource {
1007
1240
  solutions?: SolutionMetadataProperties[];
1008
1241
  }
1009
1242
 
1010
- /** 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 */
1011
1260
  export declare interface SolutionPatchRequestBody {
1012
- /** Solution result */
1013
- properties?: SolutionResourceProperties;
1261
+ /** Solution request trigger criteria */
1262
+ triggerCriteria?: TriggerCriterion[];
1263
+ /** Client input parameters to run Solution */
1264
+ parameters?: {
1265
+ [propertyName: string]: string;
1266
+ };
1267
+ /**
1268
+ * Solution Id to identify single solution.
1269
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1270
+ */
1271
+ readonly solutionId?: string;
1272
+ /**
1273
+ * Status of solution provisioning.
1274
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1275
+ */
1276
+ readonly provisioningState?: SolutionProvisioningState;
1277
+ /**
1278
+ * The title.
1279
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1280
+ */
1281
+ readonly title?: string;
1282
+ /**
1283
+ * The HTML content that needs to be rendered and shown to customer.
1284
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1285
+ */
1286
+ readonly content?: string;
1287
+ /**
1288
+ * Solution replacement maps.
1289
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1290
+ */
1291
+ readonly replacementMaps?: ReplacementMaps;
1292
+ /**
1293
+ * List of section object.
1294
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1295
+ */
1296
+ readonly sections?: Section[];
1014
1297
  }
1015
1298
 
1016
1299
  /**
@@ -1018,53 +1301,81 @@ export declare interface SolutionPatchRequestBody {
1018
1301
  * {@link KnownSolutionProvisioningState} can be used interchangeably with SolutionProvisioningState,
1019
1302
  * this enum contains the known values that the service supports.
1020
1303
  * ### Known values supported by the service
1021
- * **Succeeded** \
1022
- * **Failed** \
1023
- * **Canceled**
1304
+ * **Succeeded**: All Solutions in the Batch succeeded. \
1305
+ * **PartialComplete**: Some Solutions are still running or failed. \
1306
+ * **Failed**: All Solutions failed to run. \
1307
+ * **Running**: All Solutions are still running. \
1308
+ * **Canceled**: When Solutions request gets canceled.
1024
1309
  */
1025
1310
  export declare type SolutionProvisioningState = string;
1026
1311
 
1027
1312
  /** Solution response. */
1028
- export declare interface SolutionResource {
1313
+ export declare interface SolutionResource extends ProxyResource {
1314
+ /** Solution request trigger criteria */
1315
+ triggerCriteria?: TriggerCriterion[];
1316
+ /** Client input parameters to run Solution */
1317
+ parameters?: {
1318
+ [propertyName: string]: string;
1319
+ };
1029
1320
  /**
1030
- * Full resource uri of the resource.
1321
+ * Solution Id to identify single solution.
1031
1322
  * NOTE: This property will not be serialized. It can only be populated by the server.
1032
1323
  */
1033
- readonly id?: string;
1324
+ readonly solutionId?: string;
1034
1325
  /**
1035
- * Type of resource.
1326
+ * Status of solution provisioning.
1036
1327
  * NOTE: This property will not be serialized. It can only be populated by the server.
1037
1328
  */
1038
- readonly type?: string;
1329
+ readonly provisioningState?: SolutionProvisioningState;
1039
1330
  /**
1040
- * Resource name.
1331
+ * The title.
1041
1332
  * NOTE: This property will not be serialized. It can only be populated by the server.
1042
1333
  */
1043
- readonly name?: string;
1044
- /** Solution result */
1045
- properties?: SolutionResourceProperties;
1334
+ readonly title?: string;
1335
+ /**
1336
+ * The HTML content that needs to be rendered and shown to customer.
1337
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1338
+ */
1339
+ readonly content?: string;
1340
+ /**
1341
+ * Solution replacement maps.
1342
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1343
+ */
1344
+ readonly replacementMaps?: ReplacementMaps;
1345
+ /**
1346
+ * List of section object.
1347
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1348
+ */
1349
+ readonly sections?: Section[];
1046
1350
  }
1047
1351
 
1048
- /** Solution result */
1049
- export declare interface SolutionResourceProperties {
1050
- /** Solution request trigger criteria */
1051
- triggerCriteria?: TriggerCriterion[];
1052
- /** Client input parameters to run Solution */
1053
- parameters?: {
1054
- [propertyName: string]: string;
1055
- };
1056
- /** Solution Id to identify single solution. */
1057
- solutionId?: string;
1058
- /** Status of solution provisioning. */
1059
- provisioningState?: SolutionProvisioningState;
1060
- /** The title. */
1061
- title?: string;
1062
- /** The HTML content that needs to be rendered and shown to customer. */
1063
- content?: string;
1064
- /** Solution replacement maps. */
1065
- replacementMaps?: ReplacementMaps;
1066
- /** List of section object. */
1067
- sections?: Section[];
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[];
1068
1379
  }
1069
1380
 
1070
1381
  /** Solutions Diagnostic */
@@ -1077,12 +1388,35 @@ export declare interface SolutionsDiagnostic {
1077
1388
  statusDetails?: string;
1078
1389
  /** Place holder used in HTML Content replace control with the content */
1079
1390
  replacementKey?: string;
1391
+ /** Diagnostics estimated completion time in minutes */
1392
+ estimatedCompletionTime?: string;
1080
1393
  /** Required parameters of this item */
1081
1394
  requiredParameters?: string[];
1082
1395
  /** Diagnostic insights */
1083
1396
  insights?: Insight[];
1084
1397
  }
1085
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
+
1086
1420
  /** Troubleshooters in Solutions */
1087
1421
  export declare interface SolutionsTroubleshooters {
1088
1422
  /** Solution Id to identify single Solutions Troubleshooter */
@@ -1099,7 +1433,9 @@ export declare interface SolutionsTroubleshooters {
1099
1433
  * this enum contains the known values that the service supports.
1100
1434
  * ### Known values supported by the service
1101
1435
  * **Diagnostics**: Diagnostics resource type. \
1102
- * **Solutions**: Solutions resource type.
1436
+ * **Solutions**: Solutions resource type. \
1437
+ * **Troubleshooters**: Troubleshooters resource type. \
1438
+ * **SelfHelp**: SelfHelp resource type.
1103
1439
  */
1104
1440
  export declare type SolutionType = string;
1105
1441
 
@@ -1121,6 +1457,20 @@ export declare interface SolutionUpdateOptionalParams extends coreClient.Operati
1121
1457
  /** Contains response data for the update operation. */
1122
1458
  export declare type SolutionUpdateResponse = SolutionUpdateHeaders & SolutionResource;
1123
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
+
1124
1474
  /**
1125
1475
  * Defines values for Status. \
1126
1476
  * {@link KnownStatus} can be used interchangeably with Status,
@@ -1164,8 +1514,10 @@ export declare interface Step {
1164
1514
  export declare interface StepInput {
1165
1515
  /** Use Index as QuestionId. */
1166
1516
  questionId?: string;
1167
- /** Text Input. Will be a single line input. */
1168
- questionType?: string;
1517
+ /** Type of Question */
1518
+ questionType?: QuestionType;
1519
+ /** Question title */
1520
+ questionTitle?: string;
1169
1521
  /** User question content. */
1170
1522
  questionContent?: string;
1171
1523
  /** Default is Text. */
@@ -1242,7 +1594,7 @@ export declare interface TroubleshooterResource extends ProxyResource {
1242
1594
  export declare interface TroubleshooterResponse {
1243
1595
  /** id of the question. */
1244
1596
  questionId?: string;
1245
- /** Text Input. Will be a single line input. */
1597
+ /** Type of Question */
1246
1598
  questionType?: QuestionType;
1247
1599
  /** Response key for SingleInput. For Multi-line test/open ended question it is free form text */
1248
1600
  response?: string;
@@ -1252,17 +1604,16 @@ export declare interface TroubleshooterResponse {
1252
1604
  export declare interface Troubleshooters {
1253
1605
  /**
1254
1606
  * Creates the specific troubleshooter action under a resource or subscription using the ‘solutionId’
1255
- * and ‘properties.parameters’ as the trigger. <br/> Troubleshooters are step-by-step interactive
1256
- * guidance that scope the problem by collecting additional inputs from you in each stage while
1257
- * troubleshooting an Azure issue. You will be guided down decision tree style workflow and the best
1258
- * possible solution will be presented at the end of the workflow. <br/> Create API creates the
1259
- * Troubleshooter API using ‘parameters’ and ‘solutionId’ <br/> After creating the Troubleshooter
1260
- * instance, the following APIs can be used:<br/> CONTINUE API: to move to the next step in the flow
1261
- * <br/>GET API: to identify the next step after executing the CONTINUE API. <br/><br/> <b>Note:</b>
1262
- * ‘requiredParameters’ from solutions response must be passed via ‘properties. parameters’ in the
1263
- * request body of Troubleshooters API.
1264
- * @param scope This is an extension resource provider and only resource level extension is supported
1265
- * at the moment.
1607
+ * and ‘properties.parameters’ as the trigger. <br/> Azure Troubleshooters help with hard to classify
1608
+ * issues, reducing the gap between customer observed problems and solutions by guiding the user
1609
+ * effortlessly through the troubleshooting process. Each Troubleshooter flow represents a problem area
1610
+ * within Azure and has a complex tree-like structure that addresses many root causes. These flows are
1611
+ * prepared with the help of Subject Matter experts and customer support engineers by carefully
1612
+ * considering previous support requests raised by customers. Troubleshooters terminate at a well
1613
+ * curated solution based off of resource backend signals and customer manual selections.
1614
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1615
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1616
+ *
1266
1617
  * @param troubleshooterName Troubleshooter resource Name.
1267
1618
  * @param options The options parameters.
1268
1619
  */
@@ -1272,8 +1623,9 @@ export declare interface Troubleshooters {
1272
1623
  * resource name that is being executed.<br/> Get API is used to retrieve the result of a
1273
1624
  * Troubleshooter instance, which includes the status and result of each step in the Troubleshooter
1274
1625
  * workflow. This API requires the Troubleshooter resource name that was created using the Create API.
1275
- * @param scope This is an extension resource provider and only resource level extension is supported
1276
- * at the moment.
1626
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1627
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1628
+ *
1277
1629
  * @param troubleshooterName Troubleshooter resource Name.
1278
1630
  * @param options The options parameters.
1279
1631
  */
@@ -1283,16 +1635,18 @@ export declare interface Troubleshooters {
1283
1635
  * respective troubleshooter resource name. <br/>Continue API is used to provide inputs that are
1284
1636
  * required for the specific troubleshooter to progress into the next step in the process. This API is
1285
1637
  * used after the Troubleshooter has been created using the Create API.
1286
- * @param scope This is an extension resource provider and only resource level extension is supported
1287
- * at the moment.
1638
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1639
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1640
+ *
1288
1641
  * @param troubleshooterName Troubleshooter resource Name.
1289
1642
  * @param options The options parameters.
1290
1643
  */
1291
1644
  continue(scope: string, troubleshooterName: string, options?: TroubleshootersContinueOptionalParams): Promise<TroubleshootersContinueResponse>;
1292
1645
  /**
1293
1646
  * Ends the troubleshooter action
1294
- * @param scope This is an extension resource provider and only resource level extension is supported
1295
- * at the moment.
1647
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1648
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1649
+ *
1296
1650
  * @param troubleshooterName Troubleshooter resource Name.
1297
1651
  * @param options The options parameters.
1298
1652
  */
@@ -1301,8 +1655,9 @@ export declare interface Troubleshooters {
1301
1655
  * Restarts the troubleshooter API using applicable troubleshooter resource name as the input.<br/> It
1302
1656
  * returns new resource name which should be used in subsequent request. The old resource name is
1303
1657
  * obsolete after this API is invoked.
1304
- * @param scope This is an extension resource provider and only resource level extension is supported
1305
- * at the moment.
1658
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
1659
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
1660
+ *
1306
1661
  * @param troubleshooterName Troubleshooter resource Name.
1307
1662
  * @param options The options parameters.
1308
1663
  */
@@ -1371,10 +1726,24 @@ export declare type TroubleshootersRestartResponse = TroubleshootersRestartHeade
1371
1726
  * **Decision** \
1372
1727
  * **Solution** \
1373
1728
  * **Insight** \
1374
- * **AutomatedCheck**
1729
+ * **AutomatedCheck** \
1730
+ * **Input**
1375
1731
  */
1376
1732
  export declare type Type = string;
1377
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
+
1378
1747
  /** Video detail */
1379
1748
  export declare interface Video extends VideoGroupVideo {
1380
1749
  /** Place holder used in HTML Content replace control with the insight content */