azure.mgmt.redisenterprise.models module

class azure.mgmt.redisenterprise.models.AccessKeyType(*values)[source]

Bases: str, Enum

Which access key to regenerate.

PRIMARY = 'Primary'

SECONDARY = 'Secondary'

class azure.mgmt.redisenterprise.models.AccessKeys(**kwargs: Any)[source]

Bases: Model

The secret access keys used for authenticating connections to redis.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

primary_key (str) – The current primary key that clients can use to authenticate.
secondary_key (str) – The current secondary key that clients can use to authenticate.

class azure.mgmt.redisenterprise.models.AccessKeysAuthentication(*values)[source]

Bases: str, Enum

This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.redisenterprise.models.AccessPolicyAssignment(*, access_policy_name: str | None = None, user: _models.AccessPolicyAssignmentPropertiesUser | None = None, **kwargs: Any)[source]

Bases: ProxyResourceAutoGenerated

Describes the access policy assignment of Redis Enterprise database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
provisioning_state (str or ProvisioningState) – Current provisioning status of the access policy assignment. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, “Updating”, and “Deleting”.
access_policy_name (str) – Name of access policy under specific access policy assignment. Only “default” policy is supported for now.
user (AccessPolicyAssignmentPropertiesUser) – The user associated with the access policy.

Keyword Arguments:

access_policy_name (str) – Name of access policy under specific access policy assignment. Only “default” policy is supported for now.
user (AccessPolicyAssignmentPropertiesUser) – The user associated with the access policy.

class azure.mgmt.redisenterprise.models.AccessPolicyAssignmentList(*, value: List[_models.AccessPolicyAssignment] | None = None, **kwargs: Any)[source]

Bases: Model

The response of a list-all operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

value (list[AccessPolicyAssignment]) – List of access policy assignments.
next_link (str) – The URI to fetch the next page of results.

Keyword Arguments:

value (list[AccessPolicyAssignment]) – List of access policy assignments.

class azure.mgmt.redisenterprise.models.AccessPolicyAssignmentPropertiesUser(*, object_id: str | None = None, **kwargs: Any)[source]

Bases: Model

The user associated with the access policy.

Variables:: object_id (str) – The object ID of the user.
Keyword Arguments:: object_id (str) – The object ID of the user.

class azure.mgmt.redisenterprise.models.ActionType(*values)[source]

Bases: str, Enum

Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs.

INTERNAL = 'Internal'

class azure.mgmt.redisenterprise.models.AofFrequency(*values)[source]

Bases: str, Enum

Sets the frequency at which data is written to disk. Defaults to ‘1s’, meaning ‘every second’. Note that the ‘always’ setting is deprecated, because of its performance impact.

ALWAYS = 'always'

ONE_S = '1s'

class azure.mgmt.redisenterprise.models.Cluster(*, location: str, sku: _models.Sku, tags: Dict[str, str] | None = None, zones: List[str] | None = None, identity: _models.ManagedServiceIdentity | None = None, high_availability: str | _models.HighAvailability | None = None, minimum_tls_version: str | _models.TlsVersion | None = None, encryption: _models.ClusterPropertiesEncryption | None = None, **kwargs: Any)[source]

Bases: TrackedResource

Describes the Redis Enterprise cluster.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.
kind (str or Kind) – Distinguishes the kind of cluster. Read-only. Known values are: “v1” and “v2”.
sku (Sku) – The SKU to create, which affects price, performance, and features. Required.
zones (list[str]) – The Availability Zones where this cluster will be deployed.
identity (ManagedServiceIdentity) – The identity of the resource.
high_availability (str or HighAvailability) – Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. Known values are: “Enabled” and “Disabled”.
minimum_tls_version (str or TlsVersion) – The minimum TLS version for the cluster to support, e.g. ‘1.2’. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete – you cannot use them. They are mentioned only for the sake of consistency with old API versions. Known values are: “1.0”, “1.1”, and “1.2”.
encryption (ClusterPropertiesEncryption) – Encryption-at-rest configuration for the cluster.
host_name (str) – DNS name of the cluster endpoint.
provisioning_state (str or ProvisioningState) – Current provisioning status of the cluster. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, “Updating”, and “Deleting”.
redundancy_mode (str or RedundancyMode) – Explains the current redundancy strategy of the cluster, which affects the expected SLA. Known values are: “None”, “LR”, and “ZR”.
resource_state (str or ResourceState) – Current resource status of the cluster. Known values are: “Running”, “Creating”, “CreateFailed”, “Updating”, “UpdateFailed”, “Deleting”, “DeleteFailed”, “Enabling”, “EnableFailed”, “Disabling”, “DisableFailed”, “Disabled”, “Scaling”, “ScalingFailed”, and “Moving”.
redis_version (str) – Version of redis the cluster supports, e.g. ‘6’.
private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connections associated with the specified Redis Enterprise cluster.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.
sku (Sku) – The SKU to create, which affects price, performance, and features. Required.
zones (list[str]) – The Availability Zones where this cluster will be deployed.
identity (ManagedServiceIdentity) – The identity of the resource.
high_availability (str or HighAvailability) – Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. Known values are: “Enabled” and “Disabled”.
minimum_tls_version (str or TlsVersion) – The minimum TLS version for the cluster to support, e.g. ‘1.2’. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete – you cannot use them. They are mentioned only for the sake of consistency with old API versions. Known values are: “1.0”, “1.1”, and “1.2”.
encryption (ClusterPropertiesEncryption) – Encryption-at-rest configuration for the cluster.

