Redis Enterprise - Create

Tjänst:: Redis Cache

API-version:: 2025-07-01

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

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
clusterName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	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
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	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
properties.publicNetworkAccess	True	PublicNetworkAccess	Om offentlig nätverkstrafik kan komma åt Redis-klustret eller inte. Endast "Aktiverad" eller "Inaktiverad" kan ställas in. null returneras endast för kluster som skapats med en gammal API-version som inte har den här egenskapen och inte kan anges.
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.highAvailability		HighAvailability	Aktiverad som standard. Om highAvailability är inaktiverat replikeras inte datauppsättningen. Detta påverkar serviceavtalet för tillgänglighet och ökar risken för dataförlust.
properties.minimumTlsVersion		TlsVersion	Den lägsta TLS-versionen för klustret som ska stödjas, t.ex. "1.2". Nyare versioner kan läggas till i framtiden. Observera att TLS 1.0 och TLS 1.1 nu är helt föråldrade – du kan inte använda dem. De nämns endast för konsekvensen med gamla API-versioner.
tags		object	Resursetiketter.
zones		string[]	Tillgänglighetszonerna där det här klustret ska distribueras.

Svar

Name	Typ	Description
200 OK	Cluster	Klustret uppdaterades/håller på att uppdateras. Kontrollera provisioningState och resourceState för att se detaljerad status.
201 Created	Cluster	Klustret skapades/håller på att 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-flöde.

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

PUT https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1?api-version=2025-07-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"
      }
    },
    "publicNetworkAccess": "Disabled"
  },
  "tags": {
    "tag1": "value1"
  }
}


import com.azure.resourcemanager.redisenterprise.models.ClusterPropertiesEncryption;
import com.azure.resourcemanager.redisenterprise.models.ClusterPropertiesEncryptionCustomerManagedKeyEncryption;
import com.azure.resourcemanager.redisenterprise.models.ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity;
import com.azure.resourcemanager.redisenterprise.models.CmkIdentityType;
import com.azure.resourcemanager.redisenterprise.models.ManagedServiceIdentity;
import com.azure.resourcemanager.redisenterprise.models.ManagedServiceIdentityType;
import com.azure.resourcemanager.redisenterprise.models.PublicNetworkAccess;
import com.azure.resourcemanager.redisenterprise.models.Sku;
import com.azure.resourcemanager.redisenterprise.models.SkuName;
import com.azure.resourcemanager.redisenterprise.models.TlsVersion;
import com.azure.resourcemanager.redisenterprise.models.UserAssignedIdentity;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for RedisEnterprise Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/
     * RedisEnterpriseCreate.json
     */
    /**
     * Sample code: RedisEnterpriseCreate.
     * 
     * @param manager Entry point to RedisEnterpriseManager.
     */
    public static void redisEnterpriseCreate(com.azure.resourcemanager.redisenterprise.RedisEnterpriseManager manager) {
        manager.redisEnterprises().define("cache1").withRegion("West US").withExistingResourceGroup("rg1")
            .withSku(new Sku().withName(SkuName.ENTERPRISE_FLASH_F300).withCapacity(3))
            .withTags(mapOf("tag1", "value1")).withZones(Arrays.asList("1", "2", "3"))
            .withIdentity(new ManagedServiceIdentity().withType(ManagedServiceIdentityType.USER_ASSIGNED)
                .withUserAssignedIdentities(mapOf(
                    "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity",
                    new UserAssignedIdentity())))
            .withPublicNetworkAccess(PublicNetworkAccess.DISABLED).withMinimumTlsVersion(TlsVersion.ONE_TWO)
            .withEncryption(new ClusterPropertiesEncryption().withCustomerManagedKeyEncryption(
                new ClusterPropertiesEncryptionCustomerManagedKeyEncryption().withKeyEncryptionKeyIdentity(
                    new ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity()
                        .withUserAssignedIdentityResourceId(
                            "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity")
                        .withIdentityType(CmkIdentityType.USER_ASSIGNED_IDENTITY))
                    .withKeyEncryptionKeyUrl("fakeTokenPlaceholder")))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.redisenterprise import RedisEnterpriseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redisenterprise
# USAGE
    python redis_enterprise_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RedisEnterpriseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f",
    )

    response = client.redis_enterprise.begin_create(
        resource_group_name="rg1",
        cluster_name="cache1",
        parameters={
            "identity": {
                "type": "UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": {}
                },
            },
            "location": "West US",
            "properties": {
                "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",
                    }
                },
                "minimumTlsVersion": "1.2",
                "publicNetworkAccess": "Disabled",
            },
            "sku": {"capacity": 3, "name": "EnterpriseFlash_F300"},
            "tags": {"tag1": "value1"},
            "zones": ["1", "2", "3"],
        },
    ).result()
    print(response)


