Redis Enterprise - Create

Referens

Tjänst:: Redis Cache

API-version:: 2024-10-01

Skapar eller uppdaterar ett befintligt cachekluster (skriv över/återskapa, med potentiell stilleståndstid)

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
clusterName	path	True	string	Namnet på Redis Enterprise-klustret. Namnet måste vara 1–60 tecken långt. Tillåtna tecken(A-Z, a-z, 0-9) och bindestreck(-). Det får inte finnas några inledande eller avslutande eller efterföljande bindestreck Reguljärt uttrycksmönster: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Den geo-plats där resursen finns
sku	True	Sku	Den SKU som ska skapas, vilket påverkar pris, prestanda och funktioner.
identity		ManagedServiceIdentity	Resursens identitet.
properties.encryption		Encryption	Kryptering i vila-konfiguration för klustret.
properties.minimumTlsVersion		TlsVersion	Den lägsta TLS-versionen för klustret som ska stödjas, t.ex. "1.2"
tags		object	Resurstaggar.
zones		string[]	Tillgänglighetszonerna där det här klustret ska distribueras.

Svar

Name	Typ	Description
200 OK	Cluster	Klustret uppdaterades/uppdateras. Kontrollera provisioningState och resourceState för att se detaljerad status.
201 Created	Cluster	Klustret skapades/skapas. Kontrollera provisioningState och resourceState för att se detaljerad status.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

RedisEnterpriseCreate

Exempelbegäran

HTTP

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

{
  "location": "West US",
  "sku": {
    "name": "EnterpriseFlash_F300",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": {}
    }
  },
  "properties": {
    "minimumTlsVersion": "1.2",
    "encryption": {
      "customerManagedKeyEncryption": {
        "keyEncryptionKeyIdentity": {
          "identityType": "userAssignedIdentity",
          "userAssignedIdentityResourceId": "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity"
        },
        "keyEncryptionKeyUrl": "https://your-kv.vault.azure.net/keys/your-key/your-key-version"
      }
    }
  },
  "tags": {
    "tag1": "value1"
  }
}

Exempelsvar

Statuskod:: 201

{
  "name": "cache1",
  "type": "Microsoft.Cache/redisEnterprise",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1",
  "location": "West US",
  "sku": {
    "name": "EnterpriseFlash_F300",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "hostName": "cache1.westus.something.azure.net",
    "redisVersion": "5",
    "minimumTlsVersion": "1.2",
    "encryption": {
      "customerManagedKeyEncryption": {
        "keyEncryptionKeyIdentity": {
          "userAssignedIdentityResourceId": "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity",
          "identityType": "userAssignedIdentity"
        },
        "keyEncryptionKeyUrl": "https://your-kv.vault.azure.net/keys/your-key/your-key-version"
      }
    }
  },
  "tags": {
    "tag1": "value1"
  }
}

Statuskod:: 200

{
  "name": "cache1",
  "type": "Microsoft.Cache/redisEnterprise",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1",
  "location": "West US",
  "sku": {
    "name": "EnterpriseFlash_F300",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceState": "Running",
    "hostName": "cache1.westus.something.azure.net",
    "redisVersion": "5",
    "minimumTlsVersion": "1.2"
  },
  "tags": {
    "tag1": "value1"
  }
}

Definitioner

Name	Description
Cluster	Beskriver RedisEnterprise-klustret
CmkIdentityType	Endast userAssignedIdentity stöds i den här API-versionen. andra typer kan stödjas i framtiden
CustomerManagedKeyEncryption	Alla egenskaper för kundhanterad nyckelkryptering för resursen. Ställ in detta på ett tomt objekt för att använda Microsoft-hanterad nyckelkryptering.
Encryption	Kryptering i vila-konfiguration för klustret.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
KeyEncryptionKeyIdentity	All identitetskonfiguration för kundhanterade nyckelinställningar som definierar vilken identitet som ska användas för att autentisera till Key Vault.
ManagedServiceIdentity	Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)
ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
PrivateEndpoint	Den privata slutpunktsresursen.
PrivateEndpointConnection	Den privata slutpunktsanslutningsresursen.
PrivateEndpointConnectionProvisioningState	Det aktuella etableringstillståndet.
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt.
PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
ProvisioningState	Aktuell etableringsstatus
ResourceState	Aktuell resursstatus
Sku	SKU-parametrar som tillhandahålls för åtgärden skapa RedisEnterprise.
SkuName	Typen av RedisEnterprise-kluster som ska distribueras. Möjliga värden: (Enterprise_E10, EnterpriseFlash_F300 osv.)
TlsVersion	Den lägsta TLS-versionen för klustret som ska stödjas, t.ex. "1.2"
UserAssignedIdentity	Användartilldelade identitetsegenskaper

Cluster

