@azure/arm-redisenterprisecache 2.2.1-alpha.20230418.1 → 2.3.0-alpha.20230501.1

package/types/arm-redisenterprisecache.d.ts

@@ -1,8 +1,8 @@
 import * as coreAuth from '@azure/core-auth';
 import * as coreClient from '@azure/core-client';
+import { OperationState } from '@azure/core-lro';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
-import { PollerLike } from '@azure/core-lro';
-import { PollOperationState } from '@azure/core-lro';
+import { SimplePollerLike } from '@azure/core-lro';
 
 /** The secret access keys used for authenticating connections to redis */
 export declare interface AccessKeys {
@@ -40,14 +40,26 @@ export declare type ActionType = string;
  */
 export declare type AofFrequency = string;
 
+/** Information about the features the location supports */
+export declare interface Capability {
+    /** Feature name */
+    name?: string;
+    /** Indicates whether feature is supported or not */
+    value?: boolean;
+}
+
 /** Describes the RedisEnterprise cluster */
 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. */
     zones?: string[];
+    /** The identity of the resource. */
+    identity?: ManagedServiceIdentity;
     /** The minimum TLS version for the cluster to support, e.g. '1.2' */
     minimumTlsVersion?: TlsVersion;
+    /** Encryption-at-rest configuration for the cluster. */
+    encryption?: ClusterPropertiesEncryption;
     /**
      * DNS name of the cluster endpoint
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -96,16 +108,42 @@ export declare interface ClusterList {
     readonly nextLink?: string;
 }
 
+/** Encryption-at-rest configuration for the cluster. */
+export declare interface ClusterPropertiesEncryption {
+    /** All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. */
+    customerManagedKeyEncryption?: ClusterPropertiesEncryptionCustomerManagedKeyEncryption;
+}
+
+/** All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. */
+export declare interface ClusterPropertiesEncryptionCustomerManagedKeyEncryption {
+    /** All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */
+    keyEncryptionKeyIdentity?: ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity;
+    /** Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 */
+    keyEncryptionKeyUrl?: string;
+}
+
+/** All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */
+export declare interface ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity {
+    /** User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/<sub uuid>/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. */
+    userAssignedIdentityResourceId?: string;
+    /** Only userAssignedIdentity is supported in this API version; other types may be supported in the future */
+    identityType?: CmkIdentityType;
+}
+
 /** A partial update to the RedisEnterprise cluster */
 export declare interface ClusterUpdate {
     /** The SKU to create, which affects price, performance, and features. */
     sku?: Sku;
+    /** The identity of the resource. */
+    identity?: ManagedServiceIdentity;
     /** Resource tags. */
     tags?: {
         [propertyName: string]: string;
     };
     /** The minimum TLS version for the cluster to support, e.g. '1.2' */
     minimumTlsVersion?: TlsVersion;
+    /** Encryption-at-rest configuration for the cluster. */
+    encryption?: ClusterPropertiesEncryption;
     /**
      * DNS name of the cluster endpoint
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -133,6 +171,28 @@ export declare interface ClusterUpdate {
     readonly privateEndpointConnections?: PrivateEndpointConnection[];
 }
 
+/**
+ * Defines values for CmkIdentityType. \
+ * {@link KnownCmkIdentityType} can be used interchangeably with CmkIdentityType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **systemAssignedIdentity** \
+ * **userAssignedIdentity**
+ */
+export declare type CmkIdentityType = string;
+
+/**
+ * Defines values for CreatedByType. \
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User** \
+ * **Application** \
+ * **ManagedIdentity** \
+ * **Key**
+ */
+export declare type CreatedByType = string;
+
 /** Describes a database on the RedisEnterprise cluster */
 export declare interface Database extends ProxyResource {
     /** Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. */
@@ -197,7 +257,7 @@ export declare interface Databases {
      * @param parameters Parameters supplied to the create or update database operation.
      * @param options The options parameters.
      */
-    beginCreate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<PollerLike<PollOperationState<DatabasesCreateResponse>, DatabasesCreateResponse>>;
+    beginCreate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesCreateResponse>, DatabasesCreateResponse>>;
     /**
      * Creates a database
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -215,7 +275,7 @@ export declare interface Databases {
      * @param parameters Parameters supplied to the create or update database operation.
      * @param options The options parameters.
      */
-    beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<PollerLike<PollOperationState<DatabasesUpdateResponse>, DatabasesUpdateResponse>>;
+    beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesUpdateResponse>, DatabasesUpdateResponse>>;
     /**
      * Updates a database
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -240,7 +300,7 @@ export declare interface Databases {
      * @param databaseName The name of the database.
      * @param options The options parameters.
      */
-    beginDelete(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDelete(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Deletes a single database
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -265,7 +325,7 @@ export declare interface Databases {
      * @param parameters Specifies which key to regenerate.
      * @param options The options parameters.
      */
-    beginRegenerateKey(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<PollerLike<PollOperationState<DatabasesRegenerateKeyResponse>, DatabasesRegenerateKeyResponse>>;
+    beginRegenerateKey(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesRegenerateKeyResponse>, DatabasesRegenerateKeyResponse>>;
     /**
      * Regenerates the RedisEnterprise database's access keys.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -283,7 +343,7 @@ export declare interface Databases {
      * @param parameters Storage information for importing into the cluster
      * @param options The options parameters.
      */
-    beginImport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginImport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Imports database files to target database.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -301,7 +361,7 @@ export declare interface Databases {
      * @param parameters Storage information for exporting into the cluster
      * @param options The options parameters.
      */
-    beginExport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginExport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Exports a database file from target database.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -319,7 +379,7 @@ export declare interface Databases {
      * @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>>;
+    beginForceUnlink(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Forcibly removes the link to the specified database resource.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -329,6 +389,24 @@ export declare interface Databases {
      * @param options The options parameters.
      */
     beginForceUnlinkAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams): Promise<void>;
+    /**
+     * Flushes all the keys in this database and also from its linked databases.
+     * @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 databases to be flushed
+     * @param options The options parameters.
+     */
+    beginFlush(resourceGroupName: string, clusterName: string, databaseName: string, parameters: FlushParameters, options?: DatabasesFlushOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
+    /**
+     * Flushes all the keys in this database and also from its linked databases.
+     * @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 databases to be flushed
+     * @param options The options parameters.
+     */
+    beginFlushAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: FlushParameters, options?: DatabasesFlushOptionalParams): Promise<void>;
 }
 
 /** Optional parameters. */
@@ -358,6 +436,22 @@ export declare interface DatabasesExportOptionalParams extends coreClient.Operat
     resumeFrom?: string;
 }
 
+/** Defines headers for Databases_flush operation. */
+export declare interface DatabasesFlushHeaders {
+    /** Location URI to poll for result */
+    location?: string;
+    /** URI to poll for the operation status */
+    azureAsyncOperation?: string;
+}
+
+/** Optional parameters. */
+export declare interface DatabasesFlushOptionalParams 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 declare interface DatabasesForceUnlinkOptionalParams extends coreClient.OperationOptions {
     /** Delay to wait until next poll, in milliseconds. */
@@ -523,6 +617,12 @@ export declare interface ExportClusterParameters {
     sasUri: string;
 }
 
+/** Parameters for a Redis Enterprise active geo-replication flush operation. */
+export declare interface FlushParameters {
+    /** The resource identifiers of all the other database resources in the georeplication group to be flushed */
+    ids?: string[];
+}
+
 /** Parameters for a Redis Enterprise Active Geo Replication Force Unlink operation. */
 export declare interface ForceUnlinkParameters {
     /** The resource IDs of the database resources to be unlinked. */
@@ -566,6 +666,26 @@ export declare enum KnownClusteringPolicy {
     OSSCluster = "OSSCluster"
 }
 
+/** Known values of {@link CmkIdentityType} that the service accepts. */
+export declare enum KnownCmkIdentityType {
+    /** SystemAssignedIdentity */
+    SystemAssignedIdentity = "systemAssignedIdentity",
+    /** UserAssignedIdentity */
+    UserAssignedIdentity = "userAssignedIdentity"
+}
+
+/** Known values of {@link CreatedByType} that the service accepts. */
+export declare enum KnownCreatedByType {
+    /** User */
+    User = "User",
+    /** Application */
+    Application = "Application",
+    /** ManagedIdentity */
+    ManagedIdentity = "ManagedIdentity",
+    /** Key */
+    Key = "Key"
+}
+
 /** Known values of {@link EvictionPolicy} that the service accepts. */
 export declare enum KnownEvictionPolicy {
     /** AllKeysLFU */
@@ -600,6 +720,18 @@ export declare enum KnownLinkState {
     UnlinkFailed = "UnlinkFailed"
 }
 
+/** Known values of {@link ManagedServiceIdentityType} that the service accepts. */
+export declare enum KnownManagedServiceIdentityType {
+    /** None */
+    None = "None",
+    /** SystemAssigned */
+    SystemAssigned = "SystemAssigned",
+    /** UserAssigned */
+    UserAssigned = "UserAssigned",
+    /** SystemAssignedUserAssigned */
+    SystemAssignedUserAssigned = "SystemAssigned, UserAssigned"
+}
+
 /** Known values of {@link Origin} that the service accepts. */
 export declare enum KnownOrigin {
     /** User */
@@ -746,6 +878,46 @@ export declare interface LinkedDatabase {
  */
 export declare type LinkState = string;
 
+/** Information about location (for example: features that it supports) */
+export declare interface LocationInfo {
+    /** Location name */
+    location?: string;
+    /** List of capabilities */
+    capabilities?: Capability[];
+}
+
+/** Managed service identity (system assigned and/or user assigned identities) */
+export declare interface ManagedServiceIdentity {
+    /**
+     * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly principalId?: string;
+    /**
+     * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly tenantId?: string;
+    /** Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */
+    type: ManagedServiceIdentityType;
+    /** The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */
+    userAssignedIdentities?: {
+        [propertyName: string]: UserAssignedIdentity;
+    };
+}
+
+/**
+ * Defines values for ManagedServiceIdentityType. \
+ * {@link KnownManagedServiceIdentityType} can be used interchangeably with ManagedServiceIdentityType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **None** \
+ * **SystemAssigned** \
+ * **UserAssigned** \
+ * **SystemAssigned, UserAssigned**
+ */
+export declare type ManagedServiceIdentityType = string;
+
 /** Specifies configuration of a redis module */
 export declare interface Module {
     /** The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' */
@@ -971,7 +1143,7 @@ export declare interface PrivateEndpointConnections {
      * @param properties The private endpoint connection properties.
      * @param options The options parameters.
      */
-    beginPut(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsPutOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsPutResponse>, PrivateEndpointConnectionsPutResponse>>;
+    beginPut(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsPutOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnectionsPutResponse>, PrivateEndpointConnectionsPutResponse>>;
     /**
      * Updates the state of the specified private endpoint connection associated with the RedisEnterprise
      * cluster.
@@ -1143,7 +1315,7 @@ export declare interface RedisEnterprise {
      * @param parameters Parameters supplied to the Create RedisEnterprise operation.
      * @param options The options parameters.
      */
-    beginCreate(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: RedisEnterpriseCreateOptionalParams): Promise<PollerLike<PollOperationState<RedisEnterpriseCreateResponse>, RedisEnterpriseCreateResponse>>;
+    beginCreate(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: RedisEnterpriseCreateOptionalParams): Promise<SimplePollerLike<OperationState<RedisEnterpriseCreateResponse>, RedisEnterpriseCreateResponse>>;
     /**
      * Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -1159,7 +1331,7 @@ export declare interface RedisEnterprise {
      * @param parameters Parameters supplied to the Update RedisEnterprise operation.
      * @param options The options parameters.
      */
-    beginUpdate(resourceGroupName: string, clusterName: string, parameters: ClusterUpdate, options?: RedisEnterpriseUpdateOptionalParams): Promise<PollerLike<PollOperationState<RedisEnterpriseUpdateResponse>, RedisEnterpriseUpdateResponse>>;
+    beginUpdate(resourceGroupName: string, clusterName: string, parameters: ClusterUpdate, options?: RedisEnterpriseUpdateOptionalParams): Promise<SimplePollerLike<OperationState<RedisEnterpriseUpdateResponse>, RedisEnterpriseUpdateResponse>>;
     /**
      * Updates an existing RedisEnterprise cluster
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -1174,7 +1346,7 @@ export declare interface RedisEnterprise {
      * @param clusterName The name of the RedisEnterprise cluster.
      * @param options The options parameters.
      */
-    beginDelete(resourceGroupName: string, clusterName: string, options?: RedisEnterpriseDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDelete(resourceGroupName: string, clusterName: string, options?: RedisEnterpriseDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
     /**
      * Deletes a RedisEnterprise cache cluster.
      * @param resourceGroupName The name of the resource group. The name is case insensitive.
@@ -1264,6 +1436,7 @@ export declare class RedisEnterpriseManagementClient extends coreClient.ServiceC
     databases: Databases;
     privateEndpointConnections: PrivateEndpointConnections;
     privateLinkResources: PrivateLinkResources;
+    skus: Skus;
 }
 
 /** Optional parameters. */
@@ -1293,6 +1466,22 @@ export declare interface RegenerateKeyParameters {
     keyType: AccessKeyType;
 }
 
+/** Details about the location requested and the available skus in the location */
+export declare interface RegionSkuDetail {
+    /** Resource type which has the SKU, such as Microsoft.Cache/redisEnterprise */
+    resourceType?: string;
+    /** Details about location and its capabilities */
+    locationInfo?: LocationInfo;
+    /** Details about available skus */
+    skuDetails?: SkuDetail;
+}
+
+/** List of details about all the available SKUs */
+export declare interface RegionSkuDetails {
+    /** List of Sku Detail */
+    value?: RegionSkuDetail[];
+}
+
 /** Common fields that are returned in the response for all Azure Resource Manager resources */
 export declare interface Resource {
     /**
@@ -1310,6 +1499,11 @@ export declare interface Resource {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly type?: string;
+    /**
+     * Azure Resource Manager metadata containing createdBy and modifiedBy information.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
 }
 
 /**
@@ -1340,6 +1534,12 @@ export declare interface Sku {
     capacity?: number;
 }
 
+/** Information about Sku */
+export declare interface SkuDetail {
+    /** The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.) */
+    name?: SkuName;
+}
+
 /**
  * Defines values for SkuName. \
  * {@link KnownSkuName} can be used interchangeably with SkuName,
@@ -1355,6 +1555,39 @@ export declare interface Sku {
  */
 export declare type SkuName = string;
 
+/** Interface representing a Skus. */
+export declare interface Skus {
+    /**
+     * Gets information about skus in specified location for the given subscription id
+     * @param location The name of Azure region.
+     * @param options The options parameters.
+     */
+    list(location: string, options?: SkusListOptionalParams): PagedAsyncIterableIterator<RegionSkuDetail>;
+}
+
+/** Optional parameters. */
+export declare interface SkusListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type SkusListResponse = RegionSkuDetails;
+
+/** Metadata pertaining to creation and last modification of the resource. */
+export declare interface SystemData {
+    /** The identity that created the resource. */
+    createdBy?: string;
+    /** The type of identity that created the resource. */
+    createdByType?: CreatedByType;
+    /** The timestamp of resource creation (UTC). */
+    createdAt?: Date;
+    /** The identity that last modified the resource. */
+    lastModifiedBy?: string;
+    /** The type of identity that last modified the resource. */
+    lastModifiedByType?: CreatedByType;
+    /** The timestamp of resource last modification (UTC) */
+    lastModifiedAt?: Date;
+}
+
 /**
  * Defines values for TlsVersion. \
  * {@link KnownTlsVersion} can be used interchangeably with TlsVersion,
@@ -1376,4 +1609,18 @@ export declare interface TrackedResource extends Resource {
     location: string;
 }
 
+/** User assigned identity properties */
+export declare interface UserAssignedIdentity {
+    /**
+     * The principal ID of the assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly principalId?: string;
+    /**
+     * The client ID of the assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly clientId?: string;
+}
+
 export { }

package/types/tsdoc-metadata.json

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