@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
|
@@ -4,32 +4,35 @@ import { DiagnosticsCreateOptionalParams, DiagnosticsCreateResponse, Diagnostics
|
|
|
4
4
|
export interface Diagnostics {
|
|
5
5
|
/**
|
|
6
6
|
* Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
|
|
7
|
-
* solutions. <br/>Diagnostics
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
* @param scope
|
|
12
|
-
*
|
|
7
|
+
* solutions. <br/>Diagnostics are powerful solutions that access product resources or other relevant
|
|
8
|
+
* data and provide the root cause of the issue and the steps to address the issue.<br/><br/> <b>Note:
|
|
9
|
+
* </b> ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as
|
|
10
|
+
* an input to Diagnostics API.
|
|
11
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
12
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
13
|
+
*
|
|
13
14
|
* @param diagnosticsResourceName Unique resource name for insight resources
|
|
14
15
|
* @param options The options parameters.
|
|
15
16
|
*/
|
|
16
17
|
beginCreate(scope: string, diagnosticsResourceName: string, options?: DiagnosticsCreateOptionalParams): Promise<SimplePollerLike<OperationState<DiagnosticsCreateResponse>, DiagnosticsCreateResponse>>;
|
|
17
18
|
/**
|
|
18
19
|
* Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
|
|
19
|
-
* solutions. <br/>Diagnostics
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
* @param scope
|
|
24
|
-
*
|
|
20
|
+
* solutions. <br/>Diagnostics are powerful solutions that access product resources or other relevant
|
|
21
|
+
* data and provide the root cause of the issue and the steps to address the issue.<br/><br/> <b>Note:
|
|
22
|
+
* </b> ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as
|
|
23
|
+
* an input to Diagnostics API.
|
|
24
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
25
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
26
|
+
*
|
|
25
27
|
* @param diagnosticsResourceName Unique resource name for insight resources
|
|
26
28
|
* @param options The options parameters.
|
|
27
29
|
*/
|
|
28
30
|
beginCreateAndWait(scope: string, diagnosticsResourceName: string, options?: DiagnosticsCreateOptionalParams): Promise<DiagnosticsCreateResponse>;
|
|
29
31
|
/**
|
|
30
32
|
* Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
|
|
31
|
-
* @param scope
|
|
32
|
-
*
|
|
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
|
+
*
|
|
33
36
|
* @param diagnosticsResourceName Unique resource name for insight resources
|
|
34
37
|
* @param options The options parameters.
|
|
35
38
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"diagnostics.d.ts","sourceRoot":"","sources":["../../../src/operationsInterfaces/diagnostics.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EACL,+BAA+B,EAC/B,yBAAyB,EACzB,4BAA4B,EAC5B,sBAAsB,EACvB,MAAM,WAAW,CAAC;AAEnB,4CAA4C;AAC5C,MAAM,WAAW,WAAW;IAC1B
|
|
1
|
+
{"version":3,"file":"diagnostics.d.ts","sourceRoot":"","sources":["../../../src/operationsInterfaces/diagnostics.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EACL,+BAA+B,EAC/B,yBAAyB,EACzB,4BAA4B,EAC5B,sBAAsB,EACvB,MAAM,WAAW,CAAC;AAEnB,4CAA4C;AAC5C,MAAM,WAAW,WAAW;IAC1B;;;;;;;;;;;OAWG;IACH,WAAW,CACT,KAAK,EAAE,MAAM,EACb,uBAAuB,EAAE,MAAM,EAC/B,OAAO,CAAC,EAAE,+BAA+B,GACxC,OAAO,CACR,gBAAgB,CACd,cAAc,CAAC,yBAAyB,CAAC,EACzC,yBAAyB,CAC1B,CACF,CAAC;IACF;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,KAAK,EAAE,MAAM,EACb,uBAAuB,EAAE,MAAM,EAC/B,OAAO,CAAC,EAAE,+BAA+B,GACxC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACtC;;;;;;;OAOG;IACH,GAAG,CACD,KAAK,EAAE,MAAM,EACb,uBAAuB,EAAE,MAAM,EAC/B,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,sBAAsB,CAAC,CAAC;CACpC"}
|
|
@@ -6,15 +6,15 @@ export interface DiscoverySolution {
|
|
|
6
6
|
* Lists the relevant Azure diagnostics and solutions using [problemClassification
|
|
7
7
|
* API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND
|
|
8
8
|
* resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API,
|
|
9
|
-
* which identifies relevant Azure diagnostics and solutions.
|
|
10
|
-
* effective solutions based on the type of inputs, in the request URL <br/><br/> Mandatory input :
|
|
9
|
+
* which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input :
|
|
11
10
|
* problemClassificationId (Use the [problemClassification
|
|
12
11
|
* API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
|
|
13
12
|
* <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from
|
|
14
13
|
* Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics
|
|
15
14
|
* and Solutions API.
|
|
16
|
-
* @param scope
|
|
17
|
-
*
|
|
15
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
16
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
17
|
+
*
|
|
18
18
|
* @param options The options parameters.
|
|
19
19
|
*/
|
|
20
20
|
list(scope: string, options?: DiscoverySolutionListOptionalParams): PagedAsyncIterableIterator<SolutionMetadataResource>;
|
|
@@ -3,65 +3,74 @@ import { SolutionCreateOptionalParams, SolutionCreateResponse, SolutionGetOption
|
|
|
3
3
|
/** Interface representing a Solution. */
|
|
4
4
|
export interface Solution {
|
|
5
5
|
/**
|
|
6
|
-
* Creates a solution for the specific Azure resource or subscription using the
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
6
|
+
* Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
|
|
7
|
+
* requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
|
|
8
|
+
* self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
|
|
9
|
+
* resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware
|
|
10
|
+
* diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
|
|
11
|
+
* tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
|
|
12
|
+
* troubleshooting instructions. All these components are seamlessly converged into unified solutions
|
|
13
|
+
* tailored to address a specific support problem area. Each solution type may require one or more
|
|
14
|
+
* ‘requiredParameters’ that are required to execute the individual solution component. In the absence
|
|
15
|
+
* of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you
|
|
16
|
+
* might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from Discovery
|
|
17
|
+
* solutions response must be passed via ‘parameters’ in the request body of Solutions API. <br/>2.
|
|
18
|
+
* ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the
|
|
19
|
+
* request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
|
|
18
20
|
* ‘properties.parameters’ in the request for Troubleshooters
|
|
19
|
-
* @param scope
|
|
20
|
-
*
|
|
21
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
22
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
23
|
+
*
|
|
21
24
|
* @param solutionResourceName Solution resource Name.
|
|
22
25
|
* @param options The options parameters.
|
|
23
26
|
*/
|
|
24
27
|
beginCreate(scope: string, solutionResourceName: string, options?: SolutionCreateOptionalParams): Promise<SimplePollerLike<OperationState<SolutionCreateResponse>, SolutionCreateResponse>>;
|
|
25
28
|
/**
|
|
26
|
-
* Creates a solution for the specific Azure resource or subscription using the
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
29
|
+
* Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
|
|
30
|
+
* requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
|
|
31
|
+
* self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
|
|
32
|
+
* resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware
|
|
33
|
+
* diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
|
|
34
|
+
* tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
|
|
35
|
+
* troubleshooting instructions. All these components are seamlessly converged into unified solutions
|
|
36
|
+
* tailored to address a specific support problem area. Each solution type may require one or more
|
|
37
|
+
* ‘requiredParameters’ that are required to execute the individual solution component. In the absence
|
|
38
|
+
* of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you
|
|
39
|
+
* might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from Discovery
|
|
40
|
+
* solutions response must be passed via ‘parameters’ in the request body of Solutions API. <br/>2.
|
|
41
|
+
* ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the
|
|
42
|
+
* request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
|
|
38
43
|
* ‘properties.parameters’ in the request for Troubleshooters
|
|
39
|
-
* @param scope
|
|
40
|
-
*
|
|
44
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
45
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
46
|
+
*
|
|
41
47
|
* @param solutionResourceName Solution resource Name.
|
|
42
48
|
* @param options The options parameters.
|
|
43
49
|
*/
|
|
44
50
|
beginCreateAndWait(scope: string, solutionResourceName: string, options?: SolutionCreateOptionalParams): Promise<SolutionCreateResponse>;
|
|
45
51
|
/**
|
|
46
52
|
* Get the solution using the applicable solutionResourceName while creating the solution.
|
|
47
|
-
* @param scope
|
|
48
|
-
*
|
|
53
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
54
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
55
|
+
*
|
|
49
56
|
* @param solutionResourceName Solution resource Name.
|
|
50
57
|
* @param options The options parameters.
|
|
51
58
|
*/
|
|
52
59
|
get(scope: string, solutionResourceName: string, options?: SolutionGetOptionalParams): Promise<SolutionGetResponse>;
|
|
53
60
|
/**
|
|
54
61
|
* Update the requiredInputs or additional information needed to execute the solution
|
|
55
|
-
* @param scope
|
|
56
|
-
*
|
|
62
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
63
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
64
|
+
*
|
|
57
65
|
* @param solutionResourceName Solution resource Name.
|
|
58
66
|
* @param options The options parameters.
|
|
59
67
|
*/
|
|
60
68
|
beginUpdate(scope: string, solutionResourceName: string, options?: SolutionUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SolutionUpdateResponse>, SolutionUpdateResponse>>;
|
|
61
69
|
/**
|
|
62
70
|
* Update the requiredInputs or additional information needed to execute the solution
|
|
63
|
-
* @param scope
|
|
64
|
-
*
|
|
71
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
72
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
73
|
+
*
|
|
65
74
|
* @param solutionResourceName Solution resource Name.
|
|
66
75
|
* @param options The options parameters.
|
|
67
76
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"solution.d.ts","sourceRoot":"","sources":["../../../src/operationsInterfaces/solution.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EACL,4BAA4B,EAC5B,sBAAsB,EACtB,yBAAyB,EACzB,mBAAmB,EACnB,4BAA4B,EAC5B,sBAAsB,EACvB,MAAM,WAAW,CAAC;AAEnB,yCAAyC;AACzC,MAAM,WAAW,QAAQ;IACvB
|
|
1
|
+
{"version":3,"file":"solution.d.ts","sourceRoot":"","sources":["../../../src/operationsInterfaces/solution.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EACL,4BAA4B,EAC5B,sBAAsB,EACtB,yBAAyB,EACzB,mBAAmB,EACnB,4BAA4B,EAC5B,sBAAsB,EACvB,MAAM,WAAW,CAAC;AAEnB,yCAAyC;AACzC,MAAM,WAAW,QAAQ;IACvB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,WAAW,CACT,KAAK,EAAE,MAAM,EACb,oBAAoB,EAAE,MAAM,EAC5B,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CACR,gBAAgB,CACd,cAAc,CAAC,sBAAsB,CAAC,EACtC,sBAAsB,CACvB,CACF,CAAC;IACF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,kBAAkB,CAChB,KAAK,EAAE,MAAM,EACb,oBAAoB,EAAE,MAAM,EAC5B,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACnC;;;;;;;OAOG;IACH,GAAG,CACD,KAAK,EAAE,MAAM,EACb,oBAAoB,EAAE,MAAM,EAC5B,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChC;;;;;;;OAOG;IACH,WAAW,CACT,KAAK,EAAE,MAAM,EACb,oBAAoB,EAAE,MAAM,EAC5B,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CACR,gBAAgB,CACd,cAAc,CAAC,sBAAsB,CAAC,EACtC,sBAAsB,CACvB,CACF,CAAC;IACF;;;;;;;OAOG;IACH,kBAAkB,CAChB,KAAK,EAAE,MAAM,EACb,oBAAoB,EAAE,MAAM,EAC5B,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,sBAAsB,CAAC,CAAC;CACpC"}
|
|
@@ -3,17 +3,16 @@ import { TroubleshootersCreateOptionalParams, TroubleshootersCreateResponse, Tro
|
|
|
3
3
|
export interface Troubleshooters {
|
|
4
4
|
/**
|
|
5
5
|
* Creates the specific troubleshooter action under a resource or subscription using the ‘solutionId’
|
|
6
|
-
* and ‘properties.parameters’ as the trigger. <br/> Troubleshooters
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* at the moment.
|
|
6
|
+
* and ‘properties.parameters’ as the trigger. <br/> Azure Troubleshooters help with hard to classify
|
|
7
|
+
* issues, reducing the gap between customer observed problems and solutions by guiding the user
|
|
8
|
+
* effortlessly through the troubleshooting process. Each Troubleshooter flow represents a problem area
|
|
9
|
+
* within Azure and has a complex tree-like structure that addresses many root causes. These flows are
|
|
10
|
+
* prepared with the help of Subject Matter experts and customer support engineers by carefully
|
|
11
|
+
* considering previous support requests raised by customers. Troubleshooters terminate at a well
|
|
12
|
+
* curated solution based off of resource backend signals and customer manual selections.
|
|
13
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
14
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
15
|
+
*
|
|
17
16
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
18
17
|
* @param options The options parameters.
|
|
19
18
|
*/
|
|
@@ -23,8 +22,9 @@ export interface Troubleshooters {
|
|
|
23
22
|
* resource name that is being executed.<br/> Get API is used to retrieve the result of a
|
|
24
23
|
* Troubleshooter instance, which includes the status and result of each step in the Troubleshooter
|
|
25
24
|
* workflow. This API requires the Troubleshooter resource name that was created using the Create API.
|
|
26
|
-
* @param scope
|
|
27
|
-
*
|
|
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
|
+
*
|
|
28
28
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
29
29
|
* @param options The options parameters.
|
|
30
30
|
*/
|
|
@@ -34,16 +34,18 @@ export interface Troubleshooters {
|
|
|
34
34
|
* respective troubleshooter resource name. <br/>Continue API is used to provide inputs that are
|
|
35
35
|
* required for the specific troubleshooter to progress into the next step in the process. This API is
|
|
36
36
|
* used after the Troubleshooter has been created using the Create API.
|
|
37
|
-
* @param scope
|
|
38
|
-
*
|
|
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
|
+
*
|
|
39
40
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
40
41
|
* @param options The options parameters.
|
|
41
42
|
*/
|
|
42
43
|
continue(scope: string, troubleshooterName: string, options?: TroubleshootersContinueOptionalParams): Promise<TroubleshootersContinueResponse>;
|
|
43
44
|
/**
|
|
44
45
|
* Ends the troubleshooter action
|
|
45
|
-
* @param scope
|
|
46
|
-
*
|
|
46
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
47
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
48
|
+
*
|
|
47
49
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
48
50
|
* @param options The options parameters.
|
|
49
51
|
*/
|
|
@@ -52,8 +54,9 @@ export interface Troubleshooters {
|
|
|
52
54
|
* Restarts the troubleshooter API using applicable troubleshooter resource name as the input.<br/> It
|
|
53
55
|
* returns new resource name which should be used in subsequent request. The old resource name is
|
|
54
56
|
* obsolete after this API is invoked.
|
|
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 troubleshooterName Troubleshooter resource Name.
|
|
58
61
|
* @param options The options parameters.
|
|
59
62
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"troubleshooters.d.ts","sourceRoot":"","sources":["../../../src/operationsInterfaces/troubleshooters.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,mCAAmC,EACnC,6BAA6B,EAC7B,gCAAgC,EAChC,0BAA0B,EAC1B,qCAAqC,EACrC,+BAA+B,EAC/B,gCAAgC,EAChC,0BAA0B,EAC1B,oCAAoC,EACpC,8BAA8B,EAC/B,MAAM,WAAW,CAAC;AAEnB,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC9B
|
|
1
|
+
{"version":3,"file":"troubleshooters.d.ts","sourceRoot":"","sources":["../../../src/operationsInterfaces/troubleshooters.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,mCAAmC,EACnC,6BAA6B,EAC7B,gCAAgC,EAChC,0BAA0B,EAC1B,qCAAqC,EACrC,+BAA+B,EAC/B,gCAAgC,EAChC,0BAA0B,EAC1B,oCAAoC,EACpC,8BAA8B,EAC/B,MAAM,WAAW,CAAC;AAEnB,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,KAAK,EAAE,MAAM,EACb,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,mCAAmC,GAC5C,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC1C;;;;;;;;;;OAUG;IACH,GAAG,CACD,KAAK,EAAE,MAAM,EACb,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,gCAAgC,GACzC,OAAO,CAAC,0BAA0B,CAAC,CAAC;IACvC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,KAAK,EAAE,MAAM,EACb,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,qCAAqC,GAC9C,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAC5C;;;;;;;OAOG;IACH,GAAG,CACD,KAAK,EAAE,MAAM,EACb,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,gCAAgC,GACzC,OAAO,CAAC,0BAA0B,CAAC,CAAC;IACvC;;;;;;;;;OASG;IACH,OAAO,CACL,KAAK,EAAE,MAAM,EACb,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE,oCAAoC,GAC7C,OAAO,CAAC,8BAA8B,CAAC,CAAC;CAC5C"}
|
package/package.json
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
"sdk-type": "mgmt",
|
|
4
4
|
"author": "Microsoft Corporation",
|
|
5
5
|
"description": "A generated SDK for HelpRP.",
|
|
6
|
-
"version": "2.0.0-beta.
|
|
6
|
+
"version": "2.0.0-beta.2",
|
|
7
7
|
"engines": {
|
|
8
|
-
"node": ">=
|
|
8
|
+
"node": ">=18.0.0"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
11
|
"@azure/core-lro": "^2.5.4",
|
|
@@ -34,15 +34,17 @@
|
|
|
34
34
|
"uglify-js": "^3.4.9",
|
|
35
35
|
"rimraf": "^5.0.0",
|
|
36
36
|
"dotenv": "^16.0.0",
|
|
37
|
+
"@azure/dev-tool": "^1.0.0",
|
|
37
38
|
"@azure/identity": "^3.3.0",
|
|
38
39
|
"@azure-tools/test-recorder": "^3.0.0",
|
|
39
40
|
"@azure-tools/test-credential": "^1.0.0",
|
|
40
41
|
"mocha": "^10.0.0",
|
|
42
|
+
"@types/mocha": "^10.0.0",
|
|
43
|
+
"esm": "^3.2.18",
|
|
41
44
|
"@types/chai": "^4.2.8",
|
|
42
45
|
"chai": "^4.2.0",
|
|
43
46
|
"cross-env": "^7.0.2",
|
|
44
|
-
"@types/node": "^
|
|
45
|
-
"@azure/dev-tool": "^1.0.0",
|
|
47
|
+
"@types/node": "^18.0.0",
|
|
46
48
|
"ts-node": "^10.0.0"
|
|
47
49
|
},
|
|
48
50
|
"repository": {
|
|
@@ -114,4 +116,4 @@
|
|
|
114
116
|
"disableDocsMs": true,
|
|
115
117
|
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-selfhelp?view=azure-node-preview"
|
|
116
118
|
}
|
|
117
|
-
}
|
|
119
|
+
}
|
|
@@ -272,6 +272,7 @@ export enum KnownDiagnosticProvisioningState {
|
|
|
272
272
|
Canceled = "Canceled",
|
|
273
273
|
Failed = "Failed",
|
|
274
274
|
PartialComplete = "PartialComplete",
|
|
275
|
+
Running = "Running",
|
|
275
276
|
Succeeded = "Succeeded"
|
|
276
277
|
}
|
|
277
278
|
|
|
@@ -329,6 +330,8 @@ export enum KnownResultType {
|
|
|
329
330
|
export enum KnownSolutionProvisioningState {
|
|
330
331
|
Canceled = "Canceled",
|
|
331
332
|
Failed = "Failed",
|
|
333
|
+
PartialComplete = "PartialComplete",
|
|
334
|
+
Running = "Running",
|
|
332
335
|
Succeeded = "Succeeded"
|
|
333
336
|
}
|
|
334
337
|
|
|
@@ -532,31 +535,32 @@ export interface SolutionMetadataResource extends ProxyResource {
|
|
|
532
535
|
|
|
533
536
|
// @public
|
|
534
537
|
export interface SolutionPatchRequestBody {
|
|
535
|
-
|
|
538
|
+
readonly content?: string;
|
|
539
|
+
parameters?: {
|
|
540
|
+
[propertyName: string]: string;
|
|
541
|
+
};
|
|
542
|
+
readonly provisioningState?: SolutionProvisioningState;
|
|
543
|
+
readonly replacementMaps?: ReplacementMaps;
|
|
544
|
+
readonly sections?: Section[];
|
|
545
|
+
readonly solutionId?: string;
|
|
546
|
+
readonly title?: string;
|
|
547
|
+
triggerCriteria?: TriggerCriterion[];
|
|
536
548
|
}
|
|
537
549
|
|
|
538
550
|
// @public
|
|
539
551
|
export type SolutionProvisioningState = string;
|
|
540
552
|
|
|
541
553
|
// @public
|
|
542
|
-
export interface SolutionResource {
|
|
543
|
-
readonly
|
|
544
|
-
readonly name?: string;
|
|
545
|
-
properties?: SolutionResourceProperties;
|
|
546
|
-
readonly type?: string;
|
|
547
|
-
}
|
|
548
|
-
|
|
549
|
-
// @public
|
|
550
|
-
export interface SolutionResourceProperties {
|
|
551
|
-
content?: string;
|
|
554
|
+
export interface SolutionResource extends ProxyResource {
|
|
555
|
+
readonly content?: string;
|
|
552
556
|
parameters?: {
|
|
553
557
|
[propertyName: string]: string;
|
|
554
558
|
};
|
|
555
|
-
provisioningState?: SolutionProvisioningState;
|
|
556
|
-
replacementMaps?: ReplacementMaps;
|
|
557
|
-
sections?: Section[];
|
|
558
|
-
solutionId?: string;
|
|
559
|
-
title?: string;
|
|
559
|
+
readonly provisioningState?: SolutionProvisioningState;
|
|
560
|
+
readonly replacementMaps?: ReplacementMaps;
|
|
561
|
+
readonly sections?: Section[];
|
|
562
|
+
readonly solutionId?: string;
|
|
563
|
+
readonly title?: string;
|
|
560
564
|
triggerCriteria?: TriggerCriterion[];
|
|
561
565
|
}
|
|
562
566
|
|
|
@@ -622,7 +626,7 @@ export interface StepInput {
|
|
|
622
626
|
questionContent?: string;
|
|
623
627
|
questionContentType?: QuestionContentType;
|
|
624
628
|
questionId?: string;
|
|
625
|
-
questionType?:
|
|
629
|
+
questionType?: QuestionType;
|
|
626
630
|
recommendedOption?: string;
|
|
627
631
|
responseHint?: string;
|
|
628
632
|
// (undocumented)
|
package/src/helpRP.ts
CHANGED
|
@@ -58,7 +58,7 @@ export class HelpRP extends coreClient.ServiceClient {
|
|
|
58
58
|
credential: credentials
|
|
59
59
|
};
|
|
60
60
|
|
|
61
|
-
const packageDetails = `azsdk-js-arm-selfhelp/2.0.0-beta.
|
|
61
|
+
const packageDetails = `azsdk-js-arm-selfhelp/2.0.0-beta.2`;
|
|
62
62
|
const userAgentPrefix =
|
|
63
63
|
options.userAgentOptions && options.userAgentOptions.userAgentPrefix
|
|
64
64
|
? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
|