@azure/arm-iotfirmwaredefense 1.0.0-beta.1

package/src/operationsInterfaces/firmwareOperations.ts

@@ -0,0 +1,320 @@
+/*
+ * 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 {
+  Firmware,
+  FirmwareListByWorkspaceOptionalParams,
+  Component,
+  FirmwareListGenerateComponentListOptionalParams,
+  BinaryHardening,
+  FirmwareListGenerateBinaryHardeningListOptionalParams,
+  PasswordHash,
+  FirmwareListGeneratePasswordHashListOptionalParams,
+  Cve,
+  FirmwareListGenerateCveListOptionalParams,
+  CryptoCertificate,
+  FirmwareListGenerateCryptoCertificateListOptionalParams,
+  CryptoKey,
+  FirmwareListGenerateCryptoKeyListOptionalParams,
+  FirmwareCreateOptionalParams,
+  FirmwareCreateResponse,
+  FirmwareUpdateDefinition,
+  FirmwareUpdateOptionalParams,
+  FirmwareUpdateResponse,
+  FirmwareDeleteOptionalParams,
+  FirmwareGetOptionalParams,
+  FirmwareGetResponse,
+  FirmwareGenerateDownloadUrlOptionalParams,
+  FirmwareGenerateDownloadUrlResponse,
+  FirmwareGenerateFilesystemDownloadUrlOptionalParams,
+  FirmwareGenerateFilesystemDownloadUrlResponse,
+  FirmwareGenerateSummaryOptionalParams,
+  FirmwareGenerateSummaryResponse,
+  FirmwareGenerateComponentDetailsOptionalParams,
+  FirmwareGenerateComponentDetailsResponse,
+  FirmwareGenerateBinaryHardeningSummaryOptionalParams,
+  FirmwareGenerateBinaryHardeningSummaryResponse,
+  FirmwareGenerateBinaryHardeningDetailsOptionalParams,
+  FirmwareGenerateBinaryHardeningDetailsResponse,
+  FirmwareGenerateCveSummaryOptionalParams,
+  FirmwareGenerateCveSummaryResponse,
+  FirmwareGenerateCryptoCertificateSummaryOptionalParams,
+  FirmwareGenerateCryptoCertificateSummaryResponse,
+  FirmwareGenerateCryptoKeySummaryOptionalParams,
+  FirmwareGenerateCryptoKeySummaryResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a FirmwareOperations. */
+export interface FirmwareOperations {
+  /**
+   * Lists all of firmwares inside a workspace.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param options The options parameters.
+   */
+  listByWorkspace(
+    resourceGroupName: string,
+    workspaceName: string,
+    options?: FirmwareListByWorkspaceOptionalParams
+  ): PagedAsyncIterableIterator<Firmware>;
+  /**
+   * The operation to list all components result for a firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  listGenerateComponentList(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareListGenerateComponentListOptionalParams
+  ): PagedAsyncIterableIterator<Component>;
+  /**
+   * The operation to list all binary hardening result for a firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  listGenerateBinaryHardeningList(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareListGenerateBinaryHardeningListOptionalParams
+  ): PagedAsyncIterableIterator<BinaryHardening>;
+  /**
+   * The operation to list all password hashes for a firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  listGeneratePasswordHashList(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareListGeneratePasswordHashListOptionalParams
+  ): PagedAsyncIterableIterator<PasswordHash>;
+  /**
+   * The operation to list all cve results for a firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  listGenerateCveList(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareListGenerateCveListOptionalParams
+  ): PagedAsyncIterableIterator<Cve>;
+  /**
+   * The operation to list all crypto certificates for a firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  listGenerateCryptoCertificateList(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareListGenerateCryptoCertificateListOptionalParams
+  ): PagedAsyncIterableIterator<CryptoCertificate>;
+  /**
+   * The operation to list all crypto keys for a firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  listGenerateCryptoKeyList(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareListGenerateCryptoKeyListOptionalParams
+  ): PagedAsyncIterableIterator<CryptoKey>;
+  /**
+   * The operation to create a firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param firmware Details of the firmware being created or updated.
+   * @param options The options parameters.
+   */
+  create(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    firmware: Firmware,
+    options?: FirmwareCreateOptionalParams
+  ): Promise<FirmwareCreateResponse>;
+  /**
+   * The operation to update firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param firmware Details of the firmware being created or updated.
+   * @param options The options parameters.
+   */
+  update(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    firmware: FirmwareUpdateDefinition,
+    options?: FirmwareUpdateOptionalParams
+  ): Promise<FirmwareUpdateResponse>;
+  /**
+   * The operation to delete a firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  delete(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareDeleteOptionalParams
+  ): Promise<void>;
+  /**
+   * Get firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareGetOptionalParams
+  ): Promise<FirmwareGetResponse>;
+  /**
+   * The operation to a url for file download.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  generateDownloadUrl(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareGenerateDownloadUrlOptionalParams
+  ): Promise<FirmwareGenerateDownloadUrlResponse>;
+  /**
+   * The operation to a url for tar file download.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  generateFilesystemDownloadUrl(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareGenerateFilesystemDownloadUrlOptionalParams
+  ): Promise<FirmwareGenerateFilesystemDownloadUrlResponse>;
+  /**
+   * The operation to get a scan summary.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  generateSummary(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareGenerateSummaryOptionalParams
+  ): Promise<FirmwareGenerateSummaryResponse>;
+  /**
+   * The operation to get component details for a firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  generateComponentDetails(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareGenerateComponentDetailsOptionalParams
+  ): Promise<FirmwareGenerateComponentDetailsResponse>;
+  /**
+   * The operation to list the binary hardening summary percentages for a firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  generateBinaryHardeningSummary(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareGenerateBinaryHardeningSummaryOptionalParams
+  ): Promise<FirmwareGenerateBinaryHardeningSummaryResponse>;
+  /**
+   * The operation to get binary hardening details for a firmware.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  generateBinaryHardeningDetails(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareGenerateBinaryHardeningDetailsOptionalParams
+  ): Promise<FirmwareGenerateBinaryHardeningDetailsResponse>;
+  /**
+   * The operation to provide a high level summary of the CVEs reported for the firmware image.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  generateCveSummary(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareGenerateCveSummaryOptionalParams
+  ): Promise<FirmwareGenerateCveSummaryResponse>;
+  /**
+   * The operation to provide a high level summary of the discovered cryptographic certificates reported
+   * for the firmware image.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  generateCryptoCertificateSummary(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareGenerateCryptoCertificateSummaryOptionalParams
+  ): Promise<FirmwareGenerateCryptoCertificateSummaryResponse>;
+  /**
+   * The operation to provide a high level summary of the discovered cryptographic keys reported for the
+   * firmware image.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param firmwareId The id of the firmware.
+   * @param options The options parameters.
+   */
+  generateCryptoKeySummary(
+    resourceGroupName: string,
+    workspaceName: string,
+    firmwareId: string,
+    options?: FirmwareGenerateCryptoKeySummaryOptionalParams
+  ): Promise<FirmwareGenerateCryptoKeySummaryResponse>;
+}