Beskriver RedisEnterprise-klustret

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Resursens identitet.
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.encryption	Encryption	Kryptering i vila-konfiguration för klustret.
properties.hostName	string	DNS-namnet på klusterslutpunkten
properties.minimumTlsVersion	TlsVersion	Den lägsta TLS-versionen för klustret som ska stödjas, t.ex. "1.2"
properties.privateEndpointConnections	PrivateEndpointConnection[]	Lista över privata slutpunktsanslutningar som är associerade med det angivna RedisEnterprise-klustret
properties.provisioningState	ProvisioningState	Aktuell etableringsstatus för klustret
properties.redisVersion	string	Version av redis som klustret stöder, t.ex. "6"
properties.resourceState	ResourceState	Aktuell resursstatus för klustret
sku	Sku	Den SKU som ska skapas, vilket påverkar pris, prestanda och funktioner.
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"
zones	string[]	Tillgänglighetszonerna där det här klustret ska distribueras.

CmkIdentityType

Endast userAssignedIdentity stöds i den här API-versionen. andra typer kan stödjas i framtiden

Name	Typ	Description
systemAssignedIdentity	string
userAssignedIdentity	string

CustomerManagedKeyEncryption

Alla egenskaper för kundhanterad nyckelkryptering för resursen. Ställ in detta på ett tomt objekt för att använda Microsoft-hanterad nyckelkryptering.

Name	Typ	Description
keyEncryptionKeyIdentity	KeyEncryptionKeyIdentity	All identitetskonfiguration för kundhanterade nyckelinställningar som definierar vilken identitet som ska användas för att autentisera till Key Vault.
keyEncryptionKeyUrl	string	Url för nyckelkrypteringsnyckel, endast version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

Kryptering i vila-konfiguration för klustret.

Name	Typ	Description
customerManagedKeyEncryption	CustomerManagedKeyEncryption	Alla egenskaper för kundhanterad nyckelkryptering för resursen. Ställ in detta på ett tomt objekt för att använda Microsoft-hanterad nyckelkryptering.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

KeyEncryptionKeyIdentity

All identitetskonfiguration för kundhanterade nyckelinställningar som definierar vilken identitet som ska användas för att autentisera till Key Vault.

Name	Typ	Description
identityType	CmkIdentityType	Endast userAssignedIdentity stöds i den här API-versionen. andra typer kan stödjas i framtiden
userAssignedIdentityResourceId	string	Användartilldelad identitet som ska användas för åtkomst till url för nyckelkrypteringsnyckel. Exempel: /subscriptions/_{/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.}

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

Name	Typ	Description
principalId	string	Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string	Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
type	ManagedServiceIdentityType	Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

Den privata slutpunktsresursen.

Name	Typ	Description
id	string	ARM-identifieraren för privat slutpunkt

PrivateEndpointConnection

Den privata slutpunktsanslutningsresursen.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.privateEndpoint	PrivateEndpoint	Resursen för den privata slutpunkten.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Etableringstillståndet för den privata slutpunktsanslutningsresursen.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

Name	Typ	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

Name	Typ	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

Name	Typ	Description
actionsRequired	string	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.
description	string	Orsak till godkännande/avvisande av anslutningen.
status	PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

ProvisioningState

Aktuell etableringsstatus

Name	Typ	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ResourceState

Aktuell resursstatus

Name	Typ	Description
CreateFailed	string
Creating	string
DeleteFailed	string
Deleting	string
DisableFailed	string
Disabled	string
Disabling	string
EnableFailed	string
Enabling	string
Running	string
Scaling	string
ScalingFailed	string
UpdateFailed	string
Updating	string

Sku

SKU-parametrar som tillhandahålls för åtgärden skapa RedisEnterprise.

Name	Typ	Description
capacity	integer	Storleken på RedisEnterprise-klustret. Standardvärdet är 2 eller 3 beroende på SKU. Giltiga värden är (2, 4, 6, ...) för Företags-SKU:er och (3, 9, 15, ...) för Flash-SKU:er.
name	SkuName	Typen av RedisEnterprise-kluster som ska distribueras. Möjliga värden: (Enterprise_E10, EnterpriseFlash_F300 osv.)

SkuName

Typen av RedisEnterprise-kluster som ska distribueras. Möjliga värden: (Enterprise_E10, EnterpriseFlash_F300 osv.)

Name	Typ	Description
EnterpriseFlash_F1500	string
EnterpriseFlash_F300	string
EnterpriseFlash_F700	string
Enterprise_E1	string
Enterprise_E10	string
Enterprise_E100	string
Enterprise_E20	string
Enterprise_E200	string
Enterprise_E400	string
Enterprise_E5	string
Enterprise_E50	string

TlsVersion

Den lägsta TLS-versionen för klustret som ska stödjas, t.ex. "1.2"

Name	Typ	Description
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

Användartilldelade identitetsegenskaper

Name	Typ	Description
clientId	string	Klient-ID för den tilldelade identiteten.
principalId	string	Huvud-ID för den tilldelade identiteten.

Dela via