@azure/arm-selfhelp 1.0.0-alpha.20230428.1

package/src/models/parameters.ts

@@ -0,0 +1,136 @@
+/*
+ * 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 {
+  OperationParameter,
+  OperationURLParameter,
+  OperationQueryParameter
+} from "@azure/core-client";
+import {
+  CheckNameAvailabilityRequest as CheckNameAvailabilityRequestMapper,
+  DiagnosticResource as DiagnosticResourceMapper
+} from "../models/mappers";
+
+export const accept: OperationParameter = {
+  parameterPath: "accept",
+  mapper: {
+    defaultValue: "application/json",
+    isConstant: true,
+    serializedName: "Accept",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const $host: OperationURLParameter = {
+  parameterPath: "$host",
+  mapper: {
+    serializedName: "$host",
+    required: true,
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const apiVersion: OperationQueryParameter = {
+  parameterPath: "apiVersion",
+  mapper: {
+    defaultValue: "2023-01-01-preview",
+    isConstant: true,
+    serializedName: "api-version",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const nextLink: OperationURLParameter = {
+  parameterPath: "nextLink",
+  mapper: {
+    serializedName: "nextLink",
+    required: true,
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const contentType: OperationParameter = {
+  parameterPath: ["options", "contentType"],
+  mapper: {
+    defaultValue: "application/json",
+    isConstant: true,
+    serializedName: "Content-Type",
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const checkNameAvailabilityRequest: OperationParameter = {
+  parameterPath: ["options", "checkNameAvailabilityRequest"],
+  mapper: CheckNameAvailabilityRequestMapper
+};
+
+export const scope: OperationURLParameter = {
+  parameterPath: "scope",
+  mapper: {
+    serializedName: "scope",
+    required: true,
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const diagnosticResourceRequest: OperationParameter = {
+  parameterPath: ["options", "diagnosticResourceRequest"],
+  mapper: DiagnosticResourceMapper
+};
+
+export const diagnosticsResourceName: OperationURLParameter = {
+  parameterPath: "diagnosticsResourceName",
+  mapper: {
+    constraints: {
+      Pattern: new RegExp("^[A-Za-z0-9-+@()_]+$"),
+      MaxLength: 100,
+      MinLength: 1
+    },
+    serializedName: "diagnosticsResourceName",
+    required: true,
+    type: {
+      name: "String"
+    }
+  }
+};
+
+export const filter: OperationQueryParameter = {
+  parameterPath: ["options", "filter"],
+  mapper: {
+    serializedName: "$filter",
+    type: {
+      name: "String"
+    }
+  },
+  skipEncoding: true
+};
+
+export const skiptoken: OperationQueryParameter = {
+  parameterPath: ["options", "skiptoken"],
+  mapper: {
+    serializedName: "$skiptoken",
+    type: {
+      name: "String"
+    }
+  }
+};

package/src/operations/diagnostics.ts

@@ -0,0 +1,249 @@
+/*
+ * 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 { Diagnostics } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { HelpRP } from "../helpRP";
+import {
+  SimplePollerLike,
+  OperationState,
+  createHttpPoller
+} from "@azure/core-lro";
+import { createLroSpec } from "../lroImpl";
+import {
+  DiagnosticsCheckNameAvailabilityOptionalParams,
+  DiagnosticsCheckNameAvailabilityResponse,
+  DiagnosticsCreateOptionalParams,
+  DiagnosticsCreateResponse,
+  DiagnosticsGetOptionalParams,
+  DiagnosticsGetResponse
+} from "../models";
+
+/** Class containing Diagnostics operations. */
+export class DiagnosticsImpl implements Diagnostics {
+  private readonly client: HelpRP;
+
+  /**
+   * Initialize a new instance of the class Diagnostics class.
+   * @param client Reference to the service client
+   */
+  constructor(client: HelpRP) {
+    this.client = client;
+  }
+
+  /**
+   * This API is used to check the uniqueness of a resource name used for a diagnostic check.
+   * @param scope This is an extension resource provider and only resource level extension is supported
+   *              at the moment.
+   * @param options The options parameters.
+   */
+  checkNameAvailability(
+    scope: string,
+    options?: DiagnosticsCheckNameAvailabilityOptionalParams
+  ): Promise<DiagnosticsCheckNameAvailabilityResponse> {
+    return this.client.sendOperationRequest(
+      { scope, options },
+      checkNameAvailabilityOperationSpec
+    );
+  }
+
+  /**
+   * Diagnostics tells you precisely the root cause of the issue and how to address it. You can get
+   * diagnostics once you discover and identify the relevant solution for your Azure issue.<br/><br/> You
+   * can create diagnostics using the ‘solutionId’  from Solution Discovery API response and
+   * ‘additionalParameters’ <br/><br/> <b>Note: </b>‘requiredParameterSets’ from Solutions Discovery API
+   * response must be passed via ‘additionalParameters’ as an input to Diagnostics API
+   * @param scope This is an extension resource provider and only resource level extension is supported
+   *              at the moment.
+   * @param diagnosticsResourceName Unique resource name for insight resources
+   * @param options The options parameters.
+   */
+  async beginCreate(
+    scope: string,
+    diagnosticsResourceName: string,
+    options?: DiagnosticsCreateOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<DiagnosticsCreateResponse>,
+      DiagnosticsCreateResponse
+    >
+  > {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<DiagnosticsCreateResponse> => {
+      return this.client.sendOperationRequest(args, spec);
+    };
+    const sendOperationFn = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ) => {
+      let currentRawResponse:
+        | coreClient.FullOperationResponse
+        | undefined = undefined;
+      const providedCallback = args.options?.onResponse;
+      const callback: coreClient.RawResponseCallback = (
+        rawResponse: coreClient.FullOperationResponse,
+        flatResponse: unknown
+      ) => {
+        currentRawResponse = rawResponse;
+        providedCallback?.(rawResponse, flatResponse);
+      };
+      const updatedArgs = {
+        ...args,
+        options: {
+          ...args.options,
+          onResponse: callback
+        }
+      };
+      const flatResponse = await directSendOperation(updatedArgs, spec);
+      return {
+        flatResponse,
+        rawResponse: {
+          statusCode: currentRawResponse!.status,
+          body: currentRawResponse!.parsedBody,
+          headers: currentRawResponse!.headers.toJSON()
+        }
+      };
+    };
+
+    const lro = createLroSpec({
+      sendOperationFn,
+      args: { scope, diagnosticsResourceName, options },
+      spec: createOperationSpec
+    });
+    const poller = await createHttpPoller<
+      DiagnosticsCreateResponse,
+      OperationState<DiagnosticsCreateResponse>
+    >(lro, {
+      restoreFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs,
+      resourceLocationConfig: "azure-async-operation"
+    });
+    await poller.poll();
+    return poller;
+  }
+
+  /**
+   * Diagnostics tells you precisely the root cause of the issue and how to address it. You can get
+   * diagnostics once you discover and identify the relevant solution for your Azure issue.<br/><br/> You
+   * can create diagnostics using the ‘solutionId’  from Solution Discovery API response and
+   * ‘additionalParameters’ <br/><br/> <b>Note: </b>‘requiredParameterSets’ from Solutions Discovery API
+   * response must be passed via ‘additionalParameters’ as an input to Diagnostics API
+   * @param scope This is an extension resource provider and only resource level extension is supported
+   *              at the moment.
+   * @param diagnosticsResourceName Unique resource name for insight resources
+   * @param options The options parameters.
+   */
+  async beginCreateAndWait(
+    scope: string,
+    diagnosticsResourceName: string,
+    options?: DiagnosticsCreateOptionalParams
+  ): Promise<DiagnosticsCreateResponse> {
+    const poller = await this.beginCreate(
+      scope,
+      diagnosticsResourceName,
+      options
+    );
+    return poller.pollUntilDone();
+  }
+
+  /**
+   * Get the diagnostics using the 'diagnosticsResourceName' you chose while creating the diagnostic.
+   * @param scope This is an extension resource provider and only resource level extension is supported
+   *              at the moment.
+   * @param diagnosticsResourceName Unique resource name for insight resources
+   * @param options The options parameters.
+   */
+  get(
+    scope: string,
+    diagnosticsResourceName: string,
+    options?: DiagnosticsGetOptionalParams
+  ): Promise<DiagnosticsGetResponse> {
+    return this.client.sendOperationRequest(
+      { scope, diagnosticsResourceName, options },
+      getOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const checkNameAvailabilityOperationSpec: coreClient.OperationSpec = {
+  path: "/{scope}/providers/Microsoft.Help/checkNameAvailability",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.CheckNameAvailabilityResponse
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  requestBody: Parameters.checkNameAvailabilityRequest,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [Parameters.$host, Parameters.scope],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};
+const createOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}",
+  httpMethod: "PUT",
+  responses: {
+    200: {
+      bodyMapper: Mappers.DiagnosticResource
+    },
+    201: {
+      bodyMapper: Mappers.DiagnosticResource
+    },
+    202: {
+      bodyMapper: Mappers.DiagnosticResource
+    },
+    204: {
+      bodyMapper: Mappers.DiagnosticResource
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  requestBody: Parameters.diagnosticResourceRequest,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.scope,
+    Parameters.diagnosticsResourceName
+  ],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};
+const getOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/{scope}/providers/Microsoft.Help/diagnostics/{diagnosticsResourceName}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.DiagnosticResource
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.scope,
+    Parameters.diagnosticsResourceName
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/src/operations/discoverySolution.ts

@@ -0,0 +1,179 @@
+/*
+ * 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 { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "../pagingHelper";
+import { DiscoverySolution } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { HelpRP } from "../helpRP";
+import {
+  SolutionMetadataResource,
+  DiscoverySolutionListNextOptionalParams,
+  DiscoverySolutionListOptionalParams,
+  DiscoverySolutionListResponse,
+  DiscoverySolutionListNextResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Class containing DiscoverySolution operations. */
+export class DiscoverySolutionImpl implements DiscoverySolution {
+  private readonly client: HelpRP;
+
+  /**
+   * Initialize a new instance of the class DiscoverySolution class.
+   * @param client Reference to the service client
+   */
+  constructor(client: HelpRP) {
+    this.client = client;
+  }
+
+  /**
+   * Solutions Discovery is the initial point of entry within Help API, which helps you identify the
+   * relevant solutions for your Azure issue.<br/><br/> You can discover solutions using resourceUri OR
+   * resourceUri + problemClassificationId.<br/><br/>We will do our best in returning relevant
+   * diagnostics for your Azure issue.<br/><br/> Get the problemClassificationId(s) using this
+   * [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).<br/><br/>
+   * <b>Note: </b> ‘requiredParameterSets’ from Solutions Discovery API response must be passed via
+   * ‘additionalParameters’ as an input to Diagnostics API.
+   * @param scope This is an extension resource provider and only resource level extension is supported
+   *              at the moment.
+   * @param options The options parameters.
+   */
+  public list(
+    scope: string,
+    options?: DiscoverySolutionListOptionalParams
+  ): PagedAsyncIterableIterator<SolutionMetadataResource> {
+    const iter = this.listPagingAll(scope, options);
+    return {
+      next() {
+        return iter.next();
+      },
+      [Symbol.asyncIterator]() {
+        return this;
+      },
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listPagingPage(scope, options, settings);
+      }
+    };
+  }
+
+  private async *listPagingPage(
+    scope: string,
+    options?: DiscoverySolutionListOptionalParams,
+    settings?: PageSettings
+  ): AsyncIterableIterator<SolutionMetadataResource[]> {
+    let result: DiscoverySolutionListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(scope, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
+    while (continuationToken) {
+      result = await this._listNext(scope, continuationToken, options);
+      continuationToken = result.nextLink;
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
+  }
+
+  private async *listPagingAll(
+    scope: string,
+    options?: DiscoverySolutionListOptionalParams
+  ): AsyncIterableIterator<SolutionMetadataResource> {
+    for await (const page of this.listPagingPage(scope, options)) {
+      yield* page;
+    }
+  }
+
+  /**
+   * Solutions Discovery is the initial point of entry within Help API, which helps you identify the
+   * relevant solutions for your Azure issue.<br/><br/> You can discover solutions using resourceUri OR
+   * resourceUri + problemClassificationId.<br/><br/>We will do our best in returning relevant
+   * diagnostics for your Azure issue.<br/><br/> Get the problemClassificationId(s) using this
+   * [reference](https://learn.microsoft.com/rest/api/support/problem-classifications/list?tabs=HTTP).<br/><br/>
+   * <b>Note: </b> ‘requiredParameterSets’ from Solutions Discovery API response must be passed via
+   * ‘additionalParameters’ as an input to Diagnostics API.
+   * @param scope This is an extension resource provider and only resource level extension is supported
+   *              at the moment.
+   * @param options The options parameters.
+   */
+  private _list(
+    scope: string,
+    options?: DiscoverySolutionListOptionalParams
+  ): Promise<DiscoverySolutionListResponse> {
+    return this.client.sendOperationRequest(
+      { scope, options },
+      listOperationSpec
+    );
+  }
+
+  /**
+   * ListNext
+   * @param scope This is an extension resource provider and only resource level extension is supported
+   *              at the moment.
+   * @param nextLink The nextLink from the previous successful call to the List method.
+   * @param options The options parameters.
+   */
+  private _listNext(
+    scope: string,
+    nextLink: string,
+    options?: DiscoverySolutionListNextOptionalParams
+  ): Promise<DiscoverySolutionListNextResponse> {
+    return this.client.sendOperationRequest(
+      { scope, nextLink, options },
+      listNextOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const listOperationSpec: coreClient.OperationSpec = {
+  path: "/{scope}/providers/Microsoft.Help/discoverySolutions",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.DiscoveryResponse
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [
+    Parameters.apiVersion,
+    Parameters.filter,
+    Parameters.skiptoken
+  ],
+  urlParameters: [Parameters.$host, Parameters.scope],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const listNextOperationSpec: coreClient.OperationSpec = {
+  path: "{nextLink}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.DiscoveryResponse
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  urlParameters: [Parameters.$host, Parameters.nextLink, Parameters.scope],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/src/operations/index.ts

@@ -0,0 +1,11 @@
+/*
+ * 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.
+ */
+
+export * from "./operations";
+export * from "./diagnostics";
+export * from "./discoverySolution";