class azure.mgmt.redisenterprise.models.ClusterList(*, value: List[_models.Cluster] | None = None, **kwargs: Any)[source]

Bases: Model

The response of a list-all operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

value (list[Cluster]) – List of clusters.
next_link (str) – The URI to fetch the next page of results.

Keyword Arguments:

value (list[Cluster]) – List of clusters.

class azure.mgmt.redisenterprise.models.ClusterPropertiesEncryption(*, customer_managed_key_encryption: _models.ClusterPropertiesEncryptionCustomerManagedKeyEncryption | None = None, **kwargs: Any)[source]

Bases: Model

Encryption-at-rest configuration for the cluster.

Variables:: customer_managed_key_encryption (ClusterPropertiesEncryptionCustomerManagedKeyEncryption) – All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.
Keyword Arguments:: customer_managed_key_encryption (ClusterPropertiesEncryptionCustomerManagedKeyEncryption) – All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.

class azure.mgmt.redisenterprise.models.ClusterPropertiesEncryptionCustomerManagedKeyEncryption(*, key_encryption_key_identity: _models.ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity | None = None, key_encryption_key_url: str | None = None, **kwargs: Any)[source]

Bases: Model

All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.

Variables:

key_encryption_key_identity (ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity) – All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
key_encryption_key_url (str) – Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78.

Keyword Arguments:

key_encryption_key_identity (ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity) – All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
key_encryption_key_url (str) – Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78.

class azure.mgmt.redisenterprise.models.ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity(*, user_assigned_identity_resource_id: str | None = None, identity_type: str | _models.CmkIdentityType | None = None, **kwargs: Any)[source]

Bases: Model

All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.

Variables:

user_assigned_identity_resource_id (str) – User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/<sub uuid>/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.
identity_type (str or CmkIdentityType) – Only userAssignedIdentity is supported in this API version; other types may be supported in the future. Known values are: “systemAssignedIdentity” and “userAssignedIdentity”.

Keyword Arguments:

user_assigned_identity_resource_id (str) – User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/<sub uuid>/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.
identity_type (str or CmkIdentityType) – Only userAssignedIdentity is supported in this API version; other types may be supported in the future. Known values are: “systemAssignedIdentity” and “userAssignedIdentity”.

class azure.mgmt.redisenterprise.models.ClusterUpdate(*, sku: _models.Sku | None = None, identity: _models.ManagedServiceIdentity | None = None, tags: Dict[str, str] | None = None, high_availability: str | _models.HighAvailability | None = None, minimum_tls_version: str | _models.TlsVersion | None = None, encryption: _models.ClusterPropertiesEncryption | None = None, **kwargs: Any)[source]

Bases: Model

A partial update to the Redis Enterprise cluster.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

sku (Sku) – The SKU to create, which affects price, performance, and features.
identity (ManagedServiceIdentity) – The identity of the resource.
tags (dict[str, str]) – Resource tags.
high_availability (str or HighAvailability) – Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. Known values are: “Enabled” and “Disabled”.
minimum_tls_version (str or TlsVersion) – The minimum TLS version for the cluster to support, e.g. ‘1.2’. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete – you cannot use them. They are mentioned only for the sake of consistency with old API versions. Known values are: “1.0”, “1.1”, and “1.2”.
encryption (ClusterPropertiesEncryption) – Encryption-at-rest configuration for the cluster.
host_name (str) – DNS name of the cluster endpoint.
provisioning_state (str or ProvisioningState) – Current provisioning status of the cluster. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, “Updating”, and “Deleting”.
redundancy_mode (str or RedundancyMode) – Explains the current redundancy strategy of the cluster, which affects the expected SLA. Known values are: “None”, “LR”, and “ZR”.
resource_state (str or ResourceState) – Current resource status of the cluster. Known values are: “Running”, “Creating”, “CreateFailed”, “Updating”, “UpdateFailed”, “Deleting”, “DeleteFailed”, “Enabling”, “EnableFailed”, “Disabling”, “DisableFailed”, “Disabled”, “Scaling”, “ScalingFailed”, and “Moving”.
redis_version (str) – Version of redis the cluster supports, e.g. ‘6’.
private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connections associated with the specified Redis Enterprise cluster.

Keyword Arguments:

sku (Sku) – The SKU to create, which affects price, performance, and features.
identity (ManagedServiceIdentity) – The identity of the resource.
tags (dict[str, str]) – Resource tags.
high_availability (str or HighAvailability) – Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. Known values are: “Enabled” and “Disabled”.
minimum_tls_version (str or TlsVersion) – The minimum TLS version for the cluster to support, e.g. ‘1.2’. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete – you cannot use them. They are mentioned only for the sake of consistency with old API versions. Known values are: “1.0”, “1.1”, and “1.2”.
encryption (ClusterPropertiesEncryption) – Encryption-at-rest configuration for the cluster.

class azure.mgmt.redisenterprise.models.ClusteringPolicy(*values)[source]

Bases: str, Enum

Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database.

ENTERPRISE_CLUSTER = 'EnterpriseCluster': Enterprise clustering policy uses only the classic redis protocol, which does not support redis cluster commands.

NO_CLUSTER = 'NoCluster': The NoCluster policy is used for non-clustered Redis instances that do not require clustering features.

OSS_CLUSTER = 'OSSCluster': OSS clustering policy follows the redis cluster specification, and requires all clients to support redis clustering.

class azure.mgmt.redisenterprise.models.CmkIdentityType(*values)[source]

Bases: str, Enum

