@azure/arm-redisenterprisecache 1.1.1 → 2.0.0-alpha.20220325.1

package/review/arm-redisenterprisecache.api.md

@@ -0,0 +1,705 @@
+## API Report File for "@azure/arm-redisenterprisecache"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+// @public
+export interface AccessKeys {
+    readonly primaryKey?: string;
+    readonly secondaryKey?: string;
+}
+
+// @public
+export type AccessKeyType = "Primary" | "Secondary";
+
+// @public
+export type ActionType = string;
+
+// @public
+export type AofFrequency = string;
+
+// @public
+export type Cluster = TrackedResource & {
+    sku: Sku;
+    zones?: string[];
+    minimumTlsVersion?: TlsVersion;
+    readonly hostName?: string;
+    readonly provisioningState?: ProvisioningState;
+    readonly resourceState?: ResourceState;
+    readonly redisVersion?: string;
+    readonly privateEndpointConnections?: PrivateEndpointConnection[];
+};
+
+// @public
+export type ClusteringPolicy = string;
+
+// @public
+export interface ClusterList {
+    readonly nextLink?: string;
+    value?: Cluster[];
+}
+
+// @public
+export interface ClusterUpdate {
+    readonly hostName?: string;
+    minimumTlsVersion?: TlsVersion;
+    readonly privateEndpointConnections?: PrivateEndpointConnection[];
+    readonly provisioningState?: ProvisioningState;
+    readonly redisVersion?: string;
+    readonly resourceState?: ResourceState;
+    sku?: Sku;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export type Database = ProxyResource & {
+    clientProtocol?: Protocol;
+    port?: number;
+    readonly provisioningState?: ProvisioningState;
+    readonly resourceState?: ResourceState;
+    clusteringPolicy?: ClusteringPolicy;
+    evictionPolicy?: EvictionPolicy;
+    persistence?: Persistence;
+    modules?: Module[];
+};
+
+// @public
+export interface DatabaseList {
+    readonly nextLink?: string;
+    value?: Database[];
+}
+
+// @public
+export interface Databases {
+    beginCreate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<PollerLike<PollOperationState<DatabasesCreateResponse>, DatabasesCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<DatabasesCreateResponse>;
+    beginDelete(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<void>;
+    beginExport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginExportAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<void>;
+    beginImport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginImportAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<void>;
+    beginRegenerateKey(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<PollerLike<PollOperationState<DatabasesRegenerateKeyResponse>, DatabasesRegenerateKeyResponse>>;
+    beginRegenerateKeyAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<DatabasesRegenerateKeyResponse>;
+    beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<PollerLike<PollOperationState<DatabasesUpdateResponse>, DatabasesUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<DatabasesUpdateResponse>;
+    get(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesGetOptionalParams): Promise<DatabasesGetResponse>;
+    listByCluster(resourceGroupName: string, clusterName: string, options?: DatabasesListByClusterOptionalParams): PagedAsyncIterableIterator<Database>;
+    listKeys(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesListKeysOptionalParams): Promise<DatabasesListKeysResponse>;
+}
+
+// @public
+export interface DatabasesCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type DatabasesCreateResponse = Database;
+
+// @public
+export interface DatabasesDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface DatabasesExportOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface DatabasesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DatabasesGetResponse = Database;
+
+// @public
+export interface DatabasesImportOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface DatabasesListByClusterNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DatabasesListByClusterNextResponse = DatabaseList;
+
+// @public
+export interface DatabasesListByClusterOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DatabasesListByClusterResponse = DatabaseList;
+
+// @public
+export interface DatabasesListKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type DatabasesListKeysResponse = AccessKeys;
+
+// @public
+export interface DatabasesRegenerateKeyOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type DatabasesRegenerateKeyResponse = AccessKeys;
+
+// @public
+export interface DatabasesUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type DatabasesUpdateResponse = Database;
+
+// @public
+export interface DatabaseUpdate {
+    clientProtocol?: Protocol;
+    clusteringPolicy?: ClusteringPolicy;
+    evictionPolicy?: EvictionPolicy;
+    modules?: Module[];
+    persistence?: Persistence;
+    port?: number;
+    readonly provisioningState?: ProvisioningState;
+    readonly resourceState?: ResourceState;
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export type EvictionPolicy = string;
+
+// @public
+export interface ExportClusterParameters {
+    sasUri: string;
+}
+
+// @public
+export interface ImportClusterParameters {
+    sasUris: string[];
+}
+
+// @public
+export enum KnownActionType {
+    // (undocumented)
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownAofFrequency {
+    // (undocumented)
+    Always = "always",
+    // (undocumented)
+    OneS = "1s"
+}
+
+// @public
+export enum KnownClusteringPolicy {
+    // (undocumented)
+    EnterpriseCluster = "EnterpriseCluster",
+    // (undocumented)
+    OSSCluster = "OSSCluster"
+}
+
+// @public
+export enum KnownEvictionPolicy {
+    // (undocumented)
+    AllKeysLFU = "AllKeysLFU",
+    // (undocumented)
+    AllKeysLRU = "AllKeysLRU",
+    // (undocumented)
+    AllKeysRandom = "AllKeysRandom",
+    // (undocumented)
+    NoEviction = "NoEviction",
+    // (undocumented)
+    VolatileLFU = "VolatileLFU",
+    // (undocumented)
+    VolatileLRU = "VolatileLRU",
+    // (undocumented)
+    VolatileRandom = "VolatileRandom",
+    // (undocumented)
+    VolatileTTL = "VolatileTTL"
+}
+
+// @public
+export enum KnownOrigin {
+    // (undocumented)
+    System = "system",
+    // (undocumented)
+    User = "user",
+    // (undocumented)
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownPrivateEndpointConnectionProvisioningState {
+    // (undocumented)
+    Creating = "Creating",
+    // (undocumented)
+    Deleting = "Deleting",
+    // (undocumented)
+    Failed = "Failed",
+    // (undocumented)
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownPrivateEndpointServiceConnectionStatus {
+    // (undocumented)
+    Approved = "Approved",
+    // (undocumented)
+    Pending = "Pending",
+    // (undocumented)
+    Rejected = "Rejected"
+}
+
+// @public
+export enum KnownProtocol {
+    // (undocumented)
+    Encrypted = "Encrypted",
+    // (undocumented)
+    Plaintext = "Plaintext"
+}
+
+// @public
+export enum KnownProvisioningState {
+    // (undocumented)
+    Canceled = "Canceled",
+    // (undocumented)
+    Creating = "Creating",
+    // (undocumented)
+    Deleting = "Deleting",
+    // (undocumented)
+    Failed = "Failed",
+    // (undocumented)
+    Succeeded = "Succeeded",
+    // (undocumented)
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownRdbFrequency {
+    // (undocumented)
+    OneH = "1h",
+    // (undocumented)
+    SixH = "6h",
+    // (undocumented)
+    TwelveH = "12h"
+}
+
+// @public
+export enum KnownResourceState {
+    // (undocumented)
+    CreateFailed = "CreateFailed",
+    // (undocumented)
+    Creating = "Creating",
+    // (undocumented)
+    DeleteFailed = "DeleteFailed",
+    // (undocumented)
+    Deleting = "Deleting",
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    DisableFailed = "DisableFailed",
+    // (undocumented)
+    Disabling = "Disabling",
+    // (undocumented)
+    EnableFailed = "EnableFailed",
+    // (undocumented)
+    Enabling = "Enabling",
+    // (undocumented)
+    Running = "Running",
+    // (undocumented)
+    UpdateFailed = "UpdateFailed",
+    // (undocumented)
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownSkuName {
+    // (undocumented)
+    EnterpriseE10 = "Enterprise_E10",
+    // (undocumented)
+    EnterpriseE100 = "Enterprise_E100",
+    // (undocumented)
+    EnterpriseE20 = "Enterprise_E20",
+    // (undocumented)
+    EnterpriseE50 = "Enterprise_E50",
+    // (undocumented)
+    EnterpriseFlashF1500 = "EnterpriseFlash_F1500",
+    // (undocumented)
+    EnterpriseFlashF300 = "EnterpriseFlash_F300",
+    // (undocumented)
+    EnterpriseFlashF700 = "EnterpriseFlash_F700"
+}
+
+// @public
+export enum KnownTlsVersion {
+    // (undocumented)
+    One0 = "1.0",
+    // (undocumented)
+    One1 = "1.1",
+    // (undocumented)
+    One2 = "1.2"
+}
+
+// @public
+export interface Module {
+    args?: string;
+    name: string;
+    readonly version?: string;
+}
+
+// @public
+export interface Operation {
+    readonly actionType?: ActionType;
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    readonly nextLink?: string;
+    readonly value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = OperationListResult;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export interface OperationsStatus {
+    get(location: string, operationId: string, options?: OperationsStatusGetOptionalParams): Promise<OperationsStatusGetResponse>;
+}
+
+// @public
+export interface OperationsStatusGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsStatusGetResponse = OperationStatus;
+
+// @public
+export interface OperationStatus {
+    endTime?: string;
+    error?: ErrorResponse;
+    id?: string;
+    name?: string;
+    startTime?: string;
+    status?: string;
+}
+
+// @public
+export type Origin = string;
+
+// @public
+export interface Persistence {
+    aofEnabled?: boolean;
+    aofFrequency?: AofFrequency;
+    rdbEnabled?: boolean;
+    rdbFrequency?: RdbFrequency;
+}
+
+// @public
+export interface PrivateEndpoint {
+    readonly id?: string;
+}
+
+// @public
+export type PrivateEndpointConnection = Resource & {
+    privateEndpoint?: PrivateEndpoint;
+    privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
+    readonly provisioningState?: PrivateEndpointConnectionProvisioningState;
+};
+
+// @public
+export interface PrivateEndpointConnectionListResult {
+    value?: PrivateEndpointConnection[];
+}
+
+// @public
+export type PrivateEndpointConnectionProvisioningState = string;
+
+// @public
+export interface PrivateEndpointConnections {
+    beginPut(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsPutOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsPutResponse>, PrivateEndpointConnectionsPutResponse>>;
+    beginPutAndWait(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsPutOptionalParams): Promise<PrivateEndpointConnectionsPutResponse>;
+    delete(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>;
+    list(resourceGroupName: string, clusterName: string, options?: PrivateEndpointConnectionsListOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>;
+}
+
+// @public
+export interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
+
+// @public
+export interface PrivateEndpointConnectionsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateEndpointConnectionsListResponse = PrivateEndpointConnectionListResult;
+
+// @public
+export interface PrivateEndpointConnectionsPutOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type PrivateEndpointConnectionsPutResponse = PrivateEndpointConnection;
+
+// @public
+export type PrivateEndpointServiceConnectionStatus = string;
+
+// @public
+export type PrivateLinkResource = Resource & {
+    readonly groupId?: string;
+    readonly requiredMembers?: string[];
+    requiredZoneNames?: string[];
+};
+
+// @public
+export interface PrivateLinkResourceListResult {
+    value?: PrivateLinkResource[];
+}
+
+// @public
+export interface PrivateLinkResources {
+    listByCluster(resourceGroupName: string, clusterName: string, options?: PrivateLinkResourcesListByClusterOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource>;
+}
+
+// @public
+export interface PrivateLinkResourcesListByClusterOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateLinkResourcesListByClusterResponse = PrivateLinkResourceListResult;
+
+// @public
+export interface PrivateLinkServiceConnectionState {
+    actionsRequired?: string;
+    description?: string;
+    status?: PrivateEndpointServiceConnectionStatus;
+}
+
+// @public
+export type Protocol = string;
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export type ProxyResource = Resource & {};
+
+// @public
+export type RdbFrequency = string;
+
+// @public
+export interface RedisEnterprise {
+    beginCreate(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: RedisEnterpriseCreateOptionalParams): Promise<PollerLike<PollOperationState<RedisEnterpriseCreateResponse>, RedisEnterpriseCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: RedisEnterpriseCreateOptionalParams): Promise<RedisEnterpriseCreateResponse>;
+    beginDelete(resourceGroupName: string, clusterName: string, options?: RedisEnterpriseDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: RedisEnterpriseDeleteOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, clusterName: string, parameters: ClusterUpdate, options?: RedisEnterpriseUpdateOptionalParams): Promise<PollerLike<PollOperationState<RedisEnterpriseUpdateResponse>, RedisEnterpriseUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterUpdate, options?: RedisEnterpriseUpdateOptionalParams): Promise<RedisEnterpriseUpdateResponse>;
+    get(resourceGroupName: string, clusterName: string, options?: RedisEnterpriseGetOptionalParams): Promise<RedisEnterpriseGetResponse>;
+    list(options?: RedisEnterpriseListOptionalParams): PagedAsyncIterableIterator<Cluster>;
+    listByResourceGroup(resourceGroupName: string, options?: RedisEnterpriseListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster>;
+}
+
+// @public
+export interface RedisEnterpriseCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type RedisEnterpriseCreateResponse = Cluster;
+
+// @public
+export interface RedisEnterpriseDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface RedisEnterpriseGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RedisEnterpriseGetResponse = Cluster;
+
+// @public
+export interface RedisEnterpriseListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RedisEnterpriseListByResourceGroupNextResponse = ClusterList;
+
+// @public
+export interface RedisEnterpriseListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RedisEnterpriseListByResourceGroupResponse = ClusterList;
+
+// @public
+export interface RedisEnterpriseListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RedisEnterpriseListNextResponse = ClusterList;
+
+// @public
+export interface RedisEnterpriseListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type RedisEnterpriseListResponse = ClusterList;
+
+// @public (undocumented)
+export class RedisEnterpriseManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: RedisEnterpriseManagementClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    databases: Databases;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    operationsStatus: OperationsStatus;
+    // (undocumented)
+    privateEndpointConnections: PrivateEndpointConnections;
+    // (undocumented)
+    privateLinkResources: PrivateLinkResources;
+    // (undocumented)
+    redisEnterprise: RedisEnterprise;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface RedisEnterpriseManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface RedisEnterpriseUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type RedisEnterpriseUpdateResponse = Cluster;
+
+// @public
+export interface RegenerateKeyParameters {
+    keyType: AccessKeyType;
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public
+export type ResourceState = string;
+
+// @public
+export interface Sku {
+    capacity?: number;
+    name: SkuName;
+}
+
+// @public
+export type SkuName = string;
+
+// @public
+export type TlsVersion = string;
+
+// @public
+export type TrackedResource = Resource & {
+    tags?: {
+        [propertyName: string]: string;
+    };
+    location: string;
+};
+
+// (No @packageDocumentation comment for this package)
+
+```