# x-ms-original-file: specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseCreate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armredisenterprise_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/redisenterprise/armredisenterprise/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/3855ffb4be0cd4d227b130b67d874fa816736c04/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseCreate.json
func ExampleClient_BeginCreate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armredisenterprise.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClient().BeginCreate(ctx, "rg1", "cache1", armredisenterprise.Cluster{
		Location: to.Ptr("West US"),
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
		},
		Identity: &armredisenterprise.ManagedServiceIdentity{
			Type: to.Ptr(armredisenterprise.ManagedServiceIdentityTypeUserAssigned),
			UserAssignedIdentities: map[string]*armredisenterprise.UserAssignedIdentity{
				"/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": {},
			},
		},
		Properties: &armredisenterprise.ClusterCreateProperties{
			Encryption: &armredisenterprise.ClusterCommonPropertiesEncryption{
				CustomerManagedKeyEncryption: &armredisenterprise.ClusterCommonPropertiesEncryptionCustomerManagedKeyEncryption{
					KeyEncryptionKeyIdentity: &armredisenterprise.ClusterCommonPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity{
						IdentityType:                   to.Ptr(armredisenterprise.CmkIdentityTypeUserAssignedIdentity),
						UserAssignedIdentityResourceID: to.Ptr("/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity"),
					},
					KeyEncryptionKeyURL: to.Ptr("https://your-kv.vault.azure.net/keys/your-key/your-key-version"),
				},
			},
			MinimumTLSVersion:   to.Ptr(armredisenterprise.TLSVersionOne2),
			PublicNetworkAccess: to.Ptr(armredisenterprise.PublicNetworkAccessDisabled),
		},
		SKU: &armredisenterprise.SKU{
			Name:     to.Ptr(armredisenterprise.SKUNameEnterpriseFlashF300),
			Capacity: to.Ptr[int32](3),
		},
		Zones: []*string{
			to.Ptr("1"),
			to.Ptr("2"),
			to.Ptr("3")},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Cluster = armredisenterprise.Cluster{
	// 	Name: to.Ptr("cache1"),
	// 	Type: to.Ptr("Microsoft.Cache/redisEnterprise"),
	// 	ID: to.Ptr("/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("value1"),
	// 	},
	// 	Identity: &armredisenterprise.ManagedServiceIdentity{
	// 		Type: to.Ptr(armredisenterprise.ManagedServiceIdentityTypeUserAssigned),
	// 		UserAssignedIdentities: map[string]*armredisenterprise.UserAssignedIdentity{
	// 			"/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": &armredisenterprise.UserAssignedIdentity{
	// 				ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 			},
	// 		},
	// 	},
	// 	Kind: to.Ptr(armredisenterprise.KindV1),
	// 	Properties: &armredisenterprise.ClusterCreateProperties{
	// 		HostName: to.Ptr("cache1.westus.something.azure.net"),
	// 		MinimumTLSVersion: to.Ptr(armredisenterprise.TLSVersionOne2),
	// 		ProvisioningState: to.Ptr(armredisenterprise.ProvisioningStateSucceeded),
	// 		RedisVersion: to.Ptr("5"),
	// 		ResourceState: to.Ptr(armredisenterprise.ResourceStateRunning),
	// 		PublicNetworkAccess: to.Ptr(armredisenterprise.PublicNetworkAccessDisabled),
	// 	},
	// 	SKU: &armredisenterprise.SKU{
	// 		Name: to.Ptr(armredisenterprise.SKUNameEnterpriseFlashF300),
	// 		Capacity: to.Ptr[int32](3),
	// 	},
	// 	Zones: []*string{
	// 		to.Ptr("1"),
	// 		to.Ptr("2"),
	// 		to.Ptr("3")},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { RedisEnterpriseManagementClient } = require("@azure/arm-redisenterprisecache");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster
 *
 * @summary Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster
 * x-ms-original-file: specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseCreate.json
 */
async function redisEnterpriseCreate() {
  const subscriptionId =
    process.env["REDISENTERPRISE_SUBSCRIPTION_ID"] || "e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f";
  const resourceGroupName = process.env["REDISENTERPRISE_RESOURCE_GROUP"] || "rg1";
  const clusterName = "cache1";
  const parameters = {
    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",
      },
    },
    identity: {
      type: "UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/yourSubscription/resourceGroups/yourRg/providers/MicrosoftManagedIdentity/userAssignedIdentities/yourIdentity":
          {},
      },
    },
    location: "West US",
    minimumTlsVersion: "1.2",
    publicNetworkAccess: "Disabled",
    sku: { name: "EnterpriseFlash_F300", capacity: 3 },
    tags: { tag1: "value1" },
    zones: ["1", "2", "3"],
  };
  const credential = new DefaultAzureCredential();
  const client = new RedisEnterpriseManagementClient(credential, subscriptionId);
  const result = await client.redisEnterprise.beginCreateAndWait(
    resourceGroupName,
    clusterName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exempelsvar

Statuskod:: 201

{
  "name": "cache1",
  "type": "Microsoft.Cache/redisEnterprise",
  "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"
  ],
  "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",
    "publicNetworkAccess": "Disabled",
    "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/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"
  ],
  "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",
    "publicNetworkAccess": "Disabled"
  },
  "tags": {
    "tag1": "value1"
  }
}