Only userAssignedIdentity is supported in this API version; other types may be supported in the future.

SYSTEM_ASSIGNED_IDENTITY = 'systemAssignedIdentity'

USER_ASSIGNED_IDENTITY = 'userAssignedIdentity'

class azure.mgmt.redisenterprise.models.CreatedByType(*values)[source]

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'

KEY = 'Key'

MANAGED_IDENTITY = 'ManagedIdentity'

USER = 'User'

Bases: ProxyResource

Describes a database on the Redis Enterprise cluster.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
client_protocol (str or Protocol) – Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Known values are: “Encrypted” and “Plaintext”.
port (int) – TCP port of the database endpoint. Specified at create time. Defaults to an available port.
provisioning_state (str or ProvisioningState) – Current provisioning status of the database. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, “Updating”, and “Deleting”.
resource_state (str or ResourceState) – Current resource status of the database. Known values are: “Running”, “Creating”, “CreateFailed”, “Updating”, “UpdateFailed”, “Deleting”, “DeleteFailed”, “Enabling”, “EnableFailed”, “Disabling”, “DisableFailed”, “Disabled”, “Scaling”, “ScalingFailed”, and “Moving”.
clustering_policy (str or ClusteringPolicy) – Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database. Known values are: “EnterpriseCluster”, “OSSCluster”, and “NoCluster”.
eviction_policy (str or EvictionPolicy) – Redis eviction policy - default is VolatileLRU. Known values are: “AllKeysLFU”, “AllKeysLRU”, “AllKeysRandom”, “VolatileLRU”, “VolatileLFU”, “VolatileTTL”, “VolatileRandom”, and “NoEviction”.
persistence (Persistence) – Persistence settings.
modules (list[Module]) – Optional set of redis modules to enable in this database - modules can only be added at creation time.
geo_replication (DatabasePropertiesGeoReplication) – Optional set of properties to configure geo replication for this database.
redis_version (str) – Version of Redis the database is running on, e.g. ‘6.0’.
defer_upgrade (str or DeferUpgradeSetting) – Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade. Known values are: “Deferred” and “NotDeferred”.
access_keys_authentication (str or AccessKeysAuthentication) – This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. Known values are: “Disabled” and “Enabled”.

Keyword Arguments:

client_protocol (str or Protocol) – Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Known values are: “Encrypted” and “Plaintext”.
port (int) – TCP port of the database endpoint. Specified at create time. Defaults to an available port.
clustering_policy (str or ClusteringPolicy) – Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database. Known values are: “EnterpriseCluster”, “OSSCluster”, and “NoCluster”.
eviction_policy (str or EvictionPolicy) – Redis eviction policy - default is VolatileLRU. Known values are: “AllKeysLFU”, “AllKeysLRU”, “AllKeysRandom”, “VolatileLRU”, “VolatileLFU”, “VolatileTTL”, “VolatileRandom”, and “NoEviction”.
persistence (Persistence) – Persistence settings.
modules (list[Module]) – Optional set of redis modules to enable in this database - modules can only be added at creation time.
geo_replication (DatabasePropertiesGeoReplication) – Optional set of properties to configure geo replication for this database.
defer_upgrade (str or DeferUpgradeSetting) – Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade. Known values are: “Deferred” and “NotDeferred”.
access_keys_authentication (str or AccessKeysAuthentication) – This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. Known values are: “Disabled” and “Enabled”.

class azure.mgmt.redisenterprise.models.DatabaseList(*, value: List[_models.Database] | None = None, **kwargs: Any)[source]

Bases: Model

The response of a list-all operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

value (list[Database]) – List of databases.
next_link (str) – The URI to fetch the next page of results.

Keyword Arguments:

value (list[Database]) – List of databases.

class azure.mgmt.redisenterprise.models.DatabasePropertiesGeoReplication(*, group_nickname: str | None = None, linked_databases: List[_models.LinkedDatabase] | None = None, **kwargs: Any)[source]

Bases: Model

Optional set of properties to configure geo replication for this database.

Variables:

group_nickname (str) – Name for the group of linked database resources.
linked_databases (list[LinkedDatabase]) – List of database resources to link with this database.

Keyword Arguments:

group_nickname (str) – Name for the group of linked database resources.
linked_databases (list[LinkedDatabase]) – List of database resources to link with this database.

Bases: Model

A partial update to the Redis Enterprise database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

client_protocol (str or Protocol) – Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Known values are: “Encrypted” and “Plaintext”.
port (int) – TCP port of the database endpoint. Specified at create time. Defaults to an available port.
provisioning_state (str or ProvisioningState) – Current provisioning status of the database. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, “Updating”, and “Deleting”.
resource_state (str or ResourceState) – Current resource status of the database. Known values are: “Running”, “Creating”, “CreateFailed”, “Updating”, “UpdateFailed”, “Deleting”, “DeleteFailed”, “Enabling”, “EnableFailed”, “Disabling”, “DisableFailed”, “Disabled”, “Scaling”, “ScalingFailed”, and “Moving”.
clustering_policy (str or ClusteringPolicy) – Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database. Known values are: “EnterpriseCluster”, “OSSCluster”, and “NoCluster”.
eviction_policy (str or EvictionPolicy) – Redis eviction policy - default is VolatileLRU. Known values are: “AllKeysLFU”, “AllKeysLRU”, “AllKeysRandom”, “VolatileLRU”, “VolatileLFU”, “VolatileTTL”, “VolatileRandom”, and “NoEviction”.
persistence (Persistence) – Persistence settings.
modules (list[Module]) – Optional set of redis modules to enable in this database - modules can only be added at creation time.
geo_replication (DatabasePropertiesGeoReplication) – Optional set of properties to configure geo replication for this database.
redis_version (str) – Version of Redis the database is running on, e.g. ‘6.0’.
defer_upgrade (str or DeferUpgradeSetting) – Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade. Known values are: “Deferred” and “NotDeferred”.
access_keys_authentication (str or AccessKeysAuthentication) – This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. Known values are: “Disabled” and “Enabled”.

