@azure/arm-redisenterprisecache 2.0.0 → 2.1.0

package/src/models/index.ts

@@ -256,7 +256,7 @@ export interface Persistence {
 export interface Module {
   /** The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' */
   name: string;
-  /** Configuration options for the module, e.g. 'ERROR_RATE 0.00 INITIAL_SIZE 400'. */
+  /** Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'. */
   args?: string;
   /**
    * The version of the module, e.g. '1.0'.
@@ -265,6 +265,25 @@ export interface Module {
   readonly version?: string;
 }
 
+/** Optional set of properties to configure geo replication for this database. */
+export interface DatabasePropertiesGeoReplication {
+  /** Name for the group of linked database resources */
+  groupNickname?: string;
+  /** List of database resources to link with this database */
+  linkedDatabases?: LinkedDatabase[];
+}
+
+/** Specifies details of a linked database resource. */
+export interface LinkedDatabase {
+  /** Resource ID of a database resource to link with this database. */
+  id?: string;
+  /**
+   * State of the link between the database resources.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly state?: LinkState;
+}
+
 /** A partial update to the RedisEnterprise database */
 export interface DatabaseUpdate {
   /** Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. */
@@ -289,6 +308,8 @@ export interface DatabaseUpdate {
   persistence?: Persistence;
   /** Optional set of redis modules to enable in this database - modules can only be added at creation time. */
   modules?: Module[];
+  /** Optional set of properties to configure geo replication for this database. */
+  geoReplication?: DatabasePropertiesGeoReplication;
 }
 
 /** The secret access keys used for authenticating connections to redis */
@@ -335,6 +356,12 @@ export interface PrivateLinkResourceListResult {
   value?: PrivateLinkResource[];
 }
 
+/** Parameters for a Redis Enterprise Active Geo Replication Force Unlink operation. */
+export interface ForceUnlinkParameters {
+  /** The resource IDs of the database resources to be unlinked. */
+  ids: string[];
+}
+
 /** The Private Endpoint Connection resource. */
 export type PrivateEndpointConnection = Resource & {
   /** The resource of private end point. */
@@ -434,6 +461,8 @@ export type Database = ProxyResource & {
   persistence?: Persistence;
   /** Optional set of redis modules to enable in this database - modules can only be added at creation time. */
   modules?: Module[];
+  /** Optional set of properties to configure geo replication for this database. */
+  geoReplication?: DatabasePropertiesGeoReplication;
 };
 
 /** Known values of {@link Origin} that the service accepts. */
@@ -703,6 +732,28 @@ export enum KnownRdbFrequency {
  * **12h**
  */
 export type RdbFrequency = string;
+
+/** Known values of {@link LinkState} that the service accepts. */
+export enum KnownLinkState {
+  Linked = "Linked",
+  Linking = "Linking",
+  Unlinking = "Unlinking",
+  LinkFailed = "LinkFailed",
+  UnlinkFailed = "UnlinkFailed"
+}
+
+/**
+ * Defines values for LinkState. \
+ * {@link KnownLinkState} can be used interchangeably with LinkState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Linked** \
+ * **Linking** \
+ * **Unlinking** \
+ * **LinkFailed** \
+ * **UnlinkFailed**
+ */
+export type LinkState = string;
 /** Defines values for AccessKeyType. */
 export type AccessKeyType = "Primary" | "Secondary";
 
@@ -879,6 +930,15 @@ export interface DatabasesExportOptionalParams
   resumeFrom?: string;
 }
 
+/** Optional parameters. */
+export interface DatabasesForceUnlinkOptionalParams
+  extends coreClient.OperationOptions {
+  /** Delay to wait until next poll, in milliseconds. */
+  updateIntervalInMs?: number;
+  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+  resumeFrom?: string;
+}
+
 /** Optional parameters. */
 export interface DatabasesListByClusterNextOptionalParams
   extends coreClient.OperationOptions {}

package/src/models/mappers.ts

@@ -543,6 +543,55 @@ export const Module: coreClient.CompositeMapper = {
   }
 };
 
+export const DatabasePropertiesGeoReplication: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "DatabasePropertiesGeoReplication",
+    modelProperties: {
+      groupNickname: {
+        serializedName: "groupNickname",
+        type: {
+          name: "String"
+        }
+      },
+      linkedDatabases: {
+        serializedName: "linkedDatabases",
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "Composite",
+              className: "LinkedDatabase"
+            }
+          }
+        }
+      }
+    }
+  }
+};
+
+export const LinkedDatabase: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "LinkedDatabase",
+    modelProperties: {
+      id: {
+        serializedName: "id",
+        type: {
+          name: "String"
+        }
+      },
+      state: {
+        serializedName: "state",
+        readOnly: true,
+        type: {
+          name: "String"
+        }
+      }
+    }
+  }
+};
+
 export const DatabaseUpdate: coreClient.CompositeMapper = {
   type: {
     name: "Composite",
@@ -604,6 +653,13 @@ export const DatabaseUpdate: coreClient.CompositeMapper = {
             }
           }
         }
