@azure/arm-sphere 1.0.0-beta.1

package/src/operationsInterfaces/devices.ts

@@ -0,0 +1,235 @@
+/*
+ * 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 {
+  Device,
+  DevicesListByDeviceGroupOptionalParams,
+  DevicesGetOptionalParams,
+  DevicesGetResponse,
+  DevicesCreateOrUpdateOptionalParams,
+  DevicesCreateOrUpdateResponse,
+  DeviceUpdate,
+  DevicesUpdateOptionalParams,
+  DevicesUpdateResponse,
+  DevicesDeleteOptionalParams,
+  GenerateCapabilityImageRequest,
+  DevicesGenerateCapabilityImageOptionalParams,
+  DevicesGenerateCapabilityImageResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Devices. */
+export interface Devices {
+  /**
+   * List Device resources by DeviceGroup. '.default' and '.unassigned' are system defined values and
+   * cannot be used for product or device group name.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param deviceGroupName Name of device group.
+   * @param options The options parameters.
+   */
+  listByDeviceGroup(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    deviceGroupName: string,
+    options?: DevicesListByDeviceGroupOptionalParams
+  ): PagedAsyncIterableIterator<Device>;
+  /**
+   * Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device
+   * does not belong to a device group and product.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param deviceGroupName Name of device group.
+   * @param deviceName Device name
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    deviceGroupName: string,
+    deviceName: string,
+    options?: DevicesGetOptionalParams
+  ): Promise<DevicesGetResponse>;
+  /**
+   * Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a
+   * device to the catalog only.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param deviceGroupName Name of device group.
+   * @param deviceName Device name
+   * @param resource Resource create parameters.
+   * @param options The options parameters.
+   */
+  beginCreateOrUpdate(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    deviceGroupName: string,
+    deviceName: string,
+    resource: Device,
+    options?: DevicesCreateOrUpdateOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<DevicesCreateOrUpdateResponse>,
+      DevicesCreateOrUpdateResponse
+    >
+  >;
+  /**
+   * Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a
+   * device to the catalog only.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param deviceGroupName Name of device group.
+   * @param deviceName Device name
+   * @param resource Resource create parameters.
+   * @param options The options parameters.
+   */
+  beginCreateOrUpdateAndWait(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    deviceGroupName: string,
+    deviceName: string,
+    resource: Device,
+    options?: DevicesCreateOrUpdateOptionalParams
+  ): Promise<DevicesCreateOrUpdateResponse>;
+  /**
+   * Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a
+   * device to the catalog level.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param deviceGroupName Name of device group.
+   * @param deviceName Device name
+   * @param properties The resource properties to be updated.
+   * @param options The options parameters.
+   */
+  beginUpdate(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    deviceGroupName: string,
+    deviceName: string,
+    properties: DeviceUpdate,
+    options?: DevicesUpdateOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<DevicesUpdateResponse>,
+      DevicesUpdateResponse
+    >
+  >;
+  /**
+   * Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a
+   * device to the catalog level.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param deviceGroupName Name of device group.
+   * @param deviceName Device name
+   * @param properties The resource properties to be updated.
+   * @param options The options parameters.
+   */
+  beginUpdateAndWait(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    deviceGroupName: string,
+    deviceName: string,
+    properties: DeviceUpdate,
+    options?: DevicesUpdateOptionalParams
+  ): Promise<DevicesUpdateResponse>;
+  /**
+   * Delete a Device
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param deviceGroupName Name of device group.
+   * @param deviceName Device name
+   * @param options The options parameters.
+   */
+  beginDelete(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    deviceGroupName: string,
+    deviceName: string,
+    options?: DevicesDeleteOptionalParams
+  ): Promise<SimplePollerLike<OperationState<void>, void>>;
+  /**
+   * Delete a Device
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param deviceGroupName Name of device group.
+   * @param deviceName Device name
+   * @param options The options parameters.
+   */
+  beginDeleteAndWait(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    deviceGroupName: string,
+    deviceName: string,
+    options?: DevicesDeleteOptionalParams
+  ): Promise<void>;
+  /**
+   * Generates the capability image for the device. Use '.unassigned' or '.default' for the device group
+   * and product names to generate the image for a device that does not belong to a specific device group
+   * and product.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param deviceGroupName Name of device group.
+   * @param deviceName Device name
+   * @param generateDeviceCapabilityRequest Generate capability image request body.
+   * @param options The options parameters.
+   */
+  beginGenerateCapabilityImage(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    deviceGroupName: string,
+    deviceName: string,
+    generateDeviceCapabilityRequest: GenerateCapabilityImageRequest,
+    options?: DevicesGenerateCapabilityImageOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<DevicesGenerateCapabilityImageResponse>,
+      DevicesGenerateCapabilityImageResponse
+    >
+  >;
+  /**
+   * Generates the capability image for the device. Use '.unassigned' or '.default' for the device group
+   * and product names to generate the image for a device that does not belong to a specific device group
+   * and product.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param deviceGroupName Name of device group.
+   * @param deviceName Device name
+   * @param generateDeviceCapabilityRequest Generate capability image request body.
+   * @param options The options parameters.
+   */
+  beginGenerateCapabilityImageAndWait(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    deviceGroupName: string,
+    deviceName: string,
+    generateDeviceCapabilityRequest: GenerateCapabilityImageRequest,
+    options?: DevicesGenerateCapabilityImageOptionalParams
+  ): Promise<DevicesGenerateCapabilityImageResponse>;
+}

package/src/operationsInterfaces/images.ts

@@ -0,0 +1,109 @@
+/*
+ * 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 {
+  Image,
+  ImagesListByCatalogOptionalParams,
+  ImagesGetOptionalParams,
+  ImagesGetResponse,
+  ImagesCreateOrUpdateOptionalParams,
+  ImagesCreateOrUpdateResponse,
+  ImagesDeleteOptionalParams
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Images. */
+export interface Images {
+  /**
+   * List Image resources by Catalog
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param options The options parameters.
+   */
+  listByCatalog(
+    resourceGroupName: string,
+    catalogName: string,
+    options?: ImagesListByCatalogOptionalParams
+  ): PagedAsyncIterableIterator<Image>;
+  /**
+   * Get a Image
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param imageName Image name. Use .default for image creation.
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    catalogName: string,
+    imageName: string,
+    options?: ImagesGetOptionalParams
+  ): Promise<ImagesGetResponse>;
+  /**
+   * Create a Image
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param imageName Image name. Use .default for image creation.
+   * @param resource Resource create parameters.
+   * @param options The options parameters.
+   */
+  beginCreateOrUpdate(
+    resourceGroupName: string,
+    catalogName: string,
+    imageName: string,
+    resource: Image,
+    options?: ImagesCreateOrUpdateOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<ImagesCreateOrUpdateResponse>,
+      ImagesCreateOrUpdateResponse
+    >
+  >;
+  /**
+   * Create a Image
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param imageName Image name. Use .default for image creation.
+   * @param resource Resource create parameters.
+   * @param options The options parameters.
+   */
+  beginCreateOrUpdateAndWait(
+    resourceGroupName: string,
+    catalogName: string,
+    imageName: string,
+    resource: Image,
+    options?: ImagesCreateOrUpdateOptionalParams
+  ): Promise<ImagesCreateOrUpdateResponse>;
+  /**
+   * Delete a Image
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param imageName Image name. Use .default for image creation.
+   * @param options The options parameters.
+   */
+  beginDelete(
+    resourceGroupName: string,
+    catalogName: string,
+    imageName: string,
+    options?: ImagesDeleteOptionalParams
+  ): Promise<SimplePollerLike<OperationState<void>, void>>;
+  /**
+   * Delete a Image
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param imageName Image name. Use .default for image creation.
+   * @param options The options parameters.
+   */
+  beginDeleteAndWait(
+    resourceGroupName: string,
+    catalogName: string,
+    imageName: string,
+    options?: ImagesDeleteOptionalParams
+  ): Promise<void>;
+}

package/src/operationsInterfaces/index.ts

@@ -0,0 +1,16 @@
+/*
+ * 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 "./catalogs";
+export * from "./certificates";
+export * from "./images";
+export * from "./products";
+export * from "./deviceGroups";
+export * from "./deployments";
+export * from "./devices";

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 {
+  /**
+   * List the operations for the provider
+   * @param options The options parameters.
+   */
+  list(
+    options?: OperationsListOptionalParams
+  ): PagedAsyncIterableIterator<Operation>;
+}

package/src/operationsInterfaces/products.ts

@@ -0,0 +1,186 @@
+/*
+ * 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 {
+  Product,
+  ProductsListByCatalogOptionalParams,
+  DeviceGroup,
+  ProductsGenerateDefaultDeviceGroupsOptionalParams,
+  ProductsGetOptionalParams,
+  ProductsGetResponse,
+  ProductsCreateOrUpdateOptionalParams,
+  ProductsCreateOrUpdateResponse,
+  ProductUpdate,
+  ProductsUpdateOptionalParams,
+  ProductsUpdateResponse,
+  ProductsDeleteOptionalParams,
+  ProductsCountDevicesOptionalParams,
+  ProductsCountDevicesResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Products. */
+export interface Products {
+  /**
+   * List Product resources by Catalog
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param options The options parameters.
+   */
+  listByCatalog(
+    resourceGroupName: string,
+    catalogName: string,
+    options?: ProductsListByCatalogOptionalParams
+  ): PagedAsyncIterableIterator<Product>;
+  /**
+   * Generates default device groups for the product. '.default' and '.unassigned' are system defined
+   * values and cannot be used for product name.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param options The options parameters.
+   */
+  listGenerateDefaultDeviceGroups(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    options?: ProductsGenerateDefaultDeviceGroupsOptionalParams
+  ): PagedAsyncIterableIterator<DeviceGroup>;
+  /**
+   * Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product
+   * name.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    options?: ProductsGetOptionalParams
+  ): Promise<ProductsGetResponse>;
+  /**
+   * Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for
+   * product name.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param resource Resource create parameters.
+   * @param options The options parameters.
+   */
+  beginCreateOrUpdate(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    resource: Product,
+    options?: ProductsCreateOrUpdateOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<ProductsCreateOrUpdateResponse>,
+      ProductsCreateOrUpdateResponse
+    >
+  >;
+  /**
+   * Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for
+   * product name.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param resource Resource create parameters.
+   * @param options The options parameters.
+   */
+  beginCreateOrUpdateAndWait(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    resource: Product,
+    options?: ProductsCreateOrUpdateOptionalParams
+  ): Promise<ProductsCreateOrUpdateResponse>;
+  /**
+   * Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for
+   * product name.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param properties The resource properties to be updated.
+   * @param options The options parameters.
+   */
+  beginUpdate(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    properties: ProductUpdate,
+    options?: ProductsUpdateOptionalParams
+  ): Promise<
+    SimplePollerLike<
+      OperationState<ProductsUpdateResponse>,
+      ProductsUpdateResponse
+    >
+  >;
+  /**
+   * Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for
+   * product name.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param properties The resource properties to be updated.
+   * @param options The options parameters.
+   */
+  beginUpdateAndWait(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    properties: ProductUpdate,
+    options?: ProductsUpdateOptionalParams
+  ): Promise<ProductsUpdateResponse>;
+  /**
+   * Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for
+   * product name'
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param options The options parameters.
+   */
+  beginDelete(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    options?: ProductsDeleteOptionalParams
+  ): Promise<SimplePollerLike<OperationState<void>, void>>;
+  /**
+   * Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for
+   * product name'
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param options The options parameters.
+   */
+  beginDeleteAndWait(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    options?: ProductsDeleteOptionalParams
+  ): Promise<void>;
+  /**
+   * Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used
+   * for product name.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param catalogName Name of catalog
+   * @param productName Name of product.
+   * @param options The options parameters.
+   */
+  countDevices(
+    resourceGroupName: string,
+    catalogName: string,
+    productName: string,
+    options?: ProductsCountDevicesOptionalParams
+  ): Promise<ProductsCountDevicesResponse>;
+}

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