Keyword Arguments:

client_protocol (str or Protocol) – Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted. Known values are: “Encrypted” and “Plaintext”.
port (int) – TCP port of the database endpoint. Specified at create time. Defaults to an available port.
clustering_policy (str or ClusteringPolicy) – Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database. Known values are: “EnterpriseCluster”, “OSSCluster”, and “NoCluster”.
eviction_policy (str or EvictionPolicy) – Redis eviction policy - default is VolatileLRU. Known values are: “AllKeysLFU”, “AllKeysLRU”, “AllKeysRandom”, “VolatileLRU”, “VolatileLFU”, “VolatileTTL”, “VolatileRandom”, and “NoEviction”.
persistence (Persistence) – Persistence settings.
modules (list[Module]) – Optional set of redis modules to enable in this database - modules can only be added at creation time.
geo_replication (DatabasePropertiesGeoReplication) – Optional set of properties to configure geo replication for this database.
defer_upgrade (str or DeferUpgradeSetting) – Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade. Known values are: “Deferred” and “NotDeferred”.
access_keys_authentication (str or AccessKeysAuthentication) – This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created. Known values are: “Disabled” and “Enabled”.

class azure.mgmt.redisenterprise.models.DeferUpgradeSetting(*values)[source]

Bases: str, Enum

Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade.

DEFERRED = 'Deferred'

NOT_DEFERRED = 'NotDeferred'

class azure.mgmt.redisenterprise.models.ErrorAdditionalInfo(**kwargs: Any)[source]

Bases: Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

type (str) – The additional info type.
info (JSON) – The additional info.

class azure.mgmt.redisenterprise.models.ErrorDetail(**kwargs: Any)[source]

Bases: Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.redisenterprise.models.ErrorDetailAutoGenerated(**kwargs: Any)[source]

Bases: Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetailAutoGenerated]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.redisenterprise.models.ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables:: error (ErrorDetail) – The error object.
Keyword Arguments:: error (ErrorDetail) – The error object.

