@azure/arm-selfhelp 1.0.1-alpha.20231016.1 → 2.0.0-beta.1

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 (135) hide show
  1. package/CHANGELOG.md +92 -8
  2. package/README.md +2 -2
  3. package/dist/index.js +2045 -391
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.min.js +1 -1
  6. package/dist/index.min.js.map +1 -1
  7. package/dist-esm/samples-dev/checkNameAvailabilityPostSample.d.ts +2 -0
  8. package/dist-esm/samples-dev/checkNameAvailabilityPostSample.d.ts.map +1 -0
  9. package/dist-esm/samples-dev/{diagnosticsCheckNameAvailabilitySample.js → checkNameAvailabilityPostSample.js} +9 -9
  10. package/dist-esm/samples-dev/checkNameAvailabilityPostSample.js.map +1 -0
  11. package/dist-esm/samples-dev/diagnosticsCreateSample.js +5 -14
  12. package/dist-esm/samples-dev/diagnosticsCreateSample.js.map +1 -1
  13. package/dist-esm/samples-dev/diagnosticsGetSample.js +2 -2
  14. package/dist-esm/samples-dev/discoverySolutionListSample.js +44 -13
  15. package/dist-esm/samples-dev/discoverySolutionListSample.js.map +1 -1
  16. package/dist-esm/samples-dev/operationsListSample.js +4 -9
  17. package/dist-esm/samples-dev/operationsListSample.js.map +1 -1
  18. package/dist-esm/samples-dev/solutionCreateSample.d.ts +2 -0
  19. package/dist-esm/samples-dev/solutionCreateSample.d.ts.map +1 -0
  20. package/dist-esm/samples-dev/solutionCreateSample.js +46 -0
  21. package/dist-esm/samples-dev/solutionCreateSample.js.map +1 -0
  22. package/dist-esm/samples-dev/solutionGetSample.d.ts +2 -0
  23. package/dist-esm/samples-dev/solutionGetSample.d.ts.map +1 -0
  24. package/dist-esm/samples-dev/solutionGetSample.js +37 -0
  25. package/dist-esm/samples-dev/solutionGetSample.js.map +1 -0
  26. package/dist-esm/samples-dev/solutionUpdateSample.d.ts +2 -0
  27. package/dist-esm/samples-dev/solutionUpdateSample.d.ts.map +1 -0
  28. package/dist-esm/samples-dev/solutionUpdateSample.js +37 -0
  29. package/dist-esm/samples-dev/solutionUpdateSample.js.map +1 -0
  30. package/dist-esm/samples-dev/troubleshootersContinueSample.d.ts +2 -0
  31. package/dist-esm/samples-dev/troubleshootersContinueSample.d.ts.map +1 -0
  32. package/dist-esm/samples-dev/troubleshootersContinueSample.js +50 -0
  33. package/dist-esm/samples-dev/troubleshootersContinueSample.js.map +1 -0
  34. package/dist-esm/samples-dev/troubleshootersCreateSample.d.ts +2 -0
  35. package/dist-esm/samples-dev/troubleshootersCreateSample.d.ts.map +1 -0
  36. package/dist-esm/samples-dev/troubleshootersCreateSample.js +46 -0
  37. package/dist-esm/samples-dev/troubleshootersCreateSample.js.map +1 -0
  38. package/dist-esm/samples-dev/troubleshootersEndSample.d.ts +2 -0
  39. package/dist-esm/samples-dev/troubleshootersEndSample.d.ts.map +1 -0
  40. package/dist-esm/samples-dev/troubleshootersEndSample.js +37 -0
  41. package/dist-esm/samples-dev/troubleshootersEndSample.js.map +1 -0
  42. package/dist-esm/samples-dev/troubleshootersGetSample.d.ts +2 -0
  43. package/dist-esm/samples-dev/troubleshootersGetSample.d.ts.map +1 -0
  44. package/dist-esm/samples-dev/troubleshootersGetSample.js +37 -0
  45. package/dist-esm/samples-dev/troubleshootersGetSample.js.map +1 -0
  46. package/dist-esm/samples-dev/troubleshootersRestartSample.d.ts +2 -0
  47. package/dist-esm/samples-dev/troubleshootersRestartSample.d.ts.map +1 -0
  48. package/dist-esm/samples-dev/troubleshootersRestartSample.js +37 -0
  49. package/dist-esm/samples-dev/troubleshootersRestartSample.js.map +1 -0
  50. package/dist-esm/src/helpRP.d.ts +4 -1
  51. package/dist-esm/src/helpRP.d.ts.map +1 -1
  52. package/dist-esm/src/helpRP.js +6 -3
  53. package/dist-esm/src/helpRP.js.map +1 -1
  54. package/dist-esm/src/models/index.d.ts +641 -22
  55. package/dist-esm/src/models/index.d.ts.map +1 -1
  56. package/dist-esm/src/models/index.js +140 -8
  57. package/dist-esm/src/models/index.js.map +1 -1
  58. package/dist-esm/src/models/mappers.d.ts +30 -0
  59. package/dist-esm/src/models/mappers.d.ts.map +1 -1
  60. package/dist-esm/src/models/mappers.js +988 -13
  61. package/dist-esm/src/models/mappers.js.map +1 -1
  62. package/dist-esm/src/models/parameters.d.ts +6 -0
  63. package/dist-esm/src/models/parameters.d.ts.map +1 -1
  64. package/dist-esm/src/models/parameters.js +48 -2
  65. package/dist-esm/src/models/parameters.js.map +1 -1
  66. package/dist-esm/src/operations/checkNameAvailability.d.ts +21 -0
  67. package/dist-esm/src/operations/checkNameAvailability.d.ts.map +1 -0
  68. package/dist-esm/src/operations/checkNameAvailability.js +51 -0
  69. package/dist-esm/src/operations/checkNameAvailability.js.map +1 -0
  70. package/dist-esm/src/operations/diagnostics.d.ts +11 -18
  71. package/dist-esm/src/operations/diagnostics.d.ts.map +1 -1
  72. package/dist-esm/src/operations/diagnostics.js +10 -37
  73. package/dist-esm/src/operations/diagnostics.js.map +1 -1
  74. package/dist-esm/src/operations/discoverySolution.d.ts +20 -14
  75. package/dist-esm/src/operations/discoverySolution.d.ts.map +1 -1
  76. package/dist-esm/src/operations/discoverySolution.js +23 -22
  77. package/dist-esm/src/operations/discoverySolution.js.map +1 -1
  78. package/dist-esm/src/operations/index.d.ts +3 -0
  79. package/dist-esm/src/operations/index.d.ts.map +1 -1
  80. package/dist-esm/src/operations/index.js +3 -0
  81. package/dist-esm/src/operations/index.js.map +1 -1
  82. package/dist-esm/src/operations/operations.js +3 -8
  83. package/dist-esm/src/operations/operations.js.map +1 -1
  84. package/dist-esm/src/operations/solution.d.ts +78 -0
  85. package/dist-esm/src/operations/solution.d.ts.map +1 -0
  86. package/dist-esm/src/operations/solution.js +262 -0
  87. package/dist-esm/src/operations/solution.js.map +1 -0
  88. package/dist-esm/src/operations/troubleshooters.d.ts +70 -0
  89. package/dist-esm/src/operations/troubleshooters.d.ts.map +1 -0
  90. package/dist-esm/src/operations/troubleshooters.js +198 -0
  91. package/dist-esm/src/operations/troubleshooters.js.map +1 -0
  92. package/dist-esm/src/operationsInterfaces/checkNameAvailability.d.ts +13 -0
  93. package/dist-esm/src/operationsInterfaces/checkNameAvailability.d.ts.map +1 -0
  94. package/dist-esm/src/operationsInterfaces/checkNameAvailability.js +9 -0
  95. package/dist-esm/src/operationsInterfaces/checkNameAvailability.js.map +1 -0
  96. package/dist-esm/src/operationsInterfaces/diagnostics.d.ts +11 -18
  97. package/dist-esm/src/operationsInterfaces/diagnostics.d.ts.map +1 -1
  98. package/dist-esm/src/operationsInterfaces/discoverySolution.d.ts +10 -7
  99. package/dist-esm/src/operationsInterfaces/discoverySolution.d.ts.map +1 -1
  100. package/dist-esm/src/operationsInterfaces/index.d.ts +3 -0
  101. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -1
  102. package/dist-esm/src/operationsInterfaces/index.js +3 -0
  103. package/dist-esm/src/operationsInterfaces/index.js.map +1 -1
  104. package/dist-esm/src/operationsInterfaces/solution.d.ts +70 -0
  105. package/dist-esm/src/operationsInterfaces/solution.d.ts.map +1 -0
  106. package/dist-esm/src/operationsInterfaces/solution.js +9 -0
  107. package/dist-esm/src/operationsInterfaces/solution.js.map +1 -0
  108. package/dist-esm/src/operationsInterfaces/troubleshooters.d.ts +62 -0
  109. package/dist-esm/src/operationsInterfaces/troubleshooters.d.ts.map +1 -0
  110. package/dist-esm/src/operationsInterfaces/troubleshooters.js +9 -0
  111. package/dist-esm/src/operationsInterfaces/troubleshooters.js.map +1 -0
  112. package/dist-esm/test/selfhelp_operations_test.spec.js +5 -20
  113. package/dist-esm/test/selfhelp_operations_test.spec.js.map +1 -1
  114. package/package.json +7 -7
  115. package/review/arm-selfhelp.api.md +469 -17
  116. package/src/helpRP.ts +16 -4
  117. package/src/models/index.ts +712 -22
  118. package/src/models/mappers.ts +1024 -13
  119. package/src/models/parameters.ts +58 -2
  120. package/src/operations/checkNameAvailability.ts +68 -0
  121. package/src/operations/diagnostics.ts +10 -46
  122. package/src/operations/discoverySolution.ts +20 -14
  123. package/src/operations/index.ts +3 -0
  124. package/src/operations/solution.ts +349 -0
  125. package/src/operations/troubleshooters.ts +261 -0
  126. package/src/operationsInterfaces/checkNameAvailability.ts +27 -0
  127. package/src/operationsInterfaces/diagnostics.ts +10 -22
  128. package/src/operationsInterfaces/discoverySolution.ts +10 -7
  129. package/src/operationsInterfaces/index.ts +3 -0
  130. package/src/operationsInterfaces/solution.ts +115 -0
  131. package/src/operationsInterfaces/troubleshooters.ts +101 -0
  132. package/types/arm-selfhelp.d.ts +892 -63
  133. package/dist-esm/samples-dev/diagnosticsCheckNameAvailabilitySample.d.ts +0 -2
  134. package/dist-esm/samples-dev/diagnosticsCheckNameAvailabilitySample.d.ts.map +0 -1
  135. package/dist-esm/samples-dev/diagnosticsCheckNameAvailabilitySample.js.map +0 -1
