@azure/arm-redisenterprisecache 2.1.1-alpha.20221128.1 → 2.2.0

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 the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
+ * that point later.
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
+ */
+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/redisEnterpriseManagementClient.ts

@@ -7,6 +7,12 @@
  */
 
 import * as coreClient from "@azure/core-client";
+import * as coreRestPipeline from "@azure/core-rest-pipeline";
+import {
+  PipelineRequest,
+  PipelineResponse,
+  SendRequest
+} from "@azure/core-rest-pipeline";
 import * as coreAuth from "@azure/core-auth";
 import {
   OperationsImpl,
@@ -58,25 +64,54 @@ export class RedisEnterpriseManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-redisenterprisecache/2.1.1`;
+    const packageDetails = `azsdk-js-arm-redisenterprisecache/2.2.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);
+
+    let bearerTokenAuthenticationPolicyFound: boolean = false;
+    if (options?.pipeline && options.pipeline.getOrderedPolicies().length > 0) {
+      const pipelinePolicies: coreRestPipeline.PipelinePolicy[] = options.pipeline.getOrderedPolicies();
+      bearerTokenAuthenticationPolicyFound = pipelinePolicies.some(
+        (pipelinePolicy) =>
+          pipelinePolicy.name ===
+          coreRestPipeline.bearerTokenAuthenticationPolicyName
+      );
+    }
+    if (
+      !options ||
+      !options.pipeline ||
+      options.pipeline.getOrderedPolicies().length == 0 ||
+      !bearerTokenAuthenticationPolicyFound
+    ) {
+      this.pipeline.removePolicy({
+        name: coreRestPipeline.bearerTokenAuthenticationPolicyName
+      });
+      this.pipeline.addPolicy(
+        coreRestPipeline.bearerTokenAuthenticationPolicy({
+          credential: credentials,
+          scopes:
+            optionsWithDefaults.credentialScopes ??
+            `${optionsWithDefaults.endpoint}/.default`,
+          challengeCallbacks: {
+            authorizeRequestOnChallenge:
+              coreClient.authorizeRequestOnClaimChallenge
+          }
+        })
+      );
+    }
     // Parameter assignments
     this.subscriptionId = subscriptionId;
 
@@ -89,6 +124,35 @@ export class RedisEnterpriseManagementClient extends coreClient.ServiceClient {
     this.databases = new DatabasesImpl(this);
     this.privateEndpointConnections = new PrivateEndpointConnectionsImpl(this);
     this.privateLinkResources = new PrivateLinkResourcesImpl(this);
+    this.addCustomApiVersionPolicy(options.apiVersion);
+  }
+
+  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+  private addCustomApiVersionPolicy(apiVersion?: string) {
+    if (!apiVersion) {
+      return;
+    }
+    const apiVersionPolicy = {
+      name: "CustomApiVersionPolicy",
+      async sendRequest(
+        request: PipelineRequest,
+        next: SendRequest
+      ): Promise<PipelineResponse> {
+        const param = request.url.split("?");
+        if (param.length > 1) {
+          const newParams = param[1].split("&").map((item) => {
+            if (item.indexOf("api-version") > -1) {
+              return "api-version=" + apiVersion;
+            } else {
+              return item;
+            }
+          });
+          request.url = param[0] + "?" + newParams.join("&");
+        }
+        return next(request);
+      }
+    };
+    this.pipeline.addPolicy(apiVersionPolicy);
   }
 
   operations: Operations;

package/types/arm-redisenterprisecache.d.ts

@@ -41,7 +41,7 @@ export declare type ActionType = string;
 export declare type AofFrequency = string;
 
 /** Describes the RedisEnterprise cluster */
