Redis Enterprise - Get
Haalt informatie op over een Redis Enterprise-cluster
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}?api-version=2025-07-01
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
cluster
|
path | True |
string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ |
De naam van het Redis Enterprise-cluster. De naam moet 1 tot 60 tekens lang zijn. Toegestane tekens (A-Z, a-z, 0-9) en afbreekstreepje(-). Er kunnen geen voorloop- of volgstreepjes of opeenvolgende afbreekstreepjes zijn |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
De naam van de resourcegroep. De naam is hoofdletterongevoelig. |
|
subscription
|
path | True |
string minLength: 1 |
De id van het doelabonnement. |
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
Het verzoek is geslaagd, de response body bevat de gevraagde gegevens. |
|
| Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
OAuth2-stroom voor Azure Active Directory.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
| Name | Description |
|---|---|
| user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
RedisEnterpriseGet
Voorbeeldaanvraag
GET https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1?api-version=2025-07-01
Voorbeeldrespons
{
"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"
}
}
}
]
}
}
Definities
| Name | Description |
|---|---|
| Cluster |
Beschrijft het Redis Enterprise-cluster |
|
Cmk |
Alleen userAssignedIdentity wordt ondersteund in deze API-versie; andere typen kunnen in de toekomst worden ondersteund |
|
Customer |
Alle door de klant beheerde sleutelversleutelingseigenschappen voor de resource. Stel dit in op een leeg object om door Microsoft beheerde sleutelversleuteling te gebruiken. |
| Encryption |
Versleuteling-at-rest-configuratie voor het cluster. |
|
Error |
Aanvullende informatie over de resourcebeheerfout. |
|
Error |
De foutdetails. |
|
Error |
Foutreactie |
|
High |
Standaard ingeschakeld. Als highAvailability is uitgeschakeld, wordt de gegevensset niet gerepliceerd. Dit is van invloed op de SLA voor beschikbaarheid en verhoogt het risico op gegevensverlies. |
|
Key |
Alle identiteitsconfiguraties voor door de klant beheerde sleutelinstellingen die definiëren welke identiteit moet worden gebruikt voor verificatie bij Key Vault. |
| Kind |
Onderscheidt het soort cluster. Alleen lezen. |
|
Managed |
Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten) |
|
Managed |
Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan). |
|
Private |
De privé-eindpuntresource. |
|
Private |
De privé-eindpuntverbindingsresource. |
|
Private |
De huidige inrichtingsstatus. |
|
Private |
De verbindingsstatus van het privé-eindpunt. |
|
Private |
Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider. |
|
Provisioning |
Huidige provisioningstatus |
|
Public |
Of openbaar netwerkverkeer al dan niet toegang heeft tot het Redis-cluster. Alleen 'Ingeschakeld' of 'Uitgeschakeld' kan worden ingesteld. null wordt alleen geretourneerd voor clusters die zijn gemaakt met behulp van een oude API-versie die deze eigenschap niet hebben en niet kunnen worden ingesteld. |
|
Redundancy |
Hierin wordt de huidige redundantiestrategie van het cluster uitgelegd, die van invloed is op de verwachte SLA. |
|
Resource |
Huidige status van de middelen |
| Sku |
SKU-parameters die worden geleverd aan de Create Redis Enterprise-clusterbewerking. |
|
Sku |
Het niveau van het Redis Enterprise-cluster dat moet worden geïmplementeerd. Mogelijke waarden: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', enzovoort). Zie de meest recente prijsdocumentatie voor meer informatie over SKU's. Houd er rekening mee dat extra SKU's in de toekomst mogelijk worden ondersteund. |
|
Tls |
De minimale TLS-versie voor het cluster dat moet worden ondersteund, bijvoorbeeld '1.2'. Nieuwere versies kunnen in de toekomst worden toegevoegd. Houd er rekening mee dat TLS 1.0 en TLS 1.1 nu volledig verouderd zijn. U kunt ze niet gebruiken. Ze worden alleen genoemd omwille van consistentie met oude API-versies. |
|
User |
Door de gebruiker toegewezen identiteitseigenschappen |
Cluster
Beschrijft het Redis Enterprise-cluster
| Name | Type | Description |
|---|---|---|
| id |
string |
Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| identity |
De identiteit van de resource. |
|
| kind |
Onderscheidt het soort cluster. Alleen lezen. |
|
| location |
string |
De geografische locatie waar de resource zich bevindt |
| name |
string |
De naam van de resource |
| properties.encryption |
Versleuteling-at-rest-configuratie voor het cluster. |
|
| properties.highAvailability |
Standaard ingeschakeld. Als highAvailability is uitgeschakeld, wordt de gegevensset niet gerepliceerd. Dit is van invloed op de SLA voor beschikbaarheid en verhoogt het risico op gegevensverlies. |
|
| properties.hostName |
string |
DNS-naam van het clustereindpunt |
| properties.minimumTlsVersion |
De minimale TLS-versie voor het cluster dat moet worden ondersteund, bijvoorbeeld '1.2'. Nieuwere versies kunnen in de toekomst worden toegevoegd. Houd er rekening mee dat TLS 1.0 en TLS 1.1 nu volledig verouderd zijn. U kunt ze niet gebruiken. Ze worden alleen genoemd omwille van consistentie met oude API-versies. |
|
| properties.privateEndpointConnections |
Lijst met privé-eindpuntverbindingen die zijn gekoppeld aan het opgegeven Redis Enterprise-cluster |
|
| properties.provisioningState |
Huidige inrichtingsstatus van het cluster |
|
| properties.publicNetworkAccess |
Of openbaar netwerkverkeer al dan niet toegang heeft tot het Redis-cluster. Alleen 'Ingeschakeld' of 'Uitgeschakeld' kan worden ingesteld. null wordt alleen geretourneerd voor clusters die zijn gemaakt met behulp van een oude API-versie die deze eigenschap niet hebben en niet kunnen worden ingesteld. |
|
| properties.redisVersion |
string |
Versie van redis die het cluster ondersteunt, bijvoorbeeld '6' |
| properties.redundancyMode |
Hierin wordt de huidige redundantiestrategie van het cluster uitgelegd, die van invloed is op de verwachte SLA. |
|
| properties.resourceState |
Huidige resourcestatus van het cluster |
|
| sku |
De SKU die moet worden gemaakt, wat van invloed is op de prijs, prestaties en functies. |
|
| tags |
object |
Resourcetags. |
| type |
string |
Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
| zones |
string[] |
De beschikbaarheidszones waar dit cluster wordt geïmplementeerd. |
CmkIdentityType
Alleen userAssignedIdentity wordt ondersteund in deze API-versie; andere typen kunnen in de toekomst worden ondersteund
| Waarde | Description |
|---|---|
| systemAssignedIdentity | |
| userAssignedIdentity |
CustomerManagedKeyEncryption
Alle door de klant beheerde sleutelversleutelingseigenschappen voor de resource. Stel dit in op een leeg object om door Microsoft beheerde sleutelversleuteling te gebruiken.
| Name | Type | Description |
|---|---|---|
| keyEncryptionKeyIdentity |
Alle identiteitsconfiguraties voor door de klant beheerde sleutelinstellingen die definiëren welke identiteit moet worden gebruikt voor verificatie bij Key Vault. |
|
| keyEncryptionKeyUrl |
string |
Url van sleutelversleutelingssleutel, alleen versiebeheer. Bijvoorbeeld: |
Encryption
Versleuteling-at-rest-configuratie voor het cluster.
| Name | Type | Description |
|---|---|---|
| customerManagedKeyEncryption |
Alle door de klant beheerde sleutelversleutelingseigenschappen voor de resource. Stel dit in op een leeg object om door Microsoft beheerde sleutelversleuteling te gebruiken. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
| Name | Type | Description |
|---|---|---|
| info |
object |
De aanvullende informatie. |
| type |
string |
Het extra informatietype. |
ErrorDetail
De foutdetails.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
De fout bevat aanvullende informatie. |
|
| code |
string |
De foutcode. |
| details |
De foutdetails. |
|
| message |
string |
Het foutbericht. |
| target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
HighAvailability
Standaard ingeschakeld. Als highAvailability is uitgeschakeld, wordt de gegevensset niet gerepliceerd. Dit is van invloed op de SLA voor beschikbaarheid en verhoogt het risico op gegevensverlies.
| Waarde | Description |
|---|---|
| Enabled | |
| Disabled |
KeyEncryptionKeyIdentity
Alle identiteitsconfiguraties voor door de klant beheerde sleutelinstellingen die definiëren welke identiteit moet worden gebruikt voor verificatie bij Key Vault.
| Name | Type | Description |
|---|---|---|
| identityType |
Alleen userAssignedIdentity wordt ondersteund in deze API-versie; andere typen kunnen in de toekomst worden ondersteund |
|
| userAssignedIdentityResourceId |
string |
Door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot de URL van de sleutelversleutelingssleutel. Voorbeeld: /subscriptions//resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. |
Kind
Onderscheidt het soort cluster. Alleen lezen.
| Waarde | Description |
|---|---|
| v1 | |
| v2 |
ManagedServiceIdentity
Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten)
| Name | Type | Description |
|---|---|---|
| principalId |
string (uuid) |
De service-principal-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen verstrekt voor een door het systeem toegewezen identiteit. |
| tenantId |
string (uuid) |
De tenant-id van de door het systeem toegewezen identiteit. Deze eigenschap wordt alleen verstrekt voor een door het systeem toegewezen identiteit. |
| type |
Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan). |
|
| userAssignedIdentities |
<string,
User |
User-Assigned identiteiten |
ManagedServiceIdentityType
Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan).
| Waarde | Description |
|---|---|
| None | |
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned, UserAssigned |
PrivateEndpoint
De privé-eindpuntresource.
| Name | Type | Description |
|---|---|---|
| id |
string |
De ARM-id voor privé-eindpunt |
PrivateEndpointConnection
De privé-eindpuntverbindingsresource.
| Name | Type | Description |
|---|---|---|
| id |
string |
Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
De naam van de resource |
| properties.privateEndpoint |
De resource van het privé-eindpunt. |
|
| properties.privateLinkServiceConnectionState |
Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider. |
|
| properties.provisioningState |
De inrichtingsstatus van de privé-eindpuntverbindingsresource. |
|
| type |
string |
Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
PrivateEndpointConnectionProvisioningState
De huidige inrichtingsstatus.
| Waarde | Description |
|---|---|
| Succeeded | |
| Creating | |
| Deleting | |
| Failed |
PrivateEndpointServiceConnectionStatus
De verbindingsstatus van het privé-eindpunt.
| Waarde | Description |
|---|---|
| Pending | |
| Approved | |
| Rejected |
PrivateLinkServiceConnectionState
Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
| Name | Type | Description |
|---|---|---|
| actionsRequired |
string |
Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen. |
| description |
string |
De reden voor goedkeuring/afwijzing van de verbinding. |
| status |
Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service. |
ProvisioningState
Huidige provisioningstatus
| Waarde | Description |
|---|---|
| Succeeded | |
| Failed | |
| Canceled | |
| Creating | |
| Updating | |
| Deleting |
PublicNetworkAccess
Of openbaar netwerkverkeer al dan niet toegang heeft tot het Redis-cluster. Alleen 'Ingeschakeld' of 'Uitgeschakeld' kan worden ingesteld. null wordt alleen geretourneerd voor clusters die zijn gemaakt met behulp van een oude API-versie die deze eigenschap niet hebben en niet kunnen worden ingesteld.
| Waarde | Description |
|---|---|
| Enabled | |
| Disabled |
RedundancyMode
Hierin wordt de huidige redundantiestrategie van het cluster uitgelegd, die van invloed is op de verwachte SLA.
| Waarde | Description |
|---|---|
| None |
Geen redundantie. Verlies van beschikbaarheid zal optreden. |
| LR |
Lokale redundantie met hoge beschikbaarheid. |
| ZR |
Zone overbodig. Hogere beschikbaarheid. |
ResourceState
Huidige status van de middelen
| Waarde | Description |
|---|---|
| Running | |
| Creating | |
| CreateFailed | |
| Updating | |
| UpdateFailed | |
| Deleting | |
| DeleteFailed | |
| Enabling | |
| EnableFailed | |
| Disabling | |
| DisableFailed | |
| Disabled | |
| Scaling | |
| ScalingFailed | |
| Moving |
Sku
SKU-parameters die worden geleverd aan de Create Redis Enterprise-clusterbewerking.
| Name | Type | Description |
|---|---|---|
| capacity |
integer (int32) |
Deze eigenschap wordt alleen gebruikt met Enterprise- en EnterpriseFlash-SKU's. Bepaalt de grootte van het cluster. Geldige waarden zijn (2, 4, 6, ...) voor Enterprise-SKU's en (3, 9, 15, ...) voor EnterpriseFlash-SKU's. |
| name |
Het niveau van het Redis Enterprise-cluster dat moet worden geïmplementeerd. Mogelijke waarden: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', enzovoort). Zie de meest recente prijsdocumentatie voor meer informatie over SKU's. Houd er rekening mee dat extra SKU's in de toekomst mogelijk worden ondersteund. |
SkuName
Het niveau van het Redis Enterprise-cluster dat moet worden geïmplementeerd. Mogelijke waarden: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', enzovoort). Zie de meest recente prijsdocumentatie voor meer informatie over SKU's. Houd er rekening mee dat extra SKU's in de toekomst mogelijk worden ondersteund.
| Waarde | Description |
|---|---|
| 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
De minimale TLS-versie voor het cluster dat moet worden ondersteund, bijvoorbeeld '1.2'. Nieuwere versies kunnen in de toekomst worden toegevoegd. Houd er rekening mee dat TLS 1.0 en TLS 1.1 nu volledig verouderd zijn. U kunt ze niet gebruiken. Ze worden alleen genoemd omwille van consistentie met oude API-versies.
| Waarde | Description |
|---|---|
| 1.0 | |
| 1.1 | |
| 1.2 |
UserAssignedIdentity
Door de gebruiker toegewezen identiteitseigenschappen
| Name | Type | Description |
|---|---|---|
| clientId |
string (uuid) |
De client-id van de toegewezen identiteit. |
| principalId |
string (uuid) |
De principal-id van de toegewezen identiteit. |