Redis Enterprise - Get

參考

服務:: Redis Cache

API 版本:: 2024-10-01

取得 RedisEnterprise 叢集的相關信息

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}?api-version=2024-10-01

URI 參數

名稱	位於	必要	類型	Description
clusterName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Redis Enterprise 叢集的名稱。名稱長度必須是 1-60 個字元。允許的字元（A-Z、a-z、0-9）和連字元（-）。沒有前置或尾端或連續連字元
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	Cluster	要求成功，回應本文包含要求的詳細數據。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

RedisEnterpriseGet

範例要求

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1?api-version=2024-10-01

範例回覆

狀態碼:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1",
  "location": "West US",
  "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",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/cachePec",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/cachePe"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Please approve my connection",
            "actionsRequired": "None"
          }
        }
      }
    ]
  }
}

定義

名稱	Description
Cluster	描述 RedisEnterprise 叢集
CmkIdentityType	此 API 版本僅支援 userAssignedIdentity;未來可能支援其他類型
CustomerManagedKeyEncryption	資源的所有客戶自控金鑰加密屬性。將此設定為空白物件，以使用Microsoft管理的金鑰加密。
Encryption	叢集的待用加密組態。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
KeyEncryptionKeyIdentity	客戶管理的金鑰設定的所有身分識別組態，定義應用來驗證 Key Vault 的身分識別。
ManagedServiceIdentity	受控服務識別（系統指派和/或使用者指派的身分識別）
ManagedServiceIdentityType	受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。
PrivateEndpoint	私人端點資源。
PrivateEndpointConnection	私人端點聯機資源。
PrivateEndpointConnectionProvisioningState	目前的布建狀態。
PrivateEndpointServiceConnectionStatus	私人端點連線狀態。
PrivateLinkServiceConnectionState	服務取用者與提供者之間連線狀態的相關信息集合。
ProvisioningState	目前的布建狀態
ResourceState	目前的資源狀態
Sku	提供給建立 RedisEnterprise 作業的 SKU 參數。
SkuName	要部署的 RedisEnterprise 叢集類型。可能的值：（Enterprise_E10、EnterpriseFlash_F300等）
TlsVersion	叢集支援的最低 TLS 版本，例如 '1.2'
UserAssignedIdentity	使用者指派的身分識別屬性

Cluster

Object

描述 RedisEnterprise 叢集

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	資源的身分識別。
location	string	資源所在的地理位置
name	string	資源的名稱
properties.encryption	Encryption	叢集的待用加密組態。
properties.hostName	string	叢集端點的 DNS 名稱
properties.minimumTlsVersion	TlsVersion	叢集支援的最低 TLS 版本，例如 '1.2'
properties.privateEndpointConnections	PrivateEndpointConnection[]	與指定 RedisEnterprise 叢集相關聯的私人端點連線清單
properties.provisioningState	ProvisioningState	叢集目前的布建狀態
properties.redisVersion	string	叢集支援的 redis 版本，例如 '6'
properties.resourceState	ResourceState	叢集的目前資源狀態
sku	Sku	要建立的 SKU 會影響價格、效能和功能。
tags	object	資源標籤。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”
zones	string[]	將部署此叢集的可用性區域。

CmkIdentityType

列舉型別

此 API 版本僅支援 userAssignedIdentity;未來可能支援其他類型

值	Description
systemAssignedIdentity
userAssignedIdentity

CustomerManagedKeyEncryption

Object

資源的所有客戶自控金鑰加密屬性。將此設定為空白物件，以使用Microsoft管理的金鑰加密。

名稱	類型	Description
keyEncryptionKeyIdentity	KeyEncryptionKeyIdentity	客戶管理的金鑰設定的所有身分識別組態，定義應用來驗證 Key Vault 的身分識別。
keyEncryptionKeyUrl	string	金鑰加密金鑰 URL，僅限版本。例如：https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

Object

叢集的待用加密組態。

名稱	類型	Description
customerManagedKeyEncryption	CustomerManagedKeyEncryption	資源的所有客戶自控金鑰加密屬性。將此設定為空白物件，以使用Microsoft管理的金鑰加密。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

