@azure/arm-databox 3.0.0 → 5.0.0-beta.1

package/src/operationsInterfaces/jobs.ts

@@ -0,0 +1,205 @@
+/*
+ * 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 { PollerLike, PollOperationState } from "@azure/core-lro";
+import {
+  JobResource,
+  JobsListOptionalParams,
+  JobsListByResourceGroupOptionalParams,
+  UnencryptedCredentials,
+  JobsListCredentialsOptionalParams,
+  MarkDevicesShippedRequest,
+  JobsMarkDevicesShippedOptionalParams,
+  JobsGetOptionalParams,
+  JobsGetResponse,
+  JobsCreateOptionalParams,
+  JobsCreateResponse,
+  JobsDeleteOptionalParams,
+  JobResourceUpdateParameter,
+  JobsUpdateOptionalParams,
+  JobsUpdateResponse,
+  ShipmentPickUpRequest,
+  JobsBookShipmentPickUpOptionalParams,
+  JobsBookShipmentPickUpResponse,
+  CancellationReason,
+  JobsCancelOptionalParams
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Jobs. */
+export interface Jobs {
+  /**
+   * Lists all the jobs available under the subscription.
+   * @param options The options parameters.
+   */
+  list(
+    options?: JobsListOptionalParams
+  ): PagedAsyncIterableIterator<JobResource>;
+  /**
+   * Lists all the jobs available under the given resource group.
+   * @param resourceGroupName The Resource Group Name
+   * @param options The options parameters.
+   */
+  listByResourceGroup(
+    resourceGroupName: string,
+    options?: JobsListByResourceGroupOptionalParams
+  ): PagedAsyncIterableIterator<JobResource>;
+  /**
+   * This method gets the unencrypted secrets related to the job.
+   * @param resourceGroupName The Resource Group Name
+   * @param jobName The name of the job Resource within the specified resource group. job names must be
+   *                between 3 and 24 characters in length and use any alphanumeric and underscore only
+   * @param options The options parameters.
+   */
+  listCredentials(
+    resourceGroupName: string,
+    jobName: string,
+    options?: JobsListCredentialsOptionalParams
+  ): PagedAsyncIterableIterator<UnencryptedCredentials>;
+  /**
+   * Request to mark devices for a given job as shipped
+   * @param jobName The name of the job Resource within the specified resource group. job names must be
+   *                between 3 and 24 characters in length and use any alphanumeric and underscore only
+   * @param resourceGroupName The Resource Group Name
+   * @param markDevicesShippedRequest Mark Devices Shipped Request
+   * @param options The options parameters.
+   */
+  markDevicesShipped(
+    jobName: string,
+    resourceGroupName: string,
+    markDevicesShippedRequest: MarkDevicesShippedRequest,
+    options?: JobsMarkDevicesShippedOptionalParams
+  ): Promise<void>;
+  /**
+   * Gets information about the specified job.
+   * @param resourceGroupName The Resource Group Name
+   * @param jobName The name of the job Resource within the specified resource group. job names must be
+   *                between 3 and 24 characters in length and use any alphanumeric and underscore only
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    jobName: string,
+    options?: JobsGetOptionalParams
+  ): Promise<JobsGetResponse>;
+  /**
+   * Creates a new job with the specified parameters. Existing job cannot be updated with this API and
+   * should instead be updated with the Update job API.
+   * @param resourceGroupName The Resource Group Name
+   * @param jobName The name of the job Resource within the specified resource group. job names must be
+   *                between 3 and 24 characters in length and use any alphanumeric and underscore only
+   * @param jobResource Job details from request body.
+   * @param options The options parameters.
+   */
+  beginCreate(
+    resourceGroupName: string,
+    jobName: string,
+    jobResource: JobResource,
+    options?: JobsCreateOptionalParams
+  ): Promise<
+    PollerLike<PollOperationState<JobsCreateResponse>, JobsCreateResponse>
+  >;
+  /**
+   * Creates a new job with the specified parameters. Existing job cannot be updated with this API and
+   * should instead be updated with the Update job API.
+   * @param resourceGroupName The Resource Group Name
+   * @param jobName The name of the job Resource within the specified resource group. job names must be
+   *                between 3 and 24 characters in length and use any alphanumeric and underscore only
+   * @param jobResource Job details from request body.
+   * @param options The options parameters.
+   */
+  beginCreateAndWait(
+    resourceGroupName: string,
+    jobName: string,
+    jobResource: JobResource,
+    options?: JobsCreateOptionalParams
+  ): Promise<JobsCreateResponse>;
+  /**
+   * Deletes a job.
+   * @param resourceGroupName The Resource Group Name
+   * @param jobName The name of the job Resource within the specified resource group. job names must be
+   *                between 3 and 24 characters in length and use any alphanumeric and underscore only
+   * @param options The options parameters.
+   */
+  beginDelete(
+    resourceGroupName: string,
+    jobName: string,
+    options?: JobsDeleteOptionalParams
+  ): Promise<PollerLike<PollOperationState<void>, void>>;
+  /**
+   * Deletes a job.
+   * @param resourceGroupName The Resource Group Name
+   * @param jobName The name of the job Resource within the specified resource group. job names must be
+   *                between 3 and 24 characters in length and use any alphanumeric and underscore only
+   * @param options The options parameters.
+   */
+  beginDeleteAndWait(
+    resourceGroupName: string,
+    jobName: string,
+    options?: JobsDeleteOptionalParams
+  ): Promise<void>;
+  /**
+   * Updates the properties of an existing job.
+   * @param resourceGroupName The Resource Group Name
+   * @param jobName The name of the job Resource within the specified resource group. job names must be
+   *                between 3 and 24 characters in length and use any alphanumeric and underscore only
+   * @param jobResourceUpdateParameter Job update parameters from request body.
+   * @param options The options parameters.
+   */
+  beginUpdate(
+    resourceGroupName: string,
+    jobName: string,
+    jobResourceUpdateParameter: JobResourceUpdateParameter,
+    options?: JobsUpdateOptionalParams
+  ): Promise<
+    PollerLike<PollOperationState<JobsUpdateResponse>, JobsUpdateResponse>
+  >;
+  /**
+   * Updates the properties of an existing job.
+   * @param resourceGroupName The Resource Group Name
+   * @param jobName The name of the job Resource within the specified resource group. job names must be
+   *                between 3 and 24 characters in length and use any alphanumeric and underscore only
+   * @param jobResourceUpdateParameter Job update parameters from request body.
+   * @param options The options parameters.
+   */
+  beginUpdateAndWait(
+    resourceGroupName: string,
+    jobName: string,
+    jobResourceUpdateParameter: JobResourceUpdateParameter,
+    options?: JobsUpdateOptionalParams
+  ): Promise<JobsUpdateResponse>;
+  /**
+   * Book shipment pick up.
+   * @param resourceGroupName The Resource Group Name
+   * @param jobName The name of the job Resource within the specified resource group. job names must be
+   *                between 3 and 24 characters in length and use any alphanumeric and underscore only
+   * @param shipmentPickUpRequest Details of shipment pick up request.
+   * @param options The options parameters.
+   */
+  bookShipmentPickUp(
+    resourceGroupName: string,
+    jobName: string,
+    shipmentPickUpRequest: ShipmentPickUpRequest,
+    options?: JobsBookShipmentPickUpOptionalParams
+  ): Promise<JobsBookShipmentPickUpResponse>;
+  /**
+   * CancelJob.
+   * @param resourceGroupName The Resource Group Name
+   * @param jobName The name of the job Resource within the specified resource group. job names must be
+   *                between 3 and 24 characters in length and use any alphanumeric and underscore only
+   * @param cancellationReason Reason for cancellation.
+   * @param options The options parameters.
+   */
+  cancel(
+    resourceGroupName: string,
+    jobName: string,
+    cancellationReason: CancellationReason,
+    options?: JobsCancelOptionalParams
+  ): Promise<void>;
+}

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

