@azure/arm-sphere 1.0.0-beta.1 → 1.0.0

package/types/arm-sphere.d.ts

@@ -68,19 +68,33 @@ export declare type CapabilityType = string;
 
 /** An Azure Sphere catalog */
 export declare interface Catalog extends TrackedResource {
-    /**
-     * The status of the last operation.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly provisioningState?: ProvisioningState;
+    /** The resource-specific properties for this resource. */
+    properties?: CatalogProperties;
 }
 
 /** The response of a Catalog list operation. */
 export declare interface CatalogListResult {
     /** The Catalog items on this page */
     value: Catalog[];
-    /** The link to the next page of items */
-    nextLink?: string;
+    /**
+     * The link to the next page of items
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+}
+
+/** Catalog properties */
+export declare interface CatalogProperties {
+    /**
+     * The Azure Sphere tenant ID associated with the catalog.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly tenantId?: string;
+    /**
+     * The status of the last operation.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisioningState;
 }
 
 /** Interface representing a Catalogs. */
@@ -177,6 +191,22 @@ export declare interface Catalogs {
      * @param options The options parameters.
      */
     countDevices(resourceGroupName: string, catalogName: string, options?: CatalogsCountDevicesOptionalParams): Promise<CatalogsCountDevicesResponse>;
+    /**
+     * Creates an image. Use this action when the image ID is unknown.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param catalogName Name of catalog
+     * @param uploadImageRequest Image upload request body.
+     * @param options The options parameters.
+     */
+    beginUploadImage(resourceGroupName: string, catalogName: string, uploadImageRequest: Image_2, options?: CatalogsUploadImageOptionalParams): Promise<SimplePollerLike<OperationState<CatalogsUploadImageResponse>, CatalogsUploadImageResponse>>;
+    /**
+     * Creates an image. Use this action when the image ID is unknown.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param catalogName Name of catalog
+     * @param uploadImageRequest Image upload request body.
+     * @param options The options parameters.
+     */
+    beginUploadImageAndWait(resourceGroupName: string, catalogName: string, uploadImageRequest: Image_2, options?: CatalogsUploadImageOptionalParams): Promise<CatalogsUploadImageResponse>;
 }
 
 /** Optional parameters. */
@@ -184,7 +214,7 @@ export declare interface CatalogsCountDevicesOptionalParams extends coreClient.O
 }
 
 /** Contains response data for the countDevices operation. */
-export declare type CatalogsCountDevicesResponse = CountDeviceResponse;
+export declare type CatalogsCountDevicesResponse = CountDevicesResponse;
 
 /** Defines headers for Catalogs_createOrUpdate operation. */
 export declare interface CatalogsCreateOrUpdateHeaders {
@@ -349,6 +379,25 @@ export declare interface CatalogsUpdateOptionalParams extends coreClient.Operati
 /** Contains response data for the update operation. */
 export declare type CatalogsUpdateResponse = Catalog;
 
+/** Defines headers for Catalogs_uploadImage operation. */
+export declare interface CatalogsUploadImageHeaders {
+    /** The Retry-After header can indicate how long the client should wait before polling the operation status. */
+    retryAfter?: number;
+    /** The Location header contains the URL where the status of the long running operation can be checked. */
+    location?: string;
+}
+
+/** Optional parameters. */
+export declare interface CatalogsUploadImageOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the uploadImage operation. */
+export declare type CatalogsUploadImageResponse = CatalogsUploadImageHeaders;
+
 /** The type used for update operations of the Catalog. */
 export declare interface CatalogUpdate {
     /** Resource tags. */
@@ -359,41 +408,8 @@ export declare interface CatalogUpdate {
 
 /** An certificate resource belonging to a catalog resource. */
 export declare interface Certificate extends ProxyResource {
-    /**
-     * The certificate as a UTF-8 encoded base 64 string.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly certificate?: string;
-    /**
-     * The certificate status.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly status?: CertificateStatus;
-    /**
-     * The certificate subject.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly subject?: string;
-    /**
-     * The certificate thumbprint.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly thumbprint?: string;
-    /**
-     * The certificate expiry date.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly expiryUtc?: Date;
-    /**
-     * The certificate not before date.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly notBeforeUtc?: Date;
-    /**
-     * The status of the last operation.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly provisioningState?: ProvisioningState;
+    /** The resource-specific properties for this resource. */
+    properties?: CertificateProperties;
 }
 
 /** The certificate chain response. */
@@ -409,8 +425,11 @@ export declare interface CertificateChainResponse {
 export declare interface CertificateListResult {
     /** The Certificate items on this page */
     value: Certificate[];
-    /** The link to the next page of items */
-    nextLink?: string;
+    /**
+     * The link to the next page of items
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
 }
 
 /** The properties of certificate */
@@ -552,10 +571,14 @@ export declare interface ClaimDevicesRequest {
     deviceIdentifiers: string[];
 }
 
-/** Response to the action call for count devices in a catalog. */
+/** Response to the action call for count devices in a catalog (preview API). */
 export declare interface CountDeviceResponse extends CountElementsResponse {
 }
 
+/** Response to the action call for count devices in a catalog. */
+export declare interface CountDevicesResponse extends CountElementsResponse {
+}
+
 /** Response of the count for elements. */
 export declare interface CountElementsResponse {
     /** Number of children resources in parent resource. */
@@ -576,6 +599,23 @@ export declare type CreatedByType = string;
 
 /** An deployment resource belonging to a device group resource. */
 export declare interface Deployment extends ProxyResource {
+    /** The resource-specific properties for this resource. */
+    properties?: DeploymentProperties;
+}
+
+/** The response of a Deployment list operation. */
+export declare interface DeploymentListResult {
+    /** The Deployment items on this page */
+    value: Deployment[];
+    /**
+     * The link to the next page of items
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+}
+
+/** The properties of deployment */
+export declare interface DeploymentProperties {
     /** Deployment ID */
     deploymentId?: string;
     /** Images deployed */
@@ -592,14 +632,6 @@ export declare interface Deployment extends ProxyResource {
     readonly provisioningState?: ProvisioningState;
 }
 
-/** The response of a Deployment list operation. */
-export declare interface DeploymentListResult {
-    /** The Deployment items on this page */
-    value: Deployment[];
-    /** The link to the next page of items */
-    nextLink?: string;
-}
-
 /** Interface representing a Deployments. */
 export declare interface Deployments {
     /**
@@ -740,42 +772,29 @@ export declare type DeploymentsListByDeviceGroupResponse = DeploymentListResult;
 
 /** An device resource belonging to a device group resource. */
 export declare interface Device extends ProxyResource {
-    /** Device ID */
-    deviceId?: string;
-    /**
-     * SKU of the chip
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly chipSku?: string;
-    /**
-     * OS version available for installation when update requested
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly lastAvailableOsVersion?: string;
-    /**
-     * OS version running on device when update requested
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly lastInstalledOsVersion?: string;
-    /**
-     * Time when update requested and new OS version available
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly lastOsUpdateUtc?: Date;
-    /**
-     * Time when update was last requested
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly lastUpdateRequestUtc?: Date;
+    /** The resource-specific properties for this resource. */
+    properties?: DeviceProperties;
+}
+
+/** An device group resource belonging to a product resource. */
+export declare interface DeviceGroup extends ProxyResource {
+    /** The resource-specific properties for this resource. */
+    properties?: DeviceGroupProperties;
+}
+
+/** The response of a DeviceGroup list operation. */
+export declare interface DeviceGroupListResult {
+    /** The DeviceGroup items on this page */
+    value: DeviceGroup[];
     /**
-     * The status of the last operation.
+     * The link to the next page of items
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
-    readonly provisioningState?: ProvisioningState;
+    readonly nextLink?: string;
 }
 
-/** An device group resource belonging to a product resource. */
-export declare interface DeviceGroup extends ProxyResource {
+/** The properties of deviceGroup */
+export declare interface DeviceGroupProperties {
     /** Description of the device group. */
     description?: string;
     /** Operating system feed type of the device group. */
@@ -798,14 +817,6 @@ export declare interface DeviceGroup extends ProxyResource {
     readonly provisioningState?: ProvisioningState;
 }
 
-/** The response of a DeviceGroup list operation. */
-export declare interface DeviceGroupListResult {
-    /** The DeviceGroup items on this page */
-    value: DeviceGroup[];
-    /** The link to the next page of items */
-    nextLink?: string;
-}
-
 /** Interface representing a DeviceGroups. */
 export declare interface DeviceGroups {
     /**
@@ -929,6 +940,8 @@ export declare interface DeviceGroups {
 export declare interface DeviceGroupsClaimDevicesHeaders {
     /** The Retry-After header can indicate how long the client should wait before polling the operation status. */
     retryAfter?: number;
+    /** The Location header contains the URL where the status of the long running operation can be checked. */
+    location?: string;
 }
 
 /** Optional parameters. */
@@ -947,7 +960,7 @@ export declare interface DeviceGroupsCountDevicesOptionalParams extends coreClie
 }
 
 /** Contains response data for the countDevices operation. */
-export declare type DeviceGroupsCountDevicesResponse = CountDeviceResponse;
+export declare type DeviceGroupsCountDevicesResponse = CountDevicesResponse;
 
 /** Defines headers for DeviceGroups_createOrUpdate operation. */
 export declare interface DeviceGroupsCreateOrUpdateHeaders {
@@ -1032,6 +1045,12 @@ export declare type DeviceGroupsUpdateResponse = DeviceGroup;
 
 /** The type used for update operations of the DeviceGroup. */
 export declare interface DeviceGroupUpdate {
+    /** The updatable properties of the DeviceGroup. */
+    properties?: DeviceGroupUpdateProperties;
+}
+
+/** The updatable properties of the DeviceGroup. */
+export declare interface DeviceGroupUpdateProperties {
     /** Description of the device group. */
     description?: string;
     /** Operating system feed type of the device group. */
@@ -1068,14 +1087,47 @@ export declare interface DeviceInsight {
 export declare interface DeviceListResult {
     /** The Device items on this page */
     value: Device[];
-    /** The link to the next page of items */
-    nextLink?: string;
+    /**
+     * The link to the next page of items
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
 }
 
-/** The properties of device patch */
-export declare interface DevicePatchProperties {
-    /** Device group id */
-    deviceGroupId: string;
+/** The properties of device */
+export declare interface DeviceProperties {
+    /** Device ID */
+    deviceId?: string;
+    /**
+     * SKU of the chip
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly chipSku?: string;
+    /**
+     * OS version available for installation when update requested
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly lastAvailableOsVersion?: string;
+    /**
+     * OS version running on device when update requested
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly lastInstalledOsVersion?: string;
+    /**
+     * Time when update requested and new OS version available
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly lastOsUpdateUtc?: Date;
+    /**
+     * Time when update was last requested
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly lastUpdateRequestUtc?: Date;
+    /**
+     * The status of the last operation.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisioningState;
 }
 
 /** Interface representing a Devices. */
@@ -1234,6 +1286,8 @@ export declare interface DevicesDeleteOptionalParams extends coreClient.Operatio
 export declare interface DevicesGenerateCapabilityImageHeaders {
     /** The Retry-After header can indicate how long the client should wait before polling the operation status. */
     retryAfter?: number;
+    /** The Location header contains the URL where the status of the long running operation can be checked. */
+    location?: string;
 }
 
 /** Optional parameters. */
@@ -1287,6 +1341,12 @@ export declare type DevicesUpdateResponse = Device;
 
 /** The type used for update operations of the Device. */
 export declare interface DeviceUpdate {
+    /** The updatable properties of the Device. */
+    properties?: DeviceUpdateProperties;
+}
+
+/** The updatable properties of the Device. */
+export declare interface DeviceUpdateProperties {
     /** Device group id */
     deviceGroupId?: string;
 }
@@ -1357,6 +1417,24 @@ export declare function getContinuationToken(page: unknown): string | undefined;
 
 /** An image resource belonging to a catalog resource. */
 declare interface Image_2 extends ProxyResource {
+    /** The resource-specific properties for this resource. */
+    properties?: ImageProperties;
+}
+export { Image_2 as Image }
+
+/** The response of a Image list operation. */
+export declare interface ImageListResult {
+    /** The Image items on this page */
+    value: Image_2[];
+    /**
+     * The link to the next page of items
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+}
+
+/** The properties of image */
+export declare interface ImageProperties {
     /** Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. */
     image?: string;
     /** Image ID */
@@ -1394,15 +1472,6 @@ declare interface Image_2 extends ProxyResource {
      */
     readonly provisioningState?: ProvisioningState;
 }
-export { Image_2 as Image }
-
-/** The response of a Image list operation. */
-export declare interface ImageListResult {
-    /** The Image items on this page */
-    value: Image_2[];
-    /** The link to the next page of items */
-    nextLink?: string;
-}
 
 /** Interface representing a Images. */
 export declare interface Images {
@@ -1417,7 +1486,7 @@ export declare interface Images {
      * 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 imageName Image name. Use an image GUID for GA versions of the API.
      * @param options The options parameters.
      */
     get(resourceGroupName: string, catalogName: string, imageName: string, options?: ImagesGetOptionalParams): Promise<ImagesGetResponse>;
@@ -1425,7 +1494,7 @@ export declare interface Images {
      * 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 imageName Image name. Use an image GUID for GA versions of the API.
      * @param resource Resource create parameters.
      * @param options The options parameters.
      */
@@ -1434,7 +1503,7 @@ export declare interface Images {
      * 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 imageName Image name. Use an image GUID for GA versions of the API.
      * @param resource Resource create parameters.
      * @param options The options parameters.
      */
@@ -1443,7 +1512,7 @@ export declare interface Images {
      * 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 imageName Image name. Use an image GUID for GA versions of the API.
      * @param options The options parameters.
      */
     beginDelete(resourceGroupName: string, catalogName: string, imageName: string, options?: ImagesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
@@ -1451,7 +1520,7 @@ export declare interface Images {
      * 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 imageName Image name. Use an image GUID for GA versions of the API.
      * @param options The options parameters.
      */
     beginDeleteAndWait(resourceGroupName: string, catalogName: string, imageName: string, options?: ImagesDeleteOptionalParams): Promise<void>;
@@ -1551,12 +1620,6 @@ export declare type ImagesListByCatalogResponse = ImageListResult;
  */
 export declare type ImageType = string;
 
-/** Image upload request body. */
-export declare interface ImageUploadRequestBody {
-    /** . */
-    images: string;
-}
-
 /** Known values of {@link ActionType} that the service accepts. */
 export declare enum KnownActionType {
     /** Internal */
@@ -1825,12 +1888,32 @@ export declare type OSFeedType = string;
 export declare interface PagedDeviceInsight {
     /** The DeviceInsight items on this page */
     value: DeviceInsight[];
-    /** The link to the next page of items */
-    nextLink?: string;
+    /**
+     * The link to the next page of items
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
 }
 
 /** An product resource belonging to a catalog resource. */
 export declare interface Product extends ProxyResource {
+    /** The resource-specific properties for this resource. */
+    properties?: ProductProperties;
+}
+
+/** The response of a Product list operation. */
+export declare interface ProductListResult {
+    /** The Product items on this page */
+    value: Product[];
+    /**
+     * The link to the next page of items
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+}
+
+/** The properties of product */
+export declare interface ProductProperties {
     /** Description of the product */
     description?: string;
     /**
@@ -1840,14 +1923,6 @@ export declare interface Product extends ProxyResource {
     readonly provisioningState?: ProvisioningState;
 }
 
-/** The response of a Product list operation. */
-export declare interface ProductListResult {
-    /** The Product items on this page */
-    value: Product[];
-    /** The link to the next page of items */
-    nextLink?: string;
-}
-
 /** Interface representing a Products. */
 export declare interface Products {
     /**
@@ -1949,7 +2024,7 @@ export declare interface ProductsCountDevicesOptionalParams extends coreClient.O
 }
 
 /** Contains response data for the countDevices operation. */
-export declare type ProductsCountDevicesResponse = CountDeviceResponse;
+export declare type ProductsCountDevicesResponse = CountDevicesResponse;
 
 /** Defines headers for Products_createOrUpdate operation. */
 export declare interface ProductsCreateOrUpdateHeaders {
@@ -2040,6 +2115,12 @@ export declare type ProductsUpdateResponse = Product;
 
 /** The type used for update operations of the Product. */
 export declare interface ProductUpdate {
+    /** The updatable properties of the Product. */
+    properties?: ProductUpdateProperties;
+}
+
+/** The updatable properties of the Product. */
+export declare interface ProductUpdateProperties {
     /** Description of the product */
     description?: string;
 }

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.36.3"
+      "packageVersion": "7.43.0"
     }
   ]
 }

package/rollup.config.js

@@ -1,122 +0,0 @@
-/*
- * 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"));