KeyEncryptionKeyIdentity

Object

客戶管理的金鑰設定的所有身分識別組態，定義應用來驗證 Key Vault 的身分識別。

名稱	類型	Description
identityType	CmkIdentityType	此 API 版本僅支援 userAssignedIdentity;未來可能支援其他類型
userAssignedIdentityResourceId	string	使用者指派的身分識別可用來存取金鑰加密金鑰 URL。例如：/subscriptions/_{/resourceGroups/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。}

ManagedServiceIdentity

Object

受控服務識別（系統指派和/或使用者指派的身分識別）

名稱	類型	Description
principalId	string (uuid)	系統指派身分識別的服務主體標識碼。此屬性只會針對系統指派的身分識別提供。
tenantId	string (uuid)	系統指派身分識別的租用戶標識碼。此屬性只會針對系統指派的身分識別提供。
type	ManagedServiceIdentityType	受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 身分識別與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。字典值可以是要求中的空白物件（{}）。

ManagedServiceIdentityType

列舉型別

受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。

值	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

Object

私人端點資源。

名稱	類型	Description
id	string	私人端點的ARM標識碼

PrivateEndpointConnection

Object

私人端點聯機資源。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.privateEndpoint	PrivateEndpoint	私人端點的資源。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	服務取用者與提供者之間連線狀態的相關信息集合。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	私人端點聯機資源的布建狀態。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProvisioningState

列舉型別

目前的布建狀態。

值	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

列舉型別

私人端點連線狀態。

值	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

服務取用者與提供者之間連線狀態的相關信息集合。

名稱	類型	Description
actionsRequired	string	訊息，指出服務提供者上的變更是否需要取用者的任何更新。
description	string	核准/拒絕連線的原因。
status	PrivateEndpointServiceConnectionStatus	指出服務擁有者是否已核准/拒絕/移除連線。

ProvisioningState

列舉型別

目前的布建狀態

值	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ResourceState

列舉型別

目前的資源狀態

值	Description
CreateFailed
Creating
DeleteFailed
Deleting
DisableFailed
Disabled
Disabling
EnableFailed
Enabling
Running
Scaling
ScalingFailed
UpdateFailed
Updating

Sku

Object

提供給建立 RedisEnterprise 作業的 SKU 參數。

名稱	類型	Description
capacity	integer (int32)	RedisEnterprise 叢集的大小。默認為 2 或 3，視 SKU 而定。適用於企業 SKU 的有效值為（2、4、6、...），以及 Flash SKU 的有效值為（3、9、15...）。
name	SkuName	要部署的 RedisEnterprise 叢集類型。可能的值：（Enterprise_E10、EnterpriseFlash_F300等）

SkuName

列舉型別

要部署的 RedisEnterprise 叢集類型。可能的值：（Enterprise_E10、EnterpriseFlash_F300等）

值	Description
EnterpriseFlash_F1500
EnterpriseFlash_F300
EnterpriseFlash_F700
Enterprise_E1
Enterprise_E10
Enterprise_E100
Enterprise_E20
Enterprise_E200
Enterprise_E400
Enterprise_E5
Enterprise_E50

TlsVersion

列舉型別

叢集支援的最低 TLS 版本，例如 '1.2'

值	Description
1.0
1.1
1.2

UserAssignedIdentity

Object

使用者指派的身分識別屬性

名稱	類型	Description
clientId	string (uuid)	指派之身分識別的用戶端標識碼。
principalId	string (uuid)	指派之身分識別的主體標識碼。

共用方式為

Redis Enterprise - Get

URI 參數

回應

安全性

azure_auth

範圍

範例

RedisEnterpriseGet

範例要求

範例回覆

定義

Cluster

CmkIdentityType

CustomerManagedKeyEncryption

Encryption

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyEncryptionKeyIdentity

ManagedServiceIdentity

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ProvisioningState

ResourceState

Sku

SkuName

TlsVersion

UserAssignedIdentity

其他資源