package/src/operationsInterfaces/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 "./firmwareOperations";
+export * from "./workspaces";
+export * from "./operations";

package/src/operationsInterfaces/operations.ts

@@ -0,0 +1,22 @@
+/*
+ * 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 { Operation, OperationsListOptionalParams } from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Operations. */
+export interface Operations {
+  /**
+   * Lists the operations for this resource provider
+   * @param options The options parameters.
+   */
+  list(
+    options?: OperationsListOptionalParams
+  ): PagedAsyncIterableIterator<Operation>;
+}

package/src/operationsInterfaces/workspaces.ts

@@ -0,0 +1,107 @@
+/*
+ * 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 {
+  Workspace,
+  WorkspacesListBySubscriptionOptionalParams,
+  WorkspacesListByResourceGroupOptionalParams,
+  WorkspacesCreateOptionalParams,
+  WorkspacesCreateResponse,
+  WorkspaceUpdateDefinition,
+  WorkspacesUpdateOptionalParams,
+  WorkspacesUpdateResponse,
+  WorkspacesDeleteOptionalParams,
+  WorkspacesGetOptionalParams,
+  WorkspacesGetResponse,
+  GenerateUploadUrlRequest,
+  WorkspacesGenerateUploadUrlOptionalParams,
+  WorkspacesGenerateUploadUrlResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Workspaces. */
+export interface Workspaces {
+  /**
+   * Lists all of the firmware analysis workspaces in the specified subscription.
+   * @param options The options parameters.
+   */
+  listBySubscription(
+    options?: WorkspacesListBySubscriptionOptionalParams
+  ): PagedAsyncIterableIterator<Workspace>;
+  /**
+   * Lists all of the firmware analysis workspaces in the specified resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param options The options parameters.
+   */
+  listByResourceGroup(
+    resourceGroupName: string,
+    options?: WorkspacesListByResourceGroupOptionalParams
+  ): PagedAsyncIterableIterator<Workspace>;
+  /**
+   * The operation to create or update a firmware analysis workspace.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param workspace Parameters when creating a firmware analysis workspace.
+   * @param options The options parameters.
+   */
+  create(
+    resourceGroupName: string,
+    workspaceName: string,
+    workspace: Workspace,
+    options?: WorkspacesCreateOptionalParams
+  ): Promise<WorkspacesCreateResponse>;
+  /**
+   * The operation to update a firmware analysis workspaces.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param workspace Parameters when updating a firmware analysis workspace.
+   * @param options The options parameters.
+   */
+  update(
+    resourceGroupName: string,
+    workspaceName: string,
+    workspace: WorkspaceUpdateDefinition,
+    options?: WorkspacesUpdateOptionalParams
+  ): Promise<WorkspacesUpdateResponse>;
+  /**
+   * The operation to delete a firmware analysis workspace.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param options The options parameters.
+   */
+  delete(
+    resourceGroupName: string,
+    workspaceName: string,
+    options?: WorkspacesDeleteOptionalParams
+  ): Promise<void>;
+  /**
+   * Get firmware analysis workspace.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    workspaceName: string,
+    options?: WorkspacesGetOptionalParams
+  ): Promise<WorkspacesGetResponse>;
+  /**
+   * The operation to get a url for file upload.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param workspaceName The name of the firmware analysis workspace.
+   * @param generateUploadUrl Parameters when requesting a URL to upload firmware.
+   * @param options The options parameters.
+   */
+  generateUploadUrl(
+    resourceGroupName: string,
+    workspaceName: string,
+    generateUploadUrl: GenerateUploadUrlRequest,
+    options?: WorkspacesGenerateUploadUrlOptionalParams
+  ): Promise<WorkspacesGenerateUploadUrlResponse>;
+}

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/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-iotfirmwaredefense": [
+        "./src/index"
+      ]
+    }
+  },
+  "include": [
+    "./src/**/*.ts",
+    "./test/**/*.ts",
+    "samples-dev/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}