@@ -13,6 +13,60 @@ import { SimplePollerLike } from '@azure/core-lro';
13
13
  */
14
14
  export declare type ActionType = string;
15
15
 
16
+ /**
17
+ * Defines values for AggregationType. \
18
+ * {@link KnownAggregationType} can be used interchangeably with AggregationType,
19
+ * this enum contains the known values that the service supports.
20
+ * ### Known values supported by the service
21
+ * **Sum** \
22
+ * **Avg** \
23
+ * **Count** \
24
+ * **Min** \
25
+ * **Max**
26
+ */
27
+ export declare type AggregationType = string;
28
+
29
+ /** Only for AutomatedStep type */
30
+ export declare interface AutomatedCheckResult {
31
+ /** Insight Article Content */
32
+ result?: string;
33
+ /** Type of Result. */
34
+ type?: AutomatedCheckResultType;
35
+ }
36
+
37
+ /**
38
+ * Defines values for AutomatedCheckResultType. \
39
+ * {@link KnownAutomatedCheckResultType} can be used interchangeably with AutomatedCheckResultType,
40
+ * this enum contains the known values that the service supports.
41
+ * ### Known values supported by the service
42
+ * **Success** \
43
+ * **Warning** \
44
+ * **Error** \
45
+ * **Information**
46
+ */
47
+ export declare type AutomatedCheckResultType = string;
48
+
49
+ /** Interface representing a CheckNameAvailability. */
50
+ export declare interface CheckNameAvailability {
51
+ /**
52
+ * This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or
53
+ * solutions
54
+ * @param scope This is an extension resource provider and only resource level extension is supported
55
+ * at the moment.
56
+ * @param options The options parameters.
57
+ */
58
+ post(scope: string, options?: CheckNameAvailabilityPostOptionalParams): Promise<CheckNameAvailabilityPostResponse>;
59
+ }
60
+
61
+ /** Optional parameters. */
62
+ export declare interface CheckNameAvailabilityPostOptionalParams extends coreClient.OperationOptions {
63
+ /** The required parameters for availability check. */
64
+ checkNameAvailabilityRequest?: CheckNameAvailabilityRequest;
65
+ }
66
+
67
+ /** Contains response data for the post operation. */
68
+ export declare type CheckNameAvailabilityPostResponse = CheckNameAvailabilityResponse;
69
+
16
70
  /** The check availability request body. */