Definitioner

Name	Description
Cluster	Beskriver Redis Enterprise-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
HighAvailability	Aktiverad som standard. Om highAvailability är inaktiverat replikeras inte datauppsättningen. Detta påverkar serviceavtalet för tillgänglighet och ökar risken för dataförlust.
KeyEncryptionKeyIdentity	All identitetskonfiguration för kundhanterade nyckelinställningar som definierar vilken identitet som ska användas för att autentisera till Key Vault.
Kind	Särskiljer typen av kluster. Skrivskyddat.
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
PublicNetworkAccess	Om offentlig nätverkstrafik kan komma åt Redis-klustret eller inte. Endast "Aktiverad" eller "Inaktiverad" kan ställas in. null returneras endast för kluster som skapats med en gammal API-version som inte har den här egenskapen och inte kan anges.
RedundancyMode	Förklarar den aktuella redundansstrategin för klustret, vilket påverkar det förväntade serviceavtalet.
ResourceState	Aktuell resursstatus
Sku	SKU-parametrar som tillhandahålls för att skapa Redis Enterprise-klusteråtgärden.
SkuName	Nivån för Redis Enterprise-kluster som ska distribueras. Möjliga värden: ("Balanced_B5", "MemoryOptimized_M10", "ComputeOptimized_X5" osv.). Mer information om SKU:er finns i den senaste prisdokumentationen. Observera att ytterligare SKU:er kan få stöd i framtiden.
TlsVersion	Den lägsta TLS-versionen för klustret som ska stödjas, t.ex. "1.2". Nyare versioner kan läggas till i framtiden. Observera att TLS 1.0 och TLS 1.1 nu är helt föråldrade – du kan inte använda dem. De nämns endast för konsekvensen med gamla API-versioner.
UserAssignedIdentity	Användartilldelade identitetsegenskaper

Cluster

Objekt

Beskriver Redis Enterprise-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.
kind	Kind	Särskiljer typen av kluster. Skrivskyddat.
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.highAvailability	HighAvailability	Aktiverad som standard. Om highAvailability är inaktiverat replikeras inte datauppsättningen. Detta påverkar serviceavtalet för tillgänglighet och ökar risken för dataförlust.
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". Nyare versioner kan läggas till i framtiden. Observera att TLS 1.0 och TLS 1.1 nu är helt föråldrade – du kan inte använda dem. De nämns endast för konsekvensen med gamla API-versioner.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Lista över privata slutpunktsanslutningar som är associerade med det angivna Redis Enterprise-klustret
properties.provisioningState	ProvisioningState	Aktuell etableringsstatus för klustret
properties.publicNetworkAccess	PublicNetworkAccess	Om offentlig nätverkstrafik kan komma åt Redis-klustret eller inte. Endast "Aktiverad" eller "Inaktiverad" kan ställas in. null returneras endast för kluster som skapats med en gammal API-version som inte har den här egenskapen och inte kan anges.
properties.redisVersion	string	Version av redis som klustret stöder, t.ex. "6"
properties.redundancyMode	RedundancyMode	Förklarar den aktuella redundansstrategin för klustret, vilket påverkar det förväntade serviceavtalet.
properties.resourceState	ResourceState	Klustrets aktuella resursstatus
sku	Sku	Den SKU som ska skapas, vilket påverkar pris, prestanda och funktioner.
tags	object	Resursetiketter.
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

