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 參數

名稱	位於	必要	類型	Description
clusterName	path	True	string	Redis Enterprise 叢集的名稱。名稱長度必須是 1-60 個字元。允許的字元（A-Z、a-z、0-9）和連字元（-）。沒有前置或尾端或連續連字元 Regex 模式: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

要求本文

名稱	必要	類型	Description
location	True	string	資源所在的地理位置
sku	True	Sku	要建立的 SKU 會影響價格、效能和功能。
identity		ManagedServiceIdentity	資源的身分識別。
properties.encryption		Encryption	叢集的待用加密組態。
properties.minimumTlsVersion		TlsVersion	叢集支援的最低 TLS 版本，例如 '1.2'
tags		object	資源標籤。
zones		string[]	將部署此叢集的可用性區域。

回應

名稱	類型	Description
200 OK	Cluster	叢集已/正在更新。檢查 provisioningState 和 resourceState 以查看詳細狀態。
201 Created	Cluster	正在建立叢集。檢查 provisioningState 和 resourceState 以查看詳細狀態。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
  }
}

定義

名稱	Description
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 叢集

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /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;未來可能支援其他類型

名稱	類型	Description
systemAssignedIdentity	string
userAssignedIdentity	string

CustomerManagedKeyEncryption

資源的所有客戶自控金鑰加密屬性。將此設定為空白物件，以使用Microsoft管理的金鑰加密。

名稱	類型	Description
keyEncryptionKeyIdentity	KeyEncryptionKeyIdentity	客戶管理的金鑰設定的所有身分識別組態，定義應用來驗證 Key Vault 的身分識別。
keyEncryptionKeyUrl	string	金鑰加密金鑰 URL，僅限版本。例如：https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

叢集的待用加密組態。

名稱	類型	Description
customerManagedKeyEncryption	CustomerManagedKeyEncryption	資源的所有客戶自控金鑰加密屬性。將此設定為空白物件，以使用Microsoft管理的金鑰加密。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

KeyEncryptionKeyIdentity

客戶管理的金鑰設定的所有身分識別組態，定義應用來驗證 Key Vault 的身分識別。

名稱	類型	Description
identityType	CmkIdentityType	此 API 版本僅支援 userAssignedIdentity;未來可能支援其他類型
userAssignedIdentityResourceId	string	使用者指派的身分識別可用來存取金鑰加密金鑰 URL。例如：/subscriptions/_{/resourceGroups/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。}

ManagedServiceIdentity

受控服務識別（系統指派和/或使用者指派的身分識別）

名稱	類型	Description
principalId	string	系統指派身分識別的服務主體標識碼。此屬性只會針對系統指派的身分識別提供。
tenantId	string	系統指派身分識別的租用戶標識碼。此屬性只會針對系統指派的身分識別提供。
type	ManagedServiceIdentityType	受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 身分識別與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。字典值可以是要求中的空白物件（{}）。

ManagedServiceIdentityType

受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。

名稱	類型	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

私人端點資源。

名稱	類型	Description
id	string	私人端點的ARM標識碼

PrivateEndpointConnection

私人端點聯機資源。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /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

目前的布建狀態。

名稱	類型	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

私人端點連線狀態。

名稱	類型	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

服務取用者與提供者之間連線狀態的相關信息集合。

名稱	類型	Description
actionsRequired	string	訊息，指出服務提供者上的變更是否需要取用者的任何更新。
description	string	核准/拒絕連線的原因。
status	PrivateEndpointServiceConnectionStatus	指出服務擁有者是否已核准/拒絕/移除連線。

ProvisioningState

目前的布建狀態

名稱	類型	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ResourceState

目前的資源狀態

名稱	類型	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

提供給建立 RedisEnterprise 作業的 SKU 參數。

名稱	類型	Description
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等）

名稱	類型	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

叢集支援的最低 TLS 版本，例如 '1.2'

名稱	類型	Description
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

使用者指派的身分識別屬性

名稱	類型	Description
clientId	string	指派之身分識別的用戶端標識碼。
principalId	string	指派之身分識別的主體標識碼。

共用方式為