Redis Enterprise - Get
获取有关 Redis Enterprise 集群的信息
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}?api-version=2025-07-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
cluster
|
path | True |
string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ |
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 此名称不区分大小写。 |
|
subscription
|
path | True |
string minLength: 1 |
目标订阅的 ID。 |
|
api-version
|
query | True |
string minLength: 1 |
要用于此操作的 API 版本。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
请求成功,响应正文包含请求的详细信息。 |
|
| Other Status Codes |
描述作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
RedisEnterpriseGet
示例请求
示例响应
{
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1",
"location": "West US",
"kind": "v1",
"sku": {
"name": "EnterpriseFlash_F300",
"capacity": 3
},
"zones": [
"1",
"2",
"3"
],
"name": "cache1",
"type": "Microsoft.Cache/redisEnterprise",
"tags": {},
"properties": {
"hostName": "cache1.westus.something.azure.com",
"provisioningState": "Succeeded",
"resourceState": "Running",
"redisVersion": "6",
"minimumTlsVersion": "1.2",
"publicNetworkAccess": "Disabled",
"privateEndpointConnections": [
{
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/cachePec",
"properties": {
"privateEndpoint": {
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/cachePe"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Please approve my connection",
"actionsRequired": "None"
}
}
}
]
}
}
定义
| 名称 | 说明 |
|---|---|
| Cluster |
描述 Redis Enterprise 集群 |
|
Cmk |
此 API 版本仅支持 userAssignedIdentity;将来可能支持其他类型的 |
|
Customer |
资源的所有客户管理的密钥加密属性。 将此设置为空对象,以使用Microsoft管理的密钥加密。 |
| Encryption |
群集的静态加密配置。 |
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
|
High |
默认启用。 如果禁用 highAvailability,则不会复制数据集。 这会影响可用性 SLA,并增加数据丢失的风险。 |
|
Key |
客户管理的密钥设置的所有标识配置,用于定义应用于向 Key Vault 进行身份验证的标识。 |
| Kind |
区分集群的类型。 只读。 |
|
Managed |
托管服务标识(系统分配和/或用户分配的标识) |
|
Managed |
托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。 |
|
Private |
专用终结点资源。 |
|
Private |
专用终结点连接资源。 |
|
Private |
当前预配状态。 |
|
Private |
专用终结点连接状态。 |
|
Private |
有关服务使用者与提供程序之间的连接状态的信息集合。 |
|
Provisioning |
当前预配状态 |
|
Public |
公网流量是否可以访问Redis集群。 只能设置“启用”或“禁用”。 null 仅对于使用旧 API 版本创建的集群返回,这些 API 版本没有此属性且无法设置。 |
|
Redundancy |
说明群集的当前冗余策略,该策略会影响预期的 SLA。 |
|
Resource |
当前资源状态 |
| Sku |
SKU 参数提供给创建 Redis Enterprise 集群作。 |
|
Sku |
要部署的 Redis Enterprise 群集级别。 可能的值:(“Balanced_B5”、“MemoryOptimized_M10”、“ComputeOptimized_X5”等)。 有关 SKU 的详细信息,请参阅最新的定价文档。 请注意,将来可能会支持其他 SKU。 |
|
Tls |
要支持的群集的最低 TLS 版本,例如“1.2”。 将来可以添加较新版本。 请注意,TLS 1.0 和 TLS 1.1 现已完全过时 -- 无法使用它们。 仅为了与旧 API 版本保持一致,才提及它们。 |
|
User |
用户分配的标识属性 |
Cluster
描述 Redis Enterprise 集群
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| identity |
资源的标识。 |
|
| kind |
区分集群的类型。 只读。 |
|
| location |
string |
资源所在的地理位置 |
| name |
string |
资源的名称 |
| properties.encryption |
群集的静态加密配置。 |
|
| properties.highAvailability |
默认启用。 如果禁用 highAvailability,则不会复制数据集。 这会影响可用性 SLA,并增加数据丢失的风险。 |
|
| properties.hostName |
string |
集群终结点的 DNS 名称 |
| properties.minimumTlsVersion |
要支持的群集的最低 TLS 版本,例如“1.2”。 将来可以添加较新版本。 请注意,TLS 1.0 和 TLS 1.1 现已完全过时 -- 无法使用它们。 仅为了与旧 API 版本保持一致,才提及它们。 |
|
| properties.privateEndpointConnections |
与指定的 Redis Enterprise 群集关联的专用终结点连接列表 |
|
| properties.provisioningState |
群集的当前预配状态 |
|
| properties.publicNetworkAccess |
公网流量是否可以访问Redis集群。 只能设置“启用”或“禁用”。 null 仅对于使用旧 API 版本创建的集群返回,这些 API 版本没有此属性且无法设置。 |
|
| properties.redisVersion |
string |
集群支持的 redis 版本,例如 '6' |
| properties.redundancyMode |
说明群集的当前冗余策略,该策略会影响预期的 SLA。 |
|
| properties.resourceState |
集群的当前资源状态 |
|
| sku |
要创建的 SKU 会影响价格、性能和功能。 |
|
| tags |
object |
资源标记。 |
| type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
| zones |
string[] |
将部署此群集的可用性区域。 |
CmkIdentityType
此 API 版本仅支持 userAssignedIdentity;将来可能支持其他类型的
| 值 | 说明 |
|---|---|
| systemAssignedIdentity | |
| userAssignedIdentity |
CustomerManagedKeyEncryption
资源的所有客户管理的密钥加密属性。 将此设置为空对象,以使用Microsoft管理的密钥加密。
| 名称 | 类型 | 说明 |
|---|---|---|
| keyEncryptionKeyIdentity |
客户管理的密钥设置的所有标识配置,用于定义应用于向 Key Vault 进行身份验证的标识。 |
|
| keyEncryptionKeyUrl |
string |
密钥加密密钥 URL,仅版本控制。 例如: |
Encryption
群集的静态加密配置。
| 名称 | 类型 | 说明 |
|---|---|---|
| customerManagedKeyEncryption |
资源的所有客户管理的密钥加密属性。 将此设置为空对象,以使用Microsoft管理的密钥加密。 |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
HighAvailability
默认启用。 如果禁用 highAvailability,则不会复制数据集。 这会影响可用性 SLA,并增加数据丢失的风险。
| 值 | 说明 |
|---|---|
| Enabled | |
| Disabled |
KeyEncryptionKeyIdentity
客户管理的密钥设置的所有标识配置,用于定义应用于向 Key Vault 进行身份验证的标识。
| 名称 | 类型 | 说明 |
|---|---|---|
| identityType |
此 API 版本仅支持 userAssignedIdentity;将来可能支持其他类型的 |
|
| userAssignedIdentityResourceId |
string |
用户分配的标识用于访问密钥加密密钥 URL。 例如:/subscriptions//resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。 |
Kind
区分集群的类型。 只读。
| 值 | 说明 |
|---|---|
| v1 | |
| v2 |
ManagedServiceIdentity
托管服务标识(系统分配和/或用户分配的标识)
| 名称 | 类型 | 说明 |
|---|---|---|
| principalId |
string (uuid) |
系统分配标识的服务主体 ID。 此属性仅针对系统分配的标识提供。 |
| tenantId |
string (uuid) |
系统分配标识的租户 ID。 此属性仅针对系统分配的标识提供。 |
| type |
托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。 |
|
| userAssignedIdentities |
<string,
User |
User-Assigned 标识 |
ManagedServiceIdentityType
托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。
| 值 | 说明 |
|---|---|
| None | |
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned, UserAssigned |
PrivateEndpoint
专用终结点资源。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
专用终结点的 ARM 标识符 |
PrivateEndpointConnection
专用终结点连接资源。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
资源的名称 |
| properties.privateEndpoint |
专用终结点的资源。 |
|
| properties.privateLinkServiceConnectionState |
有关服务使用者与提供程序之间的连接状态的信息集合。 |
|
| properties.provisioningState |
专用终结点连接资源的预配状态。 |
|
| type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
PrivateEndpointConnectionProvisioningState
当前预配状态。
| 值 | 说明 |
|---|---|
| Succeeded | |
| Creating | |
| Deleting | |
| Failed |
PrivateEndpointServiceConnectionStatus
专用终结点连接状态。
| 值 | 说明 |
|---|---|
| Pending | |
| Approved | |
| Rejected |
PrivateLinkServiceConnectionState
有关服务使用者与提供程序之间的连接状态的信息集合。
| 名称 | 类型 | 说明 |
|---|---|---|
| actionsRequired |
string |
一条消息,指示服务提供商上的更改是否需要对使用者进行任何更新。 |
| description |
string |
批准/拒绝连接的原因。 |
| status |
指示连接是否已被服务的所有者批准/拒绝/删除。 |
ProvisioningState
当前预配状态
| 值 | 说明 |
|---|---|
| Succeeded | |
| Failed | |
| Canceled | |
| Creating | |
| Updating | |
| Deleting |
PublicNetworkAccess
公网流量是否可以访问Redis集群。 只能设置“启用”或“禁用”。 null 仅对于使用旧 API 版本创建的集群返回,这些 API 版本没有此属性且无法设置。
| 值 | 说明 |
|---|---|
| Enabled | |
| Disabled |
RedundancyMode
说明群集的当前冗余策略,该策略会影响预期的 SLA。
| 值 | 说明 |
|---|---|
| None |
没有冗余。 将发生可用性损失。 |
| LR |
具有高可用性的本地冗余。 |
| ZR |
区域冗余。 更高的可用性。 |
ResourceState
当前资源状态
| 值 | 说明 |
|---|---|
| Running | |
| Creating | |
| CreateFailed | |
| Updating | |
| UpdateFailed | |
| Deleting | |
| DeleteFailed | |
| Enabling | |
| EnableFailed | |
| Disabling | |
| DisableFailed | |
| Disabled | |
| Scaling | |
| ScalingFailed | |
| Moving |
Sku
SKU 参数提供给创建 Redis Enterprise 集群作。
| 名称 | 类型 | 说明 |
|---|---|---|
| capacity |
integer (int32) |
此属性仅用于 Enterprise 和 EnterpriseFlash SKU。 确定群集的大小。 企业 SKU 的有效值为(2、4、6、...),对于 EnterpriseFlash SKU,有效值为 (3、9、15、...)。 |
| name |
要部署的 Redis Enterprise 群集级别。 可能的值:(“Balanced_B5”、“MemoryOptimized_M10”、“ComputeOptimized_X5”等)。 有关 SKU 的详细信息,请参阅最新的定价文档。 请注意,将来可能会支持其他 SKU。 |
SkuName
要部署的 Redis Enterprise 群集级别。 可能的值:(“Balanced_B5”、“MemoryOptimized_M10”、“ComputeOptimized_X5”等)。 有关 SKU 的详细信息,请参阅最新的定价文档。 请注意,将来可能会支持其他 SKU。
| 值 | 说明 |
|---|---|
| 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 | |
| FlashOptimized_A4500 |
TlsVersion
要支持的群集的最低 TLS 版本,例如“1.2”。 将来可以添加较新版本。 请注意,TLS 1.0 和 TLS 1.1 现已完全过时 -- 无法使用它们。 仅为了与旧 API 版本保持一致,才提及它们。
| 值 | 说明 |
|---|---|
| 1.0 | |
| 1.1 | |
| 1.2 |
UserAssignedIdentity
用户分配的标识属性
| 名称 | 类型 | 说明 |
|---|---|---|
| clientId |
string (uuid) |
分配的标识的客户端 ID。 |
| principalId |
string (uuid) |
已分配标识的主体 ID。 |