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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (167) hide show
  1. package/CHANGELOG.md +120 -0
  2. package/LICENSE +1 -1
  3. package/README.md +3 -2
  4. package/dist/index.js +1589 -861
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.min.js +1 -1
  7. package/dist/index.min.js.map +1 -1
  8. package/dist-esm/samples-dev/checkNameAvailabilityPostSample.js +7 -7
  9. package/dist-esm/samples-dev/checkNameAvailabilityPostSample.js.map +1 -1
  10. package/dist-esm/samples-dev/diagnosticsCreateSample.js +4 -13
  11. package/dist-esm/samples-dev/diagnosticsCreateSample.js.map +1 -1
  12. package/dist-esm/samples-dev/diagnosticsGetSample.js +1 -1
  13. package/dist-esm/samples-dev/discoverySolutionListSample.js +6 -41
  14. package/dist-esm/samples-dev/discoverySolutionListSample.js.map +1 -1
  15. package/dist-esm/samples-dev/discoverySolutionNlpSubscriptionScopePostSample.d.ts +2 -0
  16. package/dist-esm/samples-dev/discoverySolutionNlpSubscriptionScopePostSample.d.ts.map +1 -0
  17. package/dist-esm/samples-dev/discoverySolutionNlpSubscriptionScopePostSample.js +45 -0
  18. package/dist-esm/samples-dev/discoverySolutionNlpSubscriptionScopePostSample.js.map +1 -0
  19. package/dist-esm/samples-dev/discoverySolutionNlpTenantScopePostSample.d.ts +2 -0
  20. package/dist-esm/samples-dev/discoverySolutionNlpTenantScopePostSample.d.ts.map +1 -0
  21. package/dist-esm/samples-dev/discoverySolutionNlpTenantScopePostSample.js +43 -0
  22. package/dist-esm/samples-dev/discoverySolutionNlpTenantScopePostSample.js.map +1 -0
  23. package/dist-esm/samples-dev/operationsListSample.js +5 -3
  24. package/dist-esm/samples-dev/operationsListSample.js.map +1 -1
  25. package/dist-esm/samples-dev/simplifiedSolutionsCreateSample.d.ts +2 -0
  26. package/dist-esm/samples-dev/simplifiedSolutionsCreateSample.d.ts.map +1 -0
  27. package/dist-esm/samples-dev/simplifiedSolutionsCreateSample.js +46 -0
  28. package/dist-esm/samples-dev/simplifiedSolutionsCreateSample.js.map +1 -0
  29. package/dist-esm/samples-dev/simplifiedSolutionsGetSample.d.ts +2 -0
  30. package/dist-esm/samples-dev/simplifiedSolutionsGetSample.d.ts.map +1 -0
  31. package/dist-esm/samples-dev/simplifiedSolutionsGetSample.js +37 -0
  32. package/dist-esm/samples-dev/simplifiedSolutionsGetSample.js.map +1 -0
  33. package/dist-esm/samples-dev/solutionCreateSample.js +8 -5
  34. package/dist-esm/samples-dev/solutionCreateSample.js.map +1 -1
  35. package/dist-esm/samples-dev/solutionGetSample.js +1 -1
  36. package/dist-esm/samples-dev/solutionSelfHelpGetSample.d.ts +2 -0
  37. package/dist-esm/samples-dev/solutionSelfHelpGetSample.d.ts.map +1 -0
  38. package/dist-esm/samples-dev/solutionSelfHelpGetSample.js +36 -0
  39. package/dist-esm/samples-dev/solutionSelfHelpGetSample.js.map +1 -0
  40. package/dist-esm/samples-dev/solutionUpdateSample.js +2 -11
  41. package/dist-esm/samples-dev/solutionUpdateSample.js.map +1 -1
  42. package/dist-esm/samples-dev/solutionWarmUpSample.d.ts +2 -0
  43. package/dist-esm/samples-dev/solutionWarmUpSample.d.ts.map +1 -0
  44. package/dist-esm/samples-dev/solutionWarmUpSample.js +37 -0
  45. package/dist-esm/samples-dev/solutionWarmUpSample.js.map +1 -0
  46. package/dist-esm/samples-dev/troubleshootersContinueSample.js +6 -6
  47. package/dist-esm/samples-dev/troubleshootersContinueSample.js.map +1 -1
  48. package/dist-esm/samples-dev/troubleshootersCreateSample.js +5 -5
  49. package/dist-esm/samples-dev/troubleshootersCreateSample.js.map +1 -1
  50. package/dist-esm/samples-dev/troubleshootersEndSample.js +1 -1
  51. package/dist-esm/samples-dev/troubleshootersGetSample.js +1 -1
  52. package/dist-esm/samples-dev/troubleshootersRestartSample.js +1 -1
  53. package/dist-esm/src/helpRP.d.ts +8 -1
  54. package/dist-esm/src/helpRP.d.ts.map +1 -1
  55. package/dist-esm/src/helpRP.js +25 -15
  56. package/dist-esm/src/helpRP.js.map +1 -1
  57. package/dist-esm/src/lroImpl.js +1 -1
  58. package/dist-esm/src/models/index.d.ts +227 -7
  59. package/dist-esm/src/models/index.d.ts.map +1 -1
  60. package/dist-esm/src/models/index.js +24 -0
  61. package/dist-esm/src/models/index.js.map +1 -1
  62. package/dist-esm/src/models/mappers.d.ts +9 -0
  63. package/dist-esm/src/models/mappers.d.ts.map +1 -1
  64. package/dist-esm/src/models/mappers.js +860 -523
  65. package/dist-esm/src/models/mappers.js.map +1 -1
  66. package/dist-esm/src/models/parameters.d.ts +6 -0
  67. package/dist-esm/src/models/parameters.d.ts.map +1 -1
  68. package/dist-esm/src/models/parameters.js +95 -44
  69. package/dist-esm/src/models/parameters.js.map +1 -1
  70. package/dist-esm/src/operations/checkNameAvailability.js +4 -4
  71. package/dist-esm/src/operations/diagnostics.d.ts +6 -10
  72. package/dist-esm/src/operations/diagnostics.d.ts.map +1 -1
  73. package/dist-esm/src/operations/diagnostics.js +24 -28
  74. package/dist-esm/src/operations/diagnostics.js.map +1 -1
  75. package/dist-esm/src/operations/discoverySolution.d.ts +3 -12
  76. package/dist-esm/src/operations/discoverySolution.d.ts.map +1 -1
  77. package/dist-esm/src/operations/discoverySolution.js +27 -36
  78. package/dist-esm/src/operations/discoverySolution.js.map +1 -1
  79. package/dist-esm/src/operations/discoverySolutionNLPSubscriptionScope.d.ts +19 -0
  80. package/dist-esm/src/operations/discoverySolutionNLPSubscriptionScope.d.ts.map +1 -0
  81. package/dist-esm/src/operations/discoverySolutionNLPSubscriptionScope.js +49 -0
  82. package/dist-esm/src/operations/discoverySolutionNLPSubscriptionScope.js.map +1 -0
  83. package/dist-esm/src/operations/discoverySolutionNLPTenantScope.d.ts +19 -0
  84. package/dist-esm/src/operations/discoverySolutionNLPTenantScope.d.ts.map +1 -0
  85. package/dist-esm/src/operations/discoverySolutionNLPTenantScope.js +49 -0
  86. package/dist-esm/src/operations/discoverySolutionNLPTenantScope.js.map +1 -0
  87. package/dist-esm/src/operations/index.d.ts +4 -0
  88. package/dist-esm/src/operations/index.d.ts.map +1 -1
  89. package/dist-esm/src/operations/index.js +4 -0
  90. package/dist-esm/src/operations/index.js.map +1 -1
  91. package/dist-esm/src/operations/operations.js +9 -9
  92. package/dist-esm/src/operations/operations.js.map +1 -1
  93. package/dist-esm/src/operations/simplifiedSolutions.d.ts +52 -0
  94. package/dist-esm/src/operations/simplifiedSolutions.d.ts.map +1 -0
  95. package/dist-esm/src/operations/simplifiedSolutions.js +159 -0
  96. package/dist-esm/src/operations/simplifiedSolutions.js.map +1 -0
  97. package/dist-esm/src/operations/solution.d.ts +20 -25
  98. package/dist-esm/src/operations/solution.d.ts.map +1 -1
  99. package/dist-esm/src/operations/solution.js +71 -54
  100. package/dist-esm/src/operations/solution.js.map +1 -1
  101. package/dist-esm/src/operations/solutionSelfHelp.d.ts +23 -0
  102. package/dist-esm/src/operations/solutionSelfHelp.d.ts.map +1 -0
  103. package/dist-esm/src/operations/solutionSelfHelp.js +51 -0
  104. package/dist-esm/src/operations/solutionSelfHelp.js.map +1 -0
  105. package/dist-esm/src/operations/troubleshooters.js +26 -26
  106. package/dist-esm/src/operations/troubleshooters.js.map +1 -1
  107. package/dist-esm/src/operationsInterfaces/diagnostics.d.ts +6 -10
  108. package/dist-esm/src/operationsInterfaces/diagnostics.d.ts.map +1 -1
  109. package/dist-esm/src/operationsInterfaces/discoverySolution.d.ts +2 -5
  110. package/dist-esm/src/operationsInterfaces/discoverySolution.d.ts.map +1 -1
  111. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.d.ts +11 -0
  112. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.d.ts.map +1 -0
  113. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.js +9 -0
  114. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.js.map +1 -0
  115. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPTenantScope.d.ts +11 -0
  116. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPTenantScope.d.ts.map +1 -0
  117. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPTenantScope.js +9 -0
  118. package/dist-esm/src/operationsInterfaces/discoverySolutionNLPTenantScope.js.map +1 -0
  119. package/dist-esm/src/operationsInterfaces/index.d.ts +4 -0
  120. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -1
  121. package/dist-esm/src/operationsInterfaces/index.js +4 -0
  122. package/dist-esm/src/operationsInterfaces/index.js.map +1 -1
  123. package/dist-esm/src/operationsInterfaces/simplifiedSolutions.d.ts +44 -0
  124. package/dist-esm/src/operationsInterfaces/simplifiedSolutions.d.ts.map +1 -0
  125. package/dist-esm/src/operationsInterfaces/simplifiedSolutions.js +9 -0
  126. package/dist-esm/src/operationsInterfaces/simplifiedSolutions.js.map +1 -0
  127. package/dist-esm/src/operationsInterfaces/solution.d.ts +20 -25
  128. package/dist-esm/src/operationsInterfaces/solution.d.ts.map +1 -1
  129. package/dist-esm/src/operationsInterfaces/solutionSelfHelp.d.ts +15 -0
  130. package/dist-esm/src/operationsInterfaces/solutionSelfHelp.d.ts.map +1 -0
  131. package/dist-esm/src/operationsInterfaces/solutionSelfHelp.js +9 -0
  132. package/dist-esm/src/operationsInterfaces/solutionSelfHelp.js.map +1 -0
  133. package/dist-esm/src/pagingHelper.js.map +1 -1
  134. package/dist-esm/test/selfhelp_operations_test.spec.js +2 -2
  135. package/dist-esm/test/selfhelp_operations_test.spec.js.map +1 -1
  136. package/package.json +8 -10
  137. package/review/arm-selfhelp.api.md +177 -2
  138. package/src/helpRP.ts +58 -17
  139. package/src/lroImpl.ts +3 -3
  140. package/src/models/index.ts +263 -22
  141. package/src/models/mappers.ts +898 -529
  142. package/src/models/parameters.ts +105 -45
  143. package/src/operations/checkNameAvailability.ts +7 -7
  144. package/src/operations/diagnostics.ts +39 -46
  145. package/src/operations/discoverySolution.ts +29 -46
  146. package/src/operations/discoverySolutionNLPSubscriptionScope.ts +64 -0
  147. package/src/operations/discoverySolutionNLPTenantScope.ts +64 -0
  148. package/src/operations/index.ts +4 -0
  149. package/src/operations/operations.ts +16 -16
  150. package/src/operations/simplifiedSolutions.ts +216 -0
  151. package/src/operations/solution.ts +101 -77
  152. package/src/operations/solutionSelfHelp.ts +68 -0
  153. package/src/operations/troubleshooters.ts +42 -47
  154. package/src/operationsInterfaces/checkNameAvailability.ts +2 -2
  155. package/src/operationsInterfaces/diagnostics.ts +10 -14
  156. package/src/operationsInterfaces/discoverySolution.ts +3 -7
  157. package/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.ts +24 -0
  158. package/src/operationsInterfaces/discoverySolutionNLPTenantScope.ts +24 -0
  159. package/src/operationsInterfaces/index.ts +4 -0
  160. package/src/operationsInterfaces/operations.ts +1 -1
  161. package/src/operationsInterfaces/simplifiedSolutions.ts +74 -0
  162. package/src/operationsInterfaces/solution.ts +30 -30
  163. package/src/operationsInterfaces/solutionSelfHelp.ts +29 -0
  164. package/src/operationsInterfaces/troubleshooters.ts +6 -6
  165. package/src/pagingHelper.ts +1 -1
  166. package/types/arm-selfhelp.d.ts +359 -46
  167. package/types/tsdoc-metadata.json +1 -1
