@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
@@ -0,0 +1,261 @@
1
+ /*
2
+ * Copyright (c) Microsoft Corporation.
3
+ * Licensed under the MIT License.
4
+ *
5
+ * Code generated by Microsoft (R) AutoRest Code Generator.
6
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
7
+ */
8
+
9
+ import { Troubleshooters } from "../operationsInterfaces";
10
+ import * as coreClient from "@azure/core-client";
11
+ import * as Mappers from "../models/mappers";
12
+ import * as Parameters from "../models/parameters";
13
+ import { HelpRP } from "../helpRP";
14
+ import {
15
+ TroubleshootersCreateOptionalParams,
16
+ TroubleshootersCreateResponse,
17
+ TroubleshootersGetOptionalParams,
18
+ TroubleshootersGetResponse,
19
+ TroubleshootersContinueOptionalParams,
20
+ TroubleshootersContinueResponse,
21
+ TroubleshootersEndOptionalParams,
22
+ TroubleshootersEndResponse,
23
+ TroubleshootersRestartOptionalParams,
24
+ TroubleshootersRestartResponse
25
+ } from "../models";
26
+
27
+ /** Class containing Troubleshooters operations. */
28
+ export class TroubleshootersImpl implements Troubleshooters {
29
+ private readonly client: HelpRP;
30
+
31
+ /**
32
+ * Initialize a new instance of the class Troubleshooters class.
33
+ * @param client Reference to the service client
34
+ */
35
+ constructor(client: HelpRP) {
36
+ this.client = client;
37
+ }
38
+
39
+ /**
40
+ * Creates the specific troubleshooter action under a resource or subscription using the ‘solutionId’
41
+ * and ‘properties.parameters’ as the trigger. <br/> Troubleshooters are step-by-step interactive
42
+ * guidance that scope the problem by collecting additional inputs from you in each stage while
43
+ * troubleshooting an Azure issue. You will be guided down decision tree style workflow and the best
44
+ * possible solution will be presented at the end of the workflow. <br/> Create API creates the
45
+ * Troubleshooter API using ‘parameters’ and ‘solutionId’ <br/> After creating the Troubleshooter
46
+ * instance, the following APIs can be used:<br/> CONTINUE API: to move to the next step in the flow
47
+ * <br/>GET API: to identify the next step after executing the CONTINUE API. <br/><br/> <b>Note:</b>
48
+ * ‘requiredParameters’ from solutions response must be passed via ‘properties. parameters’ in the
49
+ * request body of Troubleshooters API.
50
+ * @param scope This is an extension resource provider and only resource level extension is supported
51
+ * at the moment.
52
+ * @param troubleshooterName Troubleshooter resource Name.
53
+ * @param options The options parameters.
54
+ */
55
+ create(
56
+ scope: string,
57
+ troubleshooterName: string,
58
+ options?: TroubleshootersCreateOptionalParams
59
+ ): Promise<TroubleshootersCreateResponse> {
60
+ return this.client.sendOperationRequest(
61
+ { scope, troubleshooterName, options },
62
+ createOperationSpec
63
+ );
64
+ }
65
+
66
+ /**
67
+ * Gets troubleshooter instance result which includes the step status/result of the troubleshooter
68
+ * resource name that is being executed.<br/> Get API is used to retrieve the result of a
69
+ * Troubleshooter instance, which includes the status and result of each step in the Troubleshooter
70
+ * workflow. This API requires the Troubleshooter resource name that was created using the Create API.
71
+ * @param scope This is an extension resource provider and only resource level extension is supported
72
+ * at the moment.
73
+ * @param troubleshooterName Troubleshooter resource Name.
74
+ * @param options The options parameters.
75
+ */
76
+ get(
77
+ scope: string,
78
+ troubleshooterName: string,
79
+ options?: TroubleshootersGetOptionalParams
80
+ ): Promise<TroubleshootersGetResponse> {
81
+ return this.client.sendOperationRequest(
82
+ { scope, troubleshooterName, options },
83
+ getOperationSpec
84
+ );
85
+ }
86
+
87
+ /**
88
+ * Uses ‘stepId’ and ‘responses’ as the trigger to continue the troubleshooting steps for the
89
+ * respective troubleshooter resource name. <br/>Continue API is used to provide inputs that are
90
+ * required for the specific troubleshooter to progress into the next step in the process. This API is
91
+ * used after the Troubleshooter has been created using the Create API.
92
+ * @param scope This is an extension resource provider and only resource level extension is supported
93
+ * at the moment.
94
+ * @param troubleshooterName Troubleshooter resource Name.
95
+ * @param options The options parameters.
96
+ */
97
+ continue(
98
+ scope: string,
99
+ troubleshooterName: string,
100
+ options?: TroubleshootersContinueOptionalParams
101
+ ): Promise<TroubleshootersContinueResponse> {
102
+ return this.client.sendOperationRequest(
103
+ { scope, troubleshooterName, options },
104
+ continueOperationSpec
105
+ );
106
+ }
107
+
108
+ /**
109
+ * Ends the troubleshooter action
110
+ * @param scope This is an extension resource provider and only resource level extension is supported
111
+ * at the moment.
112
+ * @param troubleshooterName Troubleshooter resource Name.
113
+ * @param options The options parameters.
114
+ */
115
+ end(
116
+ scope: string,
117
+ troubleshooterName: string,
118
+ options?: TroubleshootersEndOptionalParams
119
+ ): Promise<TroubleshootersEndResponse> {
120
+ return this.client.sendOperationRequest(
121
+ { scope, troubleshooterName, options },
122
+ endOperationSpec
123
+ );
124
+ }
125
+
126
+ /**
127
+ * Restarts the troubleshooter API using applicable troubleshooter resource name as the input.<br/> It
128
+ * returns new resource name which should be used in subsequent request. The old resource name is
129
+ * obsolete after this API is invoked.
130
+ * @param scope This is an extension resource provider and only resource level extension is supported
131
+ * at the moment.
132
+ * @param troubleshooterName Troubleshooter resource Name.
133
+ * @param options The options parameters.
134
+ */
135
+ restart(
136
+ scope: string,
137
+ troubleshooterName: string,
138
+ options?: TroubleshootersRestartOptionalParams
139
+ ): Promise<TroubleshootersRestartResponse> {
140
+ return this.client.sendOperationRequest(
141
+ { scope, troubleshooterName, options },
142
+ restartOperationSpec
143
+ );
144
+ }
145
+ }
146
+ // Operation Specifications
147
+ const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
148
+
149
+ const createOperationSpec: coreClient.OperationSpec = {
150
+ path:
151
+ "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}",
152
+ httpMethod: "PUT",
153
+ responses: {
154
+ 200: {
155
+ bodyMapper: Mappers.TroubleshooterResource
156
+ },
157
+ 201: {
158
+ bodyMapper: Mappers.TroubleshooterResource
159
+ },
160
+ default: {
161
+ bodyMapper: Mappers.ErrorResponse
162
+ }
163
+ },
164
+ requestBody: Parameters.createTroubleshooterRequestBody,
165
+ queryParameters: [Parameters.apiVersion],
166
+ urlParameters: [
167
+ Parameters.$host,
168
+ Parameters.scope,
169
+ Parameters.troubleshooterName
170
+ ],
171
+ headerParameters: [Parameters.accept, Parameters.contentType],
172
+ mediaType: "json",
173
+ serializer
174
+ };
175
+ const getOperationSpec: coreClient.OperationSpec = {
176
+ path:
177
+ "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}",
178
+ httpMethod: "GET",
179
+ responses: {
180
+ 200: {
181
+ bodyMapper: Mappers.TroubleshooterResource
182
+ },
183
+ default: {
184
+ bodyMapper: Mappers.ErrorResponse
185
+ }
186
+ },
187
+ queryParameters: [Parameters.apiVersion],
188
+ urlParameters: [
189
+ Parameters.$host,
190
+ Parameters.scope,
191
+ Parameters.troubleshooterName
192
+ ],
193
+ headerParameters: [Parameters.accept],
194
+ serializer
195
+ };
196
+ const continueOperationSpec: coreClient.OperationSpec = {
197
+ path:
198
+ "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/continue",
199
+ httpMethod: "POST",
200
+ responses: {
201
+ 204: {
202
+ headersMapper: Mappers.TroubleshootersContinueHeaders
203
+ },
204
+ default: {
205
+ bodyMapper: Mappers.ErrorResponse
206
+ }
207
+ },
208
+ requestBody: Parameters.continueRequestBody,
209
+ queryParameters: [Parameters.apiVersion],
210
+ urlParameters: [
211
+ Parameters.$host,
212
+ Parameters.scope,
213
+ Parameters.troubleshooterName
214
+ ],
215
+ headerParameters: [Parameters.accept, Parameters.contentType],
216
+ mediaType: "json",
217
+ serializer
218
+ };
219
+ const endOperationSpec: coreClient.OperationSpec = {
220
+ path:
221
+ "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/end",
222
+ httpMethod: "POST",
223
+ responses: {
224
+ 204: {
225
+ headersMapper: Mappers.TroubleshootersEndHeaders
226
+ },
227
+ default: {
228
+ bodyMapper: Mappers.ErrorResponse
229
+ }
230
+ },
231
+ queryParameters: [Parameters.apiVersion],
232
+ urlParameters: [
233
+ Parameters.$host,
234
+ Parameters.scope,
235
+ Parameters.troubleshooterName
236
+ ],
237
+ headerParameters: [Parameters.accept],
238
+ serializer
239
+ };
240
+ const restartOperationSpec: coreClient.OperationSpec = {
241
+ path:
242
+ "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/restart",
243
+ httpMethod: "POST",
244
+ responses: {
245
+ 200: {
246
+ bodyMapper: Mappers.RestartTroubleshooterResponse,
247
+ headersMapper: Mappers.TroubleshootersRestartHeaders
248
+ },
249
+ default: {
250
+ bodyMapper: Mappers.ErrorResponse
251
+ }
252
+ },
253
+ queryParameters: [Parameters.apiVersion],
254
+ urlParameters: [
255
+ Parameters.$host,
256
+ Parameters.scope,
257
+ Parameters.troubleshooterName
258
+ ],
259
+ headerParameters: [Parameters.accept],
260
+ serializer
261
+ };
@@ -0,0 +1,27 @@
1
+ /*
2
+ * Copyright (c) Microsoft Corporation.
3
+ * Licensed under the MIT License.
4
+ *
5
+ * Code generated by Microsoft (R) AutoRest Code Generator.
6
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
7
+ */
8
+
9
+ import {
10
+ CheckNameAvailabilityPostOptionalParams,
11
+ CheckNameAvailabilityPostResponse
12
+ } from "../models";
13
+
14
+ /** Interface representing a CheckNameAvailability. */
15
+ export interface CheckNameAvailability {
16
+ /**
17
+ * This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or
18
+ * solutions
19
+ * @param scope This is an extension resource provider and only resource level extension is supported
20
+ * at the moment.
21
+ * @param options The options parameters.
22
+ */
23
+ post(
24
+ scope: string,
25
+ options?: CheckNameAvailabilityPostOptionalParams
26
+ ): Promise<CheckNameAvailabilityPostResponse>;
27
+ }
@@ -8,8 +8,6 @@
8
8
 