+      },
+      geoReplication: {
+        serializedName: "properties.geoReplication",
+        type: {
+          name: "Composite",
+          className: "DatabasePropertiesGeoReplication"
+        }
       }
     }
   }
@@ -728,6 +784,27 @@ export const PrivateLinkResourceListResult: coreClient.CompositeMapper = {
   }
 };
 
+export const ForceUnlinkParameters: coreClient.CompositeMapper = {
+  type: {
+    name: "Composite",
+    className: "ForceUnlinkParameters",
+    modelProperties: {
+      ids: {
+        serializedName: "ids",
+        required: true,
+        type: {
+          name: "Sequence",
+          element: {
+            type: {
+              name: "String"
+            }
+          }
+        }
+      }
+    }
+  }
+};
+
 export const PrivateEndpointConnection: coreClient.CompositeMapper = {
   type: {
     name: "Composite",
@@ -970,6 +1047,13 @@ export const Database: coreClient.CompositeMapper = {
             }
           }
         }
+      },
+      geoReplication: {
+        serializedName: "properties.geoReplication",
+        type: {
+          name: "Composite",
+          className: "DatabasePropertiesGeoReplication"
+        }
       }
     }
   }

package/src/models/parameters.ts

@@ -19,6 +19,7 @@ import {
   RegenerateKeyParameters as RegenerateKeyParametersMapper,
   ImportClusterParameters as ImportClusterParametersMapper,
   ExportClusterParameters as ExportClusterParametersMapper,
+  ForceUnlinkParameters as ForceUnlinkParametersMapper,
   PrivateEndpointConnection as PrivateEndpointConnectionMapper
 } from "../models/mappers";
 
