@azure/arm-hardwaresecuritymodules 1.0.0

package/review/arm-hardwaresecuritymodules.api.md

@@ -0,0 +1,318 @@
+## API Report File for "@azure/arm-hardwaresecuritymodules"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+// @public
+export interface ApiEntityReference {
+    id?: string;
+}
+
+// @public (undocumented)
+export class AzureDedicatedHSMResourceProvider extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureDedicatedHSMResourceProviderOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    dedicatedHsmOperations: DedicatedHsmOperations;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface AzureDedicatedHSMResourceProviderOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export type DedicatedHsm = Resource & {
+    readonly systemData?: SystemData;
+    networkProfile?: NetworkProfile;
+    managementNetworkProfile?: NetworkProfile;
+    stampId?: string;
+    readonly statusMessage?: string;
+    readonly provisioningState?: JsonWebKeyType;
+};
+
+// @public
+export interface DedicatedHsmCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type DedicatedHsmCreateOrUpdateResponse = DedicatedHsm;
+
+// @public
+export interface DedicatedHsmDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface DedicatedHsmError {
+    readonly error?: ErrorModel;
+}
+
+// @public
+export interface DedicatedHsmGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DedicatedHsmGetResponse = DedicatedHsm;
+
+// @public
+export interface DedicatedHsmListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+    top?: number;
+}
+
+// @public
+export type DedicatedHsmListByResourceGroupNextResponse = DedicatedHsmListResult;
+
+// @public
+export interface DedicatedHsmListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+    top?: number;
+}
+
+// @public
+export type DedicatedHsmListByResourceGroupResponse = DedicatedHsmListResult;
+
+// @public
+export interface DedicatedHsmListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+    top?: number;
+}
+
+// @public
+export type DedicatedHsmListBySubscriptionNextResponse = DedicatedHsmListResult;
+
+// @public
+export interface DedicatedHsmListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+    top?: number;
+}
+
+// @public
+export type DedicatedHsmListBySubscriptionResponse = DedicatedHsmListResult;
+
+// @public
+export interface DedicatedHsmListOutboundNetworkDependenciesEndpointsNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DedicatedHsmListOutboundNetworkDependenciesEndpointsNextResponse = OutboundEnvironmentEndpointCollection;
+
+// @public
+export interface DedicatedHsmListOutboundNetworkDependenciesEndpointsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DedicatedHsmListOutboundNetworkDependenciesEndpointsResponse = OutboundEnvironmentEndpointCollection;
+
+// @public
+export interface DedicatedHsmListResult {
+    nextLink?: string;
+    value?: DedicatedHsm[];
+}
+
+// @public
+export interface DedicatedHsmOperation {
+    display?: DedicatedHsmOperationDisplay;
+    readonly isDataAction?: string;
+    name?: string;
+}
+
+// @public
+export interface DedicatedHsmOperationDisplay {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface DedicatedHsmOperationListResult {
+    value?: DedicatedHsmOperation[];
+}
+
+// @public
+export interface DedicatedHsmOperations {
+    beginCreateOrUpdate(resourceGroupName: string, name: string, parameters: DedicatedHsm, options?: DedicatedHsmCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DedicatedHsmCreateOrUpdateResponse>, DedicatedHsmCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, name: string, parameters: DedicatedHsm, options?: DedicatedHsmCreateOrUpdateOptionalParams): Promise<DedicatedHsmCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, name: string, options?: DedicatedHsmDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, name: string, options?: DedicatedHsmDeleteOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, name: string, options?: DedicatedHsmUpdateOptionalParams): Promise<PollerLike<PollOperationState<DedicatedHsmUpdateResponse>, DedicatedHsmUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, name: string, options?: DedicatedHsmUpdateOptionalParams): Promise<DedicatedHsmUpdateResponse>;
+    get(resourceGroupName: string, name: string, options?: DedicatedHsmGetOptionalParams): Promise<DedicatedHsmGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: DedicatedHsmListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DedicatedHsm>;
+    listBySubscription(options?: DedicatedHsmListBySubscriptionOptionalParams): PagedAsyncIterableIterator<DedicatedHsm>;
+    listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, name: string, options?: DedicatedHsmListOutboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint>;
+}
+
+// @public
+export interface DedicatedHsmPatchParameters {
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface DedicatedHsmUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type DedicatedHsmUpdateResponse = DedicatedHsm;
+
+// @public
+export interface EndpointDependency {
+    domainName?: string;
+    endpointDetails?: EndpointDetail[];
+}
+
+// @public
+export interface EndpointDetail {
+    description?: string;
+    ipAddress?: string;
+    port?: number;
+    protocol?: string;
+}
+
+// @public
+export interface ErrorModel {
+    readonly code?: string;
+    readonly innerError?: ErrorModel;
+    readonly message?: string;
+}
+
+// @public
+export type IdentityType = string;
+
+// @public
+export type JsonWebKeyType = string;
+
+// @public
+export enum KnownIdentityType {
+    // (undocumented)
+    Application = "Application",
+    // (undocumented)
+    Key = "Key",
+    // (undocumented)
+    ManagedIdentity = "ManagedIdentity",
+    // (undocumented)
+    User = "User"
+}
+
+// @public
+export enum KnownJsonWebKeyType {
+    Allocating = "Allocating",
+    CheckingQuota = "CheckingQuota",
+    Connecting = "Connecting",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Provisioning = "Provisioning",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownSkuName {
+    PayShield10KLMK1CPS250 = "payShield10K_LMK1_CPS250",
+    PayShield10KLMK1CPS2500 = "payShield10K_LMK1_CPS2500",
+    PayShield10KLMK1CPS60 = "payShield10K_LMK1_CPS60",
+    PayShield10KLMK2CPS250 = "payShield10K_LMK2_CPS250",
+    PayShield10KLMK2CPS2500 = "payShield10K_LMK2_CPS2500",
+    PayShield10KLMK2CPS60 = "payShield10K_LMK2_CPS60",
+    SafeNetLunaNetworkHSMA790 = "SafeNet Luna Network HSM A790"
+}
+
+// @public
+export interface NetworkInterface {
+    readonly id?: string;
+    privateIpAddress?: string;
+}
+
+// @public
+export interface NetworkProfile {
+    networkInterfaces?: NetworkInterface[];
+    subnet?: ApiEntityReference;
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<DedicatedHsmOperation>;
+}
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = DedicatedHsmOperationListResult;
+
+// @public
+export interface OutboundEnvironmentEndpoint {
+    category?: string;
+    endpoints?: EndpointDependency[];
+}
+
+// @public
+export interface OutboundEnvironmentEndpointCollection {
+    readonly nextLink?: string;
+    value: OutboundEnvironmentEndpoint[];
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    location: string;
+    readonly name?: string;
+    sku?: Sku;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    readonly type?: string;
+    zones?: string[];
+}
+
+// @public
+export interface ResourceListResult {
+    nextLink?: string;
+    value?: Resource[];
+}
+
+// @public
+export interface Sku {
+    name?: SkuName;
+}
+
+// @public
+export type SkuName = string;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: IdentityType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: IdentityType;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/rollup.config.js

@@ -0,0 +1,122 @@
+/*
+ * 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 nodeResolve from "@rollup/plugin-node-resolve";
+import cjs from "@rollup/plugin-commonjs";
+import sourcemaps from "rollup-plugin-sourcemaps";
+import multiEntry from "@rollup/plugin-multi-entry";
+import json from "@rollup/plugin-json";
+
+import nodeBuiltins from "builtin-modules";
+
+// #region Warning Handler
+
+/**
+ * A function that can determine whether a rollup warning should be ignored. If
+ * the function returns `true`, then the warning will not be displayed.
+ */
+
+function ignoreNiseSinonEval(warning) {
+  return (
+    warning.code === "EVAL" &&
+    warning.id &&
+      (warning.id.includes("node_modules/nise") ||
+        warning.id.includes("node_modules/sinon")) === true
+  );
+}
+
+function ignoreChaiCircularDependency(warning) {
+  return (
+    warning.code === "CIRCULAR_DEPENDENCY" &&
+    warning.importer && warning.importer.includes("node_modules/chai") === true
+  );
+}
+
+const warningInhibitors = [ignoreChaiCircularDependency, ignoreNiseSinonEval];
+
+/**
+ * Construct a warning handler for the shared rollup configuration
+ * that ignores certain warnings that are not relevant to testing.
+ */
+function makeOnWarnForTesting() {
+  return (warning, warn) => {
+    // If every inhibitor returns false (i.e. no inhibitors), then show the warning
+    if (warningInhibitors.every((inhib) => !inhib(warning))) {
+      warn(warning);
+    }
+  };
+}
+
+// #endregion
+
+function makeBrowserTestConfig() {
+  const config = {
+    input: {
+      include: ["dist-esm/test/**/*.spec.js"],
+      exclude: ["dist-esm/test/**/node/**"]
+    },
+    output: {
+      file: `dist-test/index.browser.js`,
+      format: "umd",
+      sourcemap: true
+    },
+    preserveSymlinks: false,
+    plugins: [
+      multiEntry({ exports: false }),
+      nodeResolve({
+        mainFields: ["module", "browser"]
+      }),
+      cjs(),
+      json(),
+      sourcemaps()
+      //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
+    ],
+    onwarn: makeOnWarnForTesting(),
+    // Disable tree-shaking of test code.  In rollup-plugin-node-resolve@5.0.0,
+    // rollup started respecting the "sideEffects" field in package.json.  Since
+    // our package.json sets "sideEffects=false", this also applies to test
+    // code, which causes all tests to be removed by tree-shaking.
+    treeshake: false
+  };
+
+  return config;
+}
+
+const defaultConfigurationOptions = {
+  disableBrowserBundle: false
+};
+
+export function makeConfig(pkg, options) {
+  options = {
+    ...defaultConfigurationOptions,
+    ...(options || {})
+  };
+
+  const baseConfig = {
+    // Use the package's module field if it has one
+    input: pkg["module"] || "dist-esm/src/index.js",
+    external: [
+      ...nodeBuiltins,
+      ...Object.keys(pkg.dependencies),
+      ...Object.keys(pkg.devDependencies)
+    ],
+    output: { file: "dist/index.js", format: "cjs", sourcemap: true },
+    preserveSymlinks: false,
+    plugins: [sourcemaps(), nodeResolve()]
+  };
+
+  const config = [baseConfig];
+
+  if (!options.disableBrowserBundle) {
+    config.push(makeBrowserTestConfig());
+  }
+
+  return config;
+}
+
+export default makeConfig(require("./package.json"));

package/src/azureDedicatedHSMResourceProvider.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 coreAuth from "@azure/core-auth";
+import { OperationsImpl, DedicatedHsmOperationsImpl } from "./operations";
+import { Operations, DedicatedHsmOperations } from "./operationsInterfaces";
+import { AzureDedicatedHSMResourceProviderOptionalParams } from "./models";
+
+export class AzureDedicatedHSMResourceProvider extends coreClient.ServiceClient {
+  $host: string;
+  apiVersion: string;
+  subscriptionId: string;
+
+  /**
+   * Initializes a new instance of the AzureDedicatedHSMResourceProvider class.
+   * @param credentials Subscription credentials which uniquely identify client subscription.
+   * @param subscriptionId Subscription credentials which uniquely identify Microsoft Azure subscription.
+   *                       The subscription ID forms part of the URI for every service call.
+   * @param options The parameter options
+   */
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    subscriptionId: string,
+    options?: AzureDedicatedHSMResourceProviderOptionalParams
+  ) {
+    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: AzureDedicatedHSMResourceProviderOptionalParams = {
+      requestContentType: "application/json; charset=utf-8",
+      credential: credentials
+    };
+
+    const packageDetails = `azsdk-js-arm-hardwaresecuritymodules/1.0.0`;
+    const userAgentPrefix =
+      options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
+        : `${packageDetails}`;
+
+    if (!options.credentialScopes) {
+      options.credentialScopes = ["https://management.azure.com/.default"];
+    }
+    const optionsWithDefaults = {
+      ...defaults,
+      ...options,
+      userAgentOptions: {
+        userAgentPrefix
+      },
+      baseUri:
+        options.endpoint ?? options.baseUri ?? "https://management.azure.com"
+    };
+    super(optionsWithDefaults);
+    // Parameter assignments
+    this.subscriptionId = subscriptionId;
+
+    // Assigning values to Constant parameters
+    this.$host = options.$host || "https://management.azure.com";
+    this.apiVersion = options.apiVersion || "2021-11-30";
+    this.operations = new OperationsImpl(this);
+    this.dedicatedHsmOperations = new DedicatedHsmOperationsImpl(this);
+  }
+
+  operations: Operations;
+  dedicatedHsmOperations: DedicatedHsmOperations;
+}

package/src/index.ts

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+/// <reference lib="esnext.asynciterable" />
+export * from "./models";
+export { AzureDedicatedHSMResourceProvider } from "./azureDedicatedHSMResourceProvider";
+export * from "./operationsInterfaces";

package/src/lroImpl.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 { LongRunningOperation, LroResponse } from "@azure/core-lro";
+
+export class LroImpl<T> implements LongRunningOperation<T> {
+  constructor(
+    private sendOperationFn: (args: any, spec: any) => Promise<LroResponse<T>>,
+    private args: Record<string, unknown>,
+    private spec: {
+      readonly requestBody?: unknown;
+      readonly path?: string;
+      readonly httpMethod: string;
+    } & Record<string, any>,
+    public requestPath: string = spec.path!,
+    public requestMethod: string = spec.httpMethod
+  ) {}
+  public async sendInitialRequest(): Promise<LroResponse<T>> {
+    return this.sendOperationFn(this.args, this.spec);
+  }
+  public async sendPollRequest(path: string): Promise<LroResponse<T>> {
+    const { requestBody, ...restSpec } = this.spec;
+    return this.sendOperationFn(this.args, {
+      ...restSpec,
+      path,
+      httpMethod: "GET"
+    });
+  }
+}