9
9
  import { SimplePollerLike, OperationState } from "@azure/core-lro";
10
10
  import {
11
- DiagnosticsCheckNameAvailabilityOptionalParams,
12
- DiagnosticsCheckNameAvailabilityResponse,
13
11
  DiagnosticsCreateOptionalParams,
14
12
  DiagnosticsCreateResponse,
15
13
  DiagnosticsGetOptionalParams,
@@ -19,21 +17,11 @@ import {
19
17
  /** Interface representing a Diagnostics. */
20
18
  export interface Diagnostics {
21
19
  /**
22
- * This API is used to check the uniqueness of a resource name used for a diagnostic check.
23
- * @param scope This is an extension resource provider and only resource level extension is supported
24
- * at the moment.
25
- * @param options The options parameters.
26
- */
27
- checkNameAvailability(
28
- scope: string,
29
- options?: DiagnosticsCheckNameAvailabilityOptionalParams
30
- ): Promise<DiagnosticsCheckNameAvailabilityResponse>;
31
- /**
32
- * Diagnostics tells you precisely the root cause of the issue and how to address it. You can get
33
- * diagnostics once you discover and identify the relevant solution for your Azure issue.<br/><br/> You
34
- * can create diagnostics using the ‘solutionId’ from Solution Discovery API response and
35
- * ‘additionalParameters’ <br/><br/> <b>Note: </b>‘requiredParameterSets’ from Solutions Discovery API
36
- * response must be passed via ‘additionalParameters’ as an input to Diagnostics API
20
+ * Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
21
+ * solutions. <br/>Diagnostics tells you precisely the root cause of the issue and the steps to address
22
+ * it. You can get diagnostics once you discover the relevant solution for your Azure issue. <br/><br/>
23
+ * <b>Note: </b> requiredInputs’ from Discovery solutions response must be passed via
24
+ * ‘additionalParameters’ as an input to Diagnostics API.
37
25
  * @param scope This is an extension resource provider and only resource level extension is supported
38
26
  * at the moment.
39
27
  * @param diagnosticsResourceName Unique resource name for insight resources
@@ -50,11 +38,11 @@ export interface Diagnostics {
50
38
  >
51
39
  >;
52
40
  /**
53
- * Diagnostics tells you precisely the root cause of the issue and how to address it. You can get
54
- * diagnostics once you discover and identify the relevant solution for your Azure issue.<br/><br/> You
55
- * can create diagnostics using the ‘solutionId’ from Solution Discovery API response and
56
- * ‘additionalParameters’ <br/><br/> <b>Note: </b>‘requiredParameterSets’ from Solutions Discovery API
57
- * response must be passed via ‘additionalParameters’ as an input to Diagnostics API
41
+ * Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
42
+ * solutions. <br/>Diagnostics tells you precisely the root cause of the issue and the steps to address
43
+ * it. You can get diagnostics once you discover the relevant solution for your Azure issue. <br/><br/>
44
+ * <b>Note: </b> requiredInputs’ from Discovery solutions response must be passed via
45
+ * ‘additionalParameters’ as an input to Diagnostics API.
58
46
  * @param scope This is an extension resource provider and only resource level extension is supported
59
47
  * at the moment.
60
48
  * @param diagnosticsResourceName Unique resource name for insight resources
@@ -16,13 +16,16 @@ import {
16
16
  /** Interface representing a DiscoverySolution. */
17
17
  export interface DiscoverySolution {
18
18
  /**
19
- * Solutions Discovery is the initial point of entry within Help API, which helps you identify the
20
- * relevant solutions for your Azure issue.<br/><br/> You can discover solutions using resourceUri OR
21
- * resourceUri + problemClassificationId.<br/><br/>We will do our best in returning relevant
22
- * diagnostics for your Azure issue.<br/><br/> Get the problemClassificationId(s) using this
23
- * [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).<br/><br/>
24
- * <b>Note: </b> ‘requiredParameterSets’ from Solutions Discovery API response must be passed via
25
- * ‘additionalParameters’ as an input to Diagnostics API.
19
+ * Lists the relevant Azure diagnostics and solutions using [problemClassification
20
+ * API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND
21
+ * resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API,
22
+ * which identifies relevant Azure diagnostics and solutions. We will do our best to return the most
23
+ * effective solutions based on the type of inputs, in the request URL <br/><br/> Mandatory input :
24
+ * problemClassificationId (Use the [problemClassification
25
+ * API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
26
+ * <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from
27
+ * Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics
28
+ * and Solutions API.
26
29
  * @param scope This is an extension resource provider and only resource level extension is supported
27
30
  * at the moment.
28
31
  * @param options The options parameters.
@@ -7,5 +7,8 @@
7
7
  */
8
8
 
9
9
  export * from "./operations";
10
+ export * from "./checkNameAvailability";
10
11
  export * from "./diagnostics";
11
12
  export * from "./discoverySolution";
13
+ export * from "./solution";
14
+ export * from "./troubleshooters";
@@ -0,0 +1,115 @@
1
+ /*
2
+ * Copyright (c) Microsoft Corporation.
3
+ * Licensed under the MIT License.
4
+ *
5
+ * Code generated by Microsoft (R) AutoRest Code Generator.
6
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
7
+ */
8
+
9
+ import { SimplePollerLike, OperationState } from "@azure/core-lro";
10
+ import {
11
+ SolutionCreateOptionalParams,
12
+ SolutionCreateResponse,
13
+ SolutionGetOptionalParams,
14
+ SolutionGetResponse,
15
+ SolutionUpdateOptionalParams,
16
+ SolutionUpdateResponse
17
+ } from "../models";
18
+
19
+ /** Interface representing a Solution. */
20
+ export interface Solution {
21
+ /**
22
+ * Creates a solution for the specific Azure resource or subscription using the triggering criteria
23
+ * ‘solutionId and requiredInputs’ from discovery solutions.<br/> Solutions are a rich, insightful and
24
+ * a centralized self help experience that brings all the relevant content to troubleshoot an Azure
25
+ * issue into a unified experience. Solutions include the following components : Text, Diagnostics ,
26
+ * Troubleshooters, Images , Video tutorials, Tables , custom charts, images , AzureKB, etc, with
27
+ * capabilities to support new solutions types in the future. Each solution type may require one or
28
+ * more ‘requiredParameters’ that are required to execute the individual solution component. In the
29
+ * absence of the ‘requiredParameters’ it is likely that some of the solutions might fail execution,
30
+ * and you might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from
31
+ * Discovery solutions response must be passed via ‘parameters’ in the request body of Solutions API.
32
+ * <br/>2. ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in
33
+ * the request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
34
+ * ‘properties.parameters’ in the request for Troubleshooters
35
+ * @param scope This is an extension resource provider and only resource level extension is supported
36
+ * at the moment.
37
+ * @param solutionResourceName Solution resource Name.
38
+ * @param options The options parameters.
39
+ */
40
+ beginCreate(
41
+ scope: string,
42
+ solutionResourceName: string,
43
+ options?: SolutionCreateOptionalParams
44
+ ): Promise<
45
+ SimplePollerLike<
46
+ OperationState<SolutionCreateResponse>,
47
+ SolutionCreateResponse
48
+ >
49
+ >;
50
+ /**
51
+ * Creates a solution for the specific Azure resource or subscription using the triggering criteria
52
+ * ‘solutionId and requiredInputs’ from discovery solutions.<br/> Solutions are a rich, insightful and
53
+ * a centralized self help experience that brings all the relevant content to troubleshoot an Azure
54
+ * issue into a unified experience. Solutions include the following components : Text, Diagnostics ,
55
+ * Troubleshooters, Images , Video tutorials, Tables , custom charts, images , AzureKB, etc, with
56
+ * capabilities to support new solutions types in the future. Each solution type may require one or
57
+ * more ‘requiredParameters’ that are required to execute the individual solution component. In the
58
+ * absence of the ‘requiredParameters’ it is likely that some of the solutions might fail execution,
59
+ * and you might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from
60
+ * Discovery solutions response must be passed via ‘parameters’ in the request body of Solutions API.
61
+ * <br/>2. ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in
62
+ * the request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
63
+ * ‘properties.parameters’ in the request for Troubleshooters
64
+ * @param scope This is an extension resource provider and only resource level extension is supported
65
+ * at the moment.
66
+ * @param solutionResourceName Solution resource Name.
67
+ * @param options The options parameters.
68
+ */
69
+ beginCreateAndWait(
70
+ scope: string,
71
+ solutionResourceName: string,
72
+ options?: SolutionCreateOptionalParams
73
+ ): Promise<SolutionCreateResponse>;
74
+ /**
75
+ * Get the solution using the applicable solutionResourceName while creating the solution.
76
+ * @param scope This is an extension resource provider and only resource level extension is supported
77
+ * at the moment.
78
+ * @param solutionResourceName Solution resource Name.
79
+ * @param options The options parameters.
80
+ */
81
+ get(
82
+ scope: string,
83
+ solutionResourceName: string,
84
+ options?: SolutionGetOptionalParams
85
+ ): Promise<SolutionGetResponse>;
86
+ /**
87
+ * Update the requiredInputs or additional information needed to execute the solution
88
+ * @param scope This is an extension resource provider and only resource level extension is supported
89
+ * at the moment.
90
+ * @param solutionResourceName Solution resource Name.
91
+ * @param options The options parameters.
92
+ */
93
+ beginUpdate(
94
+ scope: string,
95
+ solutionResourceName: string,
96
+ options?: SolutionUpdateOptionalParams
97
+ ): Promise<
98
+ SimplePollerLike<
99
+ OperationState<SolutionUpdateResponse>,
100
+ SolutionUpdateResponse
101
+ >
102
+ >;
103
+ /**
104
+ * Update the requiredInputs or additional information needed to execute the solution
105
+ * @param scope This is an extension resource provider and only resource level extension is supported
106
+ * at the moment.
107
+ * @param solutionResourceName Solution resource Name.
108
+ * @param options The options parameters.
109
+ */
110
+ beginUpdateAndWait(
111
+ scope: string,
112
+ solutionResourceName: string,
113
+ options?: SolutionUpdateOptionalParams
114
+ ): Promise<SolutionUpdateResponse>;
115
+ }
@@ -0,0 +1,101 @@
1
+ /*
2
+ * Copyright (c) Microsoft Corporation.
3
+ * Licensed under the MIT License.
4
+ *
5
+ * Code generated by Microsoft (R) AutoRest Code Generator.
6
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
7
+ */
8
+
9
+ import {
10
+ TroubleshootersCreateOptionalParams,
11
+ TroubleshootersCreateResponse,
12
+ TroubleshootersGetOptionalParams,
13
+ TroubleshootersGetResponse,
14
+ TroubleshootersContinueOptionalParams,
15
+ TroubleshootersContinueResponse,
16
+ TroubleshootersEndOptionalParams,
17
+ TroubleshootersEndResponse,
18
+ TroubleshootersRestartOptionalParams,
19
+ TroubleshootersRestartResponse
20
+ } from "../models";
21
+
22
+ /** Interface representing a Troubleshooters. */
23
+ export interface Troubleshooters {
24
+ /**
25
+ * Creates the specific troubleshooter action under a resource or subscription using the ‘solutionId’
26
+ * and ‘properties.parameters’ as the trigger. <br/> Troubleshooters are step-by-step interactive
27
+ * guidance that scope the problem by collecting additional inputs from you in each stage while
28
+ * troubleshooting an Azure issue. You will be guided down decision tree style workflow and the best
29
+ * possible solution will be presented at the end of the workflow. <br/> Create API creates the
30
+ * Troubleshooter API using ‘parameters’ and ‘solutionId’ <br/> After creating the Troubleshooter
31
+ * instance, the following APIs can be used:<br/> CONTINUE API: to move to the next step in the flow
32
+ * <br/>GET API: to identify the next step after executing the CONTINUE API. <br/><br/> <b>Note:</b>
33
+ * ‘requiredParameters’ from solutions response must be passed via ‘properties. parameters’ in the
34
+ * request body of Troubleshooters API.
35
+ * @param scope This is an extension resource provider and only resource level extension is supported
36
+ * at the moment.
37
+ * @param troubleshooterName Troubleshooter resource Name.
38
+ * @param options The options parameters.
39
+ */
40
+ create(
41
+ scope: string,
42
+ troubleshooterName: string,
43
+ options?: TroubleshootersCreateOptionalParams
44
+ ): Promise<TroubleshootersCreateResponse>;
45
+ /**
46
+ * Gets troubleshooter instance result which includes the step status/result of the troubleshooter
47
+ * resource name that is being executed.<br/> Get API is used to retrieve the result of a
48
+ * Troubleshooter instance, which includes the status and result of each step in the Troubleshooter
49
+ * workflow. This API requires the Troubleshooter resource name that was created using the Create API.
50
+ * @param scope This is an extension resource provider and only resource level extension is supported
51
+ * at the moment.
52
+ * @param troubleshooterName Troubleshooter resource Name.
53
+ * @param options The options parameters.
54
+ */
55
+ get(
56
+ scope: string,
57
+ troubleshooterName: string,
58
+ options?: TroubleshootersGetOptionalParams
59
+ ): Promise<TroubleshootersGetResponse>;
60
+ /**
61
+ * Uses ‘stepId’ and ‘responses’ as the trigger to continue the troubleshooting steps for the
62
+ * respective troubleshooter resource name. <br/>Continue API is used to provide inputs that are
63
+ * required for the specific troubleshooter to progress into the next step in the process. This API is
64
+ * used after the Troubleshooter has been created using the Create API.
65
+ * @param scope This is an extension resource provider and only resource level extension is supported
66
+ * at the moment.
67
+ * @param troubleshooterName Troubleshooter resource Name.
68
+ * @param options The options parameters.
69
+ */
70
+ continue(
71
+ scope: string,
72
+ troubleshooterName: string,
73
+ options?: TroubleshootersContinueOptionalParams
74
+ ): Promise<TroubleshootersContinueResponse>;
75
+ /**
76
+ * Ends the troubleshooter action
77
+ * @param scope This is an extension resource provider and only resource level extension is supported
78
+ * at the moment.
79
+ * @param troubleshooterName Troubleshooter resource Name.
80
+ * @param options The options parameters.
81
+ */
82
+ end(
83
+ scope: string,
84
+ troubleshooterName: string,
85
+ options?: TroubleshootersEndOptionalParams
86
+ ): Promise<TroubleshootersEndResponse>;
87
+ /**
88
+ * Restarts the troubleshooter API using applicable troubleshooter resource name as the input.<br/> It
89
+ * returns new resource name which should be used in subsequent request. The old resource name is
90
+ * obsolete after this API is invoked.
91
+ * @param scope This is an extension resource provider and only resource level extension is supported
92
+ * at the moment.
93
+ * @param troubleshooterName Troubleshooter resource Name.
94
+ * @param options The options parameters.
95
+ */
96
+ restart(
97
+ scope: string,
98
+ troubleshooterName: string,
99
+ options?: TroubleshootersRestartOptionalParams
100
+ ): Promise<TroubleshootersRestartResponse>;
101
+ }