你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Redis Enterprise - Create

参考

服务:: Redis Cache

API 版本:: 2024-10-01

创建或更新现有缓存群集（覆盖/重新创建，并可能停机）缓存群集

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

URI 参数

名称	在	必需	类型	说明
clusterName	path	True	string	Redis Enterprise 群集的名称。名称长度必须为 1-60 个字符。允许的字符（A-Z、a-z、0-9）和连字符（-）。不能有前导和尾随和连续连字符正则表达式模式: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
location	True	string	资源所在的地理位置
sku	True	Sku	要创建的 SKU 会影响价格、性能和功能。
identity		ManagedServiceIdentity	资源的标识。
properties.encryption		Encryption	群集的静态加密配置。
properties.minimumTlsVersion		TlsVersion	要支持的群集的最低 TLS 版本，例如“1.2”
tags		object	资源标记。
zones		string[]	将部署此群集的可用性区域。

响应

名称	类型	说明
200 OK	Cluster	群集已/正在更新。检查 provisioningState 和 resourceState 以查看详细状态。
201 Created	Cluster	正在创建群集。检查 provisioningState 和 resourceState 以查看详细状态。
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

RedisEnterpriseCreate

示例请求

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"
  }
}

示例响应

状态代码:: 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"
  }
}

状态代码:: 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"
  }
}

定义

名称	说明
Cluster	介绍 RedisEnterprise 群集
CmkIdentityType	此 API 版本仅支持 userAssignedIdentity;将来可能支持其他类型的
CustomerManagedKeyEncryption	资源的所有客户管理的密钥加密属性。将此设置为空对象，以使用Microsoft管理的密钥加密。
Encryption	群集的静态加密配置。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
KeyEncryptionKeyIdentity	客户管理的密钥设置的所有标识配置，用于定义应用于向 Key Vault 进行身份验证的标识。
ManagedServiceIdentity	托管服务标识（系统分配和/或用户分配的标识）
ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
PrivateEndpoint	专用终结点资源。
PrivateEndpointConnection	专用终结点连接资源。
PrivateEndpointConnectionProvisioningState	当前预配状态。
PrivateEndpointServiceConnectionStatus	专用终结点连接状态。
PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
ProvisioningState	当前预配状态
ResourceState	当前资源状态
Sku	提供给创建 RedisEnterprise 操作的 SKU 参数。
SkuName	要部署的 RedisEnterprise 群集的类型。可能的值：（Enterprise_E10、EnterpriseFlash_F300等）
TlsVersion	要支持的群集的最低 TLS 版本，例如“1.2”
UserAssignedIdentity	用户分配的标识属性

Cluster

介绍 RedisEnterprise 群集

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	资源的标识。
location	string	资源所在的地理位置
name	string	资源的名称
properties.encryption	Encryption	群集的静态加密配置。
properties.hostName	string	群集终结点的 DNS 名称
properties.minimumTlsVersion	TlsVersion	要支持的群集的最低 TLS 版本，例如“1.2”
properties.privateEndpointConnections	PrivateEndpointConnection[]	与指定的 RedisEnterprise 群集关联的专用终结点连接列表
properties.provisioningState	ProvisioningState	群集的当前预配状态
properties.redisVersion	string	群集支持的 redis 版本，例如“6”
properties.resourceState	ResourceState	群集的当前资源状态
sku	Sku	要创建的 SKU 会影响价格、性能和功能。
tags	object	资源标记。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”
zones	string[]	将部署此群集的可用性区域。

CmkIdentityType

此 API 版本仅支持 userAssignedIdentity;将来可能支持其他类型的

名称	类型	说明
systemAssignedIdentity	string
userAssignedIdentity	string

CustomerManagedKeyEncryption

资源的所有客户管理的密钥加密属性。将此设置为空对象，以使用Microsoft管理的密钥加密。

名称	类型	说明
keyEncryptionKeyIdentity	KeyEncryptionKeyIdentity	客户管理的密钥设置的所有标识配置，用于定义应用于向 Key Vault 进行身份验证的标识。
keyEncryptionKeyUrl	string	密钥加密密钥 URL，仅版本控制。例如：https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

群集的静态加密配置。

名称	类型	说明
customerManagedKeyEncryption	CustomerManagedKeyEncryption	资源的所有客户管理的密钥加密属性。将此设置为空对象，以使用Microsoft管理的密钥加密。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

KeyEncryptionKeyIdentity

客户管理的密钥设置的所有标识配置，用于定义应用于向 Key Vault 进行身份验证的标识。

名称	类型	说明
identityType	CmkIdentityType	此 API 版本仅支持 userAssignedIdentity;将来可能支持其他类型的
userAssignedIdentityResourceId	string	用户分配的标识用于访问密钥加密密钥 URL。例如：/subscriptions/_{/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。}

ManagedServiceIdentity

托管服务标识（系统分配和/或用户分配的标识）

名称	类型	说明
principalId	string	系统分配标识的服务主体 ID。此属性仅针对系统分配的标识提供。
tenantId	string	系统分配标识的租户 ID。此属性仅针对系统分配的标识提供。
type	ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 标识与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。字典值可以是请求中的空对象（{}）。

ManagedServiceIdentityType

托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

专用终结点资源。

名称	类型	说明
id	string	专用终结点的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.privateEndpoint	PrivateEndpoint	专用终结点的资源。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	专用终结点连接资源的预配状态。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProvisioningState

当前预配状态。

名称	类型	说明
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

名称	类型	说明
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

名称	类型	说明
actionsRequired	string	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
description	string	批准/拒绝连接的原因。
status	PrivateEndpointServiceConnectionStatus	指示连接是否已被服务的所有者批准/拒绝/删除。

ProvisioningState

当前预配状态

名称	类型	说明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ResourceState

当前资源状态

名称	类型	说明
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

提供给创建 RedisEnterprise 操作的 SKU 参数。

名称	类型	说明
capacity	integer	RedisEnterprise 群集的大小。默认为 2 或 3，具体取决于 SKU。对于企业 SKU，有效值为（2、4、6、...），对于 Flash SKU 为（3、9、15、...）。
name	SkuName	要部署的 RedisEnterprise 群集的类型。可能的值：（Enterprise_E10、EnterpriseFlash_F300等）

SkuName

要部署的 RedisEnterprise 群集的类型。可能的值：（Enterprise_E10、EnterpriseFlash_F300等）

名称	类型	说明
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

要支持的群集的最低 TLS 版本，例如“1.2”

名称	类型	说明
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

用户分配的标识属性

名称	类型	说明
clientId	string	分配的标识的客户端 ID。
principalId	string	已分配标识的主体 ID。

通过