package/src/operationsInterfaces/service.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 {
+  SkuInformation,
+  AvailableSkuRequest,
+  ServiceListAvailableSkusByResourceGroupOptionalParams,
+  ValidateAddress,
+  ServiceValidateAddressOptionalParams,
+  ServiceValidateAddressResponse,
+  ValidationRequestUnion,
+  ServiceValidateInputsByResourceGroupOptionalParams,
+  ServiceValidateInputsByResourceGroupResponse,
+  ServiceValidateInputsOptionalParams,
+  ServiceValidateInputsResponse,
+  RegionConfigurationRequest,
+  ServiceRegionConfigurationOptionalParams,
+  ServiceRegionConfigurationResponse,
+  ServiceRegionConfigurationByResourceGroupOptionalParams,
+  ServiceRegionConfigurationByResourceGroupResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Service. */
+export interface Service {
+  /**
+   * This method provides the list of available skus for the given subscription, resource group and
+   * location.
+   * @param resourceGroupName The Resource Group Name
+   * @param location The location of the resource
+   * @param availableSkuRequest Filters for showing the available skus.
+   * @param options The options parameters.
+   */
+  listAvailableSkusByResourceGroup(
+    resourceGroupName: string,
+    location: string,
+    availableSkuRequest: AvailableSkuRequest,
+    options?: ServiceListAvailableSkusByResourceGroupOptionalParams
+  ): PagedAsyncIterableIterator<SkuInformation>;
+  /**
+   * [DEPRECATED NOTICE: This operation will soon be removed]. This method validates the customer
+   * shipping address and provide alternate addresses if any.
+   * @param location The location of the resource
+   * @param validateAddress Shipping address of the customer.
+   * @param options The options parameters.
+   */
+  validateAddress(
+    location: string,
+    validateAddress: ValidateAddress,
+    options?: ServiceValidateAddressOptionalParams
+  ): Promise<ServiceValidateAddressResponse>;
+  /**
+   * This method does all necessary pre-job creation validation under resource group.
+   * @param resourceGroupName The Resource Group Name
+   * @param location The location of the resource
+   * @param validationRequest Inputs of the customer.
+   * @param options The options parameters.
+   */
+  validateInputsByResourceGroup(
+    resourceGroupName: string,
+    location: string,
+    validationRequest: ValidationRequestUnion,
+    options?: ServiceValidateInputsByResourceGroupOptionalParams
+  ): Promise<ServiceValidateInputsByResourceGroupResponse>;
+  /**
+   * This method does all necessary pre-job creation validation under subscription.
+   * @param location The location of the resource
+   * @param validationRequest Inputs of the customer.
+   * @param options The options parameters.
+   */
+  validateInputs(
+    location: string,
+    validationRequest: ValidationRequestUnion,
+    options?: ServiceValidateInputsOptionalParams
+  ): Promise<ServiceValidateInputsResponse>;
+  /**
+   * This API provides configuration details specific to given region/location at Subscription level.
+   * @param location The location of the resource
+   * @param regionConfigurationRequest Request body to get the configuration for the region.
+   * @param options The options parameters.
+   */
+  regionConfiguration(
+    location: string,
+    regionConfigurationRequest: RegionConfigurationRequest,
+    options?: ServiceRegionConfigurationOptionalParams
+  ): Promise<ServiceRegionConfigurationResponse>;
+  /**
+   * This API provides configuration details specific to given region/location at Resource group level.
+   * @param resourceGroupName The Resource Group Name
+   * @param location The location of the resource
+   * @param regionConfigurationRequest Request body to get the configuration for the region at resource
+   *                                   group level.
+   * @param options The options parameters.
+   */
+  regionConfigurationByResourceGroup(
+    resourceGroupName: string,
+    location: string,
+    regionConfigurationRequest: RegionConfigurationRequest,
+    options?: ServiceRegionConfigurationByResourceGroupOptionalParams
+  ): Promise<ServiceRegionConfigurationByResourceGroupResponse>;
+}

package/tsconfig.json

@@ -3,7 +3,7 @@
     "module": "es6",
     "moduleResolution": "node",
     "strict": true,
-    "target": "es5",
+    "target": "es6",
     "sourceMap": true,
     "declarationMap": true,
     "esModuleInterop": true,
@@ -11,9 +11,9 @@
     "forceConsistentCasingInFileNames": true,
     "lib": ["es6", "dom"],
     "declaration": true,
-    "outDir": "./esm",
+    "outDir": "./dist-esm",
     "importHelpers": true
   },
-  "include": ["./src/**/*.ts"],
+  "include": ["./src/**/*.ts", "./test/**/*.ts"],
   "exclude": ["node_modules"]
 }