@@ -14,7 +14,7 @@ import { HelpRP } from "../helpRP";
14
14
  import {
15
15
  SimplePollerLike,
16
16
  OperationState,
17
- createHttpPoller
17
+ createHttpPoller,
18
18
  } from "@azure/core-lro";
19
19
  import { createLroSpec } from "../lroImpl";
20
20
  import {
@@ -23,7 +23,8 @@ import {
23
23
  SolutionGetOptionalParams,
24
24
  SolutionGetResponse,
25
25
  SolutionUpdateOptionalParams,
26
- SolutionUpdateResponse
26
+ SolutionUpdateResponse,
27
+ SolutionWarmUpOptionalParams,
27
28
  } from "../models";
28
29
 
29
30
  /** Class containing Solution operations. */
@@ -42,18 +43,11 @@ export class SolutionImpl implements Solution {
42
43
  * Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
43
44
  * requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
44
45
  * self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
45
- * resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware
46
- * diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
47
- * tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
48
- * troubleshooting instructions. All these components are seamlessly converged into unified solutions
49
- * tailored to address a specific support problem area. Each solution type may require one or more
50
- * ‘requiredParameters’ that are required to execute the individual solution component. In the absence
51
- * of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you
52
- * might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from Discovery
53
- * solutions response must be passed via ‘parameters’ in the request body of Solutions API. <br/>2.
54
- * ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the
55
- * request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
56
- * ‘properties.parameters’ in the request for Troubleshooters
46
+ * resolving typical troubleshooting issues. These solutions encompass: <br/> (1.) Dynamic and
47
+ * context-aware diagnostics, guided troubleshooting wizards, and data visualizations. <br/> (2.) Rich
48
+ * instructional video tutorials and illustrative diagrams and images. <br/> (3.) Thoughtfully
49
+ * assembled textual troubleshooting instructions. <br/> All these components are seamlessly converged
50
+ * into unified solutions tailored to address a specific support problem area.
57
51
  * @param scope scope = resourceUri of affected resource.<br/> For example:
58
52
  * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
59
53
  *
@@ -63,7 +57,7 @@ export class SolutionImpl implements Solution {
63
57
  async beginCreate(
64
58
  scope: string,
65
59
  solutionResourceName: string,
66
- options?: SolutionCreateOptionalParams
60
+ options?: SolutionCreateOptionalParams,
67
61
  ): Promise<
68
62
  SimplePollerLike<
69
63
  OperationState<SolutionCreateResponse>,
@@ -72,21 +66,20 @@ export class SolutionImpl implements Solution {
72
66
  > {
73
67
  const directSendOperation = async (
74
68
  args: coreClient.OperationArguments,
75
- spec: coreClient.OperationSpec
69
+ spec: coreClient.OperationSpec,
76
70
  ): Promise<SolutionCreateResponse> => {
77
71
  return this.client.sendOperationRequest(args, spec);
78
72
  };
79
73
  const sendOperationFn = async (
80
74
  args: coreClient.OperationArguments,
81
- spec: coreClient.OperationSpec
75
+ spec: coreClient.OperationSpec,
82
76
  ) => {
83
- let currentRawResponse:
84
- | coreClient.FullOperationResponse
85
- | undefined = undefined;
77
+ let currentRawResponse: coreClient.FullOperationResponse | undefined =
78
+ undefined;
86
79
  const providedCallback = args.options?.onResponse;
87
80
  const callback: coreClient.RawResponseCallback = (
88
81
  rawResponse: coreClient.FullOperationResponse,
89
- flatResponse: unknown
82
+ flatResponse: unknown,
90
83
  ) => {
91
84
  currentRawResponse = rawResponse;
92
85
  providedCallback?.(rawResponse, flatResponse);
@@ -95,8 +88,8 @@ export class SolutionImpl implements Solution {
95
88
  ...args,
96
89
  options: {
97
90
  ...args.options,
98
- onResponse: callback
99
- }
91
+ onResponse: callback,
92
+ },
100
93
  };
101
94
  const flatResponse = await directSendOperation(updatedArgs, spec);
102
95
  return {
@@ -104,15 +97,15 @@ export class SolutionImpl implements Solution {
104
97
  rawResponse: {
105
98
  statusCode: currentRawResponse!.status,
106
99
  body: currentRawResponse!.parsedBody,
107
- headers: currentRawResponse!.headers.toJSON()
108
- }
100
+ headers: currentRawResponse!.headers.toJSON(),
101
+ },
109
102
  };
110
103
  };
111
104
 
112
105
  const lro = createLroSpec({
113
106
  sendOperationFn,
114
107
  args: { scope, solutionResourceName, options },
115
- spec: createOperationSpec
108
+ spec: createOperationSpec,
116
109
  });
117
110
  const poller = await createHttpPoller<
118
111
  SolutionCreateResponse,
@@ -120,7 +113,7 @@ export class SolutionImpl implements Solution {
120
113
  >(lro, {
121
114
  restoreFrom: options?.resumeFrom,
122
115
  intervalInMs: options?.updateIntervalInMs,
123
- resourceLocationConfig: "azure-async-operation"
116
+ resourceLocationConfig: "azure-async-operation",
124
117
  });
125
118
  await poller.poll();
126
119
  return poller;
@@ -130,18 +123,11 @@ export class SolutionImpl implements Solution {
130
123
  * Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
131
124
  * requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
132
125
  * self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
133
- * resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware
134
- * diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
135
- * tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
136
- * troubleshooting instructions. All these components are seamlessly converged into unified solutions
137
- * tailored to address a specific support problem area. Each solution type may require one or more
138
- * ‘requiredParameters’ that are required to execute the individual solution component. In the absence
139
- * of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you
140
- * might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from Discovery
141
- * solutions response must be passed via ‘parameters’ in the request body of Solutions API. <br/>2.
142
- * ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the
143
- * request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
144
- * ‘properties.parameters’ in the request for Troubleshooters
126
+ * resolving typical troubleshooting issues. These solutions encompass: <br/> (1.) Dynamic and
127
+ * context-aware diagnostics, guided troubleshooting wizards, and data visualizations. <br/> (2.) Rich
128
+ * instructional video tutorials and illustrative diagrams and images. <br/> (3.) Thoughtfully
129
+ * assembled textual troubleshooting instructions. <br/> All these components are seamlessly converged
130
+ * into unified solutions tailored to address a specific support problem area.
145
131
  * @param scope scope = resourceUri of affected resource.<br/> For example:
146
132
  * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
147
133
  *
@@ -151,7 +137,7 @@ export class SolutionImpl implements Solution {
151
137
  async beginCreateAndWait(
152
138
  scope: string,
153
139
  solutionResourceName: string,
154
- options?: SolutionCreateOptionalParams
140
+ options?: SolutionCreateOptionalParams,
155
141
  ): Promise<SolutionCreateResponse> {
156
142
  const poller = await this.beginCreate(scope, solutionResourceName, options);
157
143
  return poller.pollUntilDone();
@@ -168,11 +154,11 @@ export class SolutionImpl implements Solution {
168
154
  get(
169
155
  scope: string,
170
156
  solutionResourceName: string,
171
- options?: SolutionGetOptionalParams
157
+ options?: SolutionGetOptionalParams,
172
158
  ): Promise<SolutionGetResponse> {
173
159
  return this.client.sendOperationRequest(
174
160
  { scope, solutionResourceName, options },
175
- getOperationSpec
161
+ getOperationSpec,
176
162
  );
177
163
  }
178
164
 
@@ -187,7 +173,7 @@ export class SolutionImpl implements Solution {
187
173
  async beginUpdate(
188
174
  scope: string,
189
175
  solutionResourceName: string,
190
- options?: SolutionUpdateOptionalParams
176
+ options?: SolutionUpdateOptionalParams,
191
177
  ): Promise<
192
178
  SimplePollerLike<
193
179
  OperationState<SolutionUpdateResponse>,
@@ -196,21 +182,20 @@ export class SolutionImpl implements Solution {
196
182
  > {
197
183
  const directSendOperation = async (
198
184
  args: coreClient.OperationArguments,
199
- spec: coreClient.OperationSpec
185
+ spec: coreClient.OperationSpec,
200
186
  ): Promise<SolutionUpdateResponse> => {
201
187
  return this.client.sendOperationRequest(args, spec);
202
188
  };
203
189
  const sendOperationFn = async (
204
190
  args: coreClient.OperationArguments,
205
- spec: coreClient.OperationSpec
191
+ spec: coreClient.OperationSpec,
206
192
  ) => {
207
- let currentRawResponse:
208
- | coreClient.FullOperationResponse
209
- | undefined = undefined;
193
+ let currentRawResponse: coreClient.FullOperationResponse | undefined =
194
+ undefined;
210
195
  const providedCallback = args.options?.onResponse;
211
196
  const callback: coreClient.RawResponseCallback = (
212
197
  rawResponse: coreClient.FullOperationResponse,
213
- flatResponse: unknown
198
+ flatResponse: unknown,
214
199
  ) => {
215
200
  currentRawResponse = rawResponse;
216
201
  providedCallback?.(rawResponse, flatResponse);
@@ -219,8 +204,8 @@ export class SolutionImpl implements Solution {
219
204
  ...args,
220
205
  options: {
221
206
  ...args.options,
222
- onResponse: callback
223
- }
207
+ onResponse: callback,
208
+ },
224
209
  };
225
210
  const flatResponse = await directSendOperation(updatedArgs, spec);
226
211
  return {
@@ -228,15 +213,15 @@ export class SolutionImpl implements Solution {
228
213
  rawResponse: {
229
214
  statusCode: currentRawResponse!.status,
230
215
  body: currentRawResponse!.parsedBody,
231
- headers: currentRawResponse!.headers.toJSON()
232
- }
216
+ headers: currentRawResponse!.headers.toJSON(),
217
+ },
233
218
  };
234
219
  };
235
220
 
236
221
  const lro = createLroSpec({
237
222
  sendOperationFn,
238
223
  args: { scope, solutionResourceName, options },
239
- spec: updateOperationSpec
224
+ spec: updateOperationSpec,
240
225
  });
241
226
  const poller = await createHttpPoller<
242
227
  SolutionUpdateResponse,
@@ -244,7 +229,7 @@ export class SolutionImpl implements Solution {
244
229
  >(lro, {
245
230
  restoreFrom: options?.resumeFrom,
246
231
  intervalInMs: options?.updateIntervalInMs,
247
- resourceLocationConfig: "azure-async-operation"
232
+ resourceLocationConfig: "azure-async-operation",
248
233
  });
249
234
  await poller.poll();
250
235
  return poller;
@@ -261,11 +246,30 @@ export class SolutionImpl implements Solution {
261
246
  async beginUpdateAndWait(
262
247
  scope: string,
263
248
  solutionResourceName: string,
264
- options?: SolutionUpdateOptionalParams
249
+ options?: SolutionUpdateOptionalParams,
265
250
  ): Promise<SolutionUpdateResponse> {
266
251
  const poller = await this.beginUpdate(scope, solutionResourceName, options);
267
252
  return poller.pollUntilDone();
268
253
  }
254
+
255
+ /**
256
+ * Warm up the solution resource by preloading asynchronous diagnostics results into cache
257
+ * @param scope scope = resourceUri of affected resource.<br/> For example:
258
+ * /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
259
+ *
260
+ * @param solutionResourceName Solution resource Name.
261
+ * @param options The options parameters.
262
+ */
263
+ warmUp(
264
+ scope: string,
265
+ solutionResourceName: string,
266
+ options?: SolutionWarmUpOptionalParams,
267
+ ): Promise<void> {
268
+ return this.client.sendOperationRequest(
269
+ { scope, solutionResourceName, options },
270
+ warmUpOperationSpec,
271
+ );
272
+ }
269
273
  }
270
274
  // Operation Specifications
271
275
  const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
@@ -275,51 +279,51 @@ const createOperationSpec: coreClient.OperationSpec = {
275
279
  httpMethod: "PUT",
276
280
  responses: {
277
281
  200: {
278
- bodyMapper: Mappers.SolutionResource
282
+ bodyMapper: Mappers.SolutionResource,
279
283
  },
280
284
  201: {
281
- bodyMapper: Mappers.SolutionResource
285
+ bodyMapper: Mappers.SolutionResource,
282
286
  },
283
287
  202: {
284
- bodyMapper: Mappers.SolutionResource
288
+ bodyMapper: Mappers.SolutionResource,
285
289
  },
286
290
  204: {
287
- bodyMapper: Mappers.SolutionResource
291
+ bodyMapper: Mappers.SolutionResource,
288
292
  },
289
293
  default: {
290
- bodyMapper: Mappers.ErrorResponse
291
- }
294
+ bodyMapper: Mappers.ErrorResponse,
295
+ },
292
296
  },
293
297
  requestBody: Parameters.solutionRequestBody,
294
298
  queryParameters: [Parameters.apiVersion],
295
299
  urlParameters: [
296
300
  Parameters.$host,
297
301
  Parameters.scope,
298
- Parameters.solutionResourceName
302
+ Parameters.solutionResourceName,
299
303
  ],
300
304
  headerParameters: [Parameters.accept, Parameters.contentType],
301
305
  mediaType: "json",
302
- serializer
306
+ serializer,
303
307
  };
304
308
  const getOperationSpec: coreClient.OperationSpec = {
305
309
  path: "/{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}",
306
310
  httpMethod: "GET",
307
311
  responses: {
308
312
  200: {
309
- bodyMapper: Mappers.SolutionResource
313
+ bodyMapper: Mappers.SolutionResource,
310
314
  },
311
315
  default: {
312
- bodyMapper: Mappers.ErrorResponse
313
- }
316
+ bodyMapper: Mappers.ErrorResponse,
317
+ },
314
318
  },
315
319
  queryParameters: [Parameters.apiVersion],
316
320
  urlParameters: [
317
321
  Parameters.$host,
318
322
  Parameters.scope,
319
- Parameters.solutionResourceName
323
+ Parameters.solutionResourceName,
320
324
  ],
321
325
  headerParameters: [Parameters.accept],
322
- serializer
326
+ serializer,
323
327
  };
324
328
  const updateOperationSpec: coreClient.OperationSpec = {
325
329
  path: "/{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}",
@@ -327,32 +331,52 @@ const updateOperationSpec: coreClient.OperationSpec = {
327
331
  responses: {
328
332
  200: {
329
333
  bodyMapper: Mappers.SolutionResource,
330
- headersMapper: Mappers.SolutionUpdateHeaders
334
+ headersMapper: Mappers.SolutionUpdateHeaders,
331
335
  },
332
336
  201: {
333
337
  bodyMapper: Mappers.SolutionResource,
334
- headersMapper: Mappers.SolutionUpdateHeaders
338
+ headersMapper: Mappers.SolutionUpdateHeaders,
335
339
  },
336
340
  202: {
337
341
  bodyMapper: Mappers.SolutionResource,
338
- headersMapper: Mappers.SolutionUpdateHeaders
342
+ headersMapper: Mappers.SolutionUpdateHeaders,
339
343
  },
340
344
  204: {
341
345
  bodyMapper: Mappers.SolutionResource,
342
- headersMapper: Mappers.SolutionUpdateHeaders
346
+ headersMapper: Mappers.SolutionUpdateHeaders,
343
347
  },
344
348
  default: {
345
- bodyMapper: Mappers.ErrorResponse
346
- }
349
+ bodyMapper: Mappers.ErrorResponse,
350
+ },
347
351
  },
348
352
  requestBody: Parameters.solutionPatchRequestBody,
349
353
  queryParameters: [Parameters.apiVersion],
350
354
  urlParameters: [
351
355
  Parameters.$host,
352
356
  Parameters.scope,
353
- Parameters.solutionResourceName
357
+ Parameters.solutionResourceName,
358
+ ],
359
+ headerParameters: [Parameters.accept, Parameters.contentType],
360
+ mediaType: "json",
361
+ serializer,
362
+ };
363
+ const warmUpOperationSpec: coreClient.OperationSpec = {
364
+ path: "/{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}/warmup",
365
+ httpMethod: "POST",
366
+ responses: {
367
+ 204: {},
368
+ default: {
369
+ bodyMapper: Mappers.ErrorResponse,
370
+ },
371
+ },
372
+ requestBody: Parameters.solutionWarmUpRequestBody,
373
+ queryParameters: [Parameters.apiVersion],
374
+ urlParameters: [
375
+ Parameters.$host,
376
+ Parameters.scope,
377
+ Parameters.solutionResourceName,
354
378
  ],
355
379
  headerParameters: [Parameters.accept, Parameters.contentType],
356
380
  mediaType: "json",
357
- serializer
381
+ serializer,
358
382
  };
@@ -0,0 +1,68 @@
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 { SolutionSelfHelp } 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
+ SolutionSelfHelpGetOptionalParams,
16
+ SolutionSelfHelpGetResponse,
17
+ } from "../models";
18
+
19
+ /** Class containing SolutionSelfHelp operations. */
20
+ export class SolutionSelfHelpImpl implements SolutionSelfHelp {
21
+ private readonly client: HelpRP;
22
+
23
+ /**
24
+ * Initialize a new instance of the class SolutionSelfHelp class.
25
+ * @param client Reference to the service client
26
+ */
27
+ constructor(client: HelpRP) {
28
+ this.client = client;
29
+ }
30
+
31
+ /**
32
+ * Gets Self Help Solutions for a given solutionId. Self Help Solutions consist of rich instructional
33
+ * video tutorials, links and guides to public documentation related to a specific problem that enables
34
+ * users to troubleshoot Azure issues.
35
+ * @param solutionId SolutionId is a unique id to identify a solution. You can retrieve the solution id
36
+ * using the Discovery api -
37
+ * https://learn.microsoft.com/en-us/rest/api/help/discovery-solution/list?view=rest-help-2023-09-01-preview&tabs=HTTP
38
+ * @param options The options parameters.
39
+ */
40
+ get(
41
+ solutionId: string,
42
+ options?: SolutionSelfHelpGetOptionalParams,
43
+ ): Promise<SolutionSelfHelpGetResponse> {
44
+ return this.client.sendOperationRequest(
45
+ { solutionId, options },
46
+ getOperationSpec,
47
+ );
48
+ }
49
+ }
50
+ // Operation Specifications
51
+ const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
52
+
53
+ const getOperationSpec: coreClient.OperationSpec = {
54
+ path: "/providers/Microsoft.Help/selfHelp/{solutionId}",
55
+ httpMethod: "GET",
56
+ responses: {
57
+ 200: {
58
+ bodyMapper: Mappers.SolutionResourceSelfHelp,
59
+ },
60
+ default: {
61
+ bodyMapper: Mappers.ErrorResponse,
62
+ },
63
+ },
64
+ queryParameters: [Parameters.apiVersion],
65
+ urlParameters: [Parameters.$host, Parameters.solutionId],
66
+ headerParameters: [Parameters.accept],
67
+ serializer,
68
+ };
@@ -21,7 +21,7 @@ import {
21
21
  TroubleshootersEndOptionalParams,
22
22
  TroubleshootersEndResponse,
23
23
  TroubleshootersRestartOptionalParams,
24
- TroubleshootersRestartResponse
24
+ TroubleshootersRestartResponse,
25
25
  } from "../models";
26
26
 
27
27
  /** Class containing Troubleshooters operations. */
@@ -54,11 +54,11 @@ export class TroubleshootersImpl implements Troubleshooters {
54
54
  create(
55
55
  scope: string,
56
56
  troubleshooterName: string,
57
- options?: TroubleshootersCreateOptionalParams
57
+ options?: TroubleshootersCreateOptionalParams,
58
58
  ): Promise<TroubleshootersCreateResponse> {
59
59
  return this.client.sendOperationRequest(
60
60
  { scope, troubleshooterName, options },
61
- createOperationSpec
61
+ createOperationSpec,
62
62
  );
63
63
  }
64
64
 
@@ -76,11 +76,11 @@ export class TroubleshootersImpl implements Troubleshooters {
76
76
  get(
77
77
  scope: string,
78
78
  troubleshooterName: string,
79
- options?: TroubleshootersGetOptionalParams
79
+ options?: TroubleshootersGetOptionalParams,
80
80
  ): Promise<TroubleshootersGetResponse> {
81
81
  return this.client.sendOperationRequest(
82
82
  { scope, troubleshooterName, options },
83
- getOperationSpec
83
+ getOperationSpec,
84
84
  );
85
85
  }
86
86
 
@@ -98,11 +98,11 @@ export class TroubleshootersImpl implements Troubleshooters {
98
98
  continue(
99
99
  scope: string,
100
100
  troubleshooterName: string,
101
- options?: TroubleshootersContinueOptionalParams
101
+ options?: TroubleshootersContinueOptionalParams,
102
102
  ): Promise<TroubleshootersContinueResponse> {
103
103
  return this.client.sendOperationRequest(
104
104
  { scope, troubleshooterName, options },
105
- continueOperationSpec
105
+ continueOperationSpec,
106
106
  );
107
107
  }
108
108
 
@@ -117,11 +117,11 @@ export class TroubleshootersImpl implements Troubleshooters {
117
117
  end(
118
118
  scope: string,
119
119
  troubleshooterName: string,
120
- options?: TroubleshootersEndOptionalParams
120
+ options?: TroubleshootersEndOptionalParams,
121
121
  ): Promise<TroubleshootersEndResponse> {
122
122
  return this.client.sendOperationRequest(
123
123
  { scope, troubleshooterName, options },
124
- endOperationSpec
124
+ endOperationSpec,
125
125
  );
126
126
  }
127
127
 
@@ -138,11 +138,11 @@ export class TroubleshootersImpl implements Troubleshooters {
138
138
  restart(
139
139
  scope: string,
140
140
  troubleshooterName: string,
141
- options?: TroubleshootersRestartOptionalParams
141
+ options?: TroubleshootersRestartOptionalParams,
142
142
  ): Promise<TroubleshootersRestartResponse> {
143
143
  return this.client.sendOperationRequest(
144
144
  { scope, troubleshooterName, options },
145
- restartOperationSpec
145
+ restartOperationSpec,
146
146
  );
147
147
  }
148
148
  }
@@ -150,115 +150,110 @@ export class TroubleshootersImpl implements Troubleshooters {
150
150
  const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
151
151
 
152
152
  const createOperationSpec: coreClient.OperationSpec = {
153
- path:
154
- "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}",
153
+ path: "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}",
155
154
  httpMethod: "PUT",
156
155
  responses: {
157
156
  200: {
158
- bodyMapper: Mappers.TroubleshooterResource
157
+ bodyMapper: Mappers.TroubleshooterResource,
159
158
  },
160
159
  201: {
161
- bodyMapper: Mappers.TroubleshooterResource
160
+ bodyMapper: Mappers.TroubleshooterResource,
162
161
  },
163
162
  default: {
164
- bodyMapper: Mappers.ErrorResponse
165
- }
163
+ bodyMapper: Mappers.ErrorResponse,
164
+ },
166
165
  },
167
166
  requestBody: Parameters.createTroubleshooterRequestBody,
168
167
  queryParameters: [Parameters.apiVersion],
169
168
  urlParameters: [
170
169
  Parameters.$host,
171
170
  Parameters.scope,
172
- Parameters.troubleshooterName
171
+ Parameters.troubleshooterName,
173
172
  ],
174
173
  headerParameters: [Parameters.accept, Parameters.contentType],
175
174
  mediaType: "json",
176
- serializer
175
+ serializer,
177
176
  };
178
177
  const getOperationSpec: coreClient.OperationSpec = {
179
- path:
180
- "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}",
178
+ path: "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}",
181
179
  httpMethod: "GET",
182
180
  responses: {
183
181
  200: {
184
- bodyMapper: Mappers.TroubleshooterResource
182
+ bodyMapper: Mappers.TroubleshooterResource,
185
183
  },
186
184
  default: {
187
- bodyMapper: Mappers.ErrorResponse
188
- }
185
+ bodyMapper: Mappers.ErrorResponse,
186
+ },
189
187
  },
190
188
  queryParameters: [Parameters.apiVersion],
191
189
  urlParameters: [
192
190
  Parameters.$host,
193
191
  Parameters.scope,
194
- Parameters.troubleshooterName
192
+ Parameters.troubleshooterName,
195
193
  ],
196
194
  headerParameters: [Parameters.accept],
197
- serializer
195
+ serializer,
198
196
  };
199
197
  const continueOperationSpec: coreClient.OperationSpec = {
200
- path:
201
- "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/continue",
198
+ path: "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/continue",
202
199
  httpMethod: "POST",
203
200
  responses: {
204
201
  204: {
205
- headersMapper: Mappers.TroubleshootersContinueHeaders
202
+ headersMapper: Mappers.TroubleshootersContinueHeaders,
206
203
  },
207
204
  default: {
208
- bodyMapper: Mappers.ErrorResponse
209
- }
205
+ bodyMapper: Mappers.ErrorResponse,
206
+ },
210
207
  },
211
208
  requestBody: Parameters.continueRequestBody,
212
209
  queryParameters: [Parameters.apiVersion],
213
210
  urlParameters: [
214
211
  Parameters.$host,
215
212
  Parameters.scope,
216
- Parameters.troubleshooterName
213
+ Parameters.troubleshooterName,
217
214
  ],
218
215
  headerParameters: [Parameters.accept, Parameters.contentType],
219
216
  mediaType: "json",
220
- serializer
217
+ serializer,
221
218
  };
222
219
  const endOperationSpec: coreClient.OperationSpec = {
223
- path:
224
- "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/end",
220
+ path: "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/end",
225
221
  httpMethod: "POST",
226
222
  responses: {
227
223
  204: {
228
- headersMapper: Mappers.TroubleshootersEndHeaders
224
+ headersMapper: Mappers.TroubleshootersEndHeaders,
229
225
  },
230
226
  default: {
231
- bodyMapper: Mappers.ErrorResponse
232
- }
227
+ bodyMapper: Mappers.ErrorResponse,
228
+ },
233
229
  },
234
230
  queryParameters: [Parameters.apiVersion],
235
231
  urlParameters: [
236
232
  Parameters.$host,
237
233
  Parameters.scope,
238
- Parameters.troubleshooterName
234
+ Parameters.troubleshooterName,
239
235
  ],
240
236
  headerParameters: [Parameters.accept],
241
- serializer
237
+ serializer,
242
238
  };
243
239
  const restartOperationSpec: coreClient.OperationSpec = {
244
- path:
245
- "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/restart",
240
+ path: "/{scope}/providers/Microsoft.Help/troubleshooters/{troubleshooterName}/restart",
246
241
  httpMethod: "POST",
247
242
  responses: {
248
243
  200: {
249
244
  bodyMapper: Mappers.RestartTroubleshooterResponse,
250
- headersMapper: Mappers.TroubleshootersRestartHeaders
245
+ headersMapper: Mappers.TroubleshootersRestartHeaders,
251
246
  },
252
247
  default: {
253
- bodyMapper: Mappers.ErrorResponse
254
- }
248
+ bodyMapper: Mappers.ErrorResponse,
249
+ },
255
250
  },
256
251
  queryParameters: [Parameters.apiVersion],
257
252
  urlParameters: [
258
253
  Parameters.$host,
259
254
  Parameters.scope,
260
- Parameters.troubleshooterName
255
+ Parameters.troubleshooterName,
261
256
  ],
262
257
  headerParameters: [Parameters.accept],
263
- serializer
258
+ serializer,
264
259
  };