@azure/arm-storagemover 2.0.1-alpha.20240419.1 → 2.1.0

package/src/operationsInterfaces/jobRuns.ts

@@ -11,7 +11,7 @@ import {
   JobRun,
   JobRunsListOptionalParams,
   JobRunsGetOptionalParams,
-  JobRunsGetResponse
+  JobRunsGetResponse,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -30,7 +30,7 @@ export interface JobRuns {
     storageMoverName: string,
     projectName: string,
     jobDefinitionName: string,
-    options?: JobRunsListOptionalParams
+    options?: JobRunsListOptionalParams,
   ): PagedAsyncIterableIterator<JobRun>;
   /**
    * Gets a Job Run resource.
@@ -47,6 +47,6 @@ export interface JobRuns {
     projectName: string,
     jobDefinitionName: string,
     jobRunName: string,
-    options?: JobRunsGetOptionalParams
+    options?: JobRunsGetOptionalParams,
   ): Promise<JobRunsGetResponse>;
 }

package/src/operationsInterfaces/operations.ts

@@ -17,6 +17,6 @@ export interface Operations {
    * @param options The options parameters.
    */
   list(
-    options?: OperationsListOptionalParams
+    options?: OperationsListOptionalParams,
   ): PagedAsyncIterableIterator<Operation>;
 }

package/src/operationsInterfaces/projects.ts

