Redis - Update

Service:

Redis Cache

API Version:

2023-08-01

更新現有的 Redis 快取。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}?api-version=2023-08-01

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	Redis 快取的名稱。
resourceGroupName	path	True	string	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

要求本文

名稱	類型	Description
identity	ManagedServiceIdentity	資源的身分識別。
properties.enableNonSslPort	boolean	指定是否啟用非 ssl Redis 伺服器埠 (6379) 。
properties.minimumTlsVersion	TlsVersion	選擇性：要求用戶端使用指定的 TLS 版本 (或更高版本) 來聯機 (例如 '1.0'、'1.1'、'1.2')
properties.publicNetworkAccess	PublicNetworkAccess	是否允許此快取存取公用端點。 值是選擇性的，但如果傳入，則必須是 『Enabled』 或 'Disabled'。 如果 「已停用」，私人端點就是獨佔存取方法。 預設值為 'Enabled'
properties.redisConfiguration	RedisConfiguration	所有 Redis 設定。 幾個可能的密鑰：rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-than、slowlog-max-len ，list-max-ziplist-entries，list-max-ziplist-value，hash-max-ziplist-entries，hash-max-ziplist-value，set-max-intset-entries，zset-max-ziplist-entries，zset-max-ziplist-value etc.
properties.redisVersion	string	Redis 版本。 這應該格式為 'major[.minor]'， (只需要 'major') 或 'latest' 值，這是指可用的最新穩定 Redis 版本。 支援的版本：4.0、6.0 (最新的) 。 預設值為 『latest』。
properties.replicasPerMaster	integer	要為每個主要複本建立的複本數目。
properties.replicasPerPrimary	integer	要為每個主要複本建立的複本數目。
properties.shardCount	integer	在進階叢集快取上建立的分區數目。
properties.sku	Sku	要部署之 Redis 快取的 SKU。
properties.tenantSettings	object	租用戶設定的字典
properties.updateChannel	UpdateChannel	選擇性：指定 Redis 快取將接收之每月 Redis 更新的更新通道。 使用 「預覽」更新通道的快取，至少會在「穩定」通道快取前 4 周取得最新的 Redis 更新。 默認值為 『Stable』。
tags	object	資源標籤。

回應

名稱	類型	Description
200 OK	RedisResource	已成功更新現有的 Redis 快取。 檢查 provisioningState 以查看詳細狀態。
202 Accepted	RedisResource	已成功更新現有的 Redis 快取。 檢查 Azure-AsyncOperation 標頭以輪詢詳細狀態。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

RedisCacheUpdate

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1?api-version=2023-08-01

{
  "properties": {
    "enableNonSslPort": true,
    "replicasPerPrimary": 2
  }
}

Java

import com.azure.resourcemanager.redis.models.RedisUpdateParameters;