class azure.mgmt.redisenterprise.models.ErrorResponseAutoGenerated(*, error: _models.ErrorDetailAutoGenerated | None = None, **kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables:: error (ErrorDetailAutoGenerated) – The error object.
Keyword Arguments:: error (ErrorDetailAutoGenerated) – The error object.

class azure.mgmt.redisenterprise.models.EvictionPolicy(*values)[source]

Bases: str, Enum

Redis eviction policy - default is VolatileLRU.

ALL_KEYS_LFU = 'AllKeysLFU'

ALL_KEYS_LRU = 'AllKeysLRU'

ALL_KEYS_RANDOM = 'AllKeysRandom'

NO_EVICTION = 'NoEviction'

VOLATILE_LFU = 'VolatileLFU'

VOLATILE_LRU = 'VolatileLRU'

VOLATILE_RANDOM = 'VolatileRandom'

VOLATILE_TTL = 'VolatileTTL'

class azure.mgmt.redisenterprise.models.ExportClusterParameters(*, sas_uri: str, **kwargs: Any)[source]

Bases: Model

Parameters for a Redis Enterprise export operation.

All required parameters must be populated in order to send to server.

Variables:: sas_uri (str) – SAS URI for the target directory to export to. Required.
Keyword Arguments:: sas_uri (str) – SAS URI for the target directory to export to. Required.

class azure.mgmt.redisenterprise.models.FlushParameters(*, ids: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Parameters for a Redis Enterprise active geo-replication flush operation.

Variables:: ids (list[str]) – The identifiers of all the other database resources in the georeplication group to be flushed.
Keyword Arguments:: ids (list[str]) – The identifiers of all the other database resources in the georeplication group to be flushed.

class azure.mgmt.redisenterprise.models.ForceLinkParameters(*, geo_replication: _models.ForceLinkParametersGeoReplication, **kwargs: Any)[source]

Bases: Model

Parameters for reconfiguring active geo-replication, of an existing database that was previously unlinked from a replication group.

All required parameters must be populated in order to send to server.

Variables:: geo_replication (ForceLinkParametersGeoReplication) – Properties to configure geo replication for this database. Required.
Keyword Arguments:: geo_replication (ForceLinkParametersGeoReplication) – Properties to configure geo replication for this database. Required.

class azure.mgmt.redisenterprise.models.ForceLinkParametersGeoReplication(*, group_nickname: str | None = None, linked_databases: List[_models.LinkedDatabase] | None = None, **kwargs: Any)[source]

Bases: Model

Properties to configure geo replication for this database.

Variables:

group_nickname (str) – The name of the group of linked database resources. This should match the existing replication group name.
linked_databases (list[LinkedDatabase]) – The resource IDs of the databases that are expected to be linked and included in the replication group. This parameter is used to validate that the linking is to the expected (unlinked) part of the replication group, if it is splintered.

Keyword Arguments:

group_nickname (str) – The name of the group of linked database resources. This should match the existing replication group name.
linked_databases (list[LinkedDatabase]) – The resource IDs of the databases that are expected to be linked and included in the replication group. This parameter is used to validate that the linking is to the expected (unlinked) part of the replication group, if it is splintered.

class azure.mgmt.redisenterprise.models.ForceUnlinkParameters(*, ids: List[str], **kwargs: Any)[source]

Bases: Model

Parameters for a Redis Enterprise Active Geo Replication Force Unlink operation.

All required parameters must be populated in order to send to server.

Variables:: ids (list[str]) – The resource IDs of the database resources to be unlinked. Required.
Keyword Arguments:: ids (list[str]) – The resource IDs of the database resources to be unlinked. Required.

class azure.mgmt.redisenterprise.models.HighAvailability(*values)[source]

Bases: str, Enum

Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.redisenterprise.models.ImportClusterParameters(*, sas_uris: List[str], **kwargs: Any)[source]

Bases: Model

Parameters for a Redis Enterprise import operation.

All required parameters must be populated in order to send to server.

Variables:: sas_uris (list[str]) – SAS URIs for the target blobs to import from. Required.
Keyword Arguments:: sas_uris (list[str]) – SAS URIs for the target blobs to import from. Required.

class azure.mgmt.redisenterprise.models.Kind(*values)[source]

Bases: str, Enum

Distinguishes the kind of cluster. Read-only.

V1 = 'v1'

V2 = 'v2'

class azure.mgmt.redisenterprise.models.LinkState(*values)[source]

Bases: str, Enum

State of the link between the database resources.

LINKED = 'Linked'

LINKING = 'Linking'

LINK_FAILED = 'LinkFailed'

UNLINKING = 'Unlinking'

UNLINK_FAILED = 'UnlinkFailed'

class azure.mgmt.redisenterprise.models.LinkedDatabase(*, id: str | None = None, **kwargs: Any)[source]

Bases: Model

Specifies details of a linked database resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Resource ID of a database resource to link with this database.
state (str or LinkState) – State of the link between the database resources. Known values are: “Linked”, “Linking”, “Unlinking”, “LinkFailed”, and “UnlinkFailed”.

Keyword Arguments:

id (str) – Resource ID of a database resource to link with this database.

class azure.mgmt.redisenterprise.models.ManagedServiceIdentity(*, type: str | _models.ManagedServiceIdentityType, user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None = None, **kwargs: Any)[source]

Bases: Model

Managed service identity (system assigned and/or user assigned identities).

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

principal_id (str) – The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id (str) – The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type (str or ManagedServiceIdentityType) – Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned, UserAssigned”.
user_assigned_identities (dict[str, UserAssignedIdentity]) – 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.

Keyword Arguments:

type (str or ManagedServiceIdentityType) – Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned, UserAssigned”.
user_assigned_identities (dict[str, UserAssignedIdentity]) – 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.

class azure.mgmt.redisenterprise.models.ManagedServiceIdentityType(*values)[source]

Bases: str, Enum

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

NONE = 'None'

SYSTEM_ASSIGNED = 'SystemAssigned'

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'

USER_ASSIGNED = 'UserAssigned'

class azure.mgmt.redisenterprise.models.Module(*, name: str, args: str | None = None, **kwargs: Any)[source]

Bases: Model

Specifies configuration of a redis module.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

name (str) – The name of the module, e.g. ‘RedisBloom’, ‘RediSearch’, ‘RedisTimeSeries’. Required.
args (str) – Configuration options for the module, e.g. ‘ERROR_RATE 0.01 INITIAL_SIZE 400’.
version (str) – The version of the module, e.g. ‘1.0’.

Keyword Arguments:

name (str) – The name of the module, e.g. ‘RedisBloom’, ‘RediSearch’, ‘RedisTimeSeries’. Required.
args (str) – Configuration options for the module, e.g. ‘ERROR_RATE 0.01 INITIAL_SIZE 400’.

class azure.mgmt.redisenterprise.models.Operation(*, display: _models.OperationDisplay | None = None, **kwargs: Any)[source]

Bases: Model

Details of a REST API operation, returned from the Resource Provider Operations API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

name (str) – The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.
is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for ARM/control-plane operations.
display (OperationDisplay) – Localized display information for this particular operation.
origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.
action_type (str or ActionType) – Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

Keyword Arguments:

display (OperationDisplay) – Localized display information for this particular operation.

class azure.mgmt.redisenterprise.models.OperationDisplay(**kwargs: Any)[source]

Bases: Model

Localized display information for this particular operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

provider (str) – The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.
resource (str) – The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.
operation (str) – The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.
description (str) – The short, localized friendly description of the operation; suitable for tool tips and detailed views.

class azure.mgmt.redisenterprise.models.OperationListResult(**kwargs: Any)[source]

Bases: Model

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

value (list[Operation]) – List of operations supported by the resource provider.
next_link (str) – URL to get the next set of operation list results (if there are any).

Bases: Model

The status of a long-running operation.

Variables:

id (str) – The operation’s unique id.
name (str) – The operation’s name.
start_time (str) – The start time of the operation.
end_time (str) – The end time of the operation.
status (str) – The current status of the operation.
error (ErrorResponse) – Error response describing why the operation failed.

Keyword Arguments:

id (str) – The operation’s unique id.
name (str) – The operation’s name.
start_time (str) – The start time of the operation.
end_time (str) – The end time of the operation.
status (str) – The current status of the operation.
error (ErrorResponse) – Error response describing why the operation failed.

class azure.mgmt.redisenterprise.models.Origin(*values)[source]

Bases: str, Enum

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”.

SYSTEM = 'system'

USER = 'user'

USER_SYSTEM = 'user,system'

Bases: Model

Persistence-related configuration for the Redis Enterprise database.

Variables:

aof_enabled (bool) – Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled.
rdb_enabled (bool) – Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled.
aof_frequency (str or AofFrequency) – Sets the frequency at which data is written to disk. Defaults to ‘1s’, meaning ‘every second’. Note that the ‘always’ setting is deprecated, because of its performance impact. Known values are: “1s” and “always”.
rdb_frequency (str or RdbFrequency) – Sets the frequency at which a snapshot of the database is created. Known values are: “1h”, “6h”, and “12h”.

Keyword Arguments:

aof_enabled (bool) – Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled.
rdb_enabled (bool) – Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled.
aof_frequency (str or AofFrequency) – Sets the frequency at which data is written to disk. Defaults to ‘1s’, meaning ‘every second’. Note that the ‘always’ setting is deprecated, because of its performance impact. Known values are: “1s” and “always”.
rdb_frequency (str or RdbFrequency) – Sets the frequency at which a snapshot of the database is created. Known values are: “1h”, “6h”, and “12h”.

class azure.mgmt.redisenterprise.models.PrivateEndpoint(**kwargs: Any)[source]

Bases: Model

The Private Endpoint resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:: id (str) – The ARM identifier for Private Endpoint.

class azure.mgmt.redisenterprise.models.PrivateEndpointConnection(*, private_endpoint: _models.PrivateEndpoint | None = None, private_link_service_connection_state: _models.PrivateLinkServiceConnectionState | None = None, **kwargs: Any)[source]

Bases: Resource

The Private Endpoint Connection resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
private_endpoint (PrivateEndpoint) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.
provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Known values are: “Succeeded”, “Creating”, “Deleting”, and “Failed”.

Keyword Arguments:

private_endpoint (PrivateEndpoint) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

class azure.mgmt.redisenterprise.models.PrivateEndpointConnectionListResult(*, value: List[_models.PrivateEndpointConnection] | None = None, **kwargs: Any)[source]

Bases: Model

List of private endpoint connection associated with the specified storage account.

Variables:: value (list[PrivateEndpointConnection]) – Array of private endpoint connections.
Keyword Arguments:: value (list[PrivateEndpointConnection]) – Array of private endpoint connections.

class azure.mgmt.redisenterprise.models.PrivateEndpointConnectionProvisioningState(*values)[source]

Bases: str, Enum

The current provisioning state.

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

class azure.mgmt.redisenterprise.models.PrivateEndpointServiceConnectionStatus(*values)[source]

Bases: str, Enum

The private endpoint connection status.

APPROVED = 'Approved'

PENDING = 'Pending'

REJECTED = 'Rejected'

class azure.mgmt.redisenterprise.models.PrivateLinkResource(*, required_zone_names: List[str] | None = None, **kwargs: Any)[source]

Bases: Resource

A private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.
required_zone_names (list[str]) – The private link resource Private link DNS zone name.

Keyword Arguments:

required_zone_names (list[str]) – The private link resource Private link DNS zone name.

class azure.mgmt.redisenterprise.models.PrivateLinkResourceListResult(*, value: List[_models.PrivateLinkResource] | None = None, **kwargs: Any)[source]

Bases: Model

A list of private link resources.

Variables:: value (list[PrivateLinkResource]) – Array of private link resources.
Keyword Arguments:: value (list[PrivateLinkResource]) – Array of private link resources.

class azure.mgmt.redisenterprise.models.PrivateLinkServiceConnectionState(*, status: str | _models.PrivateEndpointServiceConnectionStatus | None = None, description: str | None = None, actions_required: str | None = None, **kwargs: Any)[source]

Bases: Model

A collection of information about the state of the connection between service consumer and provider.

Variables:

status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

Keyword Arguments:

status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

class azure.mgmt.redisenterprise.models.Protocol(*values)[source]

Bases: str, Enum

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.

ENCRYPTED = 'Encrypted'

PLAINTEXT = 'Plaintext'

class azure.mgmt.redisenterprise.models.ProvisioningState(*values)[source]

Bases: str, Enum

Current provisioning status.

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

UPDATING = 'Updating'

class azure.mgmt.redisenterprise.models.ProxyResource(**kwargs: Any)[source]

Bases: ResourceAutoGenerated

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.redisenterprise.models.ProxyResourceAutoGenerated(**kwargs: Any)[source]

Bases: Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.redisenterprise.models.RdbFrequency(*values)[source]

Bases: str, Enum

Sets the frequency at which a snapshot of the database is created.

ONE_H = '1h'

SIX_H = '6h'

TWELVE_H = '12h'

class azure.mgmt.redisenterprise.models.RedundancyMode(*values)[source]

Bases: str, Enum

Explains the current redundancy strategy of the cluster, which affects the expected SLA.

LR = 'LR': Local redundancy with high availability.

NONE = 'None': No redundancy. Availability loss will occur.

ZR = 'ZR': Zone redundant. Higher availability.

class azure.mgmt.redisenterprise.models.RegenerateKeyParameters(*, key_type: str | _models.AccessKeyType, **kwargs: Any)[source]

Bases: Model

Specifies which access keys to reset to a new random value.

All required parameters must be populated in order to send to server.

Variables:: key_type (str or AccessKeyType) – Which access key to regenerate. Required. Known values are: “Primary” and “Secondary”.
Keyword Arguments:: key_type (str or AccessKeyType) – Which access key to regenerate. Required. Known values are: “Primary” and “Secondary”.

class azure.mgmt.redisenterprise.models.Resource(**kwargs: Any)[source]

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.redisenterprise.models.ResourceAutoGenerated(**kwargs: Any)[source]

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.redisenterprise.models.ResourceState(*values)[source]

Bases: str, Enum

Current resource status.

CREATE_FAILED = 'CreateFailed'

CREATING = 'Creating'

DELETE_FAILED = 'DeleteFailed'

DELETING = 'Deleting'

DISABLED = 'Disabled'

DISABLE_FAILED = 'DisableFailed'

DISABLING = 'Disabling'

ENABLE_FAILED = 'EnableFailed'

ENABLING = 'Enabling'

MOVING = 'Moving'

RUNNING = 'Running'

SCALING = 'Scaling'

SCALING_FAILED = 'ScalingFailed'

UPDATE_FAILED = 'UpdateFailed'

UPDATING = 'Updating'

class azure.mgmt.redisenterprise.models.Sku(*, name: str | _models.SkuName, capacity: int | None = None, **kwargs: Any)[source]

Bases: Model

SKU parameters supplied to the create Redis Enterprise cluster operation.

All required parameters must be populated in order to send to server.

Variables:

name (str or SkuName) – The level of Redis Enterprise cluster to deploy. Possible values: (‘Balanced_B5’, ‘MemoryOptimized_M10’, ‘ComputeOptimized_X5’, etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. Required. Known values are: “Enterprise_E1”, “Enterprise_E5”, “Enterprise_E10”, “Enterprise_E20”, “Enterprise_E50”, “Enterprise_E100”, “Enterprise_E200”, “Enterprise_E400”, “EnterpriseFlash_F300”, “EnterpriseFlash_F700”, “EnterpriseFlash_F1500”, “Balanced_B0”, “Balanced_B1”, “Balanced_B3”, “Balanced_B5”, “Balanced_B10”, “Balanced_B20”, “Balanced_B50”, “Balanced_B100”, “Balanced_B150”, “Balanced_B250”, “Balanced_B350”, “Balanced_B500”, “Balanced_B700”, “Balanced_B1000”, “MemoryOptimized_M10”, “MemoryOptimized_M20”, “MemoryOptimized_M50”, “MemoryOptimized_M100”, “MemoryOptimized_M150”, “MemoryOptimized_M250”, “MemoryOptimized_M350”, “MemoryOptimized_M500”, “MemoryOptimized_M700”, “MemoryOptimized_M1000”, “MemoryOptimized_M1500”, “MemoryOptimized_M2000”, “ComputeOptimized_X3”, “ComputeOptimized_X5”, “ComputeOptimized_X10”, “ComputeOptimized_X20”, “ComputeOptimized_X50”, “ComputeOptimized_X100”, “ComputeOptimized_X150”, “ComputeOptimized_X250”, “ComputeOptimized_X350”, “ComputeOptimized_X500”, “ComputeOptimized_X700”, “FlashOptimized_A250”, “FlashOptimized_A500”, “FlashOptimized_A700”, “FlashOptimized_A1000”, “FlashOptimized_A1500”, “FlashOptimized_A2000”, and “FlashOptimized_A4500”.
capacity (int) – This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, …) for Enterprise SKUs and (3, 9, 15, …) for EnterpriseFlash SKUs.

Keyword Arguments:

name (str or SkuName) – The level of Redis Enterprise cluster to deploy. Possible values: (‘Balanced_B5’, ‘MemoryOptimized_M10’, ‘ComputeOptimized_X5’, etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. Required. Known values are: “Enterprise_E1”, “Enterprise_E5”, “Enterprise_E10”, “Enterprise_E20”, “Enterprise_E50”, “Enterprise_E100”, “Enterprise_E200”, “Enterprise_E400”, “EnterpriseFlash_F300”, “EnterpriseFlash_F700”, “EnterpriseFlash_F1500”, “Balanced_B0”, “Balanced_B1”, “Balanced_B3”, “Balanced_B5”, “Balanced_B10”, “Balanced_B20”, “Balanced_B50”, “Balanced_B100”, “Balanced_B150”, “Balanced_B250”, “Balanced_B350”, “Balanced_B500”, “Balanced_B700”, “Balanced_B1000”, “MemoryOptimized_M10”, “MemoryOptimized_M20”, “MemoryOptimized_M50”, “MemoryOptimized_M100”, “MemoryOptimized_M150”, “MemoryOptimized_M250”, “MemoryOptimized_M350”, “MemoryOptimized_M500”, “MemoryOptimized_M700”, “MemoryOptimized_M1000”, “MemoryOptimized_M1500”, “MemoryOptimized_M2000”, “ComputeOptimized_X3”, “ComputeOptimized_X5”, “ComputeOptimized_X10”, “ComputeOptimized_X20”, “ComputeOptimized_X50”, “ComputeOptimized_X100”, “ComputeOptimized_X150”, “ComputeOptimized_X250”, “ComputeOptimized_X350”, “ComputeOptimized_X500”, “ComputeOptimized_X700”, “FlashOptimized_A250”, “FlashOptimized_A500”, “FlashOptimized_A700”, “FlashOptimized_A1000”, “FlashOptimized_A1500”, “FlashOptimized_A2000”, and “FlashOptimized_A4500”.
capacity (int) – This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, …) for Enterprise SKUs and (3, 9, 15, …) for EnterpriseFlash SKUs.

class azure.mgmt.redisenterprise.models.SkuDetails(**kwargs: Any)[source]

Bases: Model

Details of a Redis Enterprise cluster SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

name (str) – The name of the SKU.
size_in_gb (float) – The cache size in GB.

class azure.mgmt.redisenterprise.models.SkuDetailsList(*, skus: List[_models.SkuDetails] | None = None, **kwargs: Any)[source]

Bases: Model

The response of a listSkusForScaling operation.

Variables:: skus (list[SkuDetails]) – List of SKUS available to scale up or scale down.
Keyword Arguments:: skus (list[SkuDetails]) – List of SKUS available to scale up or scale down.

class azure.mgmt.redisenterprise.models.SkuName(*values)[source]

Bases: str, Enum

The level of Redis Enterprise cluster to deploy. Possible values: (‘Balanced_B5’, ‘MemoryOptimized_M10’, ‘ComputeOptimized_X5’, etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future.

BALANCED_B0 = 'Balanced_B0'

BALANCED_B1 = 'Balanced_B1'

BALANCED_B10 = 'Balanced_B10'

BALANCED_B100 = 'Balanced_B100'

BALANCED_B1000 = 'Balanced_B1000'

BALANCED_B150 = 'Balanced_B150'

BALANCED_B20 = 'Balanced_B20'

BALANCED_B250 = 'Balanced_B250'

BALANCED_B3 = 'Balanced_B3'

BALANCED_B350 = 'Balanced_B350'

BALANCED_B5 = 'Balanced_B5'

BALANCED_B50 = 'Balanced_B50'

BALANCED_B500 = 'Balanced_B500'

BALANCED_B700 = 'Balanced_B700'

COMPUTE_OPTIMIZED_X10 = 'ComputeOptimized_X10'

COMPUTE_OPTIMIZED_X100 = 'ComputeOptimized_X100'

COMPUTE_OPTIMIZED_X150 = 'ComputeOptimized_X150'

COMPUTE_OPTIMIZED_X20 = 'ComputeOptimized_X20'

COMPUTE_OPTIMIZED_X250 = 'ComputeOptimized_X250'

COMPUTE_OPTIMIZED_X3 = 'ComputeOptimized_X3'

COMPUTE_OPTIMIZED_X350 = 'ComputeOptimized_X350'

COMPUTE_OPTIMIZED_X5 = 'ComputeOptimized_X5'

COMPUTE_OPTIMIZED_X50 = 'ComputeOptimized_X50'

COMPUTE_OPTIMIZED_X500 = 'ComputeOptimized_X500'

COMPUTE_OPTIMIZED_X700 = 'ComputeOptimized_X700'

ENTERPRISE_E1 = 'Enterprise_E1'

ENTERPRISE_E10 = 'Enterprise_E10'

ENTERPRISE_E100 = 'Enterprise_E100'

ENTERPRISE_E20 = 'Enterprise_E20'

ENTERPRISE_E200 = 'Enterprise_E200'

ENTERPRISE_E400 = 'Enterprise_E400'

ENTERPRISE_E5 = 'Enterprise_E5'

ENTERPRISE_E50 = 'Enterprise_E50'

ENTERPRISE_FLASH_F1500 = 'EnterpriseFlash_F1500'

ENTERPRISE_FLASH_F300 = 'EnterpriseFlash_F300'

ENTERPRISE_FLASH_F700 = 'EnterpriseFlash_F700'

FLASH_OPTIMIZED_A1000 = 'FlashOptimized_A1000'

FLASH_OPTIMIZED_A1500 = 'FlashOptimized_A1500'

FLASH_OPTIMIZED_A2000 = 'FlashOptimized_A2000'

FLASH_OPTIMIZED_A250 = 'FlashOptimized_A250'

FLASH_OPTIMIZED_A4500 = 'FlashOptimized_A4500'

FLASH_OPTIMIZED_A500 = 'FlashOptimized_A500'

FLASH_OPTIMIZED_A700 = 'FlashOptimized_A700'

MEMORY_OPTIMIZED_M10 = 'MemoryOptimized_M10'

MEMORY_OPTIMIZED_M100 = 'MemoryOptimized_M100'

MEMORY_OPTIMIZED_M1000 = 'MemoryOptimized_M1000'

MEMORY_OPTIMIZED_M150 = 'MemoryOptimized_M150'

MEMORY_OPTIMIZED_M1500 = 'MemoryOptimized_M1500'

MEMORY_OPTIMIZED_M20 = 'MemoryOptimized_M20'

MEMORY_OPTIMIZED_M2000 = 'MemoryOptimized_M2000'

MEMORY_OPTIMIZED_M250 = 'MemoryOptimized_M250'

MEMORY_OPTIMIZED_M350 = 'MemoryOptimized_M350'

MEMORY_OPTIMIZED_M50 = 'MemoryOptimized_M50'

MEMORY_OPTIMIZED_M500 = 'MemoryOptimized_M500'

MEMORY_OPTIMIZED_M700 = 'MemoryOptimized_M700'

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.redisenterprise.models.TlsVersion(*values)[source]

Bases: str, Enum

The minimum TLS version for the cluster to support, e.g. ‘1.2’. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete – you cannot use them. They are mentioned only for the sake of consistency with old API versions.

ONE0 = '1.0'

ONE1 = '1.1'

ONE2 = '1.2'

class azure.mgmt.redisenterprise.models.TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.

class azure.mgmt.redisenterprise.models.UserAssignedIdentity(**kwargs: Any)[source]

Bases: Model

User assigned identity properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

principal_id (str) – The principal ID of the assigned identity.
client_id (str) – The client ID of the assigned identity.