@azure/arm-workloadssapvirtualinstance 1.0.0-alpha.20240322.1

package/src/operationsInterfaces/sAPVirtualInstances.ts

@@ -0,0 +1,196 @@
+/*
+ * 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 } from "@azure/core-paging";
+import { SimplePollerLike, OperationState } from "@azure/core-lro";
+import {
+  SAPVirtualInstance,
+  SAPVirtualInstancesListByResourceGroupOptionalParams,
+  SAPVirtualInstancesListBySubscriptionOptionalParams,
+  SAPVirtualInstancesCreateOptionalParams,
+  SAPVirtualInstancesCreateResponse,
+  SAPVirtualInstancesGetOptionalParams,
+  SAPVirtualInstancesGetResponse,
+  SAPVirtualInstancesUpdateOptionalParams,
+  SAPVirtualInstancesUpdateResponse,
+  SAPVirtualInstancesDeleteOptionalParams,
+  SAPVirtualInstancesDeleteResponse,
+  SAPVirtualInstancesStartOptionalParams,
+  SAPVirtualInstancesStartResponse,
+  SAPVirtualInstancesStopOptionalParams,
+  SAPVirtualInstancesStopResponse,
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a SAPVirtualInstances. */
+export interface SAPVirtualInstances {
+  /**
+   * Gets all Virtual Instances for SAP solutions resources in a Resource Group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param options The options parameters.
+   */
+  listByResourceGroup(
+    resourceGroupName: string,
+    options?: SAPVirtualInstancesListByResourceGroupOptionalParams,
+  ): PagedAsyncIterableIterator<SAPVirtualInstance>;
+  /**
+   * Gets all Virtual Instances for SAP solutions resources in a Subscription.
+   * @param options The options parameters.
+   */
+  listBySubscription(
+    options?: SAPVirtualInstancesListBySubscriptionOptionalParams,
+  ): PagedAsyncIterableIterator<SAPVirtualInstance>;
+  /**
+   * Creates a Virtual Instance for SAP solutions (VIS) resource
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param sapVirtualInstanceName The name of the Virtual Instances for SAP solutions resource
+   * @param options The options parameters.
+   */
+  beginCreate(
+    resourceGroupName: string,
+    sapVirtualInstanceName: string,
+    options?: SAPVirtualInstancesCreateOptionalParams,
+  ): Promise<
+    SimplePollerLike<
+      OperationState<SAPVirtualInstancesCreateResponse>,
+      SAPVirtualInstancesCreateResponse
+    >
+  >;
+  /**
+   * Creates a Virtual Instance for SAP solutions (VIS) resource
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param sapVirtualInstanceName The name of the Virtual Instances for SAP solutions resource
+   * @param options The options parameters.
+   */
+  beginCreateAndWait(
+    resourceGroupName: string,
+    sapVirtualInstanceName: string,
+    options?: SAPVirtualInstancesCreateOptionalParams,
+  ): Promise<SAPVirtualInstancesCreateResponse>;
+  /**
+   * Gets a Virtual Instance for SAP solutions resource
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param sapVirtualInstanceName The name of the Virtual Instances for SAP solutions resource
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    sapVirtualInstanceName: string,
+    options?: SAPVirtualInstancesGetOptionalParams,
+  ): Promise<SAPVirtualInstancesGetResponse>;
+  /**
+   * Updates a Virtual Instance for SAP solutions resource
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param sapVirtualInstanceName The name of the Virtual Instances for SAP solutions resource
+   * @param options The options parameters.
+   */
+  beginUpdate(
+    resourceGroupName: string,
+    sapVirtualInstanceName: string,
+    options?: SAPVirtualInstancesUpdateOptionalParams,
+  ): Promise<
+    SimplePollerLike<
+      OperationState<SAPVirtualInstancesUpdateResponse>,
+      SAPVirtualInstancesUpdateResponse
+    >
+  >;
+  /**
+   * Updates a Virtual Instance for SAP solutions resource
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param sapVirtualInstanceName The name of the Virtual Instances for SAP solutions resource
+   * @param options The options parameters.
+   */
+  beginUpdateAndWait(
+    resourceGroupName: string,
+    sapVirtualInstanceName: string,
+    options?: SAPVirtualInstancesUpdateOptionalParams,
+  ): Promise<SAPVirtualInstancesUpdateResponse>;
+  /**
+   * Deletes a Virtual Instance for SAP solutions resource and its child resources, that is the
+   * associated Central Services Instance, Application Server Instances and Database Instance.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param sapVirtualInstanceName The name of the Virtual Instances for SAP solutions resource
+   * @param options The options parameters.
+   */
+  beginDelete(
+    resourceGroupName: string,
+    sapVirtualInstanceName: string,
+    options?: SAPVirtualInstancesDeleteOptionalParams,
+  ): Promise<
+    SimplePollerLike<
+      OperationState<SAPVirtualInstancesDeleteResponse>,
+      SAPVirtualInstancesDeleteResponse
+    >
+  >;
+  /**
+   * Deletes a Virtual Instance for SAP solutions resource and its child resources, that is the
+   * associated Central Services Instance, Application Server Instances and Database Instance.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param sapVirtualInstanceName The name of the Virtual Instances for SAP solutions resource
+   * @param options The options parameters.
+   */
+  beginDeleteAndWait(
+    resourceGroupName: string,
+    sapVirtualInstanceName: string,
+    options?: SAPVirtualInstancesDeleteOptionalParams,
+  ): Promise<SAPVirtualInstancesDeleteResponse>;
+  /**
+   * Starts the SAP application, that is the Central Services instance and Application server instances.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param sapVirtualInstanceName The name of the Virtual Instances for SAP solutions resource
+   * @param options The options parameters.
+   */
+  beginStart(
+    resourceGroupName: string,
+    sapVirtualInstanceName: string,
+    options?: SAPVirtualInstancesStartOptionalParams,
+  ): Promise<
+    SimplePollerLike<
+      OperationState<SAPVirtualInstancesStartResponse>,
+      SAPVirtualInstancesStartResponse
+    >
+  >;
+  /**
+   * Starts the SAP application, that is the Central Services instance and Application server instances.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param sapVirtualInstanceName The name of the Virtual Instances for SAP solutions resource
+   * @param options The options parameters.
+   */
+  beginStartAndWait(
+    resourceGroupName: string,
+    sapVirtualInstanceName: string,
+    options?: SAPVirtualInstancesStartOptionalParams,
+  ): Promise<SAPVirtualInstancesStartResponse>;
+  /**
+   * Stops the SAP Application, that is the Application server instances and Central Services instance.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param sapVirtualInstanceName The name of the Virtual Instances for SAP solutions resource
+   * @param options The options parameters.
+   */
+  beginStop(
+    resourceGroupName: string,
+    sapVirtualInstanceName: string,
+    options?: SAPVirtualInstancesStopOptionalParams,
+  ): Promise<
+    SimplePollerLike<
+      OperationState<SAPVirtualInstancesStopResponse>,
+      SAPVirtualInstancesStopResponse
+    >
+  >;
+  /**
+   * Stops the SAP Application, that is the Application server instances and Central Services instance.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param sapVirtualInstanceName The name of the Virtual Instances for SAP solutions resource
+   * @param options The options parameters.
+   */
+  beginStopAndWait(
+    resourceGroupName: string,
+    sapVirtualInstanceName: string,
+    options?: SAPVirtualInstancesStopOptionalParams,
+  ): Promise<SAPVirtualInstancesStopResponse>;
+}

