Redis Enterprise - Get

Referentie

Service:: Redis Cache

API-versie:: 2024-10-01

Haalt informatie op over een RedisEnterprise-cluster

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

URI-parameters

Name	In	Vereist	Type	Description
clusterName	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
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	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	Cluster	De aanvraag is voltooid. De hoofdtekst van de reactie bevat de aangevraagde details.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

RedisEnterpriseGet

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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"
          }
        }
      }
    ]
  }
}

Definities

Name	Description
Cluster	Beschrijft het RedisEnterprise-cluster
CmkIdentityType	Alleen userAssignedIdentity wordt ondersteund in deze API-versie; andere typen kunnen in de toekomst worden ondersteund
CustomerManagedKeyEncryption	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.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
KeyEncryptionKeyIdentity	Alle identiteitsconfiguraties voor door de klant beheerde sleutelinstellingen die definiëren welke identiteit moet worden gebruikt voor verificatie bij Key Vault.
ManagedServiceIdentity	Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten)
ManagedServiceIdentityType	Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan).
PrivateEndpoint	De privé-eindpuntresource.
PrivateEndpointConnection	De privé-eindpuntverbindingsresource.
PrivateEndpointConnectionProvisioningState	De huidige inrichtingsstatus.
PrivateEndpointServiceConnectionStatus	De verbindingsstatus van het privé-eindpunt.
PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
ProvisioningState	Huidige inrichtingsstatus
ResourceState	Huidige resourcestatus
Sku	SKU-parameters die zijn opgegeven voor de bewerking RedisEnterprise maken.
SkuName	Het type RedisEnterprise-cluster dat moet worden geïmplementeerd. Mogelijke waarden: (Enterprise_E10, EnterpriseFlash_F300 enzovoort)
TlsVersion	De minimale TLS-versie voor het cluster dat moet worden ondersteund, bijvoorbeeld '1.2'
UserAssignedIdentity	Door de gebruiker toegewezen identiteitseigenschappen

Cluster

Object

Beschrijft het RedisEnterprise-cluster

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	De identiteit van de resource.
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.encryption	Encryption	Versleuteling-at-rest-configuratie voor het cluster.
properties.hostName	string	DNS-naam van het clustereindpunt
properties.minimumTlsVersion	TlsVersion	De minimale TLS-versie voor het cluster dat moet worden ondersteund, bijvoorbeeld '1.2'
properties.privateEndpointConnections	PrivateEndpointConnection[]	Lijst met privé-eindpuntverbindingen die zijn gekoppeld aan het opgegeven RedisEnterprise-cluster
properties.provisioningState	ProvisioningState	Huidige inrichtingsstatus van het cluster
properties.redisVersion	string	Versie van redis die het cluster ondersteunt, bijvoorbeeld '6'
properties.resourceState	ResourceState	Huidige resourcestatus van het cluster
sku	Sku	De SKU die moet worden gemaakt, wat van invloed is op de prijs, prestaties en functies.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'
zones	string[]	De beschikbaarheidszones waar dit cluster wordt geïmplementeerd.

CmkIdentityType

Inventarisatie

Alleen userAssignedIdentity wordt ondersteund in deze API-versie; andere typen kunnen in de toekomst worden ondersteund

Waarde	Description
systemAssignedIdentity
userAssignedIdentity

CustomerManagedKeyEncryption

Object

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	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: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

Object

Versleuteling-at-rest-configuratie voor het cluster.

Name	Type	Description
customerManagedKeyEncryption	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

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

KeyEncryptionKeyIdentity

Object

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	CmkIdentityType	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. Bijvoorbeeld: /subscriptions/_{/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.}

ManagedServiceIdentity

Object

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	ManagedServiceIdentityType	Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned identiteiten De set door de gebruiker toegewezen identiteiten die aan de resource zijn gekoppeld. De woordenlijstsleutels userAssignedIdentities zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. De waarden van de woordenlijst kunnen lege objecten ({}) zijn in aanvragen.

ManagedServiceIdentityType

Inventarisatie

Type beheerde service-identiteit (waarbij zowel SystemAssigned- als UserAssigned-typen zijn toegestaan).

Waarde	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

Object

De privé-eindpuntresource.

Name	Type	Description
id	string	De ARM-id voor privé-eindpunt

PrivateEndpointConnection

Object

De privé-eindpuntverbindingsresource.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.privateEndpoint	PrivateEndpoint	De resource van het privé-eindpunt.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	De inrichtingsstatus van de privé-eindpuntverbindingsresource.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateEndpointConnectionProvisioningState

Inventarisatie

De huidige inrichtingsstatus.

Waarde	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Inventarisatie

De verbindingsstatus van het privé-eindpunt.

Waarde	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

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	PrivateEndpointServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

ProvisioningState

Inventarisatie

Huidige inrichtingsstatus

Waarde	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ResourceState

Inventarisatie

Huidige resourcestatus

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

Sku

Object

SKU-parameters die zijn opgegeven voor de bewerking RedisEnterprise maken.

Name	Type	Description
capacity	integer (int32)	De grootte van het RedisEnterprise-cluster. De standaardwaarde is 2 of 3, afhankelijk van de SKU. Geldige waarden zijn (2, 4, 6, ...) voor Enterprise-SKU's en (3, 9, 15, ...) voor Flash-SKU's.
name	SkuName	Het type RedisEnterprise-cluster dat moet worden geïmplementeerd. Mogelijke waarden: (Enterprise_E10, EnterpriseFlash_F300 enzovoort)

SkuName

Inventarisatie

Het type RedisEnterprise-cluster dat moet worden geïmplementeerd. Mogelijke waarden: (Enterprise_E10, EnterpriseFlash_F300 enzovoort)

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

TlsVersion

Inventarisatie

De minimale TLS-versie voor het cluster dat moet worden ondersteund, bijvoorbeeld '1.2'

Waarde	Description
1.0
1.1
1.2

UserAssignedIdentity

Object

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.

Delen via

Redis Enterprise - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

RedisEnterpriseGet

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Cluster

CmkIdentityType

CustomerManagedKeyEncryption

Encryption

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyEncryptionKeyIdentity

ManagedServiceIdentity

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ProvisioningState

ResourceState

Sku

SkuName

TlsVersion

UserAssignedIdentity

Aanvullende resources