Uppräkning

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

Värde	Description
systemAssignedIdentity
userAssignedIdentity

CustomerManagedKeyEncryption

Objekt

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

Objekt

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

Objekt

Ytterligare information om resurshanteringsfelet.

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

ErrorDetail

Objekt

Felinformationen.

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

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

HighAvailability

Uppräkning

Aktiverad som standard. Om highAvailability är inaktiverat replikeras inte datauppsättningen. Detta påverkar serviceavtalet för tillgänglighet och ökar risken för dataförlust.

Värde	Description
Enabled
Disabled

KeyEncryptionKeyIdentity

Objekt

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/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.}

Kind

Uppräkning

Särskiljer typen av kluster. Skrivskyddat.

Värde	Description
v1
v2

ManagedServiceIdentity

Objekt

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

Name	Typ	Description
principalId	string (uuid)	Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.
tenantId	string (uuid)	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

Uppräkning

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

Värde	Description
None
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned

PrivateEndpoint

Objekt

Den privata slutpunktsresursen.

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

PrivateEndpointConnection

Objekt

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

Uppräkning

Det aktuella etableringstillståndet.

Värde	Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Uppräkning

Anslutningsstatus för privat slutpunkt.

Värde	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Objekt

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

Uppräkning

Aktuell etableringsstatus

Värde	Description
Succeeded
Failed
Canceled
Creating
Updating
Deleting

PublicNetworkAccess

Uppräkning

Om offentlig nätverkstrafik kan komma åt Redis-klustret eller inte. Endast "Aktiverad" eller "Inaktiverad" kan ställas in. null returneras endast för kluster som skapats med en gammal API-version som inte har den här egenskapen och inte kan anges.

Värde	Description
Enabled
Disabled

RedundancyMode

Uppräkning

Förklarar den aktuella redundansstrategin för klustret, vilket påverkar det förväntade serviceavtalet.

Värde	Description
None	Ingen redundans. Tillgänglighetsförlust kommer att inträffa.
LR	Lokal redundans med hög tillgänglighet.
ZR	Zon redundant. Högre tillgänglighet.

ResourceState

Uppräkning

Aktuell resursstatus

Värde	Description
Running
Creating
CreateFailed
Updating
UpdateFailed
Deleting
DeleteFailed
Enabling
EnableFailed
Disabling
DisableFailed
Disabled
Scaling
ScalingFailed
Moving

Sku

Objekt

SKU-parametrar som tillhandahålls för att skapa Redis Enterprise-klusteråtgärden.

Name	Typ	Description
capacity	integer (int32)	Den här egenskapen används endast med Enterprise- och EnterpriseFlash-SKU:er. Avgör klustrets storlek. Giltiga värden är (2, 4, 6, ...) för Företags-SKU:er och (3, 9, 15, ...) för EnterpriseFlash-SKU:er.
name	SkuName	Nivån för Redis Enterprise-kluster som ska distribueras. Möjliga värden: ("Balanced_B5", "MemoryOptimized_M10", "ComputeOptimized_X5" osv.). Mer information om SKU:er finns i den senaste prisdokumentationen. Observera att ytterligare SKU:er kan få stöd i framtiden.

SkuName

Uppräkning

Nivån för Redis Enterprise-kluster som ska distribueras. Möjliga värden: ("Balanced_B5", "MemoryOptimized_M10", "ComputeOptimized_X5" osv.). Mer information om SKU:er finns i den senaste prisdokumentationen. Observera att ytterligare SKU:er kan få stöd i framtiden.

Värde	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

Uppräkning

Den lägsta TLS-versionen för klustret som ska stödjas, t.ex. "1.2". Nyare versioner kan läggas till i framtiden. Observera att TLS 1.0 och TLS 1.1 nu är helt föråldrade – du kan inte använda dem. De nämns endast för konsekvensen med gamla API-versioner.

Värde	Description
1.0
1.1
1.2

UserAssignedIdentity

Objekt

Användartilldelade identitetsegenskaper

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

Dela via

Redis Enterprise - Create

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

RedisEnterpriseCreate

Exempelbegäran

Exempelsvar

Definitioner

Cluster

CmkIdentityType

CustomerManagedKeyEncryption

Encryption

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HighAvailability

KeyEncryptionKeyIdentity

Kind

ManagedServiceIdentity

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ProvisioningState

PublicNetworkAccess

RedundancyMode

ResourceState

Sku

SkuName

TlsVersion

UserAssignedIdentity