@azure/arm-selfhelp 2.0.0-beta.1 → 2.0.0-beta.2
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.
- package/CHANGELOG.md +94 -1
- package/dist/index.js +253 -209
- package/dist/index.js.map +1 -1
- package/dist/index.min.js +1 -1
- package/dist/index.min.js.map +1 -1
- package/dist-esm/samples-dev/diagnosticsCreateSample.js +12 -3
- package/dist-esm/samples-dev/diagnosticsCreateSample.js.map +1 -1
- package/dist-esm/samples-dev/discoverySolutionListSample.js +4 -4
- package/dist-esm/samples-dev/solutionCreateSample.js +3 -8
- package/dist-esm/samples-dev/solutionCreateSample.js.map +1 -1
- package/dist-esm/samples-dev/solutionUpdateSample.js +10 -1
- package/dist-esm/samples-dev/solutionUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/troubleshootersCreateSample.js +2 -2
- package/dist-esm/src/helpRP.js +1 -1
- package/dist-esm/src/models/index.d.ts +126 -85
- package/dist-esm/src/models/index.d.ts.map +1 -1
- package/dist-esm/src/models/index.js +25 -19
- package/dist-esm/src/models/index.js.map +1 -1
- package/dist-esm/src/models/mappers.d.ts +1 -2
- package/dist-esm/src/models/mappers.d.ts.map +1 -1
- package/dist-esm/src/models/mappers.js +129 -109
- package/dist-esm/src/models/mappers.js.map +1 -1
- package/dist-esm/src/operations/checkNameAvailability.d.ts +3 -2
- package/dist-esm/src/operations/checkNameAvailability.d.ts.map +1 -1
- package/dist-esm/src/operations/checkNameAvailability.js +3 -2
- package/dist-esm/src/operations/checkNameAvailability.js.map +1 -1
- package/dist-esm/src/operations/diagnostics.d.ts +17 -14
- package/dist-esm/src/operations/diagnostics.d.ts.map +1 -1
- package/dist-esm/src/operations/diagnostics.js +17 -14
- package/dist-esm/src/operations/diagnostics.js.map +1 -1
- package/dist-esm/src/operations/discoverySolution.d.ts +11 -10
- package/dist-esm/src/operations/discoverySolution.d.ts.map +1 -1
- package/dist-esm/src/operations/discoverySolution.js +11 -10
- package/dist-esm/src/operations/discoverySolution.js.map +1 -1
- package/dist-esm/src/operations/solution.d.ts +43 -34
- package/dist-esm/src/operations/solution.d.ts.map +1 -1
- package/dist-esm/src/operations/solution.js +43 -34
- package/dist-esm/src/operations/solution.js.map +1 -1
- package/dist-esm/src/operations/troubleshooters.d.ts +22 -19
- package/dist-esm/src/operations/troubleshooters.d.ts.map +1 -1
- package/dist-esm/src/operations/troubleshooters.js +22 -19
- package/dist-esm/src/operations/troubleshooters.js.map +1 -1
- package/dist-esm/src/operationsInterfaces/checkNameAvailability.d.ts +3 -2
- package/dist-esm/src/operationsInterfaces/checkNameAvailability.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/diagnostics.d.ts +17 -14
- package/dist-esm/src/operationsInterfaces/diagnostics.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/discoverySolution.d.ts +4 -4
- package/dist-esm/src/operationsInterfaces/solution.d.ts +43 -34
- package/dist-esm/src/operationsInterfaces/solution.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/troubleshooters.d.ts +22 -19
- package/dist-esm/src/operationsInterfaces/troubleshooters.d.ts.map +1 -1
- package/package.json +7 -5
- package/review/arm-selfhelp.api.md +21 -17
- package/src/helpRP.ts +1 -1
- package/src/models/index.ts +125 -87
- package/src/models/mappers.ts +140 -111
- package/src/operations/checkNameAvailability.ts +3 -2
- package/src/operations/diagnostics.ts +17 -14
- package/src/operations/discoverySolution.ts +11 -10
- package/src/operations/solution.ts +43 -34
- package/src/operations/troubleshooters.ts +22 -19
- package/src/operationsInterfaces/checkNameAvailability.ts +3 -2
- package/src/operationsInterfaces/diagnostics.ts +17 -14
- package/src/operationsInterfaces/discoverySolution.ts +4 -4
- package/src/operationsInterfaces/solution.ts +43 -34
- package/src/operationsInterfaces/troubleshooters.ts +22 -19
- package/types/arm-selfhelp.d.ts +182 -126
- package/types/tsdoc-metadata.json +1 -1
|
@@ -38,15 +38,15 @@ export class DiscoverySolutionImpl implements DiscoverySolution {
|
|
|
38
38
|
* Lists the relevant Azure diagnostics and solutions using [problemClassification
|
|
39
39
|
* API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND
|
|
40
40
|
* resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API,
|
|
41
|
-
* which identifies relevant Azure diagnostics and solutions.
|
|
42
|
-
* effective solutions based on the type of inputs, in the request URL <br/><br/> Mandatory input :
|
|
41
|
+
* which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input :
|
|
43
42
|
* problemClassificationId (Use the [problemClassification
|
|
44
43
|
* API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
|
|
45
44
|
* <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from
|
|
46
45
|
* Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics
|
|
47
46
|
* and Solutions API.
|
|
48
|
-
* @param scope
|
|
49
|
-
*
|
|
47
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
48
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
49
|
+
*
|
|
50
50
|
* @param options The options parameters.
|
|
51
51
|
*/
|
|
52
52
|
public list(
|
|
@@ -106,15 +106,15 @@ export class DiscoverySolutionImpl implements DiscoverySolution {
|
|
|
106
106
|
* Lists the relevant Azure diagnostics and solutions using [problemClassification
|
|
107
107
|
* API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND
|
|
108
108
|
* resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API,
|
|
109
|
-
* which identifies relevant Azure diagnostics and solutions.
|
|
110
|
-
* effective solutions based on the type of inputs, in the request URL <br/><br/> Mandatory input :
|
|
109
|
+
* which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input :
|
|
111
110
|
* problemClassificationId (Use the [problemClassification
|
|
112
111
|
* API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
|
|
113
112
|
* <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from
|
|
114
113
|
* Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics
|
|
115
114
|
* and Solutions API.
|
|
116
|
-
* @param scope
|
|
117
|
-
*
|
|
115
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
116
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
117
|
+
*
|
|
118
118
|
* @param options The options parameters.
|
|
119
119
|
*/
|
|
120
120
|
private _list(
|
|
@@ -129,8 +129,9 @@ export class DiscoverySolutionImpl implements DiscoverySolution {
|
|
|
129
129
|
|
|
130
130
|
/**
|
|
131
131
|
* ListNext
|
|
132
|
-
* @param scope
|
|
133
|
-
*
|
|
132
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
133
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
134
|
+
*
|
|
134
135
|
* @param nextLink The nextLink from the previous successful call to the List method.
|
|
135
136
|
* @param options The options parameters.
|
|
136
137
|
*/
|
|
@@ -39,21 +39,24 @@ export class SolutionImpl implements Solution {
|
|
|
39
39
|
}
|
|
40
40
|
|
|
41
41
|
/**
|
|
42
|
-
* Creates a solution for the specific Azure resource or subscription using the
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
42
|
+
* Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
|
|
43
|
+
* requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
|
|
44
|
+
* 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
|
|
54
56
|
* ‘properties.parameters’ in the request for Troubleshooters
|
|
55
|
-
* @param scope
|
|
56
|
-
*
|
|
57
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
58
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
59
|
+
*
|
|
57
60
|
* @param solutionResourceName Solution resource Name.
|
|
58
61
|
* @param options The options parameters.
|
|
59
62
|
*/
|
|
@@ -124,21 +127,24 @@ export class SolutionImpl implements Solution {
|
|
|
124
127
|
}
|
|
125
128
|
|
|
126
129
|
/**
|
|
127
|
-
* Creates a solution for the specific Azure resource or subscription using the
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
130
|
+
* Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
|
|
131
|
+
* requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
|
|
132
|
+
* 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
|
|
139
144
|
* ‘properties.parameters’ in the request for Troubleshooters
|
|
140
|
-
* @param scope
|
|
141
|
-
*
|
|
145
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
146
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
147
|
+
*
|
|
142
148
|
* @param solutionResourceName Solution resource Name.
|
|
143
149
|
* @param options The options parameters.
|
|
144
150
|
*/
|
|
@@ -153,8 +159,9 @@ export class SolutionImpl implements Solution {
|
|
|
153
159
|
|
|
154
160
|
/**
|
|
155
161
|
* Get the solution using the applicable solutionResourceName while creating the solution.
|
|
156
|
-
* @param scope
|
|
157
|
-
*
|
|
162
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
163
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
164
|
+
*
|
|
158
165
|
* @param solutionResourceName Solution resource Name.
|
|
159
166
|
* @param options The options parameters.
|
|
160
167
|
*/
|
|
@@ -171,8 +178,9 @@ export class SolutionImpl implements Solution {
|
|
|
171
178
|
|
|
172
179
|
/**
|
|
173
180
|
* Update the requiredInputs or additional information needed to execute the solution
|
|
174
|
-
* @param scope
|
|
175
|
-
*
|
|
181
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
182
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
183
|
+
*
|
|
176
184
|
* @param solutionResourceName Solution resource Name.
|
|
177
185
|
* @param options The options parameters.
|
|
178
186
|
*/
|
|
@@ -244,8 +252,9 @@ export class SolutionImpl implements Solution {
|
|
|
244
252
|
|
|
245
253
|
/**
|
|
246
254
|
* Update the requiredInputs or additional information needed to execute the solution
|
|
247
|
-
* @param scope
|
|
248
|
-
*
|
|
255
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
256
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
257
|
+
*
|
|
249
258
|
* @param solutionResourceName Solution resource Name.
|
|
250
259
|
* @param options The options parameters.
|
|
251
260
|
*/
|
|
@@ -38,17 +38,16 @@ export class TroubleshootersImpl implements Troubleshooters {
|
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Creates the specific troubleshooter action under a resource or subscription using the ‘solutionId’
|
|
41
|
-
* and ‘properties.parameters’ as the trigger. <br/> Troubleshooters
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* at the moment.
|
|
41
|
+
* and ‘properties.parameters’ as the trigger. <br/> Azure Troubleshooters help with hard to classify
|
|
42
|
+
* issues, reducing the gap between customer observed problems and solutions by guiding the user
|
|
43
|
+
* effortlessly through the troubleshooting process. Each Troubleshooter flow represents a problem area
|
|
44
|
+
* within Azure and has a complex tree-like structure that addresses many root causes. These flows are
|
|
45
|
+
* prepared with the help of Subject Matter experts and customer support engineers by carefully
|
|
46
|
+
* considering previous support requests raised by customers. Troubleshooters terminate at a well
|
|
47
|
+
* curated solution based off of resource backend signals and customer manual selections.
|
|
48
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
49
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
50
|
+
*
|
|
52
51
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
53
52
|
* @param options The options parameters.
|
|
54
53
|
*/
|
|
@@ -68,8 +67,9 @@ export class TroubleshootersImpl implements Troubleshooters {
|
|
|
68
67
|
* resource name that is being executed.<br/> Get API is used to retrieve the result of a
|
|
69
68
|
* Troubleshooter instance, which includes the status and result of each step in the Troubleshooter
|
|
70
69
|
* workflow. This API requires the Troubleshooter resource name that was created using the Create API.
|
|
71
|
-
* @param scope
|
|
72
|
-
*
|
|
70
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
71
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
72
|
+
*
|
|
73
73
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
74
74
|
* @param options The options parameters.
|
|
75
75
|
*/
|
|
@@ -89,8 +89,9 @@ export class TroubleshootersImpl implements Troubleshooters {
|
|
|
89
89
|
* respective troubleshooter resource name. <br/>Continue API is used to provide inputs that are
|
|
90
90
|
* required for the specific troubleshooter to progress into the next step in the process. This API is
|
|
91
91
|
* used after the Troubleshooter has been created using the Create API.
|
|
92
|
-
* @param scope
|
|
93
|
-
*
|
|
92
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
93
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
94
|
+
*
|
|
94
95
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
95
96
|
* @param options The options parameters.
|
|
96
97
|
*/
|
|
@@ -107,8 +108,9 @@ export class TroubleshootersImpl implements Troubleshooters {
|
|
|
107
108
|
|
|
108
109
|
/**
|
|
109
110
|
* Ends the troubleshooter action
|
|
110
|
-
* @param scope
|
|
111
|
-
*
|
|
111
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
112
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
113
|
+
*
|
|
112
114
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
113
115
|
* @param options The options parameters.
|
|
114
116
|
*/
|
|
@@ -127,8 +129,9 @@ export class TroubleshootersImpl implements Troubleshooters {
|
|
|
127
129
|
* Restarts the troubleshooter API using applicable troubleshooter resource name as the input.<br/> It
|
|
128
130
|
* returns new resource name which should be used in subsequent request. The old resource name is
|
|
129
131
|
* obsolete after this API is invoked.
|
|
130
|
-
* @param scope
|
|
131
|
-
*
|
|
132
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
133
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
134
|
+
*
|
|
132
135
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
133
136
|
* @param options The options parameters.
|
|
134
137
|
*/
|
|
@@ -16,8 +16,9 @@ export interface CheckNameAvailability {
|
|
|
16
16
|
/**
|
|
17
17
|
* This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or
|
|
18
18
|
* solutions
|
|
19
|
-
* @param scope
|
|
20
|
-
*
|
|
19
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
20
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
21
|
+
*
|
|
21
22
|
* @param options The options parameters.
|
|
22
23
|
*/
|
|
23
24
|
post(
|
|
@@ -18,12 +18,13 @@ import {
|
|
|
18
18
|
export interface Diagnostics {
|
|
19
19
|
/**
|
|
20
20
|
* Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
|
|
21
|
-
* solutions. <br/>Diagnostics
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* @param scope
|
|
26
|
-
*
|
|
21
|
+
* solutions. <br/>Diagnostics are powerful solutions that access product resources or other relevant
|
|
22
|
+
* data and provide the root cause of the issue and the steps to address the issue.<br/><br/> <b>Note:
|
|
23
|
+
* </b> ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as
|
|
24
|
+
* an input to Diagnostics API.
|
|
25
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
26
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
27
|
+
*
|
|
27
28
|
* @param diagnosticsResourceName Unique resource name for insight resources
|
|
28
29
|
* @param options The options parameters.
|
|
29
30
|
*/
|
|
@@ -39,12 +40,13 @@ export interface Diagnostics {
|
|
|
39
40
|
>;
|
|
40
41
|
/**
|
|
41
42
|
* Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
|
|
42
|
-
* solutions. <br/>Diagnostics
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
* @param scope
|
|
47
|
-
*
|
|
43
|
+
* solutions. <br/>Diagnostics are powerful solutions that access product resources or other relevant
|
|
44
|
+
* data and provide the root cause of the issue and the steps to address the issue.<br/><br/> <b>Note:
|
|
45
|
+
* </b> ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as
|
|
46
|
+
* an input to Diagnostics API.
|
|
47
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
48
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
49
|
+
*
|
|
48
50
|
* @param diagnosticsResourceName Unique resource name for insight resources
|
|
49
51
|
* @param options The options parameters.
|
|
50
52
|
*/
|
|
@@ -55,8 +57,9 @@ export interface Diagnostics {
|
|
|
55
57
|
): Promise<DiagnosticsCreateResponse>;
|
|
56
58
|
/**
|
|
57
59
|
* Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
|
|
58
|
-
* @param scope
|
|
59
|
-
*
|
|
60
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
61
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
62
|
+
*
|
|
60
63
|
* @param diagnosticsResourceName Unique resource name for insight resources
|
|
61
64
|
* @param options The options parameters.
|
|
62
65
|
*/
|
|
@@ -19,15 +19,15 @@ export interface DiscoverySolution {
|
|
|
19
19
|
* Lists the relevant Azure diagnostics and solutions using [problemClassification
|
|
20
20
|
* API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND
|
|
21
21
|
* resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API,
|
|
22
|
-
* which identifies relevant Azure diagnostics and solutions.
|
|
23
|
-
* effective solutions based on the type of inputs, in the request URL <br/><br/> Mandatory input :
|
|
22
|
+
* which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input :
|
|
24
23
|
* problemClassificationId (Use the [problemClassification
|
|
25
24
|
* API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
|
|
26
25
|
* <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from
|
|
27
26
|
* Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics
|
|
28
27
|
* and Solutions API.
|
|
29
|
-
* @param scope
|
|
30
|
-
*
|
|
28
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
29
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
30
|
+
*
|
|
31
31
|
* @param options The options parameters.
|
|
32
32
|
*/
|
|
33
33
|
list(
|
|
@@ -19,21 +19,24 @@ import {
|
|
|
19
19
|
/** Interface representing a Solution. */
|
|
20
20
|
export interface Solution {
|
|
21
21
|
/**
|
|
22
|
-
* Creates a solution for the specific Azure resource or subscription using the
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
22
|
+
* Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
|
|
23
|
+
* requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
|
|
24
|
+
* self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
|
|
25
|
+
* resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware
|
|
26
|
+
* diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
|
|
27
|
+
* tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
|
|
28
|
+
* troubleshooting instructions. All these components are seamlessly converged into unified solutions
|
|
29
|
+
* tailored to address a specific support problem area. Each solution type may require one or more
|
|
30
|
+
* ‘requiredParameters’ that are required to execute the individual solution component. In the absence
|
|
31
|
+
* of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you
|
|
32
|
+
* might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from Discovery
|
|
33
|
+
* solutions response must be passed via ‘parameters’ in the request body of Solutions API. <br/>2.
|
|
34
|
+
* ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the
|
|
35
|
+
* request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
|
|
34
36
|
* ‘properties.parameters’ in the request for Troubleshooters
|
|
35
|
-
* @param scope
|
|
36
|
-
*
|
|
37
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
38
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
39
|
+
*
|
|
37
40
|
* @param solutionResourceName Solution resource Name.
|
|
38
41
|
* @param options The options parameters.
|
|
39
42
|
*/
|
|
@@ -48,21 +51,24 @@ export interface Solution {
|
|
|
48
51
|
>
|
|
49
52
|
>;
|
|
50
53
|
/**
|
|
51
|
-
* Creates a solution for the specific Azure resource or subscription using the
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
54
|
+
* Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
|
|
55
|
+
* requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
|
|
56
|
+
* self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
|
|
57
|
+
* resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware
|
|
58
|
+
* diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
|
|
59
|
+
* tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
|
|
60
|
+
* troubleshooting instructions. All these components are seamlessly converged into unified solutions
|
|
61
|
+
* tailored to address a specific support problem area. Each solution type may require one or more
|
|
62
|
+
* ‘requiredParameters’ that are required to execute the individual solution component. In the absence
|
|
63
|
+
* of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you
|
|
64
|
+
* might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from Discovery
|
|
65
|
+
* solutions response must be passed via ‘parameters’ in the request body of Solutions API. <br/>2.
|
|
66
|
+
* ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the
|
|
67
|
+
* request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
|
|
63
68
|
* ‘properties.parameters’ in the request for Troubleshooters
|
|
64
|
-
* @param scope
|
|
65
|
-
*
|
|
69
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
70
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
71
|
+
*
|
|
66
72
|
* @param solutionResourceName Solution resource Name.
|
|
67
73
|
* @param options The options parameters.
|
|
68
74
|
*/
|
|
@@ -73,8 +79,9 @@ export interface Solution {
|
|
|
73
79
|
): Promise<SolutionCreateResponse>;
|
|
74
80
|
/**
|
|
75
81
|
* Get the solution using the applicable solutionResourceName while creating the solution.
|
|
76
|
-
* @param scope
|
|
77
|
-
*
|
|
82
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
83
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
84
|
+
*
|
|
78
85
|
* @param solutionResourceName Solution resource Name.
|
|
79
86
|
* @param options The options parameters.
|
|
80
87
|
*/
|
|
@@ -85,8 +92,9 @@ export interface Solution {
|
|
|
85
92
|
): Promise<SolutionGetResponse>;
|
|
86
93
|
/**
|
|
87
94
|
* Update the requiredInputs or additional information needed to execute the solution
|
|
88
|
-
* @param scope
|
|
89
|
-
*
|
|
95
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
96
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
97
|
+
*
|
|
90
98
|
* @param solutionResourceName Solution resource Name.
|
|
91
99
|
* @param options The options parameters.
|
|
92
100
|
*/
|
|
@@ -102,8 +110,9 @@ export interface Solution {
|
|
|
102
110
|
>;
|
|
103
111
|
/**
|
|
104
112
|
* Update the requiredInputs or additional information needed to execute the solution
|
|
105
|
-
* @param scope
|
|
106
|
-
*
|
|
113
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
114
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
115
|
+
*
|
|
107
116
|
* @param solutionResourceName Solution resource Name.
|
|
108
117
|
* @param options The options parameters.
|
|
109
118
|
*/
|
|
@@ -23,17 +23,16 @@ import {
|
|
|
23
23
|
export interface Troubleshooters {
|
|
24
24
|
/**
|
|
25
25
|
* Creates the specific troubleshooter action under a resource or subscription using the ‘solutionId’
|
|
26
|
-
* and ‘properties.parameters’ as the trigger. <br/> Troubleshooters
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* at the moment.
|
|
26
|
+
* and ‘properties.parameters’ as the trigger. <br/> Azure Troubleshooters help with hard to classify
|
|
27
|
+
* issues, reducing the gap between customer observed problems and solutions by guiding the user
|
|
28
|
+
* effortlessly through the troubleshooting process. Each Troubleshooter flow represents a problem area
|
|
29
|
+
* within Azure and has a complex tree-like structure that addresses many root causes. These flows are
|
|
30
|
+
* prepared with the help of Subject Matter experts and customer support engineers by carefully
|
|
31
|
+
* considering previous support requests raised by customers. Troubleshooters terminate at a well
|
|
32
|
+
* curated solution based off of resource backend signals and customer manual selections.
|
|
33
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
34
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
35
|
+
*
|
|
37
36
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
38
37
|
* @param options The options parameters.
|
|
39
38
|
*/
|
|
@@ -47,8 +46,9 @@ export interface Troubleshooters {
|
|
|
47
46
|
* resource name that is being executed.<br/> Get API is used to retrieve the result of a
|
|
48
47
|
* Troubleshooter instance, which includes the status and result of each step in the Troubleshooter
|
|
49
48
|
* workflow. This API requires the Troubleshooter resource name that was created using the Create API.
|
|
50
|
-
* @param scope
|
|
51
|
-
*
|
|
49
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
50
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
51
|
+
*
|
|
52
52
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
53
53
|
* @param options The options parameters.
|
|
54
54
|
*/
|
|
@@ -62,8 +62,9 @@ export interface Troubleshooters {
|
|
|
62
62
|
* respective troubleshooter resource name. <br/>Continue API is used to provide inputs that are
|
|
63
63
|
* required for the specific troubleshooter to progress into the next step in the process. This API is
|
|
64
64
|
* used after the Troubleshooter has been created using the Create API.
|
|
65
|
-
* @param scope
|
|
66
|
-
*
|
|
65
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
66
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
67
|
+
*
|
|
67
68
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
68
69
|
* @param options The options parameters.
|
|
69
70
|
*/
|
|
@@ -74,8 +75,9 @@ export interface Troubleshooters {
|
|
|
74
75
|
): Promise<TroubleshootersContinueResponse>;
|
|
75
76
|
/**
|
|
76
77
|
* Ends the troubleshooter action
|
|
77
|
-
* @param scope
|
|
78
|
-
*
|
|
78
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
79
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
80
|
+
*
|
|
79
81
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
80
82
|
* @param options The options parameters.
|
|
81
83
|
*/
|
|
@@ -88,8 +90,9 @@ export interface Troubleshooters {
|
|
|
88
90
|
* Restarts the troubleshooter API using applicable troubleshooter resource name as the input.<br/> It
|
|
89
91
|
* returns new resource name which should be used in subsequent request. The old resource name is
|
|
90
92
|
* obsolete after this API is invoked.
|
|
91
|
-
* @param scope
|
|
92
|
-
*
|
|
93
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
94
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
95
|
+
*
|
|
93
96
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
94
97
|
* @param options The options parameters.
|
|
95
98
|
*/
|