@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
package/types/arm-selfhelp.d.ts
CHANGED
|
@@ -51,8 +51,9 @@ export declare interface CheckNameAvailability {
|
|
|
51
51
|
/**
|
|
52
52
|
* This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or
|
|
53
53
|
* solutions
|
|
54
|
-
* @param scope
|
|
55
|
-
*
|
|
54
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
55
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
56
|
+
*
|
|
56
57
|
* @param options The options parameters.
|
|
57
58
|
*/
|
|
58
59
|
post(scope: string, options?: CheckNameAvailabilityPostOptionalParams): Promise<CheckNameAvailabilityPostResponse>;
|
|
@@ -145,13 +146,14 @@ export declare interface DiagnosticInvocation {
|
|
|
145
146
|
* **Succeeded**: All Diagnostics in the Batch succeeded. \
|
|
146
147
|
* **PartialComplete**: Some Diagnostics are still running or failed. \
|
|
147
148
|
* **Failed**: All Diagnostics failed to run. \
|
|
149
|
+
* **Running**: All Diagnostics are still running. \
|
|
148
150
|
* **Canceled**: When Diagnostic request gets canceled.
|
|
149
151
|
*/
|
|
150
152
|
export declare type DiagnosticProvisioningState = string;
|
|
151
153
|
|
|
152
154
|
/** Diagnostic resource */
|
|
153
155
|
export declare interface DiagnosticResource extends ProxyResource {
|
|
154
|
-
/** Global parameters
|
|
156
|
+
/** Global parameters is an optional map which can be used to add key and value to request body to improve the diagnostics results */
|
|
155
157
|
globalParameters?: {
|
|
156
158
|
[propertyName: string]: string;
|
|
157
159
|
};
|
|
@@ -178,32 +180,35 @@ export declare interface DiagnosticResource extends ProxyResource {
|
|
|
178
180
|
export declare interface Diagnostics {
|
|
179
181
|
/**
|
|
180
182
|
* Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
|
|
181
|
-
* solutions. <br/>Diagnostics
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
*
|
|
185
|
-
* @param scope
|
|
186
|
-
*
|
|
183
|
+
* solutions. <br/>Diagnostics are powerful solutions that access product resources or other relevant
|
|
184
|
+
* data and provide the root cause of the issue and the steps to address the issue.<br/><br/> <b>Note:
|
|
185
|
+
* </b> ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as
|
|
186
|
+
* an input to Diagnostics API.
|
|
187
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
188
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
189
|
+
*
|
|
187
190
|
* @param diagnosticsResourceName Unique resource name for insight resources
|
|
188
191
|
* @param options The options parameters.
|
|
189
192
|
*/
|
|
190
193
|
beginCreate(scope: string, diagnosticsResourceName: string, options?: DiagnosticsCreateOptionalParams): Promise<SimplePollerLike<OperationState<DiagnosticsCreateResponse>, DiagnosticsCreateResponse>>;
|
|
191
194
|
/**
|
|
192
195
|
* Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
|
|
193
|
-
* solutions. <br/>Diagnostics
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
* @param scope
|
|
198
|
-
*
|
|
196
|
+
* solutions. <br/>Diagnostics are powerful solutions that access product resources or other relevant
|
|
197
|
+
* data and provide the root cause of the issue and the steps to address the issue.<br/><br/> <b>Note:
|
|
198
|
+
* </b> ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as
|
|
199
|
+
* an input to Diagnostics API.
|
|
200
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
201
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
202
|
+
*
|
|
199
203
|
* @param diagnosticsResourceName Unique resource name for insight resources
|
|
200
204
|
* @param options The options parameters.
|
|
201
205
|
*/
|
|
202
206
|
beginCreateAndWait(scope: string, diagnosticsResourceName: string, options?: DiagnosticsCreateOptionalParams): Promise<DiagnosticsCreateResponse>;
|
|
203
207
|
/**
|
|
204
208
|
* Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
|
|
205
|
-
* @param scope
|
|
206
|
-
*
|
|
209
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
210
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
211
|
+
*
|
|
207
212
|
* @param diagnosticsResourceName Unique resource name for insight resources
|
|
208
213
|
* @param options The options parameters.
|
|
209
214
|
*/
|
|
@@ -244,15 +249,15 @@ export declare interface DiscoverySolution {
|
|
|
244
249
|
* Lists the relevant Azure diagnostics and solutions using [problemClassification
|
|
245
250
|
* API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND
|
|
246
251
|
* resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API,
|
|
247
|
-
* which identifies relevant Azure diagnostics and solutions.
|
|
248
|
-
* effective solutions based on the type of inputs, in the request URL <br/><br/> Mandatory input :
|
|
252
|
+
* which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input :
|
|
249
253
|
* problemClassificationId (Use the [problemClassification
|
|
250
254
|
* API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP))
|
|
251
255
|
* <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b> ‘requiredInputs’ from
|
|
252
256
|
* Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics
|
|
253
257
|
* and Solutions API.
|
|
254
|
-
* @param scope
|
|
255
|
-
*
|
|
258
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
259
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
260
|
+
*
|
|
256
261
|
* @param options The options parameters.
|
|
257
262
|
*/
|
|
258
263
|
list(scope: string, options?: DiscoverySolutionListOptionalParams): PagedAsyncIterableIterator<SolutionMetadataResource>;
|
|
@@ -267,7 +272,7 @@ export declare type DiscoverySolutionListNextResponse = DiscoveryResponse;
|
|
|
267
272
|
|
|
268
273
|
/** Optional parameters. */
|
|
269
274
|
export declare interface DiscoverySolutionListOptionalParams extends coreClient.OperationOptions {
|
|
270
|
-
/** 'ProblemClassificationId'
|
|
275
|
+
/** 'ProblemClassificationId' is a mandatory filter to get solutions ids. It also supports optional 'ResourceType' and 'SolutionType' filters. The [$filter](https://learn.microsoft.com/en-us/odata/webapi/first-odata-api#filter) supports only 'and', 'or' and 'eq' operators. Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' */
|
|
271
276
|
filter?: string;
|
|
272
277
|
/** Skiptoken is only used if a previous operation returned a partial result. */
|
|
273
278
|
skiptoken?: string;
|
|
@@ -351,10 +356,10 @@ export declare interface ErrorResponse {
|
|
|
351
356
|
* {@link KnownExecutionStatus} can be used interchangeably with ExecutionStatus,
|
|
352
357
|
* this enum contains the known values that the service supports.
|
|
353
358
|
* ### Known values supported by the service
|
|
354
|
-
* **Success
|
|
355
|
-
* **Running
|
|
356
|
-
* **Failed
|
|
357
|
-
* **Warning
|
|
359
|
+
* **Success**: Step execution succeeded. \
|
|
360
|
+
* **Running**: Step execution running \
|
|
361
|
+
* **Failed**: Step execution failed \
|
|
362
|
+
* **Warning**: Step execution warning
|
|
358
363
|
*/
|
|
359
364
|
export declare type ExecutionStatus = string;
|
|
360
365
|
|
|
@@ -497,19 +502,21 @@ export declare enum KnownDiagnosticProvisioningState {
|
|
|
497
502
|
PartialComplete = "PartialComplete",
|
|
498
503
|
/** All Diagnostics failed to run. */
|
|
499
504
|
Failed = "Failed",
|
|
505
|
+
/** All Diagnostics are still running. */
|
|
506
|
+
Running = "Running",
|
|
500
507
|
/** When Diagnostic request gets canceled. */
|
|
501
508
|
Canceled = "Canceled"
|
|
502
509
|
}
|
|
503
510
|
|
|
504
511
|
/** Known values of {@link ExecutionStatus} that the service accepts. */
|
|
505
512
|
export declare enum KnownExecutionStatus {
|
|
506
|
-
/**
|
|
513
|
+
/** Step execution succeeded. */
|
|
507
514
|
Success = "Success",
|
|
508
|
-
/**
|
|
515
|
+
/** Step execution running */
|
|
509
516
|
Running = "Running",
|
|
510
|
-
/**
|
|
517
|
+
/** Step execution failed */
|
|
511
518
|
Failed = "Failed",
|
|
512
|
-
/**
|
|
519
|
+
/** Step execution warning */
|
|
513
520
|
Warning = "Warning"
|
|
514
521
|
}
|
|
515
522
|
|
|
@@ -575,11 +582,15 @@ export declare enum KnownResultType {
|
|
|
575
582
|
|
|
576
583
|
/** Known values of {@link SolutionProvisioningState} that the service accepts. */
|
|
577
584
|
export declare enum KnownSolutionProvisioningState {
|
|
578
|
-
/**
|
|
585
|
+
/** All Solutions in the Batch succeeded. */
|
|
579
586
|
Succeeded = "Succeeded",
|
|
580
|
-
/**
|
|
587
|
+
/** Some Solutions are still running or failed. */
|
|
588
|
+
PartialComplete = "PartialComplete",
|
|
589
|
+
/** All Solutions failed to run. */
|
|
581
590
|
Failed = "Failed",
|
|
582
|
-
/**
|
|
591
|
+
/** All Solutions are still running. */
|
|
592
|
+
Running = "Running",
|
|
593
|
+
/** When Solutions request gets canceled. */
|
|
583
594
|
Canceled = "Canceled"
|
|
584
595
|
}
|
|
585
596
|
|
|
@@ -895,65 +906,74 @@ export declare interface Section {
|
|
|
895
906
|
/** Interface representing a Solution. */
|
|
896
907
|
export declare interface Solution {
|
|
897
908
|
/**
|
|
898
|
-
* Creates a solution for the specific Azure resource or subscription using the
|
|
899
|
-
*
|
|
900
|
-
*
|
|
901
|
-
*
|
|
902
|
-
*
|
|
903
|
-
*
|
|
904
|
-
*
|
|
905
|
-
*
|
|
906
|
-
*
|
|
907
|
-
*
|
|
908
|
-
*
|
|
909
|
-
*
|
|
909
|
+
* Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
|
|
910
|
+
* requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
|
|
911
|
+
* self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
|
|
912
|
+
* resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware
|
|
913
|
+
* diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
|
|
914
|
+
* tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
|
|
915
|
+
* troubleshooting instructions. All these components are seamlessly converged into unified solutions
|
|
916
|
+
* tailored to address a specific support problem area. Each solution type may require one or more
|
|
917
|
+
* ‘requiredParameters’ that are required to execute the individual solution component. In the absence
|
|
918
|
+
* of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you
|
|
919
|
+
* might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from Discovery
|
|
920
|
+
* solutions response must be passed via ‘parameters’ in the request body of Solutions API. <br/>2.
|
|
921
|
+
* ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the
|
|
922
|
+
* request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
|
|
910
923
|
* ‘properties.parameters’ in the request for Troubleshooters
|
|
911
|
-
* @param scope
|
|
912
|
-
*
|
|
924
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
925
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
926
|
+
*
|
|
913
927
|
* @param solutionResourceName Solution resource Name.
|
|
914
928
|
* @param options The options parameters.
|
|
915
929
|
*/
|
|
916
930
|
beginCreate(scope: string, solutionResourceName: string, options?: SolutionCreateOptionalParams): Promise<SimplePollerLike<OperationState<SolutionCreateResponse>, SolutionCreateResponse>>;
|
|
917
931
|
/**
|
|
918
|
-
* Creates a solution for the specific Azure resource or subscription using the
|
|
919
|
-
*
|
|
920
|
-
*
|
|
921
|
-
*
|
|
922
|
-
*
|
|
923
|
-
*
|
|
924
|
-
*
|
|
925
|
-
*
|
|
926
|
-
*
|
|
927
|
-
*
|
|
928
|
-
*
|
|
929
|
-
*
|
|
932
|
+
* Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
|
|
933
|
+
* requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
|
|
934
|
+
* self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
|
|
935
|
+
* resolving typical troubleshooting issues. These solutions encompass (1.) dynamic and context-aware
|
|
936
|
+
* diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
|
|
937
|
+
* tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
|
|
938
|
+
* troubleshooting instructions. All these components are seamlessly converged into unified solutions
|
|
939
|
+
* tailored to address a specific support problem area. Each solution type may require one or more
|
|
940
|
+
* ‘requiredParameters’ that are required to execute the individual solution component. In the absence
|
|
941
|
+
* of the ‘requiredParameters’ it is likely that some of the solutions might fail execution, and you
|
|
942
|
+
* might see an empty response. <br/><br/> <b>Note:</b> <br/>1. ‘requiredInputs’ from Discovery
|
|
943
|
+
* solutions response must be passed via ‘parameters’ in the request body of Solutions API. <br/>2.
|
|
944
|
+
* ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in the
|
|
945
|
+
* request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
|
|
930
946
|
* ‘properties.parameters’ in the request for Troubleshooters
|
|
931
|
-
* @param scope
|
|
932
|
-
*
|
|
947
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
948
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
949
|
+
*
|
|
933
950
|
* @param solutionResourceName Solution resource Name.
|
|
934
951
|
* @param options The options parameters.
|
|
935
952
|
*/
|
|
936
953
|
beginCreateAndWait(scope: string, solutionResourceName: string, options?: SolutionCreateOptionalParams): Promise<SolutionCreateResponse>;
|
|
937
954
|
/**
|
|
938
955
|
* Get the solution using the applicable solutionResourceName while creating the solution.
|
|
939
|
-
* @param scope
|
|
940
|
-
*
|
|
956
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
957
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
958
|
+
*
|
|
941
959
|
* @param solutionResourceName Solution resource Name.
|
|
942
960
|
* @param options The options parameters.
|
|
943
961
|
*/
|
|
944
962
|
get(scope: string, solutionResourceName: string, options?: SolutionGetOptionalParams): Promise<SolutionGetResponse>;
|
|
945
963
|
/**
|
|
946
964
|
* Update the requiredInputs or additional information needed to execute the solution
|
|
947
|
-
* @param scope
|
|
948
|
-
*
|
|
965
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
966
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
967
|
+
*
|
|
949
968
|
* @param solutionResourceName Solution resource Name.
|
|
950
969
|
* @param options The options parameters.
|
|
951
970
|
*/
|
|
952
971
|
beginUpdate(scope: string, solutionResourceName: string, options?: SolutionUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SolutionUpdateResponse>, SolutionUpdateResponse>>;
|
|
953
972
|
/**
|
|
954
973
|
* Update the requiredInputs or additional information needed to execute the solution
|
|
955
|
-
* @param scope
|
|
956
|
-
*
|
|
974
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
975
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
976
|
+
*
|
|
957
977
|
* @param solutionResourceName Solution resource Name.
|
|
958
978
|
* @param options The options parameters.
|
|
959
979
|
*/
|
|
@@ -1007,10 +1027,44 @@ export declare interface SolutionMetadataResource extends ProxyResource {
|
|
|
1007
1027
|
solutions?: SolutionMetadataProperties[];
|
|
1008
1028
|
}
|
|
1009
1029
|
|
|
1010
|
-
/** Solution response
|
|
1030
|
+
/** Solution response */
|
|
1011
1031
|
export declare interface SolutionPatchRequestBody {
|
|
1012
|
-
/** Solution
|
|
1013
|
-
|
|
1032
|
+
/** Solution request trigger criteria */
|
|
1033
|
+
triggerCriteria?: TriggerCriterion[];
|
|
1034
|
+
/** Client input parameters to run Solution */
|
|
1035
|
+
parameters?: {
|
|
1036
|
+
[propertyName: string]: string;
|
|
1037
|
+
};
|
|
1038
|
+
/**
|
|
1039
|
+
* Solution Id to identify single solution.
|
|
1040
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1041
|
+
*/
|
|
1042
|
+
readonly solutionId?: string;
|
|
1043
|
+
/**
|
|
1044
|
+
* Status of solution provisioning.
|
|
1045
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1046
|
+
*/
|
|
1047
|
+
readonly provisioningState?: SolutionProvisioningState;
|
|
1048
|
+
/**
|
|
1049
|
+
* The title.
|
|
1050
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1051
|
+
*/
|
|
1052
|
+
readonly title?: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* The HTML content that needs to be rendered and shown to customer.
|
|
1055
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1056
|
+
*/
|
|
1057
|
+
readonly content?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* Solution replacement maps.
|
|
1060
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1061
|
+
*/
|
|
1062
|
+
readonly replacementMaps?: ReplacementMaps;
|
|
1063
|
+
/**
|
|
1064
|
+
* List of section object.
|
|
1065
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1066
|
+
*/
|
|
1067
|
+
readonly sections?: Section[];
|
|
1014
1068
|
}
|
|
1015
1069
|
|
|
1016
1070
|
/**
|
|
@@ -1018,53 +1072,52 @@ export declare interface SolutionPatchRequestBody {
|
|
|
1018
1072
|
* {@link KnownSolutionProvisioningState} can be used interchangeably with SolutionProvisioningState,
|
|
1019
1073
|
* this enum contains the known values that the service supports.
|
|
1020
1074
|
* ### Known values supported by the service
|
|
1021
|
-
* **Succeeded
|
|
1022
|
-
* **
|
|
1023
|
-
* **
|
|
1075
|
+
* **Succeeded**: All Solutions in the Batch succeeded. \
|
|
1076
|
+
* **PartialComplete**: Some Solutions are still running or failed. \
|
|
1077
|
+
* **Failed**: All Solutions failed to run. \
|
|
1078
|
+
* **Running**: All Solutions are still running. \
|
|
1079
|
+
* **Canceled**: When Solutions request gets canceled.
|
|
1024
1080
|
*/
|
|
1025
1081
|
export declare type SolutionProvisioningState = string;
|
|
1026
1082
|
|
|
1027
1083
|
/** Solution response. */
|
|
1028
|
-
export declare interface SolutionResource {
|
|
1084
|
+
export declare interface SolutionResource extends ProxyResource {
|
|
1085
|
+
/** Solution request trigger criteria */
|
|
1086
|
+
triggerCriteria?: TriggerCriterion[];
|
|
1087
|
+
/** Client input parameters to run Solution */
|
|
1088
|
+
parameters?: {
|
|
1089
|
+
[propertyName: string]: string;
|
|
1090
|
+
};
|
|
1029
1091
|
/**
|
|
1030
|
-
*
|
|
1092
|
+
* Solution Id to identify single solution.
|
|
1031
1093
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1032
1094
|
*/
|
|
1033
|
-
readonly
|
|
1095
|
+
readonly solutionId?: string;
|
|
1034
1096
|
/**
|
|
1035
|
-
*
|
|
1097
|
+
* Status of solution provisioning.
|
|
1036
1098
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1037
1099
|
*/
|
|
1038
|
-
readonly
|
|
1100
|
+
readonly provisioningState?: SolutionProvisioningState;
|
|
1039
1101
|
/**
|
|
1040
|
-
*
|
|
1102
|
+
* The title.
|
|
1041
1103
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1042
1104
|
*/
|
|
1043
|
-
readonly
|
|
1044
|
-
/**
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
provisioningState?: SolutionProvisioningState;
|
|
1060
|
-
/** The title. */
|
|
1061
|
-
title?: string;
|
|
1062
|
-
/** The HTML content that needs to be rendered and shown to customer. */
|
|
1063
|
-
content?: string;
|
|
1064
|
-
/** Solution replacement maps. */
|
|
1065
|
-
replacementMaps?: ReplacementMaps;
|
|
1066
|
-
/** List of section object. */
|
|
1067
|
-
sections?: Section[];
|
|
1105
|
+
readonly title?: string;
|
|
1106
|
+
/**
|
|
1107
|
+
* The HTML content that needs to be rendered and shown to customer.
|
|
1108
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1109
|
+
*/
|
|
1110
|
+
readonly content?: string;
|
|
1111
|
+
/**
|
|
1112
|
+
* Solution replacement maps.
|
|
1113
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1114
|
+
*/
|
|
1115
|
+
readonly replacementMaps?: ReplacementMaps;
|
|
1116
|
+
/**
|
|
1117
|
+
* List of section object.
|
|
1118
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1119
|
+
*/
|
|
1120
|
+
readonly sections?: Section[];
|
|
1068
1121
|
}
|
|
1069
1122
|
|
|
1070
1123
|
/** Solutions Diagnostic */
|
|
@@ -1164,8 +1217,8 @@ export declare interface Step {
|
|
|
1164
1217
|
export declare interface StepInput {
|
|
1165
1218
|
/** Use Index as QuestionId. */
|
|
1166
1219
|
questionId?: string;
|
|
1167
|
-
/**
|
|
1168
|
-
questionType?:
|
|
1220
|
+
/** Type of Question */
|
|
1221
|
+
questionType?: QuestionType;
|
|
1169
1222
|
/** User question content. */
|
|
1170
1223
|
questionContent?: string;
|
|
1171
1224
|
/** Default is Text. */
|
|
@@ -1242,7 +1295,7 @@ export declare interface TroubleshooterResource extends ProxyResource {
|
|
|
1242
1295
|
export declare interface TroubleshooterResponse {
|
|
1243
1296
|
/** id of the question. */
|
|
1244
1297
|
questionId?: string;
|
|
1245
|
-
/**
|
|
1298
|
+
/** Type of Question */
|
|
1246
1299
|
questionType?: QuestionType;
|
|
1247
1300
|
/** Response key for SingleInput. For Multi-line test/open ended question it is free form text */
|
|
1248
1301
|
response?: string;
|
|
@@ -1252,17 +1305,16 @@ export declare interface TroubleshooterResponse {
|
|
|
1252
1305
|
export declare interface Troubleshooters {
|
|
1253
1306
|
/**
|
|
1254
1307
|
* Creates the specific troubleshooter action under a resource or subscription using the ‘solutionId’
|
|
1255
|
-
* and ‘properties.parameters’ as the trigger. <br/> Troubleshooters
|
|
1256
|
-
*
|
|
1257
|
-
*
|
|
1258
|
-
*
|
|
1259
|
-
*
|
|
1260
|
-
*
|
|
1261
|
-
*
|
|
1262
|
-
*
|
|
1263
|
-
*
|
|
1264
|
-
*
|
|
1265
|
-
* at the moment.
|
|
1308
|
+
* and ‘properties.parameters’ as the trigger. <br/> Azure Troubleshooters help with hard to classify
|
|
1309
|
+
* issues, reducing the gap between customer observed problems and solutions by guiding the user
|
|
1310
|
+
* effortlessly through the troubleshooting process. Each Troubleshooter flow represents a problem area
|
|
1311
|
+
* within Azure and has a complex tree-like structure that addresses many root causes. These flows are
|
|
1312
|
+
* prepared with the help of Subject Matter experts and customer support engineers by carefully
|
|
1313
|
+
* considering previous support requests raised by customers. Troubleshooters terminate at a well
|
|
1314
|
+
* curated solution based off of resource backend signals and customer manual selections.
|
|
1315
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
1316
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
1317
|
+
*
|
|
1266
1318
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
1267
1319
|
* @param options The options parameters.
|
|
1268
1320
|
*/
|
|
@@ -1272,8 +1324,9 @@ export declare interface Troubleshooters {
|
|
|
1272
1324
|
* resource name that is being executed.<br/> Get API is used to retrieve the result of a
|
|
1273
1325
|
* Troubleshooter instance, which includes the status and result of each step in the Troubleshooter
|
|
1274
1326
|
* workflow. This API requires the Troubleshooter resource name that was created using the Create API.
|
|
1275
|
-
* @param scope
|
|
1276
|
-
*
|
|
1327
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
1328
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
1329
|
+
*
|
|
1277
1330
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
1278
1331
|
* @param options The options parameters.
|
|
1279
1332
|
*/
|
|
@@ -1283,16 +1336,18 @@ export declare interface Troubleshooters {
|
|
|
1283
1336
|
* respective troubleshooter resource name. <br/>Continue API is used to provide inputs that are
|
|
1284
1337
|
* required for the specific troubleshooter to progress into the next step in the process. This API is
|
|
1285
1338
|
* used after the Troubleshooter has been created using the Create API.
|
|
1286
|
-
* @param scope
|
|
1287
|
-
*
|
|
1339
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
1340
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
1341
|
+
*
|
|
1288
1342
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
1289
1343
|
* @param options The options parameters.
|
|
1290
1344
|
*/
|
|
1291
1345
|
continue(scope: string, troubleshooterName: string, options?: TroubleshootersContinueOptionalParams): Promise<TroubleshootersContinueResponse>;
|
|
1292
1346
|
/**
|
|
1293
1347
|
* Ends the troubleshooter action
|
|
1294
|
-
* @param scope
|
|
1295
|
-
*
|
|
1348
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
1349
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
1350
|
+
*
|
|
1296
1351
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
1297
1352
|
* @param options The options parameters.
|
|
1298
1353
|
*/
|
|
@@ -1301,8 +1356,9 @@ export declare interface Troubleshooters {
|
|
|
1301
1356
|
* Restarts the troubleshooter API using applicable troubleshooter resource name as the input.<br/> It
|
|
1302
1357
|
* returns new resource name which should be used in subsequent request. The old resource name is
|
|
1303
1358
|
* obsolete after this API is invoked.
|
|
1304
|
-
* @param scope
|
|
1305
|
-
*
|
|
1359
|
+
* @param scope scope = resourceUri of affected resource.<br/> For example:
|
|
1360
|
+
* /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
|
|
1361
|
+
*
|
|
1306
1362
|
* @param troubleshooterName Troubleshooter resource Name.
|
|
1307
1363
|
* @param options The options parameters.
|
|
1308
1364
|
*/
|