@azure/arm-batch 9.1.1-alpha.20240313.1 → 9.2.0-alpha.20240321.2

package/src/operationsInterfaces/privateEndpointConnectionOperations.ts

@@ -16,7 +16,7 @@ import {
   PrivateEndpointConnectionUpdateOptionalParams,
   PrivateEndpointConnectionUpdateResponse,
   PrivateEndpointConnectionDeleteOptionalParams,
-  PrivateEndpointConnectionDeleteResponse
+  PrivateEndpointConnectionDeleteResponse,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -31,7 +31,7 @@ export interface PrivateEndpointConnectionOperations {
   listByBatchAccount(
     resourceGroupName: string,
     accountName: string,
-    options?: PrivateEndpointConnectionListByBatchAccountOptionalParams
+    options?: PrivateEndpointConnectionListByBatchAccountOptionalParams,
   ): PagedAsyncIterableIterator<PrivateEndpointConnection>;
   /**
    * Gets information about the specified private endpoint connection.
@@ -45,7 +45,7 @@ export interface PrivateEndpointConnectionOperations {
     resourceGroupName: string,
     accountName: string,
     privateEndpointConnectionName: string,
-    options?: PrivateEndpointConnectionGetOptionalParams
+    options?: PrivateEndpointConnectionGetOptionalParams,
   ): Promise<PrivateEndpointConnectionGetResponse>;
   /**
    * Updates the properties of an existing private endpoint connection.
@@ -62,7 +62,7 @@ export interface PrivateEndpointConnectionOperations {
     accountName: string,
     privateEndpointConnectionName: string,
     parameters: PrivateEndpointConnection,
-    options?: PrivateEndpointConnectionUpdateOptionalParams
+    options?: PrivateEndpointConnectionUpdateOptionalParams,
   ): Promise<
     SimplePollerLike<
       OperationState<PrivateEndpointConnectionUpdateResponse>,
@@ -84,7 +84,7 @@ export interface PrivateEndpointConnectionOperations {
     accountName: string,
     privateEndpointConnectionName: string,
     parameters: PrivateEndpointConnection,
-    options?: PrivateEndpointConnectionUpdateOptionalParams
+    options?: PrivateEndpointConnectionUpdateOptionalParams,
   ): Promise<PrivateEndpointConnectionUpdateResponse>;
   /**
    * Deletes the specified private endpoint connection.
@@ -98,7 +98,7 @@ export interface PrivateEndpointConnectionOperations {
     resourceGroupName: string,
     accountName: string,
     privateEndpointConnectionName: string,
-    options?: PrivateEndpointConnectionDeleteOptionalParams
+    options?: PrivateEndpointConnectionDeleteOptionalParams,
   ): Promise<
     SimplePollerLike<
       OperationState<PrivateEndpointConnectionDeleteResponse>,
@@ -117,6 +117,6 @@ export interface PrivateEndpointConnectionOperations {
     resourceGroupName: string,
     accountName: string,
     privateEndpointConnectionName: string,
-    options?: PrivateEndpointConnectionDeleteOptionalParams
+    options?: PrivateEndpointConnectionDeleteOptionalParams,
   ): Promise<PrivateEndpointConnectionDeleteResponse>;
 }

package/src/operationsInterfaces/privateLinkResourceOperations.ts

@@ -11,7 +11,7 @@ import {
   PrivateLinkResource,
   PrivateLinkResourceListByBatchAccountOptionalParams,
   PrivateLinkResourceGetOptionalParams,
-  PrivateLinkResourceGetResponse
+  PrivateLinkResourceGetResponse,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -26,7 +26,7 @@ export interface PrivateLinkResourceOperations {
   listByBatchAccount(
     resourceGroupName: string,
     accountName: string,
-    options?: PrivateLinkResourceListByBatchAccountOptionalParams
+    options?: PrivateLinkResourceListByBatchAccountOptionalParams,
   ): PagedAsyncIterableIterator<PrivateLinkResource>;
   /**
    * Gets information about the specified private link resource.
@@ -40,6 +40,6 @@ export interface PrivateLinkResourceOperations {
     resourceGroupName: string,
     accountName: string,
     privateLinkResourceName: string,
-    options?: PrivateLinkResourceGetOptionalParams
+    options?: PrivateLinkResourceGetOptionalParams,
   ): Promise<PrivateLinkResourceGetResponse>;
 }

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/types/arm-batch.d.ts

@@ -250,6 +250,18 @@ export declare type ApplicationUpdateResponse = Application;
 /** Defines values for AuthenticationMode. */
 export declare type AuthenticationMode = "SharedKey" | "AAD" | "TaskAuthenticationToken";
 
+/** The configuration parameters used for performing automatic OS upgrade. */
+export declare interface AutomaticOSUpgradePolicy {
+    /** Whether OS image rollback feature should be disabled. */
+    disableAutomaticRollback?: boolean;
+    /** Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. <br /><br /> If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/en-us/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true. */
+    enableAutomaticOSUpgrade?: boolean;
+    /** Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. */
+    useRollingUpgradePolicy?: boolean;
+    /** Defer OS upgrades on the TVMs if they are running tasks. */
+    osRollingUpgradeDeferral?: boolean;
+}
+
 /** The results and errors from an execution of a pool autoscale formula. */
 export declare interface AutoScaleRun {
     /** The time at which the autoscale formula was last evaluated. */
@@ -636,7 +648,7 @@ export declare interface BatchAccountOperations {
      * you must make sure your network allows outbound access to these endpoints. Failure to allow access
      * to these endpoints may cause Batch to mark the affected nodes as unusable. For more information
      * about creating a pool inside of a virtual network, see
-     * https://docs.microsoft.com/azure/batch/batch-virtual-network.
+     * https://docs.microsoft.com/en-us/azure/batch/batch-virtual-network.
      * @param resourceGroupName The name of the resource group that contains the Batch account.
      * @param accountName The name of the Batch account.
      * @param options The options parameters.
@@ -1916,6 +1928,8 @@ export declare interface Pool extends ProxyResource {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly currentNodeCommunicationMode?: NodeCommunicationMode;
+    /** Describes an upgrade policy - automatic, manual, or rolling. */
+    upgradePolicy?: UpgradePolicy;
     /** The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. */
     resourceTags?: {
         [propertyName: string]: string;
@@ -2483,6 +2497,24 @@ export declare interface ResourceFile {
 /** Defines values for ResourceIdentityType. */
 export declare type ResourceIdentityType = "SystemAssigned" | "UserAssigned" | "None";
 
+/** The configuration parameters used while performing a rolling upgrade. */
+export declare interface RollingUpgradePolicy {
+    /** Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. */
+    enableCrossZoneUpgrade?: boolean;
+    /** The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. */
+    maxBatchInstancePercent?: number;
+    /** The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. */
+    maxUnhealthyInstancePercent?: number;
+    /** The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. */
+    maxUnhealthyUpgradedInstancePercent?: number;
+    /** The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. */
+    pauseTimeBetweenBatches?: string;
+    /** Upgrade all unhealthy instances in a scale set before any healthy instances. */
+    prioritizeUnhealthyInstances?: boolean;
+    /** Rollback failed instances to previous model if the Rolling Upgrade policy is violated. */
+    rollbackFailedInstancesOnPolicyBreach?: boolean;
+}
+
 /** Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. */
 export declare interface ScaleSettings {
     /** This property and autoScale are mutually exclusive and one of the properties must be specified. */
@@ -2559,6 +2591,11 @@ export declare interface SupportedSku {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly capabilities?: SkuCapability[];
+    /**
+     * The time when Azure Batch service will retire this SKU.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly batchSupportEndOfLife?: Date;
 }
 
 /** The Batch List supported SKUs operation response. */
@@ -2598,6 +2635,19 @@ export declare interface UefiSettings {
     vTpmEnabled?: boolean;
 }
 
+/** Defines values for UpgradeMode. */
+export declare type UpgradeMode = "automatic" | "manual" | "rolling";
+
+/** Describes an upgrade policy - automatic, manual, or rolling. */
+export declare interface UpgradePolicy {
+    /** Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> **Manual** - You  control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> **Automatic** - All virtual machines in the scale set are automatically updated at the same time.<br /><br /> **Rolling** - Scale set performs updates in batches with an optional pause time in between. */
+    mode: UpgradeMode;
+    /** The configuration parameters used for performing automatic OS upgrade. */
+    automaticOSUpgradePolicy?: AutomaticOSUpgradePolicy;
+    /** This property is only supported on Pools with the virtualMachineConfiguration property. */
+    rollingUpgradePolicy?: RollingUpgradePolicy;
+}
+
 /** Properties used to create a user on an Azure Batch node. */
 export declare interface UserAccount {
     /** The name of the user account. Names can contain any Unicode characters up to a maximum length of 20. */

package/types/tsdoc-metadata.json

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