/** Samples for Redis Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheUpdate.json
     */
    /**
     * Sample code: RedisCacheUpdate.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void redisCacheUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.redisCaches().manager().serviceClient().getRedis().update("rg1", "cache1",
            new RedisUpdateParameters().withEnableNonSslPort(true).withReplicasPerPrimary(2),
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.redis import RedisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redis
# USAGE
    python redis_cache_update.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 = RedisManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.redis.begin_update(
        resource_group_name="rg1",
        name="cache1",
        parameters={"properties": {"enableNonSslPort": True, "replicasPerPrimary": 2}},
    ).result()
    print(response)


# x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheUpdate.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

Go

package armredis_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/redis/armredis/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/20312e2b31df58f0ea7560e87062d62aa92f0a14/specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheUpdate.json
func ExampleClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armredis.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClient().BeginUpdate(ctx, "rg1", "cache1", armredis.UpdateParameters{
		Properties: &armredis.UpdateProperties{
			EnableNonSSLPort:   to.Ptr(true),
			ReplicasPerPrimary: to.Ptr[int32](2),
		},
	}, 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.ResourceInfo = armredis.ResourceInfo{
	// 	Name: to.Ptr("cache1"),
	// 	Type: to.Ptr("Microsoft.Cache/Redis"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armredis.Properties{
	// 		EnableNonSSLPort: to.Ptr(true),
	// 		RedisConfiguration: &armredis.CommonPropertiesRedisConfiguration{
	// 			Maxclients: to.Ptr("1000"),
	// 			MaxmemoryDelta: to.Ptr("50"),
	// 			MaxmemoryReserved: to.Ptr("50"),
	// 		},
	// 		RedisVersion: to.Ptr("3.0"),
	// 		ReplicasPerMaster: to.Ptr[int32](2),
	// 		ReplicasPerPrimary: to.Ptr[int32](2),
	// 		UpdateChannel: to.Ptr(armredis.UpdateChannelStable),
	// 		SKU: &armredis.SKU{
	// 			Name: to.Ptr(armredis.SKUNamePremium),
	// 			Capacity: to.Ptr[int32](1),
	// 			Family: to.Ptr(armredis.SKUFamilyP),
	// 		},
	// 		AccessKeys: &armredis.AccessKeys{
	// 			PrimaryKey: to.Ptr("<primaryKey>"),
	// 			SecondaryKey: to.Ptr("<secondaryKey>"),
	// 		},
	// 		HostName: to.Ptr("cache1.redis.cache.windows.net"),
	// 		Instances: []*armredis.InstanceDetails{
	// 			{
	// 				IsMaster: to.Ptr(true),
	// 				IsPrimary: to.Ptr(true),
	// 				NonSSLPort: to.Ptr[int32](13000),
	// 				SSLPort: to.Ptr[int32](15000),
	// 			},
	// 			{
	// 				IsMaster: to.Ptr(false),
	// 				IsPrimary: to.Ptr(false),
	// 				NonSSLPort: to.Ptr[int32](13001),
	// 				SSLPort: to.Ptr[int32](15001),
	// 			},
	// 			{
	// 				IsMaster: to.Ptr(false),
	// 				IsPrimary: to.Ptr(false),
	// 				NonSSLPort: to.Ptr[int32](13002),
	// 				SSLPort: to.Ptr[int32](15002),
	// 		}},
	// 		Port: to.Ptr[int32](6379),
	// 		ProvisioningState: to.Ptr(armredis.ProvisioningStateSucceeded),
	// 		SSLPort: to.Ptr[int32](6380),
	// 	},
	// }
}

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

JavaScript

const { RedisManagementClient } = require("@azure/arm-rediscache");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Update an existing Redis cache.
 *
 * @summary Update an existing Redis cache.
 * x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheUpdate.json
 */