-export declare type Cluster = TrackedResource & {
+export declare interface Cluster extends TrackedResource {
     /** The SKU to create, which affects price, performance, and features. */
     sku: Sku;
     /** The Availability Zones where this cluster will be deployed. */
@@ -73,7 +73,7 @@ export declare type Cluster = TrackedResource & {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly privateEndpointConnections?: PrivateEndpointConnection[];
-};
+}
 
 /**
  * Defines values for ClusteringPolicy. \
@@ -134,7 +134,7 @@ export declare interface ClusterUpdate {
 }
 
 /** Describes a database on the RedisEnterprise cluster */
-export declare type Database = ProxyResource & {
+export declare interface Database extends ProxyResource {
     /** Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. */
     clientProtocol?: Protocol;
     /** TCP port of the database endpoint. Specified at create time. Defaults to an available port. */
@@ -159,7 +159,7 @@ export declare type Database = ProxyResource & {
     modules?: Module[];
     /** Optional set of properties to configure geo replication for this database. */
     geoReplication?: DatabasePropertiesGeoReplication;
-};
+}
 
 /** The response of a list-all operation. */
 export declare interface DatabaseList {
@@ -529,6 +529,15 @@ export declare interface ForceUnlinkParameters {
     ids: string[];
 }
 
+/**
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
+ * that point later.
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
+ */
+export declare function getContinuationToken(page: unknown): string | undefined;
+
 /** Parameters for a Redis Enterprise import operation. */
 export declare interface ImportClusterParameters {
     /** SAS URIs for the target blobs to import from */
@@ -537,118 +546,179 @@ export declare interface ImportClusterParameters {
 
 /** Known values of {@link ActionType} that the service accepts. */
 export declare enum KnownActionType {
+    /** Internal */
     Internal = "Internal"
 }
 
 /** Known values of {@link AofFrequency} that the service accepts. */
 export declare enum KnownAofFrequency {
+    /** OneS */
     OneS = "1s",
+    /** Always */
     Always = "always"
 }
 
 /** Known values of {@link ClusteringPolicy} that the service accepts. */
 export declare enum KnownClusteringPolicy {
+    /** EnterpriseCluster */
     EnterpriseCluster = "EnterpriseCluster",
+    /** OSSCluster */
     OSSCluster = "OSSCluster"
 }
 
 /** Known values of {@link EvictionPolicy} that the service accepts. */
 export declare enum KnownEvictionPolicy {
+    /** AllKeysLFU */
     AllKeysLFU = "AllKeysLFU",
+    /** AllKeysLRU */
     AllKeysLRU = "AllKeysLRU",
+    /** AllKeysRandom */
     AllKeysRandom = "AllKeysRandom",
+    /** VolatileLRU */
     VolatileLRU = "VolatileLRU",
+    /** VolatileLFU */
     VolatileLFU = "VolatileLFU",
+    /** VolatileTTL */
     VolatileTTL = "VolatileTTL",
+    /** VolatileRandom */
     VolatileRandom = "VolatileRandom",
+    /** NoEviction */
     NoEviction = "NoEviction"
 }
 
 /** Known values of {@link LinkState} that the service accepts. */
 export declare enum KnownLinkState {
+    /** Linked */
     Linked = "Linked",
+    /** Linking */
     Linking = "Linking",
+    /** Unlinking */
     Unlinking = "Unlinking",
+    /** LinkFailed */
     LinkFailed = "LinkFailed",
+    /** UnlinkFailed */
     UnlinkFailed = "UnlinkFailed"
 }
 
 /** Known values of {@link Origin} that the service accepts. */
 export declare enum KnownOrigin {
+    /** User */
     User = "user",
+    /** System */
     System = "system",
+    /** UserSystem */
     UserSystem = "user,system"
 }
 
 /** Known values of {@link PrivateEndpointConnectionProvisioningState} that the service accepts. */
 export declare enum KnownPrivateEndpointConnectionProvisioningState {
+    /** Succeeded */
     Succeeded = "Succeeded",
+    /** Creating */
     Creating = "Creating",
+    /** Deleting */
     Deleting = "Deleting",
+    /** Failed */
     Failed = "Failed"
 }
 
 /** Known values of {@link PrivateEndpointServiceConnectionStatus} that the service accepts. */
 export declare enum KnownPrivateEndpointServiceConnectionStatus {
+    /** Pending */
     Pending = "Pending",
+    /** Approved */
     Approved = "Approved",
+    /** Rejected */
     Rejected = "Rejected"
 }
 
 /** Known values of {@link Protocol} that the service accepts. */
 export declare enum KnownProtocol {
+    /** Encrypted */
     Encrypted = "Encrypted",
+    /** Plaintext */
     Plaintext = "Plaintext"
 }
 
 /** Known values of {@link ProvisioningState} that the service accepts. */
 export declare enum KnownProvisioningState {
+    /** Succeeded */
     Succeeded = "Succeeded",
+    /** Failed */
     Failed = "Failed",
+    /** Canceled */
     Canceled = "Canceled",
+    /** Creating */
     Creating = "Creating",
+    /** Updating */
     Updating = "Updating",
+    /** Deleting */
     Deleting = "Deleting"
 }
 
 /** Known values of {@link RdbFrequency} that the service accepts. */
 export declare enum KnownRdbFrequency {
+    /** OneH */
     OneH = "1h",
+    /** SixH */
     SixH = "6h",
+    /** TwelveH */
     TwelveH = "12h"
 }
 
 /** Known values of {@link ResourceState} that the service accepts. */
 export declare enum KnownResourceState {
+    /** Running */
     Running = "Running",
+    /** Creating */
     Creating = "Creating",
+    /** CreateFailed */
     CreateFailed = "CreateFailed",
+    /** Updating */
     Updating = "Updating",
+    /** UpdateFailed */
     UpdateFailed = "UpdateFailed",
+    /** Deleting */
     Deleting = "Deleting",
+    /** DeleteFailed */
     DeleteFailed = "DeleteFailed",
+    /** Enabling */
     Enabling = "Enabling",
+    /** EnableFailed */
     EnableFailed = "EnableFailed",
+    /** Disabling */
     Disabling = "Disabling",
+    /** DisableFailed */
     DisableFailed = "DisableFailed",
+    /** Disabled */
     Disabled = "Disabled"
 }
 
 /** Known values of {@link SkuName} that the service accepts. */
 export declare enum KnownSkuName {
+    /** EnterpriseE10 */
     EnterpriseE10 = "Enterprise_E10",
+    /** EnterpriseE20 */
     EnterpriseE20 = "Enterprise_E20",
+    /** EnterpriseE50 */
     EnterpriseE50 = "Enterprise_E50",
+    /** EnterpriseE100 */
     EnterpriseE100 = "Enterprise_E100",
+    /** EnterpriseFlashF300 */
     EnterpriseFlashF300 = "EnterpriseFlash_F300",
+    /** EnterpriseFlashF700 */
     EnterpriseFlashF700 = "EnterpriseFlash_F700",
+    /** EnterpriseFlashF1500 */
     EnterpriseFlashF1500 = "EnterpriseFlash_F1500"
 }
 
 /** Known values of {@link TlsVersion} that the service accepts. */
 export declare enum KnownTlsVersion {
+    /** One0 */
     One0 = "1.0",
+    /** One1 */
     One1 = "1.1",
+    /** One2 */
     One2 = "1.2"
 }
 
@@ -780,8 +850,8 @@ export declare type OperationsListResponse = OperationListResult;
 export declare interface OperationsStatus {
     /**
      * Gets the status of operation.
-     * @param location The region the operation is in.
-     * @param operationId The operation's unique identifier.
+     * @param location The name of Azure region.
+     * @param operationId The ID of an ongoing async operation.
      * @param options The options parameters.
      */
     get(location: string, operationId: string, options?: OperationsStatusGetOptionalParams): Promise<OperationsStatusGetResponse>;
@@ -843,7 +913,7 @@ export declare interface PrivateEndpoint {
 }
 
 /** The Private Endpoint Connection resource. */
-export declare type PrivateEndpointConnection = Resource & {
+export declare interface PrivateEndpointConnection extends Resource {
     /** The resource of private end point. */
     privateEndpoint?: PrivateEndpoint;
     /** A collection of information about the state of the connection between service consumer and provider. */
@@ -853,7 +923,7 @@ export declare type PrivateEndpointConnection = Resource & {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly provisioningState?: PrivateEndpointConnectionProvisioningState;
-};
+}
 
 /** List of private endpoint connection associated with the specified storage account */
 export declare interface PrivateEndpointConnectionListResult {
@@ -965,7 +1035,7 @@ export declare type PrivateEndpointConnectionsPutResponse = PrivateEndpointConne
 export declare type PrivateEndpointServiceConnectionStatus = string;
 
 /** A private link resource */
-export declare type PrivateLinkResource = Resource & {
+export declare interface PrivateLinkResource extends Resource {
     /**
      * The private link resource group id.
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -978,7 +1048,7 @@ export declare type PrivateLinkResource = Resource & {
     readonly requiredMembers?: string[];
     /** The private link resource Private link DNS zone name. */
     requiredZoneNames?: string[];
-};
+}
 
 /** A list of private link resources */
 export declare interface PrivateLinkResourceListResult {
@@ -1039,7 +1109,8 @@ export declare type Protocol = string;
 export declare type ProvisioningState = string;
 
 /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
-export declare type ProxyResource = Resource & {};
+export declare interface ProxyResource extends Resource {
+}
 
 /**
  * Defines values for RdbFrequency. \
@@ -1185,6 +1256,8 @@ export declare class RedisEnterpriseManagementClient extends coreClient.ServiceC
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: RedisEnterpriseManagementClientOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
     operations: Operations;
     operationsStatus: OperationsStatus;
     redisEnterprise: RedisEnterprise;
@@ -1294,13 +1367,13 @@ export declare type SkuName = string;
 export declare type TlsVersion = string;
 
 /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
-export declare type TrackedResource = Resource & {
+export declare interface TrackedResource extends Resource {
     /** Resource tags. */
     tags?: {
         [propertyName: string]: string;
     };
     /** The geo-location where the resource lives */
     location: string;
-};
+}
 
 export { }

package/types/tsdoc-metadata.json

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