@@ -18,7 +18,7 @@ import {
   ProjectUpdateParameters,
   ProjectsUpdateOptionalParams,
   ProjectsUpdateResponse,
-  ProjectsDeleteOptionalParams
+  ProjectsDeleteOptionalParams,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -33,7 +33,7 @@ export interface Projects {
   list(
     resourceGroupName: string,
     storageMoverName: string,
-    options?: ProjectsListOptionalParams
+    options?: ProjectsListOptionalParams,
   ): PagedAsyncIterableIterator<Project>;
   /**
    * Gets a Project resource.
@@ -46,7 +46,7 @@ export interface Projects {
     resourceGroupName: string,
     storageMoverName: string,
     projectName: string,
-    options?: ProjectsGetOptionalParams
+    options?: ProjectsGetOptionalParams,
   ): Promise<ProjectsGetResponse>;
   /**
    * Creates or updates a Project resource, which is a logical grouping of related jobs.
@@ -61,7 +61,7 @@ export interface Projects {
     storageMoverName: string,
     projectName: string,
     project: Project,
-    options?: ProjectsCreateOrUpdateOptionalParams
+    options?: ProjectsCreateOrUpdateOptionalParams,
   ): Promise<ProjectsCreateOrUpdateResponse>;
   /**
    * Updates properties for a Project resource. Properties not specified in the request body will be
@@ -77,7 +77,7 @@ export interface Projects {
     storageMoverName: string,
     projectName: string,
     project: ProjectUpdateParameters,
-    options?: ProjectsUpdateOptionalParams
+    options?: ProjectsUpdateOptionalParams,
   ): Promise<ProjectsUpdateResponse>;
   /**
    * Deletes a Project resource.
@@ -90,7 +90,7 @@ export interface Projects {
     resourceGroupName: string,
     storageMoverName: string,
     projectName: string,
-    options?: ProjectsDeleteOptionalParams
+    options?: ProjectsDeleteOptionalParams,
   ): Promise<SimplePollerLike<OperationState<void>, void>>;
   /**
    * Deletes a Project resource.
@@ -103,6 +103,6 @@ export interface Projects {
     resourceGroupName: string,
     storageMoverName: string,
     projectName: string,
-    options?: ProjectsDeleteOptionalParams
+    options?: ProjectsDeleteOptionalParams,
   ): Promise<void>;
 }

package/src/operationsInterfaces/storageMovers.ts

@@ -19,7 +19,7 @@ import {
   StorageMoverUpdateParameters,
   StorageMoversUpdateOptionalParams,
   StorageMoversUpdateResponse,
-  StorageMoversDeleteOptionalParams
+  StorageMoversDeleteOptionalParams,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -30,7 +30,7 @@ export interface StorageMovers {
    * @param options The options parameters.
    */
   listBySubscription(
-    options?: StorageMoversListBySubscriptionOptionalParams
+    options?: StorageMoversListBySubscriptionOptionalParams,
   ): PagedAsyncIterableIterator<StorageMover>;
   /**
    * Lists all Storage Movers in a resource group.
@@ -39,7 +39,7 @@ export interface StorageMovers {
    */
   list(
     resourceGroupName: string,
-    options?: StorageMoversListOptionalParams
+    options?: StorageMoversListOptionalParams,
   ): PagedAsyncIterableIterator<StorageMover>;
   /**
    * Gets a Storage Mover resource.
@@ -50,7 +50,7 @@ export interface StorageMovers {
   get(
     resourceGroupName: string,
     storageMoverName: string,
-    options?: StorageMoversGetOptionalParams
+    options?: StorageMoversGetOptionalParams,
   ): Promise<StorageMoversGetResponse>;
   /**
    * Creates or updates a top-level Storage Mover resource.
@@ -64,7 +64,7 @@ export interface StorageMovers {
     resourceGroupName: string,
     storageMoverName: string,
     storageMover: StorageMover,
-    options?: StorageMoversCreateOrUpdateOptionalParams
+    options?: StorageMoversCreateOrUpdateOptionalParams,
   ): Promise<StorageMoversCreateOrUpdateResponse>;
   /**
    * Updates properties for a Storage Mover resource. Properties not specified in the request body will
@@ -78,7 +78,7 @@ export interface StorageMovers {
     resourceGroupName: string,
     storageMoverName: string,
     storageMover: StorageMoverUpdateParameters,
-    options?: StorageMoversUpdateOptionalParams
+    options?: StorageMoversUpdateOptionalParams,
   ): Promise<StorageMoversUpdateResponse>;
   /**
    * Deletes a Storage Mover resource.
@@ -89,7 +89,7 @@ export interface StorageMovers {
   beginDelete(
     resourceGroupName: string,
     storageMoverName: string,
-    options?: StorageMoversDeleteOptionalParams
+    options?: StorageMoversDeleteOptionalParams,
   ): Promise<SimplePollerLike<OperationState<void>, void>>;
   /**
    * Deletes a Storage Mover resource.
@@ -100,6 +100,6 @@ export interface StorageMovers {
   beginDeleteAndWait(
     resourceGroupName: string,
     storageMoverName: string,
-    options?: StorageMoversDeleteOptionalParams
+    options?: StorageMoversDeleteOptionalParams,
   ): Promise<void>;
 }

package/src/pagingHelper.ts

@@ -28,7 +28,7 @@ export function getContinuationToken(page: unknown): string | undefined {
 
 export function setContinuationToken(
   page: unknown,
-  continuationToken: string | undefined
+  continuationToken: string | undefined,
 ): void {
   if (typeof page !== "object" || page === null || !continuationToken) {
     return;

package/src/storageMoverClient.ts

@@ -11,7 +11,7 @@ import * as coreRestPipeline from "@azure/core-rest-pipeline";
 import {
   PipelineRequest,
   PipelineResponse,
-  SendRequest
+  SendRequest,
 } from "@azure/core-rest-pipeline";
 import * as coreAuth from "@azure/core-auth";
 import {
@@ -21,7 +21,7 @@ import {
   EndpointsImpl,
   ProjectsImpl,
   JobDefinitionsImpl,
-  JobRunsImpl
+  JobRunsImpl,
 } from "./operations";
 import {
   Operations,
@@ -30,7 +30,7 @@ import {
   Endpoints,
   Projects,
   JobDefinitions,
-  JobRuns
+  JobRuns,
 } from "./operationsInterfaces";
 import { StorageMoverClientOptionalParams } from "./models";
 
@@ -48,7 +48,7 @@ export class StorageMoverClient extends coreClient.ServiceClient {
   constructor(
     credentials: coreAuth.TokenCredential,
     subscriptionId: string,
-    options?: StorageMoverClientOptionalParams
+    options?: StorageMoverClientOptionalParams,
   ) {
     if (credentials === undefined) {
       throw new Error("'credentials' cannot be null");
@@ -63,10 +63,10 @@ export class StorageMoverClient extends coreClient.ServiceClient {
     }
     const defaults: StorageMoverClientOptionalParams = {
       requestContentType: "application/json; charset=utf-8",
-      credential: credentials
+      credential: credentials,
     };
 
-    const packageDetails = `azsdk-js-arm-storagemover/2.0.1`;
+    const packageDetails = `azsdk-js-arm-storagemover/2.1.0`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -76,20 +76,21 @@ export class StorageMoverClient extends coreClient.ServiceClient {
       ...defaults,
       ...options,
       userAgentOptions: {
-        userAgentPrefix
+        userAgentPrefix,
       },
       endpoint:
-        options.endpoint ?? options.baseUri ?? "https://management.azure.com"
+        options.endpoint ?? options.baseUri ?? "https://management.azure.com",
     };
     super(optionsWithDefaults);
 
     let bearerTokenAuthenticationPolicyFound: boolean = false;
     if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
-      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
+      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] =
+        options.pipeline.getOrderedPolicies();
       bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
         (pipelinePolicy) =>
           pipelinePolicy.name ===
-          coreRestPipeline.bearerTokenAuthenticationPolicyName
+          coreRestPipeline.bearerTokenAuthenticationPolicyName,
       );
     }
     if (
@@ -99,7 +100,7 @@ export class StorageMoverClient extends coreClient.ServiceClient {
       !bearerTokenAuthenticationPolicyFound
     ) {
       this.pipeline.removePolicy({
-        name: coreRestPipeline.bearerTokenAuthenticationPolicyName
+        name: coreRestPipeline.bearerTokenAuthenticationPolicyName,
       });
       this.pipeline.addPolicy(
         coreRestPipeline.bearerTokenAuthenticationPolicy({
@@ -109,9 +110,9 @@ export class StorageMoverClient extends coreClient.ServiceClient {
             `${optionsWithDefaults.endpoint}/.default`,
           challengeCallbacks: {
             authorizeRequestOnChallenge:
-              coreClient.authorizeRequestOnClaimChallenge
-          }
-        })
+              coreClient.authorizeRequestOnClaimChallenge,
+          },
+        }),
       );
     }
     // Parameter assignments
@@ -119,7 +120,7 @@ export class StorageMoverClient extends coreClient.ServiceClient {
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2023-10-01";
+    this.apiVersion = options.apiVersion || "2024-07-01";
     this.operations = new OperationsImpl(this);
     this.storageMovers = new StorageMoversImpl(this);
     this.agents = new AgentsImpl(this);
@@ -139,7 +140,7 @@ export class StorageMoverClient extends coreClient.ServiceClient {
       name: "CustomApiVersionPolicy",
       async sendRequest(
         request: PipelineRequest,
-        next: SendRequest
+        next: SendRequest,
       ): Promise<PipelineResponse> {
         const param = request.url.split("?");
         if (param.length > 1) {
@@ -153,7 +154,7 @@ export class StorageMoverClient extends coreClient.ServiceClient {
           request.url = param[0] + "?" + newParams.join("&");
         }
         return next(request);
-      }
+      },
     };
     this.pipeline.addPolicy(apiVersionPolicy);
   }

package/types/arm-storagemover.d.ts

@@ -56,6 +56,13 @@ export declare interface Agent extends ProxyResource {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly uptimeInSeconds?: number;
+    /**
+     * The agent's local time zone represented in Windows format.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly timeZone?: string;
+    /** The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent's local time. */
+    uploadLimitSchedule?: UploadLimitSchedule;
     /** NOTE: This property will not be serialized. It can only be populated by the server. */
     readonly errorDetails?: AgentPropertiesErrorDetails;
     /**
@@ -197,6 +204,8 @@ export declare type AgentsUpdateResponse = Agent;
 export declare interface AgentUpdateParameters {
     /** A description for the Agent. */
     description?: string;
+    /** The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent's local time. */
+    uploadLimitSchedule?: UploadLimitSchedule;
 }
 
 /** The Azure Key Vault secret URIs which store the credentials. */
@@ -279,6 +288,9 @@ export declare type CredentialsUnion = Credentials | AzureKeyVaultSmbCredentials
  */
 export declare type CredentialType = string;
 
+/** Defines values for DayOfWeek. */
+export declare type DayOfWeek = "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday";
+
 /** The Endpoint resource, which contains information about file sources and targets. */
 export declare interface Endpoint extends ProxyResource {
     /** The resource specific properties for the Storage Mover resource. */
@@ -618,7 +630,8 @@ export declare interface JobDefinitions {
      */
     beginDeleteAndWait(resourceGroupName: string, storageMoverName: string, projectName: string, jobDefinitionName: string, options?: JobDefinitionsDeleteOptionalParams): Promise<void>;
     /**
-     * Requests an Agent to start a new instance of this Job Definition, generating a new Job Run resource.
+     * Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for
+     * execution.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param storageMoverName The name of the Storage Mover resource.
      * @param projectName The name of the Project resource.
@@ -945,7 +958,8 @@ export declare type JobRunsListResponse = JobRunList;
  * **Canceling** \
  * **Canceled** \
  * **Failed** \
- * **Succeeded**
+ * **Succeeded** \
+ * **PausedByBandwidthManagement**
  */
 export declare type JobRunStatus = string;
 
@@ -1036,7 +1050,17 @@ export declare enum KnownJobRunStatus {
     /** Failed */
     Failed = "Failed",
     /** Succeeded */
-    Succeeded = "Succeeded"
+    Succeeded = "Succeeded",
+    /** PausedByBandwidthManagement */
+    PausedByBandwidthManagement = "PausedByBandwidthManagement"
+}
+
+/** Known values of {@link Minute} that the service accepts. */
+export declare enum KnownMinute {
+    /** Zero */
+    Zero = 0,
+    /** Thirty */
+    Thirty = 30
 }
 
 /** Known values of {@link NfsVersion} that the service accepts. */
@@ -1062,9 +1086,25 @@ export declare enum KnownOrigin {
 /** Known values of {@link ProvisioningState} that the service accepts. */
 export declare enum KnownProvisioningState {
     /** Succeeded */
-    Succeeded = "Succeeded"
+    Succeeded = "Succeeded",
+    /** Canceled */
+    Canceled = "Canceled",
+    /** Failed */
+    Failed = "Failed",
+    /** Deleting */
+    Deleting = "Deleting"
 }
 
+/**
+ * Defines values for Minute. \
+ * {@link KnownMinute} can be used interchangeably with Minute,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **0** \
+ * **30**
+ */
+export declare type Minute = number;
+
 /** The properties of NFS share endpoint. */
 export declare interface NfsMountEndpointProperties extends EndpointBaseProperties {
     /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -1321,7 +1361,10 @@ export declare interface ProjectUpdateParameters {
  * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
  *  this enum contains the known values that the service supports.
  * ### Known values supported by the service
- * **Succeeded**
+ * **Succeeded** \
+ * **Canceled** \
+ * **Failed** \
+ * **Deleting**
  */
 export declare type ProvisioningState = string;
 
@@ -1329,6 +1372,14 @@ export declare type ProvisioningState = string;
 export declare interface ProxyResource extends Resource {
 }
 
+/** The schedule recurrence. */
+export declare interface Recurrence {
+    /** The start time of the schedule recurrence. Full hour and 30-minute intervals are supported. */
+    startTime: Time;
+    /** The end time of the schedule recurrence. Full hour and 30-minute intervals are supported. */
+    endTime: Time;
+}
+
 /** Common fields that are returned in the response for all Azure Resource Manager resources */
 export declare interface Resource {
     /**
@@ -1564,6 +1615,14 @@ export declare interface SystemData {
     lastModifiedAt?: Date;
 }
 
+/** The time of day. */
+export declare interface Time {
+    /** The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0. */
+    hour: number;
+    /** The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0. */
+    minute?: Minute;
+}
+
 /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
 export declare interface TrackedResource extends Resource {
     /** Resource tags. */
@@ -1574,4 +1633,26 @@ export declare interface TrackedResource extends Resource {
     location: string;
 }
 
+/** The WAN-link upload limit. */
+export declare interface UploadLimit {
+    /** The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary. */
+    limitInMbps: number;
+}
+
+/** The WAN-link upload limit schedule. Overlapping recurrences are not allowed. */
+export declare interface UploadLimitSchedule {
+    /** The set of weekly repeating recurrences of the WAN-link upload limit schedule. */
+    weeklyRecurrences?: UploadLimitWeeklyRecurrence[];
+}
+
+/** The weekly recurrence of the WAN-link upload limit schedule. The start time must be earlier in the day than the end time. The recurrence must not span across multiple days. */
+export declare interface UploadLimitWeeklyRecurrence extends WeeklyRecurrence, UploadLimit {
+}
+
+/** The weekly recurrence of the schedule. */
+export declare interface WeeklyRecurrence extends Recurrence {
+    /** The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence. */
+    days: DayOfWeek[];
+}
+
 export { }

package/types/tsdoc-metadata.json

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