async function redisCacheUpdate() {
  const subscriptionId = process.env["REDIS_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["REDIS_RESOURCE_GROUP"] || "rg1";
  const name = "cache1";
  const parameters = {
    enableNonSslPort: true,
    replicasPerPrimary: 2,
  };
  const credential = new DefaultAzureCredential();
  const client = new RedisManagementClient(credential, subscriptionId);
  const result = await client.redis.beginUpdateAndWait(resourceGroupName, name, 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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Redis;
using Azure.ResourceManager.Redis.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheUpdate.json
// this example is just showing the usage of "Redis_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this RedisResource created on azure
// for more information of creating RedisResource, please refer to the document of RedisResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string name = "cache1";
ResourceIdentifier redisResourceId = RedisResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
RedisResource redis = client.GetRedisResource(redisResourceId);

// invoke the operation
RedisPatch patch = new RedisPatch()
{
    EnableNonSslPort = true,
    ReplicasPerPrimary = 2,
};
ArmOperation<RedisResource> lro = await redis.UpdateAsync(WaitUntil.Completed, patch);
RedisResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
RedisData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
  "location": "West US",
  "name": "cache1",
  "type": "Microsoft.Cache/Redis",
  "tags": {},
  "properties": {
    "accessKeys": {
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>"
    },
    "provisioningState": "Succeeded",
    "redisVersion": "3.0",
    "sku": {
      "name": "Premium",
      "family": "P",
      "capacity": 1
    },
    "enableNonSslPort": true,
    "replicasPerMaster": 2,
    "replicasPerPrimary": 2,
    "updateChannel": "Stable",
    "redisConfiguration": {
      "maxclients": "1000",
      "maxmemory-reserved": "50",
      "maxmemory-delta": "50"
    },
    "hostName": "cache1.redis.cache.windows.net",
    "port": 6379,
    "sslPort": 6380,
    "instances": [
      {
        "sslPort": 15000,
        "nonSslPort": 13000,
        "isMaster": true,
        "isPrimary": true
      },
      {
        "sslPort": 15001,
        "nonSslPort": 13001,
        "isMaster": false,
        "isPrimary": false
      },
      {
        "sslPort": 15002,
        "nonSslPort": 13002,
        "isMaster": false,
        "isPrimary": false
      }
    ]
  }
}

Status code:

202

location: https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult...

Response Body

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
  "location": "West US",
  "name": "cache1",
  "type": "Microsoft.Cache/Redis",
  "tags": {},
  "properties": {
    "accessKeys": {
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>"
    },
    "provisioningState": "Succeeded",
    "redisVersion": "3.0",
    "sku": {
      "name": "Premium",
      "family": "P",
      "capacity": 1
    },
    "enableNonSslPort": true,
    "replicasPerMaster": 2,
    "replicasPerPrimary": 2,
    "updateChannel": "Stable",
    "redisConfiguration": {
      "maxclients": "1000",
      "maxmemory-reserved": "50",
      "maxmemory-delta": "50"
    },
    "hostName": "cache1.redis.cache.windows.net",
    "port": 6379,
    "sslPort": 6380,
    "instances": [
      {
        "sslPort": 15000,
        "nonSslPort": 13000,
        "isMaster": true,
        "isPrimary": true
      },
      {
        "sslPort": 15001,
        "nonSslPort": 13001,
        "isMaster": false,
        "isPrimary": false
      },
      {
        "sslPort": 15002,
        "nonSslPort": 13002,
        "isMaster": false,
        "isPrimary": false
      }
    ]
  }
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ManagedServiceIdentity	受控服務識別 (系統指派和/或使用者指派的身分識別)
ManagedServiceIdentityType	(允許 SystemAssigned 和 UserAssigned 類型的受控服務識別類型) 。
PrivateEndpoint	私人端點資源。
PrivateEndpointConnection	私人端點聯機資源。
PrivateEndpointConnectionProvisioningState	目前的布建狀態。
PrivateEndpointServiceConnectionStatus	私人端點連線狀態。
PrivateLinkServiceConnectionState	服務取用者與提供者之間連線狀態的相關信息集合。
ProvisioningState	Redis 實例布建狀態。
PublicNetworkAccess	是否允許此快取存取公用端點。 值是選擇性的，但如果傳入，則必須是 『Enabled』 或 'Disabled'。 如果 「已停用」，私人端點就是獨佔存取方法。 預設值為 'Enabled'
RedisAccessKeys	Redis 快取存取金鑰。
RedisConfiguration	所有 Redis 設定。 幾個可能的密鑰：rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-than、slowlog-max-len ，list-max-ziplist-entries，list-max-ziplist-value，hash-max-ziplist-entries，hash-max-ziplist-value，set-max-intset-entries，zset-max-ziplist-entries，zset-max-ziplist-value etc.
RedisInstanceDetails	Redis 單一實例的詳細數據。
RedisLinkedServer	連結的伺服器識別碼
RedisResource	List 或 Get Operation 中的單一 Redis 專案。
RedisUpdateParameters	提供給 Update Redis 作業的參數。
Sku	提供給建立 Redis 作業的 SKU 參數。
SkuFamily	要使用的 SKU 系列。 有效值： (C、P) 。 (C = 基本/標準，P = 進階) 。
SkuName	要部署的 Redis 快取類型。 有效值： (Basic、Standard、Premium)
TlsVersion	選擇性：要求用戶端使用指定的 TLS 版本 (或更高版本) 來聯機 (例如 '1.0'、'1.1'、'1.2')
UpdateChannel	選擇性：指定 Redis 快取將接收之每月 Redis 更新的更新通道。 使用 「預覽」更新通道的快取，至少會在「穩定」通道快取前 4 周取得最新的 Redis 更新。 默認值為 『Stable』。
UserAssignedIdentity	使用者指派的身分識別屬性

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

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

Redis 實例布建狀態。

名稱	類型	Description
ConfiguringAAD	string
Creating	string
Deleting	string
Disabled	string
Failed	string
Linking	string
Provisioning	string
RecoveringScaleFailure	string
Scaling	string
Succeeded	string
Unlinking	string
Unprovisioning	string
Updating	string

PublicNetworkAccess

是否允許此快取存取公用端點。 值是選擇性的，但如果傳入，則必須是 『Enabled』 或 'Disabled'。 如果 「已停用」，私人端點就是獨佔存取方法。 預設值為 'Enabled'

名稱	類型	Description
Disabled	string
Enabled	string

RedisAccessKeys

Redis 快取存取金鑰。

名稱	類型	Description
primaryKey	string	用戶端可用來向 Redis 快取進行驗證的目前主鍵。
secondaryKey	string	用戶端可用來向 Redis 快取進行驗證的目前次要金鑰。

RedisConfiguration

所有 Redis 設定。 幾個可能的密鑰：rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-than、slowlog-max-len ，list-max-ziplist-entries，list-max-ziplist-value，hash-max-ziplist-entries，hash-max-ziplist-value，set-max-intset-entries，zset-max-ziplist-entries，zset-max-ziplist-value etc.

名稱	類型	Description
aad-enabled	string	指定快取是否已啟用或停用 AAD 型驗證
aof-backup-enabled	string	指定是否啟用 aof 備份
aof-storage-connection-string-0	string	第一個記憶體帳戶 連接字串
aof-storage-connection-string-1	string	第二個記憶體帳戶 連接字串
authnotrequired	string	指定是否停用驗證。 強烈建議您不要從安全性觀點設定此屬性。
maxclients	string	最大客戶端設定
maxfragmentationmemory-reserved	string	保留給每個分區片段的 MB 值
maxmemory-delta	string	保留給每個分區之非快取使用量的 MB 值，例如故障轉移。
maxmemory-policy	string	當數據不符合其記憶體限制時所使用的收回策略。
maxmemory-reserved	string	保留給每個分區之非快取使用量的 MB 值，例如故障轉移。
notify-keyspace-events	string	應監視的keyspace事件。
preferred-data-archive-auth-method	string	慣用的驗證方法，用來與用於數據封存的記憶體帳戶通訊、指定 SAS 或 ManagedIdentity，預設值為 SAS
preferred-data-persistence-auth-method	string	慣用的驗證方法，用來與用於數據持續性的記憶體帳戶通訊、指定SAS或ManagedIdentity、預設值為SAS
rdb-backup-enabled	string	指定是否啟用 rdb 備份
rdb-backup-frequency	string	指定以分鐘為單位建立 rdb 備份的頻率。 有效值： (15、30、60、360、720、1440)
rdb-backup-max-snapshot-count	string	指定 rdb 備份的快照集數目上限
rdb-storage-connection-string	string	用來儲存 rdb 檔案的記憶體帳戶 連接字串
storage-subscription-id	string	使用 ManagedIdentity (aof/rdb) 之記憶體帳戶的 SubscriptionId。
zonal-configuration	string	分區設定

RedisInstanceDetails

Redis 單一實例的詳細數據。

名稱	類型	Description
isMaster	boolean	指定實例是否為主要節點。
isPrimary	boolean	指定實例是否為主要節點。
nonSslPort	integer	如果 enableNonSslPort 為 true，請提供 Redis 實例非 SSL 埠。
shardId	integer	如果已啟用叢集，則 Redis 實例的分區標識碼
sslPort	integer	Redis 實例 SSL 埠。
zone	string	如果快取使用可用性區域，請指定此實例所在的可用性區域。

RedisLinkedServer

連結的伺服器識別碼

名稱	類型	Description
id	string	連結的伺服器識別碼。

RedisResource

List 或 Get Operation 中的單一 Redis 專案。

名稱	類型	預設值	Description
enableNonSslPort	boolean	False	指定是否啟用非 ssl Redis 伺服器埠 (6379) 。
id	string		資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity		資源的身分識別。
location	string		資源所在的地理位置
minimumTlsVersion	TlsVersion		選擇性：要求用戶端使用指定的 TLS 版本 (或更高版本) 來聯機 (例如 '1.0'、'1.1'、'1.2')
name	string		資源的名稱
properties.accessKeys	RedisAccessKeys		Redis 快取的索引鍵 - 如果此物件不是 Create 或更新 redis 快取的回應，則不會設定
properties.hostName	string		Redis 主機名。
properties.instances	RedisInstanceDetails[]		與快取相關聯的 Redis 實例清單
properties.linkedServers	RedisLinkedServer[]		與快取相關聯的連結伺服器清單
properties.port	integer		Redis 非 SSL 埠。
properties.privateEndpointConnections	PrivateEndpointConnection[]		與指定 Redis 快取相關聯的私人端點連線清單
properties.provisioningState	ProvisioningState		Redis 實例布建狀態。
properties.sku	Sku		要部署之 Redis 快取的 SKU。
properties.sslPort	integer		Redis SSL 埠。
properties.staticIP	string		靜態IP位址。 您可以選擇性地在現有的 Azure 虛擬網路 內部署 Redis 快取時指定;預設會自動指派。
properties.subnetId	string		虛擬網路中要部署 Redis 快取之子網的完整資源識別碼。 範例格式：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft。{網络|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1
publicNetworkAccess	PublicNetworkAccess	Enabled	是否允許此快取存取公用端點。 值是選擇性的，但如果傳入，則必須是 『Enabled』 或 'Disabled'。 如果 「已停用」，私人端點就是獨佔存取方法。 預設值為 'Enabled'
redisConfiguration	RedisConfiguration		所有 Redis 設定。 幾個可能的密鑰：rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-than、slowlog-max-len ，list-max-ziplist-entries，list-max-ziplist-value，hash-max-ziplist-entries，hash-max-ziplist-value，set-max-intset-entries，zset-max-ziplist-entries，zset-max-ziplist-value etc.
redisVersion	string		Redis 版本。 這應該格式為 'major[.minor]'， (只需要 'major') 或 'latest' 值，這是指可用的最新穩定 Redis 版本。 支援的版本：4.0、6.0 (最新的) 。 預設值為 『latest』。
replicasPerMaster	integer		要為每個主要複本建立的複本數目。
replicasPerPrimary	integer		要為每個主要複本建立的複本數目。
shardCount	integer		在進階叢集快取上建立的分區數目。
tags	object		資源標籤。
tenantSettings	object		租用戶設定的字典
type	string		資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”
updateChannel	UpdateChannel		選擇性：指定 Redis 快取將接收之每月 Redis 更新的更新通道。 使用 「預覽」更新通道的快取，至少會在「穩定」通道快取前 4 周取得最新的 Redis 更新。 默認值為 『Stable』。
zones	string[]		可用性區域清單，表示資源需要來自何處。

RedisUpdateParameters

提供給 Update Redis 作業的參數。

名稱	類型	預設值	Description
identity	ManagedServiceIdentity		資源的身分識別。
properties.enableNonSslPort	boolean	False	指定是否啟用非 ssl Redis 伺服器埠 (6379) 。
properties.minimumTlsVersion	TlsVersion		選擇性：要求用戶端使用指定的 TLS 版本 (或更高版本) 來聯機 (例如 '1.0'、'1.1'、'1.2')
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	是否允許此快取存取公用端點。 值是選擇性的，但如果傳入，則必須是 『Enabled』 或 'Disabled'。 如果 「已停用」，私人端點就是獨佔存取方法。 預設值為 'Enabled'
properties.redisConfiguration	RedisConfiguration		所有 Redis 設定。 幾個可能的密鑰：rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-than、slowlog-max-len ，list-max-ziplist-entries，list-max-ziplist-value，hash-max-ziplist-entries，hash-max-ziplist-value，set-max-intset-entries，zset-max-ziplist-entries，zset-max-ziplist-value etc.
properties.redisVersion	string		Redis 版本。 這應該格式為 'major[.minor]'， (只需要 'major') 或 'latest' 值，這是指可用的最新穩定 Redis 版本。 支援的版本：4.0、6.0 (最新的) 。 預設值為 『latest』。
properties.replicasPerMaster	integer		要為每個主要複本建立的複本數目。
properties.replicasPerPrimary	integer		要為每個主要複本建立的複本數目。
properties.shardCount	integer		在進階叢集快取上建立的分區數目。
properties.sku	Sku		要部署之 Redis 快取的 SKU。
properties.tenantSettings	object		租用戶設定的字典
properties.updateChannel	UpdateChannel		選擇性：指定 Redis 快取將接收之每月 Redis 更新的更新通道。 使用 「預覽」更新通道的快取，至少會在「穩定」通道快取前 4 周取得最新的 Redis 更新。 默認值為 『Stable』。
tags	object		資源標籤。

Sku

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

名稱	類型	Description
capacity	integer	要部署的 Redis 快取大小。 有效值：適用於 C (Basic/Standard) 系列 (0、1、2、3、4、5、6) ，適用於 P (Premium) 系列 (1、2、3、4) 。
family	SkuFamily	要使用的 SKU 系列。 有效值： (C、P) 。 (C = 基本/標準，P = 進階) 。
name	SkuName	要部署的 Redis 快取類型。 有效值： (Basic、Standard、Premium)

SkuFamily

要使用的 SKU 系列。 有效值： (C、P) 。 (C = 基本/標準，P = 進階) 。

名稱	類型	Description
C	string
P	string

SkuName

要部署的 Redis 快取類型。 有效值： (Basic、Standard、Premium)

名稱	類型	Description
Basic	string
Premium	string
Standard	string

TlsVersion

選擇性：要求用戶端使用指定的 TLS 版本 (或更高版本) 來聯機 (例如 '1.0'、'1.1'、'1.2')

名稱	類型	Description
1.0	string
1.1	string
1.2	string

UpdateChannel

選擇性：指定 Redis 快取將接收之每月 Redis 更新的更新通道。 使用 「預覽」更新通道的快取，至少會在「穩定」通道快取前 4 周取得最新的 Redis 更新。 默認值為 『Stable』。

名稱	類型	Description
Preview	string
Stable	string

UserAssignedIdentity

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

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