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

package/src/operationsInterfaces/checkNameAvailability.ts

@@ -8,7 +8,7 @@
 
 import {
   CheckNameAvailabilityPostOptionalParams,
-  CheckNameAvailabilityPostResponse
+  CheckNameAvailabilityPostResponse,
 } from "../models";
 
 /** Interface representing a CheckNameAvailability. */
@@ -23,6 +23,6 @@ export interface CheckNameAvailability {
    */
   post(
     scope: string,
-    options?: CheckNameAvailabilityPostOptionalParams
+    options?: CheckNameAvailabilityPostOptionalParams,
   ): Promise<CheckNameAvailabilityPostResponse>;
 }

package/src/operationsInterfaces/diagnostics.ts

@@ -11,17 +11,15 @@ import {
   DiagnosticsCreateOptionalParams,
   DiagnosticsCreateResponse,
   DiagnosticsGetOptionalParams,
-  DiagnosticsGetResponse
+  DiagnosticsGetResponse,
 } from "../models";
 
 /** Interface representing a Diagnostics. */
 export interface Diagnostics {
   /**
-   * Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
-   * solutions. <br/>Diagnostics are powerful solutions that access product resources or other relevant
-   * data and provide the root cause of the issue and the steps to address the issue.<br/><br/> <b>Note:
-   * </b> ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as
-   * an input to Diagnostics API.
+   * Creates a diagnostic for the specific resource using solutionId from discovery solutions.
+   * <br/>Diagnostics are powerful solutions that access product resources or other relevant data and
+   * provide the root cause of the issue and the steps to address the issue.<br/><br/>
    * @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
    *
@@ -31,7 +29,7 @@ export interface Diagnostics {
   beginCreate(
     scope: string,
     diagnosticsResourceName: string,
-    options?: DiagnosticsCreateOptionalParams
+    options?: DiagnosticsCreateOptionalParams,
   ): Promise<
     SimplePollerLike<
       OperationState<DiagnosticsCreateResponse>,
@@ -39,11 +37,9 @@ export interface Diagnostics {
     >
   >;
   /**
-   * Creates a diagnostic for the specific resource using solutionId and requiredInputs* from discovery
-   * solutions. <br/>Diagnostics are powerful solutions that access product resources or other relevant
-   * data and provide the root cause of the issue and the steps to address the issue.<br/><br/> <b>Note:
-   * </b> ‘requiredInputs’ from Discovery solutions response must be passed via ‘additionalParameters’ as
-   * an input to Diagnostics API.
+   * Creates a diagnostic for the specific resource using solutionId from discovery solutions.
+   * <br/>Diagnostics are powerful solutions that access product resources or other relevant data and
+   * provide the root cause of the issue and the steps to address the issue.<br/><br/>
    * @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
    *
@@ -53,7 +49,7 @@ export interface Diagnostics {
   beginCreateAndWait(
     scope: string,
     diagnosticsResourceName: string,
-    options?: DiagnosticsCreateOptionalParams
+    options?: DiagnosticsCreateOptionalParams,
   ): Promise<DiagnosticsCreateResponse>;
   /**
    * Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
@@ -66,6 +62,6 @@ export interface Diagnostics {
   get(
     scope: string,
     diagnosticsResourceName: string,
-    options?: DiagnosticsGetOptionalParams
+    options?: DiagnosticsGetOptionalParams,
   ): Promise<DiagnosticsGetResponse>;
 }

package/src/operationsInterfaces/discoverySolution.ts

@@ -9,14 +9,14 @@
 import { PagedAsyncIterableIterator } from "@azure/core-paging";
 import {
   SolutionMetadataResource,
-  DiscoverySolutionListOptionalParams
+  DiscoverySolutionListOptionalParams,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
 /** Interface representing a DiscoverySolution. */
 export interface DiscoverySolution {
   /**
-   * Lists the relevant Azure diagnostics and solutions using [problemClassification
+   * Lists the relevant Azure Diagnostics, Solutions and Troubleshooters using [problemClassification
    * API](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP)) AND
    * resourceUri or resourceType.<br/> Discovery Solutions is the initial entry point within Help API,
    * which identifies relevant Azure diagnostics and solutions. <br/><br/> Required Input :
@@ -25,13 +25,9 @@ export interface DiscoverySolution {
    * <br/>Optional input: resourceUri OR resource Type <br/><br/> <b>Note: </b>  ‘requiredInputs’ from
    * Discovery solutions response must be passed via ‘additionalParameters’ as an input to Diagnostics
    * and Solutions API.
-   * @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 options The options parameters.
    */
   list(
-    scope: string,
-    options?: DiscoverySolutionListOptionalParams
+    options?: DiscoverySolutionListOptionalParams,
   ): PagedAsyncIterableIterator<SolutionMetadataResource>;
 }

package/src/operationsInterfaces/discoverySolutionNLPSubscriptionScope.ts

@@ -0,0 +1,24 @@
+/*
+ * 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 {
+  DiscoverySolutionNLPSubscriptionScopePostOptionalParams,
+  DiscoverySolutionNLPSubscriptionScopePostResponse,
+} from "../models";
+
+/** Interface representing a DiscoverySolutionNLPSubscriptionScope. */
+export interface DiscoverySolutionNLPSubscriptionScope {
+  /**
+   * Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue
+   * summary and subscription.
+   * @param options The options parameters.
+   */
+  post(
+    options?: DiscoverySolutionNLPSubscriptionScopePostOptionalParams,
+  ): Promise<DiscoverySolutionNLPSubscriptionScopePostResponse>;
+}

package/src/operationsInterfaces/discoverySolutionNLPTenantScope.ts

@@ -0,0 +1,24 @@
+/*
+ * 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 {
+  DiscoverySolutionNLPTenantScopePostOptionalParams,
+  DiscoverySolutionNLPTenantScopePostResponse,
+} from "../models";
+
+/** Interface representing a DiscoverySolutionNLPTenantScope. */
+export interface DiscoverySolutionNLPTenantScope {
+  /**
+   * Search for relevant Azure Diagnostics, Solutions and Troubleshooters using a natural language issue
+   * summary.
+   * @param options The options parameters.
+   */
+  post(
+    options?: DiscoverySolutionNLPTenantScopePostOptionalParams,
+  ): Promise<DiscoverySolutionNLPTenantScopePostResponse>;
+}

package/src/operationsInterfaces/index.ts

@@ -11,4 +11,8 @@ export * from "./checkNameAvailability";
 export * from "./diagnostics";
 export * from "./discoverySolution";
 export * from "./solution";
+export * from "./simplifiedSolutions";
 export * from "./troubleshooters";
+export * from "./solutionSelfHelp";
+export * from "./discoverySolutionNLPTenantScope";
+export * from "./discoverySolutionNLPSubscriptionScope";

package/src/operationsInterfaces/operations.ts

@@ -17,6 +17,6 @@ export interface Operations {
    * @param options The options parameters.
    */
   list(
-    options?: OperationsListOptionalParams
+    options?: OperationsListOptionalParams,
   ): PagedAsyncIterableIterator<Operation>;
 }

package/src/operationsInterfaces/simplifiedSolutions.ts

@@ -0,0 +1,74 @@
+/*
+ * 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 { SimplePollerLike, OperationState } from "@azure/core-lro";
+import {
+  SimplifiedSolutionsCreateOptionalParams,
+  SimplifiedSolutionsCreateResponse,
+  SimplifiedSolutionsGetOptionalParams,
+  SimplifiedSolutionsGetResponse,
+} from "../models";
+
+/** Interface representing a SimplifiedSolutions. */
+export interface SimplifiedSolutions {
+  /**
+   * Creates Simplified Solutions for an Azure subscription using 'solutionId' from Discovery Solutions
+   * as the input. <br/><br/> Simplified Solutions API makes the consumption of solutions APIs easier
+   * while still providing access to the same powerful solutions rendered in Solutions API. With
+   * Simplified Solutions, users don't have to worry about stitching together the article using
+   * replacement maps and can use the content in the API response to directly render as HTML
+   * content.<br/>
+   * @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 simplifiedSolutionsResourceName Simplified Solutions Resource Name.
+   * @param options The options parameters.
+   */
+  beginCreate(
+    scope: string,
+    simplifiedSolutionsResourceName: string,
+    options?: SimplifiedSolutionsCreateOptionalParams,
+  ): Promise<
+    SimplePollerLike<
+      OperationState<SimplifiedSolutionsCreateResponse>,
+      SimplifiedSolutionsCreateResponse
+    >
+  >;
+  /**
+   * Creates Simplified Solutions for an Azure subscription using 'solutionId' from Discovery Solutions
+   * as the input. <br/><br/> Simplified Solutions API makes the consumption of solutions APIs easier
+   * while still providing access to the same powerful solutions rendered in Solutions API. With
+   * Simplified Solutions, users don't have to worry about stitching together the article using
+   * replacement maps and can use the content in the API response to directly render as HTML
+   * content.<br/>
+   * @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 simplifiedSolutionsResourceName Simplified Solutions Resource Name.
+   * @param options The options parameters.
+   */
+  beginCreateAndWait(
+    scope: string,
+    simplifiedSolutionsResourceName: string,
+    options?: SimplifiedSolutionsCreateOptionalParams,
+  ): Promise<SimplifiedSolutionsCreateResponse>;
+  /**
+   * Get the simplified Solutions using the applicable solutionResourceName while creating the simplified
+   * Solutions.
+   * @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 simplifiedSolutionsResourceName Simplified Solutions Resource Name.
+   * @param options The options parameters.
+   */
+  get(
+    scope: string,
+    simplifiedSolutionsResourceName: string,
+    options?: SimplifiedSolutionsGetOptionalParams,
+  ): Promise<SimplifiedSolutionsGetResponse>;
+}

package/src/operationsInterfaces/solution.ts

@@ -13,7 +13,8 @@ import {
   SolutionGetOptionalParams,
   SolutionGetResponse,
   SolutionUpdateOptionalParams,
-  SolutionUpdateResponse
+  SolutionUpdateResponse,
+  SolutionWarmUpOptionalParams,
 } from "../models";
 
 /** Interface representing a Solution. */
@@ -22,18 +23,11 @@ export interface Solution {
    * 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 (1.) dynamic and context-aware
-   * diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
-   * tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
-   * troubleshooting instructions. All these components are seamlessly converged into unified solutions
-   * tailored to address a specific support problem area. 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
+   * 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
    *
@@ -43,7 +37,7 @@ export interface Solution {
   beginCreate(
     scope: string,
     solutionResourceName: string,
-    options?: SolutionCreateOptionalParams
+    options?: SolutionCreateOptionalParams,
   ): Promise<
     SimplePollerLike<
       OperationState<SolutionCreateResponse>,
@@ -54,18 +48,11 @@ export interface Solution {
    * 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 (1.) dynamic and context-aware
-   * diagnostics, guided troubleshooting wizards, and data visualizations, (2.) rich instructional video
-   * tutorials and illustrative diagrams and images, and (3.) thoughtfully assembled textual
-   * troubleshooting instructions. All these components are seamlessly converged into unified solutions
-   * tailored to address a specific support problem area. 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
+   * 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
    *
@@ -75,7 +62,7 @@ export interface Solution {
   beginCreateAndWait(
     scope: string,
     solutionResourceName: string,
-    options?: SolutionCreateOptionalParams
+    options?: SolutionCreateOptionalParams,
   ): Promise<SolutionCreateResponse>;
   /**
    * Get the solution using the applicable solutionResourceName while creating the solution.
@@ -88,7 +75,7 @@ export interface Solution {
   get(
     scope: string,
     solutionResourceName: string,
-    options?: SolutionGetOptionalParams
+    options?: SolutionGetOptionalParams,
   ): Promise<SolutionGetResponse>;
   /**
    * Update the requiredInputs or additional information needed to execute the solution
@@ -101,7 +88,7 @@ export interface Solution {
   beginUpdate(
     scope: string,
     solutionResourceName: string,
-    options?: SolutionUpdateOptionalParams
+    options?: SolutionUpdateOptionalParams,
   ): Promise<
     SimplePollerLike<
       OperationState<SolutionUpdateResponse>,
@@ -119,6 +106,19 @@ export interface Solution {
   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,7 +16,7 @@ import {
   TroubleshootersEndOptionalParams,
   TroubleshootersEndResponse,
   TroubleshootersRestartOptionalParams,
-  TroubleshootersRestartResponse
+  TroubleshootersRestartResponse,
 } from "../models";
 
 /** Interface representing a Troubleshooters. */
@@ -39,7 +39,7 @@ export interface Troubleshooters {
   create(
     scope: string,
     troubleshooterName: string,
-    options?: TroubleshootersCreateOptionalParams
+    options?: TroubleshootersCreateOptionalParams,
   ): Promise<TroubleshootersCreateResponse>;
   /**
    * Gets troubleshooter instance result which includes the step status/result of the troubleshooter
@@ -55,7 +55,7 @@ export interface Troubleshooters {
   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
@@ -71,7 +71,7 @@ export interface Troubleshooters {
   continue(
     scope: string,
     troubleshooterName: string,
-    options?: TroubleshootersContinueOptionalParams
+    options?: TroubleshootersContinueOptionalParams,
   ): Promise<TroubleshootersContinueResponse>;
   /**
    * Ends the troubleshooter action
@@ -84,7 +84,7 @@ export interface Troubleshooters {
   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
@@ -99,6 +99,6 @@ export interface Troubleshooters {
   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;