17
71
  export declare interface CheckNameAvailabilityRequest {
18
72
  /** The name of the resource for which availability needs to be checked. */
@@ -31,6 +85,24 @@ export declare interface CheckNameAvailabilityResponse {
31
85
  message?: string;
32
86
  }
33
87
 
88
+ /**
89
+ * Defines values for Confidence. \
90
+ * {@link KnownConfidence} can be used interchangeably with Confidence,
91
+ * this enum contains the known values that the service supports.
92
+ * ### Known values supported by the service
93
+ * **Low** \
94
+ * **Medium** \
95
+ * **High**
96
+ */
97
+ export declare type Confidence = string;
98
+
99
+ /** Troubleshooter ContinueRequest body. */
100
+ export declare interface ContinueRequestBody {
101
+ /** Unique id of the result. */
102
+ stepId?: string;
103
+ responses?: TroubleshooterResponse[];
104
+ }
105
+
34
106
  /**
35
107
  * Defines values for CreatedByType. \
36
108
  * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
@@ -65,6 +137,18 @@ export declare interface DiagnosticInvocation {
65
137
  };
66
138
  }
67
139
 
140
+ /**
141
+ * Defines values for DiagnosticProvisioningState. \
142
+ * {@link KnownDiagnosticProvisioningState} can be used interchangeably with DiagnosticProvisioningState,
143
+ * this enum contains the known values that the service supports.
144
+ * ### Known values supported by the service
145
+ * **Succeeded**: All Diagnostics in the Batch succeeded. \
146
+ * **PartialComplete**: Some Diagnostics are still running or failed. \
147
+ * **Failed**: All Diagnostics failed to run. \
148
+ * **Canceled**: When Diagnostic request gets canceled.
149
+ */
150
+ export declare type DiagnosticProvisioningState = string;
151
+
68
152
  /** Diagnostic resource */
69
153
  export declare interface DiagnosticResource extends ProxyResource {
70
154
  /** Global parameters that can be passed to all solutionIds. */
@@ -82,7 +166,7 @@ export declare interface DiagnosticResource extends ProxyResource {
82
166
  * Status of diagnostic provisioning.
83
167
  * NOTE: This property will not be serialized. It can only be populated by the server.
84
168
  */
85
- readonly provisioningState?: ProvisioningState;
169
+ readonly provisioningState?: DiagnosticProvisioningState;
86
170
  /**
87
171
  * Array of Diagnostics.
88
172
  * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -93,18 +177,11 @@ export declare interface DiagnosticResource extends ProxyResource {
93
177
  /** Interface representing a Diagnostics. */
94
178
  export declare interface Diagnostics {
95
179
  /**
96
- * This API is used to check the uniqueness of a resource name used for a diagnostic check.
97
- * @param scope This is an extension resource provider and only resource level extension is supported
98
- * at the moment.
99
- * @param options The options parameters.
100
- */
101
- checkNameAvailability(scope: string, options?: DiagnosticsCheckNameAvailabilityOptionalParams): Promise<DiagnosticsCheckNameAvailabilityResponse>;
102
- /**
103
- * Diagnostics tells you precisely the root cause of the issue and how to address it. You can get
104
- * diagnostics once you discover and identify the relevant solution for your Azure issue.<br/><br/> You
105
- * can create diagnostics using the ‘solutionId’ from Solution Discovery API response and
106
- * ‘additionalParameters’ <br/><br/> <b>Note: </b>‘requiredParameterSets’ from Solutions Discovery API
107
- * response must be passed via ‘additionalParameters’ as an input to Diagnostics API
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.
108
185
  * @param scope This is an extension resource provider and only resource level extension is supported
109
186
  * at the moment.
110
187
  * @param diagnosticsResourceName Unique resource name for insight resources
@@ -112,11 +189,11 @@ export declare interface Diagnostics {
112
189
  */
113
190
  beginCreate(scope: string, diagnosticsResourceName: string, options?: DiagnosticsCreateOptionalParams): Promise<SimplePollerLike<OperationState<DiagnosticsCreateResponse>, DiagnosticsCreateResponse>>;
114
191
  /**
115
- * Diagnostics tells you precisely the root cause of the issue and how to address it. You can get
116
- * diagnostics once you discover and identify the relevant solution for your Azure issue.<br/><br/> You
117
- * can create diagnostics using the ‘solutionId’ from Solution Discovery API response and
118
- * ‘additionalParameters’ <br/><br/> <b>Note: </b>‘requiredParameterSets’ from Solutions Discovery API
119
- * response must be passed via ‘additionalParameters’ as an input to Diagnostics API
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.
120
197
  * @param scope This is an extension resource provider and only resource level extension is supported
121
198
  * at the moment.
122
199
  * @param diagnosticsResourceName Unique resource name for insight resources
@@ -133,15 +210,6 @@ export declare interface Diagnostics {
133
210
  get(scope: string, diagnosticsResourceName: string, options?: DiagnosticsGetOptionalParams): Promise<DiagnosticsGetResponse>;
134
211
  }
135
212
 
136
- /** Optional parameters. */
137
- export declare interface DiagnosticsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
138
- /** The required parameters for availability check. */
139
- checkNameAvailabilityRequest?: CheckNameAvailabilityRequest;
140
- }
141
-
142
- /** Contains response data for the checkNameAvailability operation. */
143
- export declare type DiagnosticsCheckNameAvailabilityResponse = CheckNameAvailabilityResponse;
144
-
145
213
  /** Optional parameters. */
146
214
  export declare interface DiagnosticsCreateOptionalParams extends coreClient.OperationOptions {
147
215
  /** The required request body for this insightResource invocation. */
@@ -164,7 +232,7 @@ export declare type DiagnosticsGetResponse = DiagnosticResource;
164
232
 
165
233
  /** Discovery response. */
166
234
  export declare interface DiscoveryResponse {
167
- /** The list of solution metadata. */
235
+ /** The list of metadata. */
168
236
  value?: SolutionMetadataResource[];
169
237
  /** The link used to get the next page of solution metadata. */
170
238
  nextLink?: string;
@@ -173,13 +241,16 @@ export declare interface DiscoveryResponse {
173
241
  /** Interface representing a DiscoverySolution. */
174
242
  export declare interface DiscoverySolution {
175
243
  /**
176
- * Solutions Discovery is the initial point of entry within Help API, which helps you identify the
177
- * relevant solutions for your Azure issue.<br/><br/> You can discover solutions using resourceUri OR
178
- * resourceUri + problemClassificationId.<br/><br/>We will do our best in returning relevant
179
- * diagnostics for your Azure issue.<br/><br/> Get the problemClassificationId(s) using this
180
- * [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).<br/><br/>
181
- * <b>Note: </b> ‘requiredParameterSets’ from Solutions Discovery API response must be passed via
182
- * ‘additionalParameters’ as an input to Diagnostics API.
244
+ * Lists the relevant Azure diagnostics and solutions using [problemClassification
245
+ * API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND
246
+ * 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 :
249
+ * problemClassificationId (Use the [problemClassification
250
+ * API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
251
+ * <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from
252
+ * Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics
253
+ * and Solutions API.
183
254
  * @param scope This is an extension resource provider and only resource level extension is supported
184
255
  * at the moment.
185
256
  * @param options The options parameters.
@@ -196,9 +267,9 @@ export declare type DiscoverySolutionListNextResponse = DiscoveryResponse;
196
267
 
197
268
  /** Optional parameters. */
198
269
  export declare interface DiscoverySolutionListOptionalParams extends coreClient.OperationOptions {
199
- /** Can be used to filter solutionIds by 'ProblemClassificationId'. The filter supports only 'and' and 'eq' operators. Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' and ProblemClassificationId eq '0a9673c2-7af6-4e19-90d3-4ee2461076d9'. */
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' */
200
271
  filter?: string;
201
- /** Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. */
272
+ /** Skiptoken is only used if a previous operation returned a partial result. */
202
273
  skiptoken?: string;
203
274
  }
204
275
 
@@ -275,6 +346,34 @@ export declare interface ErrorResponse {
275
346
  error?: ErrorDetail;
276
347
  }
277
348
 
349
+ /**
350
+ * Defines values for ExecutionStatus. \
351
+ * {@link KnownExecutionStatus} can be used interchangeably with ExecutionStatus,
352
+ * this enum contains the known values that the service supports.
353
+ * ### Known values supported by the service
354
+ * **Success** \
355
+ * **Running** \
356
+ * **Failed** \
357
+ * **Warning**
358
+ */
359
+ export declare type ExecutionStatus = string;
360
+
361
+ /** Filter criterion */
362
+ export declare interface Filter {
363
+ /** Filter name */
364
+ name?: string;
365
+ /** Filter values */
366
+ values?: string;
367
+ /** Filter operator */
368
+ operator?: string;
369
+ }
370
+
371
+ /** Filter group */
372
+ export declare interface FilterGroup {
373
+ /** List of filters */
374
+ filter?: Filter[];
375
+ }
376
+
278
377
  /**
279
378
  * Given the last `.value` produced by the `byPage` iterator,
280
379
  * returns a continuation token that can be used to begin paging from
@@ -296,8 +395,11 @@ export declare class HelpRP extends coreClient.ServiceClient {
296
395
  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
297
396
  private addCustomApiVersionPolicy;
298
397
  operations: Operations;
398
+ checkNameAvailability: CheckNameAvailability;
299
399
  diagnostics: Diagnostics;
300
400
  discoverySolution: DiscoverySolution;
401
+ solution: Solution;
402
+ troubleshooters: Troubleshooters;
301
403
  }
302
404
 
303
405
  /** Optional parameters. */
@@ -321,7 +423,7 @@ export declare interface HelpRPOptionalParams extends coreClient.ServiceClientOp
321
423
  */
322
424
  export declare type ImportanceLevel = string;
323
425
 
324
- /** Detailed insights(s) obtained via the invocation of an insight diagnostic troubleshooter. */
426
+ /** Detailed insights(s) obtained via the invocation of an insight diagnostic */
325
427
  export declare interface Insight {
326
428
  /** Article id. */
327
429
  id?: string;
@@ -339,6 +441,42 @@ export declare enum KnownActionType {
339
441
  Internal = "Internal"
340
442
  }
341
443
 
444
+ /** Known values of {@link AggregationType} that the service accepts. */
445
+ export declare enum KnownAggregationType {
446
+ /** Sum */
447
+ Sum = "Sum",
448
+ /** Avg */
449
+ Avg = "Avg",
450
+ /** Count */
451
+ Count = "Count",
452
+ /** Min */
453
+ Min = "Min",
454
+ /** Max */
455
+ Max = "Max"
456
+ }
457
+
458
+ /** Known values of {@link AutomatedCheckResultType} that the service accepts. */
459
+ export declare enum KnownAutomatedCheckResultType {
460
+ /** Success */
461
+ Success = "Success",
462
+ /** Warning */
463
+ Warning = "Warning",
464
+ /** Error */
465
+ Error = "Error",
466
+ /** Information */
467
+ Information = "Information"
468
+ }
469
+
470
+ /** Known values of {@link Confidence} that the service accepts. */
471
+ export declare enum KnownConfidence {
472
+ /** Low */
473
+ Low = "Low",
474
+ /** Medium */
475
+ Medium = "Medium",
476
+ /** High */
477
+ High = "High"
478
+ }
479
+
342
480
  /** Known values of {@link CreatedByType} that the service accepts. */
343
481
  export declare enum KnownCreatedByType {
344
482
  /** User */
@@ -351,6 +489,30 @@ export declare enum KnownCreatedByType {
351
489
  Key = "Key"
352
490
  }
353
491
 
492
+ /** Known values of {@link DiagnosticProvisioningState} that the service accepts. */
493
+ export declare enum KnownDiagnosticProvisioningState {
494
+ /** All Diagnostics in the Batch succeeded. */
495
+ Succeeded = "Succeeded",
496
+ /** Some Diagnostics are still running or failed. */
497
+ PartialComplete = "PartialComplete",
498
+ /** All Diagnostics failed to run. */
499
+ Failed = "Failed",
500
+ /** When Diagnostic request gets canceled. */
501
+ Canceled = "Canceled"
502
+ }
503
+
504
+ /** Known values of {@link ExecutionStatus} that the service accepts. */
505
+ export declare enum KnownExecutionStatus {
506
+ /** Success */
507
+ Success = "Success",
508
+ /** Running */
509
+ Running = "Running",
510
+ /** Failed */
511
+ Failed = "Failed",
512
+ /** Warning */
513
+ Warning = "Warning"
514
+ }
515
+
354
516
  /** Known values of {@link ImportanceLevel} that the service accepts. */
355
517
  export declare enum KnownImportanceLevel {
356
518
  /** A critical insight has been found after running the diagnostic. */
@@ -361,6 +523,16 @@ export declare enum KnownImportanceLevel {
361
523
  Information = "Information"
362
524
  }
363
525
 
526
+ /** Known values of {@link Name} that the service accepts. */
527
+ export declare enum KnownName {
528
+ /** SolutionId */
529
+ SolutionId = "SolutionId",
530
+ /** ProblemClassificationId */
531
+ ProblemClassificationId = "ProblemClassificationId",
532
+ /** ReplacementKey */
533
+ ReplacementKey = "ReplacementKey"
534
+ }
535
+
364
536
  /** Known values of {@link Origin} that the service accepts. */
365
537
  export declare enum KnownOrigin {
366
538
  /** User */
@@ -371,18 +543,54 @@ export declare enum KnownOrigin {
371
543
  UserSystem = "user,system"
372
544
  }
373
545
 
374
- /** Known values of {@link ProvisioningState} that the service accepts. */
375
- export declare enum KnownProvisioningState {
376
- /** All Diagnostics in the Batch succeeded. */
546
+ /** Known values of {@link QuestionContentType} that the service accepts. */
547
+ export declare enum KnownQuestionContentType {
548
+ /** Text */
549
+ Text = "Text",
550
+ /** Html */
551
+ Html = "Html",
552
+ /** Markdown */
553
+ Markdown = "Markdown"
554
+ }
555
+
556
+ /** Known values of {@link QuestionType} that the service accepts. */
557
+ export declare enum KnownQuestionType {
558
+ /** SingleChoice radio button */
559
+ RadioButton = "RadioButton",
560
+ /** SingleChoice dropdown. */
561
+ Dropdown = "Dropdown",
562
+ /** Text Input */
563
+ TextInput = "TextInput",
564
+ /** MultiLineInfoBox */
565
+ MultiLineInfoBox = "MultiLineInfoBox"
566
+ }
567
+
568
+ /** Known values of {@link ResultType} that the service accepts. */
569
+ export declare enum KnownResultType {
570
+ /** Community */
571
+ Community = "Community",
572
+ /** Documentation */
573
+ Documentation = "Documentation"
574
+ }
575
+
576
+ /** Known values of {@link SolutionProvisioningState} that the service accepts. */
577
+ export declare enum KnownSolutionProvisioningState {
578
+ /** Succeeded */
377
579
  Succeeded = "Succeeded",
378
- /** Some Diagnostics are still running or failed. */
379
- PartialComplete = "PartialComplete",
380
- /** All Diagnostics failed to run. */
580
+ /** Failed */
381
581
  Failed = "Failed",
382
- /** When Diagnostic request gets canceled. */
582
+ /** Canceled */
383
583
  Canceled = "Canceled"
384
584
  }
385
585
 
586
+ /** Known values of {@link SolutionType} that the service accepts. */
587
+ export declare enum KnownSolutionType {
588
+ /** Diagnostics resource type. */
589
+ Diagnostics = "Diagnostics",
590
+ /** Solutions resource type. */
591
+ Solutions = "Solutions"
592
+ }
593
+
386
594
  /** Known values of {@link Status} that the service accepts. */
387
595
  export declare enum KnownStatus {
388
596
  /** Diagnostic creation failed. */
@@ -397,6 +605,59 @@ export declare enum KnownStatus {
397
605
  Timeout = "Timeout"
398
606
  }
399
607
 
608
+ /** Known values of {@link TroubleshooterProvisioningState} that the service accepts. */
609
+ export declare enum KnownTroubleshooterProvisioningState {
610
+ /** Succeeded */
611
+ Succeeded = "Succeeded",
612
+ /** Failed */
613
+ Failed = "Failed",
614
+ /** Canceled */
615
+ Canceled = "Canceled",
616
+ /** Running */
617
+ Running = "Running",
618
+ /** AutoContinue */
619
+ AutoContinue = "AutoContinue"
620
+ }
621
+
622
+ /** Known values of {@link Type} that the service accepts. */
623
+ export declare enum KnownType {
624
+ /** Decision */
625
+ Decision = "Decision",
626
+ /** Solution */
627
+ Solution = "Solution",
628
+ /** Insight */
629
+ Insight = "Insight",
630
+ /** AutomatedCheck */
631
+ AutomatedCheck = "AutomatedCheck"
632
+ }
633
+
634
+ /** Solutions metrics based chart */
635
+ export declare interface MetricsBasedChart {
636
+ /** Chart name */
637
+ name?: string;
638
+ /** Allowed values are Sum, Avg, Count, Min, Max. Default is Sum */
639
+ aggregationType?: AggregationType;
640
+ /** Time span duration */
641
+ timeSpanDuration?: string;
642
+ /** Chart title */
643
+ title?: string;
644
+ /** Filter group */
645
+ filterGroup?: FilterGroup;
646
+ /** Place holder used in HTML Content replace control with the content */
647
+ replacementKey?: string;
648
+ }
649
+
650
+ /**
651
+ * Defines values for Name. \
652
+ * {@link KnownName} can be used interchangeably with Name,
653
+ * this enum contains the known values that the service supports.
654
+ * ### Known values supported by the service
655
+ * **SolutionId** \
656
+ * **ProblemClassificationId** \
657
+ * **ReplacementKey**
658
+ */
659
+ export declare type Name = string;
660
+
400
661
  /** Details of a REST API operation, returned from the Resource Provider Operations API */
401
662
  export declare interface Operation {
402
663
  /**
@@ -495,26 +756,53 @@ export declare type OperationsListResponse = OperationListResult;
495
756
  */
496
757
  export declare type Origin = string;
497
758
 
759
+ /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
760
+ export declare interface ProxyResource extends Resource {
761
+ }
762
+
498
763
  /**
499
- * Defines values for ProvisioningState. \
500
- * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
764
+ * Defines values for QuestionContentType. \
765
+ * {@link KnownQuestionContentType} can be used interchangeably with QuestionContentType,
501
766
  * this enum contains the known values that the service supports.
502
767
  * ### Known values supported by the service
503
- * **Succeeded**: All Diagnostics in the Batch succeeded. \
504
- * **PartialComplete**: Some Diagnostics are still running or failed. \
505
- * **Failed**: All Diagnostics failed to run. \
506
- * **Canceled**: When Diagnostic request gets canceled.
768
+ * **Text** \
769
+ * **Html** \
770
+ * **Markdown**
507
771
  */
508
- export declare type ProvisioningState = string;
772
+ export declare type QuestionContentType = string;
509
773
 
510
- /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
511
- export declare interface ProxyResource extends Resource {
774
+ /**
775
+ * Defines values for QuestionType. \
776
+ * {@link KnownQuestionType} can be used interchangeably with QuestionType,
777
+ * this enum contains the known values that the service supports.
778
+ * ### Known values supported by the service
779
+ * **RadioButton**: SingleChoice radio button \
780
+ * **Dropdown**: SingleChoice dropdown. \
781
+ * **TextInput**: Text Input \
782
+ * **MultiLineInfoBox**: MultiLineInfoBox
783
+ */
784
+ export declare type QuestionType = string;
785
+
786
+ /** Solution replacement maps. */
787
+ export declare interface ReplacementMaps {
788
+ /** Solution AzureKB results */
789
+ webResults?: WebResult[];
790
+ /** Solution diagnostics results. */
791
+ diagnostics?: SolutionsDiagnostic[];
792
+ /** Solutions Troubleshooters */
793
+ troubleshooters?: SolutionsTroubleshooters[];
794
+ /** Solution metrics based charts */
795
+ metricsBasedCharts?: MetricsBasedChart[];
796
+ /** Video solutions, which have the power to engage the customer by stimulating their senses */
797
+ videos?: Video[];
798
+ /** Group of Videos */
799
+ videoGroups?: VideoGroup[];
512
800
  }
513
801
 
514
802
  /** Common fields that are returned in the response for all Azure Resource Manager resources */
515
803
  export declare interface Resource {
516
804
  /**
517
- * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
805
+ * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
518
806
  * NOTE: This property will not be serialized. It can only be populated by the server.
519
807
  */
520
808
  readonly id?: string;
@@ -535,18 +823,304 @@ export declare interface Resource {
535
823
  readonly systemData?: SystemData;
536
824
  }
537
825
 
538
- /** Solution Metadata resource */
539
- export declare interface SolutionMetadataResource extends ProxyResource {
826
+ /** The status of the resource. */
827
+ export declare interface ResponseOption {
828
+ /** Unique string. */
829
+ key?: string;
830
+ /** Option description */
831
+ value?: string;
832
+ }
833
+
834
+ /** Troubleshooter step input response validation properties */
835
+ export declare interface ResponseValidationProperties {
836
+ /** Regex used for the input validation. */
837
+ regex?: string;
838
+ /** Default True */
839
+ isRequired?: boolean;
840
+ /** Validation Error Message. */
841
+ validationErrorMessage?: string;
842
+ /** Max text input (open Ended Text). */
843
+ maxLength?: number;
844
+ }
845
+
846
+ /** Troubleshooter restart response */
847
+ export declare interface RestartTroubleshooterResponse {
848
+ /**
849
+ * Updated TroubleshooterResource Name .
850
+ * NOTE: This property will not be serialized. It can only be populated by the server.
851
+ */
852
+ readonly troubleshooterResourceName?: string;
853
+ }
854
+
855
+ /**
856
+ * Defines values for ResultType. \
857
+ * {@link KnownResultType} can be used interchangeably with ResultType,
858
+ * this enum contains the known values that the service supports.
859
+ * ### Known values supported by the service
860
+ * **Community** \
861
+ * **Documentation**
862
+ */
863
+ export declare type ResultType = string;
864
+
865
+ /** Details of an AzureKB search result. */
866
+ export declare interface SearchResult {
867
+ /** Unique id of the result. */
868
+ solutionId?: string;
869
+ /** Content of the search result. */
870
+ content?: string;
871
+ /** Title of the search result. */
872
+ title?: string;
873
+ /** Confidence of the search result. */
874
+ confidence?: Confidence;
875
+ /** Source of the search result. */
876
+ source?: string;
877
+ /** Result type of the search result. */
878
+ resultType?: ResultType;
879
+ /** rank of the search result */
880
+ rank?: number;
881
+ /** Link to the document. */
882
+ link?: string;
883
+ }
884
+
885
+ /** Part of the solution and are dividers in the solution rendering. */
886
+ export declare interface Section {
887
+ /** Solution sections title. */
888
+ title?: string;
889
+ /** Solution sections content. */
890
+ content?: string;
891
+ /** Solution replacement maps. */
892
+ replacementMaps?: ReplacementMaps;
893
+ }
894
+
895
+ /** Interface representing a Solution. */
896
+ export declare interface Solution {
897
+ /**
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.
913
+ * @param solutionResourceName Solution resource Name.
914
+ * @param options The options parameters.
915
+ */
916
+ beginCreate(scope: string, solutionResourceName: string, options?: SolutionCreateOptionalParams): Promise<SimplePollerLike<OperationState<SolutionCreateResponse>, SolutionCreateResponse>>;
917
+ /**
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.
933
+ * @param solutionResourceName Solution resource Name.
934
+ * @param options The options parameters.
935
+ */
936
+ beginCreateAndWait(scope: string, solutionResourceName: string, options?: SolutionCreateOptionalParams): Promise<SolutionCreateResponse>;
937
+ /**
938
+ * 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.
941
+ * @param solutionResourceName Solution resource Name.
942
+ * @param options The options parameters.
943
+ */
944
+ get(scope: string, solutionResourceName: string, options?: SolutionGetOptionalParams): Promise<SolutionGetResponse>;
945
+ /**
946
+ * 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.
949
+ * @param solutionResourceName Solution resource Name.
950
+ * @param options The options parameters.
951
+ */
952
+ beginUpdate(scope: string, solutionResourceName: string, options?: SolutionUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SolutionUpdateResponse>, SolutionUpdateResponse>>;
953
+ /**
954
+ * 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.
957
+ * @param solutionResourceName Solution resource Name.
958
+ * @param options The options parameters.
959
+ */
960
+ beginUpdateAndWait(scope: string, solutionResourceName: string, options?: SolutionUpdateOptionalParams): Promise<SolutionUpdateResponse>;
961
+ }
962
+
963
+ /** Optional parameters. */
964
+ export declare interface SolutionCreateOptionalParams extends coreClient.OperationOptions {
965
+ /** The required request body for this solution resource creation. */
966
+ solutionRequestBody?: SolutionResource;
967
+ /** Delay to wait until next poll, in milliseconds. */
968
+ updateIntervalInMs?: number;
969
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
970
+ resumeFrom?: string;
971
+ }
972
+
973
+ /** Contains response data for the create operation. */
974
+ export declare type SolutionCreateResponse = SolutionResource;
975
+
976
+ /** Optional parameters. */
977
+ export declare interface SolutionGetOptionalParams extends coreClient.OperationOptions {
978
+ }
979
+
980
+ /** Contains response data for the get operation. */
981
+ export declare type SolutionGetResponse = SolutionResource;
982
+
983
+ /** Metadata Properties */
984
+ export declare interface SolutionMetadataProperties {
540
985
  /** Solution Id. */
541
986
  solutionId?: string;
542
- /** Solution Type. */
543
- solutionType?: string;
544
- /** A detailed description of solution. */
545
- description?: string;
546
- /** Required parameters for invoking this particular solution. */
547
- requiredParameterSets?: string[][];
987
+ /**
988
+ * Solution Type.
989
+ * NOTE: This property will not be serialized. It can only be populated by the server.
990
+ */
991
+ readonly solutionType?: SolutionType;
992
+ /**
993
+ * A detailed description of solution.
994
+ * NOTE: This property will not be serialized. It can only be populated by the server.
995
+ */
996
+ readonly description?: string;
997
+ /**
998
+ * Required parameters for invoking this particular solution.
999
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1000
+ */
1001
+ readonly requiredInputs?: string[];
1002
+ }
1003
+
1004
+ /** Metadata resource */
1005
+ export declare interface SolutionMetadataResource extends ProxyResource {
1006
+ /** List of metadata. */
1007
+ solutions?: SolutionMetadataProperties[];
1008
+ }
1009
+
1010
+ /** Solution response. */
1011
+ export declare interface SolutionPatchRequestBody {
1012
+ /** Solution result */
1013
+ properties?: SolutionResourceProperties;
1014
+ }
1015
+
1016
+ /**
1017
+ * Defines values for SolutionProvisioningState. \
1018
+ * {@link KnownSolutionProvisioningState} can be used interchangeably with SolutionProvisioningState,
1019
+ * this enum contains the known values that the service supports.
1020
+ * ### Known values supported by the service
1021
+ * **Succeeded** \
1022
+ * **Failed** \
1023
+ * **Canceled**
1024
+ */
1025
+ export declare type SolutionProvisioningState = string;
1026
+
1027
+ /** Solution response. */
1028
+ export declare interface SolutionResource {
1029
+ /**
1030
+ * Full resource uri of the resource.
1031
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1032
+ */
1033
+ readonly id?: string;
1034
+ /**
1035
+ * Type of resource.
1036
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1037
+ */
1038
+ readonly type?: string;
1039
+ /**
1040
+ * Resource name.
1041
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1042
+ */
1043
+ readonly name?: string;
1044
+ /** Solution result */
1045
+ properties?: SolutionResourceProperties;
1046
+ }
1047
+
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[];
1068
+ }
1069
+
1070
+ /** Solutions Diagnostic */
1071
+ export declare interface SolutionsDiagnostic {
1072
+ /** Solution Id to identify single Solutions Diagnostic */
1073
+ solutionId?: string;
1074
+ /** Denotes the status of the diagnostic resource. */
1075
+ status?: Status;
1076
+ /** Details of the status */
1077
+ statusDetails?: string;
1078
+ /** Place holder used in HTML Content replace control with the content */
1079
+ replacementKey?: string;
1080
+ /** Required parameters of this item */
1081
+ requiredParameters?: string[];
1082
+ /** Diagnostic insights */
1083
+ insights?: Insight[];
1084
+ }
1085
+
1086
+ /** Troubleshooters in Solutions */
1087
+ export declare interface SolutionsTroubleshooters {
1088
+ /** Solution Id to identify single Solutions Troubleshooter */
1089
+ solutionId?: string;
1090
+ /** Troubleshooter title */
1091
+ title?: string;
1092
+ /** Troubleshooter summary */
1093
+ summary?: string;
548
1094
  }
549
1095
 
1096
+ /**
1097
+ * Defines values for SolutionType. \
1098
+ * {@link KnownSolutionType} can be used interchangeably with SolutionType,
1099
+ * this enum contains the known values that the service supports.
1100
+ * ### Known values supported by the service
1101
+ * **Diagnostics**: Diagnostics resource type. \
1102
+ * **Solutions**: Solutions resource type.
1103
+ */
1104
+ export declare type SolutionType = string;
1105
+
1106
+ /** Defines headers for Solution_update operation. */
1107
+ export declare interface SolutionUpdateHeaders {
1108
+ location?: string;
1109
+ }
1110
+
1111
+ /** Optional parameters. */
1112
+ export declare interface SolutionUpdateOptionalParams extends coreClient.OperationOptions {
1113
+ /** The required request body for updating a solution resource. */
1114
+ solutionPatchRequestBody?: SolutionPatchRequestBody;
1115
+ /** Delay to wait until next poll, in milliseconds. */
1116
+ updateIntervalInMs?: number;
1117
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1118
+ resumeFrom?: string;
1119
+ }
1120
+
1121
+ /** Contains response data for the update operation. */
1122
+ export declare type SolutionUpdateResponse = SolutionUpdateHeaders & SolutionResource;
1123
+
550
1124
  /**
551
1125
  * Defines values for Status. \
552
1126
  * {@link KnownStatus} can be used interchangeably with Status,
@@ -560,6 +1134,53 @@ export declare interface SolutionMetadataResource extends ProxyResource {
560
1134
  */
561
1135
  export declare type Status = string;
562
1136
 
1137
+ /** Troubleshooter step */
1138
+ export declare interface Step {
1139
+ /** Unique step id. */
1140
+ id?: string;
1141
+ /** Step title. */
1142
+ title?: string;
1143
+ /** Step description. */
1144
+ description?: string;
1145
+ /** Get or sets the Step guidance. */
1146
+ guidance?: string;
1147
+ /** Status of Troubleshooter Step execution. */
1148
+ executionStatus?: ExecutionStatus;
1149
+ /** This field has more detailed status description of the execution status. */
1150
+ executionStatusDescription?: string;
1151
+ /** Type of Troubleshooting step. */
1152
+ type?: Type;
1153
+ /** is this last step of the workflow. */
1154
+ isLastStep?: boolean;
1155
+ inputs?: StepInput[];
1156
+ /** Only for AutomatedStep type */
1157
+ automatedCheckResults?: AutomatedCheckResult;
1158
+ insights?: Insight[];
1159
+ /** The error detail. */
1160
+ error?: ErrorDetail;
1161
+ }
1162
+
1163
+ /** Details of step input. */
1164
+ export declare interface StepInput {
1165
+ /** Use Index as QuestionId. */
1166
+ questionId?: string;
1167
+ /** Text Input. Will be a single line input. */
1168
+ questionType?: string;
1169
+ /** User question content. */
1170
+ questionContent?: string;
1171
+ /** Default is Text. */
1172
+ questionContentType?: QuestionContentType;
1173
+ /** Place holder text for response hints. */
1174
+ responseHint?: string;
1175
+ /** Result of Automate step. */
1176
+ recommendedOption?: string;
1177
+ /** Text of response that was selected. */
1178
+ selectedOptionValue?: string;
1179
+ /** Troubleshooter step input response validation properties */
1180
+ responseValidationProperties?: ResponseValidationProperties;
1181
+ responseOptions?: ResponseOption[];
1182
+ }
1183
+
563
1184
  /** Metadata pertaining to creation and last modification of the resource. */
564
1185
  export declare interface SystemData {
565
1186
  /** The identity that created the resource. */
@@ -576,4 +1197,212 @@ export declare interface SystemData {
576
1197
  lastModifiedAt?: Date;
577
1198
  }
578
1199
 
1200
+ /** Solution request trigger criterion. SolutionId/ProblemClassificationId is the only supported trigger type for Solution PUT request. ReplacementKey is the only supported trigger type for Solution PATCH request. */
1201
+ export declare interface TriggerCriterion {
1202
+ /** Trigger criterion name. */
1203
+ name?: Name;
1204
+ /** Trigger criterion value. */
1205
+ value?: string;
1206
+ }
1207
+
1208
+ /**
1209
+ * Defines values for TroubleshooterProvisioningState. \
1210
+ * {@link KnownTroubleshooterProvisioningState} can be used interchangeably with TroubleshooterProvisioningState,
1211
+ * this enum contains the known values that the service supports.
1212
+ * ### Known values supported by the service
1213
+ * **Succeeded** \
1214
+ * **Failed** \
1215
+ * **Canceled** \
1216
+ * **Running** \
1217
+ * **AutoContinue**
1218
+ */
1219
+ export declare type TroubleshooterProvisioningState = string;
1220
+
1221
+ /** Troubleshooter response. */
1222
+ export declare interface TroubleshooterResource extends ProxyResource {
1223
+ /** Solution Id to identify single troubleshooter. */
1224
+ solutionId?: string;
1225
+ /** Client input parameters to run Troubleshooter Resource */
1226
+ parameters?: {
1227
+ [propertyName: string]: string;
1228
+ };
1229
+ /**
1230
+ * Status of troubleshooter provisioning.
1231
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1232
+ */
1233
+ readonly provisioningState?: TroubleshooterProvisioningState;
1234
+ /**
1235
+ * List of step object.
1236
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1237
+ */
1238
+ readonly steps?: Step[];
1239
+ }
1240
+
1241
+ /** User Response for Troubleshooter continue request */
1242
+ export declare interface TroubleshooterResponse {
1243
+ /** id of the question. */
1244
+ questionId?: string;
1245
+ /** Text Input. Will be a single line input. */
1246
+ questionType?: QuestionType;
1247
+ /** Response key for SingleInput. For Multi-line test/open ended question it is free form text */
1248
+ response?: string;
1249
+ }
1250
+
1251
+ /** Interface representing a Troubleshooters. */
1252
+ export declare interface Troubleshooters {
1253
+ /**
1254
+ * 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.
1266
+ * @param troubleshooterName Troubleshooter resource Name.
1267
+ * @param options The options parameters.
1268
+ */
1269
+ create(scope: string, troubleshooterName: string, options?: TroubleshootersCreateOptionalParams): Promise<TroubleshootersCreateResponse>;
1270
+ /**
1271
+ * Gets troubleshooter instance result which includes the step status/result of the troubleshooter
1272
+ * resource name that is being executed.<br/> Get API is used to retrieve the result of a
1273
+ * Troubleshooter instance, which includes the status and result of each step in the Troubleshooter
1274
+ * 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.
1277
+ * @param troubleshooterName Troubleshooter resource Name.
1278
+ * @param options The options parameters.
1279
+ */
1280
+ get(scope: string, troubleshooterName: string, options?: TroubleshootersGetOptionalParams): Promise<TroubleshootersGetResponse>;
1281
+ /**
1282
+ * Uses ‘stepId’ and ‘responses’ as the trigger to continue the troubleshooting steps for the
1283
+ * respective troubleshooter resource name. <br/>Continue API is used to provide inputs that are
1284
+ * required for the specific troubleshooter to progress into the next step in the process. This API is
1285
+ * 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.
1288
+ * @param troubleshooterName Troubleshooter resource Name.
1289
+ * @param options The options parameters.
1290
+ */
1291
+ continue(scope: string, troubleshooterName: string, options?: TroubleshootersContinueOptionalParams): Promise<TroubleshootersContinueResponse>;
1292
+ /**
1293
+ * Ends the troubleshooter action
1294
+ * @param scope This is an extension resource provider and only resource level extension is supported
1295
+ * at the moment.
1296
+ * @param troubleshooterName Troubleshooter resource Name.
1297
+ * @param options The options parameters.
1298
+ */
1299
+ end(scope: string, troubleshooterName: string, options?: TroubleshootersEndOptionalParams): Promise<TroubleshootersEndResponse>;
1300
+ /**
1301
+ * Restarts the troubleshooter API using applicable troubleshooter resource name as the input.<br/> It
1302
+ * returns new resource name which should be used in subsequent request. The old resource name is
1303
+ * 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.
1306
+ * @param troubleshooterName Troubleshooter resource Name.
1307
+ * @param options The options parameters.
1308
+ */
1309
+ restart(scope: string, troubleshooterName: string, options?: TroubleshootersRestartOptionalParams): Promise<TroubleshootersRestartResponse>;
1310
+ }
1311
+
1312
+ /** Defines headers for Troubleshooters_continue operation. */
1313
+ export declare interface TroubleshootersContinueHeaders {
1314
+ location?: string;
1315
+ }
1316
+
1317
+ /** Optional parameters. */
1318
+ export declare interface TroubleshootersContinueOptionalParams extends coreClient.OperationOptions {
1319
+ /** The required request body for going to next step in Troubleshooter resource. */
1320
+ continueRequestBody?: ContinueRequestBody;
1321
+ }
1322
+
1323
+ /** Contains response data for the continue operation. */
1324
+ export declare type TroubleshootersContinueResponse = TroubleshootersContinueHeaders;
1325
+
1326
+ /** Optional parameters. */
1327
+ export declare interface TroubleshootersCreateOptionalParams extends coreClient.OperationOptions {
1328
+ /** The required request body for this Troubleshooter resource creation. */
1329
+ createTroubleshooterRequestBody?: TroubleshooterResource;
1330
+ }
1331
+
1332
+ /** Contains response data for the create operation. */
1333
+ export declare type TroubleshootersCreateResponse = TroubleshooterResource;
1334
+
1335
+ /** Defines headers for Troubleshooters_end operation. */
1336
+ export declare interface TroubleshootersEndHeaders {
1337
+ location?: string;
1338
+ }
1339
+
1340
+ /** Optional parameters. */
1341
+ export declare interface TroubleshootersEndOptionalParams extends coreClient.OperationOptions {
1342
+ }
1343
+
1344
+ /** Contains response data for the end operation. */
1345
+ export declare type TroubleshootersEndResponse = TroubleshootersEndHeaders;
1346
+
1347
+ /** Optional parameters. */
1348
+ export declare interface TroubleshootersGetOptionalParams extends coreClient.OperationOptions {
1349
+ }
1350
+
1351
+ /** Contains response data for the get operation. */
1352
+ export declare type TroubleshootersGetResponse = TroubleshooterResource;
1353
+
1354
+ /** Defines headers for Troubleshooters_restart operation. */
1355
+ export declare interface TroubleshootersRestartHeaders {
1356
+ location?: string;
1357
+ }
1358
+
1359
+ /** Optional parameters. */
1360
+ export declare interface TroubleshootersRestartOptionalParams extends coreClient.OperationOptions {
1361
+ }
1362
+
1363
+ /** Contains response data for the restart operation. */
1364
+ export declare type TroubleshootersRestartResponse = TroubleshootersRestartHeaders & RestartTroubleshooterResponse;
1365
+
1366
+ /**
1367
+ * Defines values for Type. \
1368
+ * {@link KnownType} can be used interchangeably with Type,
1369
+ * this enum contains the known values that the service supports.
1370
+ * ### Known values supported by the service
1371
+ * **Decision** \
1372
+ * **Solution** \
1373
+ * **Insight** \
1374
+ * **AutomatedCheck**
1375
+ */
1376
+ export declare type Type = string;
1377
+
1378
+ /** Video detail */
1379
+ export declare interface Video extends VideoGroupVideo {
1380
+ /** Place holder used in HTML Content replace control with the insight content */
1381
+ replacementKey?: string;
1382
+ }
1383
+
1384
+ /** Video group detail */
1385
+ export declare interface VideoGroup {
1386
+ /** List of videos will be shown to customers */
1387
+ videos?: VideoGroupVideo[];
1388
+ /** Place holder used in HTML Content replace control with the insight content */
1389
+ replacementKey?: string;
1390
+ }
1391
+
1392
+ /** VideoGroup video detail */
1393
+ export declare interface VideoGroupVideo {
1394
+ /** Link to the video */
1395
+ src?: string;
1396
+ /** Title of the video */
1397
+ title?: string;
1398
+ }
1399
+
1400
+ /** AzureKB web result */
1401
+ export declare interface WebResult {
1402
+ /** Place holder used in HTML Content replace control with the content */
1403
+ replacementKey?: string;
1404
+ /** AzureKB search results */
1405
+ searchResults?: SearchResult[];
1406
+ }
1407
+
579
1408
  export { }