@@ -49,7 +50,7 @@ export const $host: OperationURLParameter = {
 export const apiVersion: OperationQueryParameter = {
   parameterPath: "apiVersion",
   mapper: {
-    defaultValue: "2021-08-01",
+    defaultValue: "2022-01-01",
     isConstant: true,
     serializedName: "api-version",
     type: {
@@ -190,6 +191,11 @@ export const parameters6: OperationParameter = {
   mapper: ExportClusterParametersMapper
 };
 
+export const parameters7: OperationParameter = {
+  parameterPath: "parameters",
+  mapper: ForceUnlinkParametersMapper
+};
+
 export const privateEndpointConnectionName: OperationURLParameter = {
   parameterPath: "privateEndpointConnectionName",
   mapper: {

package/src/operations/databases.ts

@@ -36,6 +36,8 @@ import {
   DatabasesImportOptionalParams,
   ExportClusterParameters,
   DatabasesExportOptionalParams,
+  ForceUnlinkParameters,
+  DatabasesForceUnlinkOptionalParams,
   DatabasesListByClusterNextResponse
 } from "../models";
 
@@ -204,11 +206,13 @@ export class DatabasesImpl implements Databases {
       { resourceGroupName, clusterName, databaseName, parameters, options },
       createOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs,
       lroResourceLocationConfig: "original-uri"
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -300,11 +304,13 @@ export class DatabasesImpl implements Databases {
       { resourceGroupName, clusterName, databaseName, parameters, options },
       updateOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs,
       lroResourceLocationConfig: "azure-async-operation"
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -408,11 +414,13 @@ export class DatabasesImpl implements Databases {
       { resourceGroupName, clusterName, databaseName, options },
       deleteOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs,
       lroResourceLocationConfig: "azure-async-operation"
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -520,11 +528,13 @@ export class DatabasesImpl implements Databases {
       { resourceGroupName, clusterName, databaseName, parameters, options },
       regenerateKeyOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs,
       lroResourceLocationConfig: "azure-async-operation"
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -611,11 +621,13 @@ export class DatabasesImpl implements Databases {
       { resourceGroupName, clusterName, databaseName, parameters, options },
       importOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs,
       lroResourceLocationConfig: "azure-async-operation"
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -702,11 +714,13 @@ export class DatabasesImpl implements Databases {
       { resourceGroupName, clusterName, databaseName, parameters, options },
       exportOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs,
       lroResourceLocationConfig: "azure-async-operation"
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -734,6 +748,99 @@ export class DatabasesImpl implements Databases {
     return poller.pollUntilDone();
   }
 
+  /**
+   * Forcibly removes the link to the specified database resource.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param clusterName The name of the RedisEnterprise cluster.
+   * @param databaseName The name of the database.
+   * @param parameters Information identifying the database to be unlinked.
+   * @param options The options parameters.
+   */
+  async beginForceUnlink(
+    resourceGroupName: string,
+    clusterName: string,
+    databaseName: string,
+    parameters: ForceUnlinkParameters,
+    options?: DatabasesForceUnlinkOptionalParams
+  ): Promise<PollerLike<PollOperationState<void>, void>> {
+    const directSendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ): Promise<void> => {
+      return this.client.sendOperationRequest(args, spec);
+    };
+    const sendOperation = async (
+      args: coreClient.OperationArguments,
+      spec: coreClient.OperationSpec
+    ) => {
+      let currentRawResponse:
+        | coreClient.FullOperationResponse
+        | undefined = undefined;
+      const providedCallback = args.options?.onResponse;
+      const callback: coreClient.RawResponseCallback = (
+        rawResponse: coreClient.FullOperationResponse,
+        flatResponse: unknown
+      ) => {
+        currentRawResponse = rawResponse;
+        providedCallback?.(rawResponse, flatResponse);
+      };
+      const updatedArgs = {
+        ...args,
+        options: {
+          ...args.options,
+          onResponse: callback
+        }
+      };
+      const flatResponse = await directSendOperation(updatedArgs, spec);
+      return {
+        flatResponse,
+        rawResponse: {
+          statusCode: currentRawResponse!.status,
+          body: currentRawResponse!.parsedBody,
+          headers: currentRawResponse!.headers.toJSON()
+        }
+      };
+    };
+
+    const lro = new LroImpl(
+      sendOperation,
+      { resourceGroupName, clusterName, databaseName, parameters, options },
+      forceUnlinkOperationSpec
+    );
+    const poller = new LroEngine(lro, {
+      resumeFrom: options?.resumeFrom,
+      intervalInMs: options?.updateIntervalInMs,
+      lroResourceLocationConfig: "azure-async-operation"
+    });
+    await poller.poll();
+    return poller;
+  }
+
+  /**
+   * Forcibly removes the link to the specified database resource.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param clusterName The name of the RedisEnterprise cluster.
+   * @param databaseName The name of the database.
+   * @param parameters Information identifying the database to be unlinked.
+   * @param options The options parameters.
+   */
+  async beginForceUnlinkAndWait(
+    resourceGroupName: string,
+    clusterName: string,
+    databaseName: string,
+    parameters: ForceUnlinkParameters,
+    options?: DatabasesForceUnlinkOptionalParams
+  ): Promise<void> {
+    const poller = await this.beginForceUnlink(
+      resourceGroupName,
+      clusterName,
+      databaseName,
+      parameters,
+      options
+    );
+    return poller.pollUntilDone();
+  }
+
   /**
    * ListByClusterNext
    * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -1002,6 +1109,32 @@ const exportOperationSpec: coreClient.OperationSpec = {
   mediaType: "json",
   serializer
 };
+const forceUnlinkOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/forceUnlink",
+  httpMethod: "POST",
+  responses: {
+    200: {},
+    201: {},
+    202: {},
+    204: {},
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  requestBody: Parameters.parameters7,
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.clusterName,
+    Parameters.databaseName
+  ],
+  headerParameters: [Parameters.accept, Parameters.contentType],
+  mediaType: "json",
+  serializer
+};
 const listByClusterNextOperationSpec: coreClient.OperationSpec = {
   path: "{nextLink}",
   httpMethod: "GET",

package/src/operations/privateEndpointConnections.ts

@@ -201,10 +201,12 @@ export class PrivateEndpointConnectionsImpl
       },
       putOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs
     });
+    await poller.poll();
+    return poller;
   }
 
   /**

package/src/operations/redisEnterprise.ts

@@ -204,11 +204,13 @@ export class RedisEnterpriseImpl implements RedisEnterprise {
       { resourceGroupName, clusterName, parameters, options },
       createOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs,
       lroResourceLocationConfig: "original-uri"
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -295,11 +297,13 @@ export class RedisEnterpriseImpl implements RedisEnterprise {
       { resourceGroupName, clusterName, parameters, options },
       updateOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs,
       lroResourceLocationConfig: "azure-async-operation"
     });
+    await poller.poll();
+    return poller;
   }
 
   /**
@@ -379,11 +383,13 @@ export class RedisEnterpriseImpl implements RedisEnterprise {
       { resourceGroupName, clusterName, options },
       deleteOperationSpec
     );
-    return new LroEngine(lro, {
+    const poller = new LroEngine(lro, {
       resumeFrom: options?.resumeFrom,
       intervalInMs: options?.updateIntervalInMs,
       lroResourceLocationConfig: "azure-async-operation"
     });
+    await poller.poll();
+    return poller;
   }
 
   /**

package/src/operationsInterfaces/databases.ts

@@ -27,7 +27,9 @@ import {
   ImportClusterParameters,
   DatabasesImportOptionalParams,
   ExportClusterParameters,
-  DatabasesExportOptionalParams
+  DatabasesExportOptionalParams,
+  ForceUnlinkParameters,
+  DatabasesForceUnlinkOptionalParams
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -261,4 +263,34 @@ export interface Databases {
     parameters: ExportClusterParameters,
     options?: DatabasesExportOptionalParams
   ): Promise<void>;
+  /**
+   * Forcibly removes the link to the specified database resource.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param clusterName The name of the RedisEnterprise cluster.
+   * @param databaseName The name of the database.
+   * @param parameters Information identifying the database to be unlinked.
+   * @param options The options parameters.
+   */
+  beginForceUnlink(
+    resourceGroupName: string,
+    clusterName: string,
+    databaseName: string,
+    parameters: ForceUnlinkParameters,
+    options?: DatabasesForceUnlinkOptionalParams
+  ): Promise<PollerLike<PollOperationState<void>, void>>;
+  /**
+   * Forcibly removes the link to the specified database resource.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param clusterName The name of the RedisEnterprise cluster.
+   * @param databaseName The name of the database.
+   * @param parameters Information identifying the database to be unlinked.
+   * @param options The options parameters.
+   */
+  beginForceUnlinkAndWait(
+    resourceGroupName: string,
+    clusterName: string,
+    databaseName: string,
+    parameters: ForceUnlinkParameters,
+    options?: DatabasesForceUnlinkOptionalParams
+  ): Promise<void>;
 }

package/src/redisEnterpriseManagementClient.ts

@@ -58,7 +58,7 @@ export class RedisEnterpriseManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-redisenterprisecache/2.0.0`;
+    const packageDetails = `azsdk-js-arm-redisenterprisecache/2.1.0`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -73,7 +73,8 @@ export class RedisEnterpriseManagementClient extends coreClient.ServiceClient {
       userAgentOptions: {
         userAgentPrefix
       },
-      baseUri: options.endpoint || "https://management.azure.com"
+      baseUri:
+        options.endpoint ?? options.baseUri ?? "https://management.azure.com"
     };
     super(optionsWithDefaults);
     // Parameter assignments
@@ -81,7 +82,7 @@ export class RedisEnterpriseManagementClient extends coreClient.ServiceClient {
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2021-08-01";
+    this.apiVersion = options.apiVersion || "2022-01-01";
     this.operations = new OperationsImpl(this);
     this.operationsStatus = new OperationsStatusImpl(this);
     this.redisEnterprise = new RedisEnterpriseImpl(this);

package/tsconfig.json

@@ -9,12 +9,25 @@
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "forceConsistentCasingInFileNames": true,
-    "lib": ["es6", "dom"],
+    "lib": [
+      "es6",
+      "dom"
+    ],
     "declaration": true,
     "outDir": "./dist-esm",
     "importHelpers": true,
-    "paths": { "@azure/arm-redisenterprisecache": ["./src/index"] }
+    "paths": {
+      "@azure/arm-redisenterprisecache": [
+        "./src/index"
+      ]
+    }
   },
-  "include": ["./src/**/*.ts", "./test/**/*.ts", "samples-dev/**/*.ts"],
-  "exclude": ["node_modules"]
-}
+  "include": [
+    "./src/**/*.ts",
+    "./test/**/*.ts",
+    "samples-dev/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}