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 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 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 への認証に使用する ID を定義するカスタマー マネージド キー設定のすべての ID 構成。 |
| Kind |
クラスターの種類を区別します。 読み取り専用。 |
|
Managed |
マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID) |
|
Managed |
マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 |
|
Private |
プライベート エンドポイント リソース。 |
|
Private |
プライベート エンドポイント接続リソース。 |
|
Private |
現在のプロビジョニング状態。 |
|
Private |
プライベート エンドポイント接続の状態。 |
|
Private |
サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。 |
|
Provisioning |
現在のプロビジョニング状況 |
|
Public |
パブリックネットワークトラフィックがRedisクラスターにアクセスできるかどうか。 「有効」または「無効」のみ設定できます。 null は、このプロパティを持たず、設定できない古い API バージョンを使用して作成されたクラスターに対してのみ返されます。 |
|
Redundancy |
予想される SLA に影響を与えるクラスタの現在の冗長性戦略について説明します。 |
|
Resource |
現在のリソースステータス |
| Sku |
Redis Enterprise クラスターの作成操作に指定された SKU パラメーター。 |
|
Sku |
デプロイする Redis Enterprise クラスターのレベル。 指定できる値: ('Balanced_B5'、'MemoryOptimized_M10'、'ComputeOptimized_X5'など)。 SKU の詳細については、最新の価格ドキュメントを参照してください。 今後、追加の SKU がサポートされる可能性があることに注意してください。 |
|
Tls |
サポートするクラスターの最小 TLS バージョン (例: '1.2')。 新しいバージョンは、今後追加される可能性があります。 TLS 1.0 と TLS 1.1 は完全に廃止され、使用できないことに注意してください。 これらは、古い API バージョンとの一貫性のためにのみ言及されています。 |
|
User |
ユーザー割り当て ID プロパティ |
Cluster
Redis Enterprise クラスターについて説明します
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| identity |
リソースの ID。 |
|
| 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 バージョンを使用して作成されたクラスターに対してのみ返されます。 |
|
| 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 への認証に使用する ID を定義するカスタマー マネージド キー設定のすべての ID 構成。 |
|
| 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 への認証に使用する ID を定義するカスタマー マネージド キー設定のすべての ID 構成。
| 名前 | 型 | 説明 |
|---|---|---|
| identityType |
この API バージョンでは userAssignedIdentity のみがサポートされています。他の型は将来サポートされる可能性があります |
|
| userAssignedIdentityResourceId |
string |
キー暗号化キー URL へのアクセスに使用するユーザー割り当て ID。 例: /subscriptions//resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。 |
Kind
クラスターの種類を区別します。 読み取り専用。
| 値 | 説明 |
|---|---|
| v1 | |
| v2 |
ManagedServiceIdentity
マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)
| 名前 | 型 | 説明 |
|---|---|---|
| principalId |
string (uuid) |
システム割り当て ID のサービス プリンシパル ID。 このプロパティは、システム割り当て ID にのみ提供されます。 |
| tenantId |
string (uuid) |
システム割り当て ID のテナント ID。 このプロパティは、システム割り当て ID にのみ提供されます。 |
| type |
マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 |
|
| userAssignedIdentities |
<string,
User |
User-Assigned ID |
ManagedServiceIdentityType
マネージド サービス ID の種類 (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 バージョンを使用して作成されたクラスターに対してのみ返されます。
| 値 | 説明 |
|---|---|
| Enabled | |
| Disabled |
RedundancyMode
予想される SLA に影響を与えるクラスタの現在の冗長性戦略について説明します。
| 値 | 説明 |
|---|---|
| None |
冗長性はありません。 可用性の損失が発生します。 |
| LR |
高可用性を備えたローカル冗長性。 |
| ZR |
ゾーン冗長。 可用性の向上。 |
ResourceState
現在のリソースステータス
| 値 | 説明 |
|---|---|
| Running | |
| Creating | |
| CreateFailed | |
| Updating | |
| UpdateFailed | |
| Deleting | |
| DeleteFailed | |
| Enabling | |
| EnableFailed | |
| Disabling | |
| DisableFailed | |
| Disabled | |
| Scaling | |
| ScalingFailed | |
| Moving |
Sku
Redis Enterprise クラスターの作成操作に指定された SKU パラメーター。
| 名前 | 型 | 説明 |
|---|---|---|
| capacity |
integer (int32) |
このプロパティは、Enterprise SKU と 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
ユーザー割り当て ID プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
| clientId |
string (uuid) |
割り当てられた ID のクライアント ID。 |
| principalId |
string (uuid) |
割り当てられた ID のプリンシパル ID。 |