package/src/pagingHelper.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 interface PageInfo {
+  continuationToken?: string;
+}
+
+const pageMap = new WeakMap<object, PageInfo>();
+
+/**
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
+ * that point later.
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
+ */
+export function getContinuationToken(page: unknown): string | undefined {
+  if (typeof page !== "object" || page === null) {
+    return undefined;
+  }
+  return pageMap.get(page)?.continuationToken;
+}
+
+export function setContinuationToken(
+  page: unknown,
+  continuationToken: string | undefined,
+): void {
+  if (typeof page !== "object" || page === null || !continuationToken) {
+    return;
+  }
+  const pageInfo = pageMap.get(page) ?? {};
+  pageInfo.continuationToken = continuationToken;
+  pageMap.set(page, pageInfo);
+}

package/src/workloadsClient.ts

@@ -0,0 +1,327 @@
+/*
+ * 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 * as coreClient from "@azure/core-client";
+import * as coreRestPipeline from "@azure/core-rest-pipeline";
+import {
+  PipelineRequest,
+  PipelineResponse,
+  SendRequest,
+} from "@azure/core-rest-pipeline";
+import * as coreAuth from "@azure/core-auth";
+import {
+  SAPVirtualInstancesImpl,
+  SAPCentralInstancesImpl,
+  SAPDatabaseInstancesImpl,
+  SAPApplicationServerInstancesImpl,
+  OperationsImpl,
+} from "./operations";
+import {
+  SAPVirtualInstances,
+  SAPCentralInstances,
+  SAPDatabaseInstances,
+  SAPApplicationServerInstances,
+  Operations,
+} from "./operationsInterfaces";
+import * as Parameters from "./models/parameters";
+import * as Mappers from "./models/mappers";
+import {
+  WorkloadsClientOptionalParams,
+  SAPSizingRecommendationsOptionalParams,
+  SAPSizingRecommendationsResponse,
+  SAPSupportedSkuOptionalParams,
+  SAPSupportedSkuResponse,
+  SAPDiskConfigurationsOptionalParams,
+  SAPDiskConfigurationsResponse,
+  SAPAvailabilityZoneDetailsOptionalParams,
+  SAPAvailabilityZoneDetailsResponse,
+} from "./models";
+
+export class WorkloadsClient extends coreClient.ServiceClient {
+  $host: string;
+  subscriptionId: string;
+  apiVersion: string;
+
+  /**
+   * Initializes a new instance of the WorkloadsClient class.
+   * @param credentials Subscription credentials which uniquely identify client subscription.
+   * @param subscriptionId The ID of the target subscription.
+   * @param options The parameter options
+   */
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    subscriptionId: string,
+    options?: WorkloadsClientOptionalParams,
+  ) {
+    if (credentials === undefined) {
+      throw new Error("'credentials' cannot be null");
+    }
+    if (subscriptionId === undefined) {
+      throw new Error("'subscriptionId' cannot be null");
+    }
+
+    // Initializing default values for options
+    if (!options) {
+      options = {};
+    }
+    const defaults: WorkloadsClientOptionalParams = {
+      requestContentType: "application/json; charset=utf-8",
+      credential: credentials,
+    };
+
+    const packageDetails = `azsdk-js-arm-workloadssapvirtualinstance/1.0.0-beta.1`;
+    const userAgentPrefix =
+      options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
+        : `${packageDetails}`;
+
+    const optionsWithDefaults = {
+      ...defaults,
+      ...options,
+      userAgentOptions: {
+        userAgentPrefix,
+      },
+      endpoint:
+        options.endpoint ?? options.baseUri ?? "https://management.azure.com",
+    };
+    super(optionsWithDefaults);
+
+    let bearerTokenAuthenticationPolicyFound: boolean = false;
+    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
+      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] =
+        options.pipeline.getOrderedPolicies();
+      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+        (pipelinePolicy) =>
+          pipelinePolicy.name ===
+          coreRestPipeline.bearerTokenAuthenticationPolicyName,
+      );
+    }
+    if (
+      !options ||
+      !options.pipeline ||
+      options.pipeline.getOrderedPolicies().length == 0 ||
+      !bearerTokenAuthenticationPolicyFound
+    ) {
+      this.pipeline.removePolicy({
+        name: coreRestPipeline.bearerTokenAuthenticationPolicyName,
+      });
+      this.pipeline.addPolicy(
+        coreRestPipeline.bearerTokenAuthenticationPolicy({
+          credential: credentials,
+          scopes:
+            optionsWithDefaults.credentialScopes ??
+            `${optionsWithDefaults.endpoint}/.default`,
+          challengeCallbacks: {
+            authorizeRequestOnChallenge:
+              coreClient.authorizeRequestOnClaimChallenge,
+          },
+        }),
+      );
+    }
+    // Parameter assignments
+    this.subscriptionId = subscriptionId;
+
+    // Assigning values to Constant parameters
+    this.$host = options.$host || "https://management.azure.com";
+    this.apiVersion = options.apiVersion || "2023-10-01-preview";
+    this.sAPVirtualInstances = new SAPVirtualInstancesImpl(this);
+    this.sAPCentralInstances = new SAPCentralInstancesImpl(this);
+    this.sAPDatabaseInstances = new SAPDatabaseInstancesImpl(this);
+    this.sAPApplicationServerInstances = new SAPApplicationServerInstancesImpl(
+      this,
+    );
+    this.operations = new OperationsImpl(this);
+    this.addCustomApiVersionPolicy(options.apiVersion);
+  }
+
+  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+  private addCustomApiVersionPolicy(apiVersion?: string) {
+    if (!apiVersion) {
+      return;
+    }
+    const apiVersionPolicy = {
+      name: "CustomApiVersionPolicy",
+      async sendRequest(
+        request: PipelineRequest,
+        next: SendRequest,
+      ): Promise<PipelineResponse> {
+        const param = request.url.split("?");
+        if (param.length > 1) {
+          const newParams = param[1].split("&").map((item) => {
+            if (item.indexOf("api-version") > -1) {
+              return "api-version=" + apiVersion;
+            } else {
+              return item;
+            }
+          });
+          request.url = param[0] + "?" + newParams.join("&");
+        }
+        return next(request);
+      },
+    };
+    this.pipeline.addPolicy(apiVersionPolicy);
+  }
+
+  /**
+   * Get SAP sizing recommendations by providing input SAPS for application tier and memory required for
+   * database tier
+   * @param location The name of Azure region.
+   * @param options The options parameters.
+   */
+  sAPSizingRecommendations(
+    location: string,
+    options?: SAPSizingRecommendationsOptionalParams,
+  ): Promise<SAPSizingRecommendationsResponse> {
+    return this.sendOperationRequest(
+      { location, options },
+      sAPSizingRecommendationsOperationSpec,
+    );
+  }
+
+  /**
+   * Get a list of SAP supported SKUs for ASCS, Application and Database tier.
+   * @param location The name of Azure region.
+   * @param options The options parameters.
+   */
+  sAPSupportedSku(
+    location: string,
+    options?: SAPSupportedSkuOptionalParams,
+  ): Promise<SAPSupportedSkuResponse> {
+    return this.sendOperationRequest(
+      { location, options },
+      sAPSupportedSkuOperationSpec,
+    );
+  }
+
+  /**
+   * Get the SAP Disk Configuration Layout prod/non-prod SAP System.
+   * @param location The name of Azure region.
+   * @param options The options parameters.
+   */
+  sAPDiskConfigurations(
+    location: string,
+    options?: SAPDiskConfigurationsOptionalParams,
+  ): Promise<SAPDiskConfigurationsResponse> {
+    return this.sendOperationRequest(
+      { location, options },
+      sAPDiskConfigurationsOperationSpec,
+    );
+  }
+
+  /**
+   * Get the recommended SAP Availability Zone Pair Details for your region.
+   * @param location The name of Azure region.
+   * @param options The options parameters.
+   */
+  sAPAvailabilityZoneDetails(
+    location: string,
+    options?: SAPAvailabilityZoneDetailsOptionalParams,
+  ): Promise<SAPAvailabilityZoneDetailsResponse> {
+    return this.sendOperationRequest(
+      { location, options },
+      sAPAvailabilityZoneDetailsOperationSpec,
+    );
+  }
+
+  sAPVirtualInstances: SAPVirtualInstances;
+  sAPCentralInstances: SAPCentralInstances;
+  sAPDatabaseInstances: SAPDatabaseInstances;
+  sAPApplicationServerInstances: SAPApplicationServerInstances;
+  operations: Operations;
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const sAPSizingRecommendationsOperationSpec: coreClient.OperationSpec = {
+  path: "/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/{location}/sapVirtualInstanceMetadata/default/getSizingRecommendations",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.SAPSizingRecommendationResult,
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse,
+    },
+  },
+  requestBody: Parameters.sAPSizingRecommendation,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.location,
+  ],
+  headerParameters: [Parameters.contentType, Parameters.accept],
+  mediaType: "json",
+  serializer,
+};
+const sAPSupportedSkuOperationSpec: coreClient.OperationSpec = {
+  path: "/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/{location}/sapVirtualInstanceMetadata/default/getSapSupportedSku",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.SAPSupportedResourceSkusResult,
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse,
+    },
+  },
+  requestBody: Parameters.sAPSupportedSku,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.location,
+  ],
+  headerParameters: [Parameters.contentType, Parameters.accept],
+  mediaType: "json",
+  serializer,
+};
+const sAPDiskConfigurationsOperationSpec: coreClient.OperationSpec = {
+  path: "/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/{location}/sapVirtualInstanceMetadata/default/getDiskConfigurations",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.SAPDiskConfigurationsResult,
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse,
+    },
+  },
+  requestBody: Parameters.sAPDiskConfigurations,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.location,
+  ],
+  headerParameters: [Parameters.contentType, Parameters.accept],
+  mediaType: "json",
+  serializer,
+};
+const sAPAvailabilityZoneDetailsOperationSpec: coreClient.OperationSpec = {
+  path: "/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/{location}/sapVirtualInstanceMetadata/default/getAvailabilityZoneDetails",
+  httpMethod: "POST",
+  responses: {
+    200: {
+      bodyMapper: Mappers.SAPAvailabilityZoneDetailsResult,
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse,
+    },
+  },
+  requestBody: Parameters.sAPAvailabilityZoneDetails,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.location,
+  ],
+  headerParameters: [Parameters.contentType, Parameters.accept],
+  mediaType: "json",
+  serializer,
+};

package/tsconfig.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    "module": "es6",
+    "moduleResolution": "node",
+    "strict": true,
+    "target": "es6",
+    "sourceMap": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": [
+      "es6",
+      "dom"
+    ],
+    "declaration": true,
+    "outDir": "./dist-esm",
+    "importHelpers": true,
+    "paths": {
+      "@azure/arm-workloadssapvirtualinstance": [
+        "./src/index"
+      ]
+    }
+  },
+  "include": [
+    "./src/**/*.ts",
+    "./test/**/*.ts",
+    "samples-dev/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}