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

package/src/operationsInterfaces/solution.ts

@@ -13,34 +13,31 @@ import {
   SolutionGetOptionalParams,
   SolutionGetResponse,
   SolutionUpdateOptionalParams,
-  SolutionUpdateResponse
+  SolutionUpdateResponse,
+  SolutionWarmUpOptionalParams,
 } from "../models";
 
 /** Interface representing a Solution. */
 export interface Solution {
   /**
-   * Creates a solution for the specific Azure resource or subscription using the triggering criteria
-   * ‘solutionId and requiredInputs’ from discovery solutions.<br/> Solutions are a rich, insightful and
-   * a centralized self help experience that brings all the relevant content to troubleshoot an Azure
-   * issue into a unified experience. Solutions include the following components : Text, Diagnostics ,
-   * Troubleshooters, Images , Video tutorials, Tables , custom charts, images , AzureKB, etc, with
-   * capabilities to support new solutions types in the future. Each solution type may require one or
-   * more ‘requiredParameters’ that are required to execute the individual solution component. In the
-   * absence of the ‘requiredParameters’ it is likely that some of the solutions might fail execution,
-   * and you might see an empty response. <br/><br/> <b>Note:</b>  <br/>1. ‘requiredInputs’ from
-   * Discovery solutions response must be passed via ‘parameters’ in the request body of Solutions API.
-   * <br/>2. ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in
-   * the request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
-   * ‘properties.parameters’ in the request for Troubleshooters
-   * @param scope This is an extension resource provider and only resource level extension is supported
-   *              at the moment.
+   * Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
+   * requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
+   * self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
+   * resolving typical troubleshooting issues. These solutions encompass: <br/> (1.) Dynamic and
+   * context-aware diagnostics, guided troubleshooting wizards, and data visualizations. <br/> (2.) Rich
+   * instructional video tutorials and illustrative diagrams and images. <br/> (3.) Thoughtfully
+   * assembled textual troubleshooting instructions. <br/> All these components are seamlessly converged
+   * into unified solutions tailored to address a specific support problem area.
+   * @param scope scope = resourceUri of affected resource.<br/> For example:
+   *              /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
+   *
    * @param solutionResourceName Solution resource Name.
    * @param options The options parameters.
    */
   beginCreate(
     scope: string,
     solutionResourceName: string,
-    options?: SolutionCreateOptionalParams
+    options?: SolutionCreateOptionalParams,
   ): Promise<
     SimplePollerLike<
       OperationState<SolutionCreateResponse>,
@@ -48,52 +45,50 @@ export interface Solution {
     >
   >;
   /**
-   * Creates a solution for the specific Azure resource or subscription using the triggering criteria
-   * ‘solutionId and requiredInputs’ from discovery solutions.<br/> Solutions are a rich, insightful and
-   * a centralized self help experience that brings all the relevant content to troubleshoot an Azure
-   * issue into a unified experience. Solutions include the following components : Text, Diagnostics ,
-   * Troubleshooters, Images , Video tutorials, Tables , custom charts, images , AzureKB, etc, with
-   * capabilities to support new solutions types in the future. Each solution type may require one or
-   * more ‘requiredParameters’ that are required to execute the individual solution component. In the
-   * absence of the ‘requiredParameters’ it is likely that some of the solutions might fail execution,
-   * and you might see an empty response. <br/><br/> <b>Note:</b>  <br/>1. ‘requiredInputs’ from
-   * Discovery solutions response must be passed via ‘parameters’ in the request body of Solutions API.
-   * <br/>2. ‘requiredParameters’ from the Solutions response is the same as ‘ additionalParameters’ in
-   * the request for diagnostics <br/>3. ‘requiredParameters’ from the Solutions response is the same as
-   * ‘properties.parameters’ in the request for Troubleshooters
-   * @param scope This is an extension resource provider and only resource level extension is supported
-   *              at the moment.
+   * Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and
+   * requiredInputs’ from discovery solutions. <br/> Azure solutions comprise a comprehensive library of
+   * self-help resources that have been thoughtfully curated by Azure engineers to aid customers in
+   * resolving typical troubleshooting issues. These solutions encompass: <br/> (1.) Dynamic and
+   * context-aware diagnostics, guided troubleshooting wizards, and data visualizations. <br/> (2.) Rich
+   * instructional video tutorials and illustrative diagrams and images. <br/> (3.) Thoughtfully
+   * assembled textual troubleshooting instructions. <br/> All these components are seamlessly converged
+   * into unified solutions tailored to address a specific support problem area.
+   * @param scope scope = resourceUri of affected resource.<br/> For example:
+   *              /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
+   *
    * @param solutionResourceName Solution resource Name.
    * @param options The options parameters.
    */
   beginCreateAndWait(
     scope: string,
     solutionResourceName: string,
-    options?: SolutionCreateOptionalParams
+    options?: SolutionCreateOptionalParams,
   ): Promise<SolutionCreateResponse>;
   /**
    * Get the solution using the applicable solutionResourceName while creating the solution.
-   * @param scope This is an extension resource provider and only resource level extension is supported
-   *              at the moment.
+   * @param scope scope = resourceUri of affected resource.<br/> For example:
+   *              /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
+   *
    * @param solutionResourceName Solution resource Name.
    * @param options The options parameters.
    */
   get(
     scope: string,
     solutionResourceName: string,
-    options?: SolutionGetOptionalParams
+    options?: SolutionGetOptionalParams,
   ): Promise<SolutionGetResponse>;
   /**
    * Update the requiredInputs or additional information needed to execute the solution
-   * @param scope This is an extension resource provider and only resource level extension is supported
-   *              at the moment.
+   * @param scope scope = resourceUri of affected resource.<br/> For example:
+   *              /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
+   *
    * @param solutionResourceName Solution resource Name.
    * @param options The options parameters.
    */
   beginUpdate(
     scope: string,
     solutionResourceName: string,
-    options?: SolutionUpdateOptionalParams
+    options?: SolutionUpdateOptionalParams,
   ): Promise<
     SimplePollerLike<
       OperationState<SolutionUpdateResponse>,
@@ -102,14 +97,28 @@ export interface Solution {
   >;
   /**
    * Update the requiredInputs or additional information needed to execute the solution
-   * @param scope This is an extension resource provider and only resource level extension is supported
-   *              at the moment.
+   * @param scope scope = resourceUri of affected resource.<br/> For example:
+   *              /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
+   *
    * @param solutionResourceName Solution resource Name.
    * @param options The options parameters.
    */
   beginUpdateAndWait(
     scope: string,
     solutionResourceName: string,
-    options?: SolutionUpdateOptionalParams
+    options?: SolutionUpdateOptionalParams,
   ): Promise<SolutionUpdateResponse>;
+  /**
+   * Warm up the solution resource by preloading asynchronous diagnostics results into cache
+   * @param scope scope = resourceUri of affected resource.<br/> For example:
+   *              /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
+   *
+   * @param solutionResourceName Solution resource Name.
+   * @param options The options parameters.
+   */
+  warmUp(
+    scope: string,
+    solutionResourceName: string,
+    options?: SolutionWarmUpOptionalParams,
+  ): Promise<void>;
 }

package/src/operationsInterfaces/solutionSelfHelp.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import {
+  SolutionSelfHelpGetOptionalParams,
+  SolutionSelfHelpGetResponse,
+} from "../models";
+
+/** Interface representing a SolutionSelfHelp. */
+export interface SolutionSelfHelp {
+  /**
+   * Gets Self Help Solutions for a given solutionId. Self Help Solutions consist of rich instructional
+   * video tutorials, links and guides to public documentation related to a specific problem that enables
+   * users to troubleshoot Azure issues.
+   * @param solutionId SolutionId is a unique id to identify a solution. You can retrieve the solution id
+   *                   using the Discovery api -
+   *                   https://learn.microsoft.com/en-us/rest/api/help/discovery-solution/list?view=rest-help-2023-09-01-preview&tabs=HTTP
+   * @param options The options parameters.
+   */
+  get(
+    solutionId: string,
+    options?: SolutionSelfHelpGetOptionalParams,
+  ): Promise<SolutionSelfHelpGetResponse>;
+}

package/src/operationsInterfaces/troubleshooters.ts

@@ -16,86 +16,89 @@ import {
   TroubleshootersEndOptionalParams,
   TroubleshootersEndResponse,
   TroubleshootersRestartOptionalParams,
-  TroubleshootersRestartResponse
+  TroubleshootersRestartResponse,
 } from "../models";
 
 /** Interface representing a Troubleshooters. */
 export interface Troubleshooters {
   /**
    * Creates the specific troubleshooter action under a resource or subscription using the ‘solutionId’
-   * and  ‘properties.parameters’ as the trigger. <br/> Troubleshooters are step-by-step interactive
-   * guidance that scope the problem by collecting additional inputs from you in each stage while
-   * troubleshooting an Azure issue. You will be guided down decision tree style workflow and the best
-   * possible solution will be presented at the end of the workflow. <br/> Create API creates the
-   * Troubleshooter API using ‘parameters’ and ‘solutionId’ <br/> After creating the Troubleshooter
-   * instance, the following APIs can be used:<br/> CONTINUE API: to move to the next step in the flow
-   * <br/>GET API: to identify the next step after executing the CONTINUE API.   <br/><br/> <b>Note:</b>
-   * ‘requiredParameters’ from solutions response must be passed via ‘properties. parameters’ in the
-   * request body of Troubleshooters API.
-   * @param scope This is an extension resource provider and only resource level extension is supported
-   *              at the moment.
+   * and  ‘properties.parameters’ as the trigger. <br/> Azure Troubleshooters help with hard to classify
+   * issues, reducing the gap between customer observed problems and solutions by guiding the user
+   * effortlessly through the troubleshooting process. Each Troubleshooter flow represents a problem area
+   * within Azure and has a complex tree-like structure that addresses many root causes. These flows are
+   * prepared with the help of Subject Matter experts and customer support engineers by carefully
+   * considering previous support requests raised by customers. Troubleshooters terminate at a well
+   * curated solution based off of resource backend signals and customer manual selections.
+   * @param scope scope = resourceUri of affected resource.<br/> For example:
+   *              /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
+   *
    * @param troubleshooterName Troubleshooter resource Name.
    * @param options The options parameters.
    */
   create(
     scope: string,
     troubleshooterName: string,
-    options?: TroubleshootersCreateOptionalParams
+    options?: TroubleshootersCreateOptionalParams,
   ): Promise<TroubleshootersCreateResponse>;
   /**
    * Gets troubleshooter instance result which includes the step status/result of the troubleshooter
    * resource name that is being executed.<br/> Get API is used to retrieve the result of a
    * Troubleshooter instance, which includes the status and result of each step in the Troubleshooter
    * workflow. This API requires the Troubleshooter resource name that was created using the Create API.
-   * @param scope This is an extension resource provider and only resource level extension is supported
-   *              at the moment.
+   * @param scope scope = resourceUri of affected resource.<br/> For example:
+   *              /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
+   *
    * @param troubleshooterName Troubleshooter resource Name.
    * @param options The options parameters.
    */
   get(
     scope: string,
     troubleshooterName: string,
-    options?: TroubleshootersGetOptionalParams
+    options?: TroubleshootersGetOptionalParams,
   ): Promise<TroubleshootersGetResponse>;
   /**
    * Uses ‘stepId’ and ‘responses’ as the trigger to continue the troubleshooting steps for the
    * respective troubleshooter resource name. <br/>Continue API is used to provide inputs that are
    * required for the specific troubleshooter to progress into the next step in the process. This API is
    * used after the Troubleshooter has been created using the Create API.
-   * @param scope This is an extension resource provider and only resource level extension is supported
-   *              at the moment.
+   * @param scope scope = resourceUri of affected resource.<br/> For example:
+   *              /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
+   *
    * @param troubleshooterName Troubleshooter resource Name.
    * @param options The options parameters.
    */
   continue(
     scope: string,
     troubleshooterName: string,
-    options?: TroubleshootersContinueOptionalParams
+    options?: TroubleshootersContinueOptionalParams,
   ): Promise<TroubleshootersContinueResponse>;
   /**
    * Ends the troubleshooter action
-   * @param scope This is an extension resource provider and only resource level extension is supported
-   *              at the moment.
+   * @param scope scope = resourceUri of affected resource.<br/> For example:
+   *              /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
+   *
    * @param troubleshooterName Troubleshooter resource Name.
    * @param options The options parameters.
    */
   end(
     scope: string,
     troubleshooterName: string,
-    options?: TroubleshootersEndOptionalParams
+    options?: TroubleshootersEndOptionalParams,
   ): Promise<TroubleshootersEndResponse>;
   /**
    * Restarts the troubleshooter API using applicable troubleshooter resource name as the input.<br/> It
    * returns new resource name which should be used in subsequent request. The old resource name is
    * obsolete after this API is invoked.
-   * @param scope This is an extension resource provider and only resource level extension is supported
-   *              at the moment.
+   * @param scope scope = resourceUri of affected resource.<br/> For example:
+   *              /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
+   *
    * @param troubleshooterName Troubleshooter resource Name.
    * @param options The options parameters.
    */
   restart(
     scope: string,
     troubleshooterName: string,
-    options?: TroubleshootersRestartOptionalParams
+    options?: TroubleshootersRestartOptionalParams,
   ): Promise<TroubleshootersRestartResponse>;
 }

package/src/pagingHelper.ts

@@ -28,7 +28,7 @@ export function getContinuationToken(page: unknown): string | undefined {
 
 export function setContinuationToken(
   page: unknown,
-  continuationToken: string | undefined
+  continuationToken: string | undefined,
 ): void {
   if (typeof page !== "object" || page === null || !continuationToken) {
     return;