@azure/arm-storage 18.0.1-alpha.20221128.1 → 18.1.0

package/src/operations/tableOperations.ts

@@ -6,7 +6,8 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "../pagingHelper";
 import { TableOperations } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -16,6 +17,7 @@ import {
   Table,
   TableListNextOptionalParams,
   TableListOptionalParams,
+  TableListResponse,
   TableCreateOptionalParams,
   TableCreateResponse,
   TableUpdateOptionalParams,
@@ -23,7 +25,6 @@ import {
   TableGetOptionalParams,
   TableGetResponse,
   TableDeleteOptionalParams,
-  TableListResponse,
   TableListNextResponse
 } from "../models";
 
@@ -62,8 +63,16 @@ export class TableOperationsImpl implements TableOperations {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listPagingPage(resourceGroupName, accountName, options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listPagingPage(
+          resourceGroupName,
+          accountName,
+          options,
+          settings
+        );
       }
     };
   }
@@ -71,11 +80,18 @@ export class TableOperationsImpl implements TableOperations {
   private async *listPagingPage(
     resourceGroupName: string,
     accountName: string,
-    options?: TableListOptionalParams
+    options?: TableListOptionalParams,
+    settings?: PageSettings
   ): AsyncIterableIterator<Table[]> {
-    let result = await this._list(resourceGroupName, accountName, options);
-    yield result.value || [];
-    let continuationToken = result.nextLink;
+    let result: TableListResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._list(resourceGroupName, accountName, options);
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
     while (continuationToken) {
       result = await this._listNext(
         resourceGroupName,
@@ -84,7 +100,9 @@ export class TableOperationsImpl implements TableOperations {
         options
       );
       continuationToken = result.nextLink;
-      yield result.value || [];
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
     }
   }
 

package/src/operations/usages.ts

@@ -6,7 +6,7 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
 import { Usages } from "../operationsInterfaces";
 import * as coreClient from "@azure/core-client";
 import * as Mappers from "../models/mappers";
@@ -48,17 +48,22 @@ export class UsagesImpl implements Usages {
       [Symbol.asyncIterator]() {
         return this;
       },
-      byPage: () => {
-        return this.listByLocationPagingPage(location, options);
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listByLocationPagingPage(location, options, settings);
       }
     };
   }
 
   private async *listByLocationPagingPage(
     location: string,
-    options?: UsagesListByLocationOptionalParams
+    options?: UsagesListByLocationOptionalParams,
+    _settings?: PageSettings
   ): AsyncIterableIterator<Usage[]> {
-    let result = await this._listByLocation(location, options);
+    let result: UsagesListByLocationResponse;
+    result = await this._listByLocation(location, options);
     yield result.value || [];
   }
 

package/src/operationsInterfaces/storageAccounts.ts

@@ -236,9 +236,16 @@ export interface StorageAccounts {
     options?: StorageAccountsListServiceSASOptionalParams
   ): Promise<StorageAccountsListServiceSASResponse>;
   /**
-   * Failover request can be triggered for a storage account in case of availability issues. The failover
-   * occurs from the storage account's primary cluster to secondary cluster for RA-GRS accounts. The
-   * secondary cluster will become primary after failover.
+   * A failover request can be triggered for a storage account in the event a primary endpoint becomes
+   * unavailable for any reason. The failover occurs from the storage account's primary cluster to the
+   * secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and
+   * the account is converted to LRS. In the case of a Planned Failover, the primary and secondary
+   * clusters are swapped after failover and the account remains geo-replicated. Failover should continue
+   * to be used in the event of availability issues as Planned failover is only available while the
+   * primary and secondary endpoints are available. The primary use case of a Planned Failover is
+   * disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter
+   * to 'Planned'. Learn more about the failover options here-
+   * https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidanceS
    * @param resourceGroupName The name of the resource group within the user's subscription. The name is
    *                          case insensitive.
    * @param accountName The name of the storage account within the specified resource group. Storage
@@ -252,9 +259,16 @@ export interface StorageAccounts {
     options?: StorageAccountsFailoverOptionalParams
   ): Promise<PollerLike<PollOperationState<void>, void>>;
   /**
-   * Failover request can be triggered for a storage account in case of availability issues. The failover
-   * occurs from the storage account's primary cluster to secondary cluster for RA-GRS accounts. The
-   * secondary cluster will become primary after failover.
+   * A failover request can be triggered for a storage account in the event a primary endpoint becomes
+   * unavailable for any reason. The failover occurs from the storage account's primary cluster to the
+   * secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and
+   * the account is converted to LRS. In the case of a Planned Failover, the primary and secondary
+   * clusters are swapped after failover and the account remains geo-replicated. Failover should continue
+   * to be used in the event of availability issues as Planned failover is only available while the
+   * primary and secondary endpoints are available. The primary use case of a Planned Failover is
+   * disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter
+   * to 'Planned'. Learn more about the failover options here-
+   * https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance
    * @param resourceGroupName The name of the resource group within the user's subscription. The name is
    *                          case insensitive.
    * @param accountName The name of the storage account within the specified resource group. Storage

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 a result page from a pageable operation, returns a
+ * continuation token that can be used to begin paging from
+ * that point later.
+ * @param page A result object from calling .byPage() on a paged operation.
+ * @returns The continuation token that can be passed into byPage().
+ */
+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/src/storageManagementClient.ts

@@ -92,22 +92,19 @@ export class StorageManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-storage/18.0.1`;
+    const packageDetails = `azsdk-js-arm-storage/18.1.0`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
         : `${packageDetails}`;
 
-    if (!options.credentialScopes) {
-      options.credentialScopes = ["https://management.azure.com/.default"];
-    }
     const optionsWithDefaults = {
       ...defaults,
       ...options,
       userAgentOptions: {
         userAgentPrefix
       },
-      baseUri:
+      endpoint:
         options.endpoint ?? options.baseUri ?? "https://management.azure.com"
     };
     super(optionsWithDefaults);
@@ -133,7 +130,9 @@ export class StorageManagementClient extends coreClient.ServiceClient {
       this.pipeline.addPolicy(
         coreRestPipeline.bearerTokenAuthenticationPolicy({
           credential: credentials,
-          scopes: `${optionsWithDefaults.credentialScopes}`,
+          scopes:
+            optionsWithDefaults.credentialScopes ??
+            `${optionsWithDefaults.endpoint}/.default`,
           challengeCallbacks: {
             authorizeRequestOnChallenge:
               coreClient.authorizeRequestOnClaimChallenge
@@ -146,7 +145,7 @@ export class StorageManagementClient extends coreClient.ServiceClient {
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2022-05-01";
+    this.apiVersion = options.apiVersion || "2022-09-01";
     this.operations = new OperationsImpl(this);
     this.skus = new SkusImpl(this);
     this.storageAccounts = new StorageAccountsImpl(this);

package/types/arm-storage.d.ts

@@ -554,10 +554,10 @@ export declare type BlobContainersLeaseResponse = LeaseContainerResponse;
 
 /** Optional parameters. */
 export declare interface BlobContainersListNextOptionalParams extends coreClient.OperationOptions {
-    /** Optional. Specified maximum number of containers that can be included in the list. */
-    maxpagesize?: string;
     /** Optional. When specified, only container names starting with the filter will be listed. */
     filter?: string;
+    /** Optional. Specified maximum number of containers that can be included in the list. */
+    maxpagesize?: string;
     /** Optional, used to include the properties for soft deleted blob containers. */
     include?: ListContainersInclude;
 }
@@ -567,10 +567,10 @@ export declare type BlobContainersListNextResponse = ListContainerItems;
 
 /** Optional parameters. */
 export declare interface BlobContainersListOptionalParams extends coreClient.OperationOptions {
-    /** Optional. Specified maximum number of containers that can be included in the list. */
-    maxpagesize?: string;
     /** Optional. When specified, only container names starting with the filter will be listed. */
     filter?: string;
+    /** Optional. Specified maximum number of containers that can be included in the list. */
+    maxpagesize?: string;
     /** Optional, used to include the properties for soft deleted blob containers. */
     include?: ListContainersInclude;
 }
@@ -1330,6 +1330,12 @@ export declare type EncryptionScopesGetResponse = EncryptionScope;
 
 /** Optional parameters. */
 export declare interface EncryptionScopesListNextOptionalParams extends coreClient.OperationOptions {
+    /** Optional, specifies the maximum number of encryption scopes that will be included in the list response. */
+    maxpagesize?: number;
+    /** Optional. When specified, only encryption scope names starting with the filter will be listed. */
+    filter?: string;
+    /** Optional, when specified, will list encryption scopes with the specific state. Defaults to All */
+    include?: ListEncryptionScopesInclude;
 }
 
 /** Contains response data for the listNext operation. */
@@ -1337,6 +1343,12 @@ export declare type EncryptionScopesListNextResponse = EncryptionScopeListResult
 
 /** Optional parameters. */
 export declare interface EncryptionScopesListOptionalParams extends coreClient.OperationOptions {
+    /** Optional, specifies the maximum number of encryption scopes that will be included in the list response. */
+    maxpagesize?: number;
+    /** Optional. When specified, only encryption scope names starting with the filter will be listed. */
+    filter?: string;
+    /** Optional, when specified, will list encryption scopes with the specific state. Defaults to All */
+    include?: ListEncryptionScopesInclude;
 }
 
 /** Contains response data for the list operation. */
@@ -1877,10 +1889,10 @@ export declare type FileSharesLeaseResponse = FileSharesLeaseHeaders & LeaseShar
 
 /** Optional parameters. */
 export declare interface FileSharesListNextOptionalParams extends coreClient.OperationOptions {
-    /** Optional. Specified maximum number of shares that can be included in the list. */
-    maxpagesize?: string;
     /** Optional. When specified, only share names starting with the filter will be listed. */
     filter?: string;
+    /** Optional. Specified maximum number of shares that can be included in the list. */
+    maxpagesize?: string;
     /** Optional, used to expand the properties within share's properties. Valid values are: deleted, snapshots. Should be passed as a string with delimiter ',' */
     expand?: string;
 }
@@ -1890,10 +1902,10 @@ export declare type FileSharesListNextResponse = FileShareItems;
 
 /** Optional parameters. */
 export declare interface FileSharesListOptionalParams extends coreClient.OperationOptions {
-    /** Optional. Specified maximum number of shares that can be included in the list. */
-    maxpagesize?: string;
     /** Optional. When specified, only share names starting with the filter will be listed. */
     filter?: string;
+    /** Optional. Specified maximum number of shares that can be included in the list. */
+    maxpagesize?: string;
     /** Optional, used to expand the properties within share's properties. Valid values are: deleted, snapshots. Should be passed as a string with delimiter ',' */
     expand?: string;
 }
@@ -1952,6 +1964,15 @@ export declare interface GeoReplicationStats {
  */
 export declare type GeoReplicationStatus = string;
 
+/**
+ * Given a result page from a pageable operation, returns a
+ * continuation token that can be used to begin paging from
+ * that point later.
+ * @param page A result object from calling .byPage() on a paged operation.
+ * @returns The continuation token that can be passed into byPage().
+ */
+export declare function getContinuationToken(page: unknown): string | undefined;
+
 /** Defines values for HttpProtocol. */
 export declare type HttpProtocol = "https,http" | "https";
 
@@ -2473,6 +2494,16 @@ export declare enum KnownListContainersInclude {
     Deleted = "deleted"
 }
 
+/** Known values of {@link ListEncryptionScopesInclude} that the service accepts. */
+export declare enum KnownListEncryptionScopesInclude {
+    /** All */
+    All = "All",
+    /** Enabled */
+    Enabled = "Enabled",
+    /** Disabled */
+    Disabled = "Disabled"
+}
+
 /** Known values of {@link ManagementPolicyName} that the service accepts. */
 export declare enum KnownManagementPolicyName {
     /** Default */
@@ -2963,6 +2994,17 @@ export declare interface ListContainerItems {
  */
 export declare type ListContainersInclude = string;
 
+/**
+ * Defines values for ListEncryptionScopesInclude. \
+ * {@link KnownListEncryptionScopesInclude} can be used interchangeably with ListEncryptionScopesInclude,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **All** \
+ * **Enabled** \
+ * **Disabled**
+ */
+export declare type ListEncryptionScopesInclude = string;
+
 export declare interface ListQueue extends Resource {
     /** A name-value pair that represents queue metadata. */
     metadata?: {
@@ -3271,10 +3313,14 @@ export declare interface ManagementPolicyAction {
 
 /** Management policy action for base blob. */
 export declare interface ManagementPolicyBaseBlob {
-    /** The function to tier blobs to cool storage. Support blobs currently at Hot tier */
+    /** The function to tier blobs to cool storage. */
     tierToCool?: DateAfterModification;
-    /** The function to tier blobs to archive storage. Support blobs currently at Hot or Cool tier */
+    /** The function to tier blobs to archive storage. */
     tierToArchive?: DateAfterModification;
+    /** The function to tier blobs to cold storage. */
+    tierToCold?: DateAfterModification;
+    /** The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts */
+    tierToHot?: DateAfterModification;
     /** The function to delete the blob */
     delete?: DateAfterModification;
     /** This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. */
@@ -3328,20 +3374,28 @@ export declare interface ManagementPolicySchema {
 
 /** Management policy action for snapshot. */
 export declare interface ManagementPolicySnapShot {
-    /** The function to tier blob snapshot to cool storage. Support blob snapshot currently at Hot tier */
+    /** The function to tier blob snapshot to cool storage. */
     tierToCool?: DateAfterCreation;
-    /** The function to tier blob snapshot to archive storage. Support blob snapshot currently at Hot or Cool tier */
+    /** The function to tier blob snapshot to archive storage. */
     tierToArchive?: DateAfterCreation;
+    /** The function to tier blobs to cold storage. */
+    tierToCold?: DateAfterCreation;
+    /** The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts */
+    tierToHot?: DateAfterCreation;
     /** The function to delete the blob snapshot */
     delete?: DateAfterCreation;
 }
 
 /** Management policy action for blob version. */
 export declare interface ManagementPolicyVersion {
-    /** The function to tier blob version to cool storage. Support blob version currently at Hot tier */
+    /** The function to tier blob version to cool storage. */
     tierToCool?: DateAfterCreation;
-    /** The function to tier blob version to archive storage. Support blob version currently at Hot or Cool tier */
+    /** The function to tier blob version to archive storage. */
     tierToArchive?: DateAfterCreation;
+    /** The function to tier blobs to cold storage. */
+    tierToCold?: DateAfterCreation;
+    /** The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts */
+    tierToHot?: DateAfterCreation;
     /** The function to delete the blob version */
     delete?: DateAfterCreation;
 }
@@ -3934,10 +3988,10 @@ export declare type QueueGetResponse = StorageQueue;
 
 /** Optional parameters. */
 export declare interface QueueListNextOptionalParams extends coreClient.OperationOptions {
-    /** Optional, a maximum number of queues that should be included in a list queue response */
-    maxpagesize?: string;
     /** Optional, When specified, only the queues with a name starting with the given filter will be listed. */
     filter?: string;
+    /** Optional, a maximum number of queues that should be included in a list queue response */
+    maxpagesize?: string;
 }
 
 /** Contains response data for the listNext operation. */
@@ -3945,10 +3999,10 @@ export declare type QueueListNextResponse = ListQueueResource;
 
 /** Optional parameters. */
 export declare interface QueueListOptionalParams extends coreClient.OperationOptions {
-    /** Optional, a maximum number of queues that should be included in a list queue response */
-    maxpagesize?: string;
     /** Optional, When specified, only the queues with a name starting with the given filter will be listed. */
     filter?: string;
+    /** Optional, a maximum number of queues that should be included in a list queue response */
+    maxpagesize?: string;
 }
 
 /** Contains response data for the list operation. */
@@ -4872,9 +4926,16 @@ export declare interface StorageAccounts {
      */
     listServiceSAS(resourceGroupName: string, accountName: string, parameters: ServiceSasParameters, options?: StorageAccountsListServiceSASOptionalParams): Promise<StorageAccountsListServiceSASResponse>;
     /**
-     * Failover request can be triggered for a storage account in case of availability issues. The failover
-     * occurs from the storage account's primary cluster to secondary cluster for RA-GRS accounts. The
-     * secondary cluster will become primary after failover.
+     * A failover request can be triggered for a storage account in the event a primary endpoint becomes
+     * unavailable for any reason. The failover occurs from the storage account's primary cluster to the
+     * secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and
+     * the account is converted to LRS. In the case of a Planned Failover, the primary and secondary
+     * clusters are swapped after failover and the account remains geo-replicated. Failover should continue
+     * to be used in the event of availability issues as Planned failover is only available while the
+     * primary and secondary endpoints are available. The primary use case of a Planned Failover is
+     * disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter
+     * to 'Planned'. Learn more about the failover options here-
+     * https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidanceS
      * @param resourceGroupName The name of the resource group within the user's subscription. The name is
      *                          case insensitive.
      * @param accountName The name of the storage account within the specified resource group. Storage
@@ -4884,9 +4945,16 @@ export declare interface StorageAccounts {
      */
     beginFailover(resourceGroupName: string, accountName: string, options?: StorageAccountsFailoverOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
     /**
-     * Failover request can be triggered for a storage account in case of availability issues. The failover
-     * occurs from the storage account's primary cluster to secondary cluster for RA-GRS accounts. The
-     * secondary cluster will become primary after failover.
+     * A failover request can be triggered for a storage account in the event a primary endpoint becomes
+     * unavailable for any reason. The failover occurs from the storage account's primary cluster to the
+     * secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and
+     * the account is converted to LRS. In the case of a Planned Failover, the primary and secondary
+     * clusters are swapped after failover and the account remains geo-replicated. Failover should continue
+     * to be used in the event of availability issues as Planned failover is only available while the
+     * primary and secondary endpoints are available. The primary use case of a Planned Failover is
+     * disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter
+     * to 'Planned'. Learn more about the failover options here-
+     * https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance
      * @param resourceGroupName The name of the resource group within the user's subscription. The name is
      *                          case insensitive.
      * @param accountName The name of the storage account within the specified resource group. Storage