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 パラメーター

名前	/	必須	型	説明
name	path	True	string	Redis キャッシュの名前。
resourceGroupName	path	True	string	リソース グループの名前。 名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
identity	ManagedServiceIdentity	リソースの ID。
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-slower-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 など。
properties.redisVersion	string	Redis のバージョン。 これは、'major[.minor]' ('major' のみが必要) または使用可能な最新の安定した Redis バージョンを参照する値 'latest' の形式である必要があります。 サポートされているバージョン: 4.0、6.0 (最新)。 既定値は 'latest' です。
properties.replicasPerMaster	integer	プライマリごとに作成されるレプリカの数。
properties.replicasPerPrimary	integer	プライマリごとに作成されるレプリカの数。
properties.shardCount	integer	Premium クラスター キャッシュに作成されるシャードの数。
properties.sku	Sku	デプロイする Redis キャッシュの SKU。
properties.tenantSettings	object	テナント設定のディクショナリ
properties.updateChannel	UpdateChannel	省略可能: Redis Cache が受け取る毎月の Redis 更新プログラムの更新チャネルを指定します。 "プレビュー" 更新チャネルを使用するキャッシュでは、少なくとも "安定" チャネル キャッシュの 4 週間前に最新の Redis 更新プログラムが取得されます。 既定値は 'Stable' です。
tags	object	リソース タグ。

応答

名前	型	説明
200 OK	RedisResource	既存の Redis Cache が正常に更新されました。 provisioningState を確認して、詳細な状態を確認します。
202 Accepted	RedisResource	既存の Redis Cache が正常に更新されました。 ヘッダー Azure-AsyncOperation 確認して、詳細な状態をポーリングします。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
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
      }
    ]
  }
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ManagedServiceIdentity	マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)
ManagedServiceIdentityType	マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
PrivateEndpoint	プライベート エンドポイント リソース。
PrivateEndpointConnection	プライベート エンドポイント接続リソース。
PrivateEndpointConnectionProvisioningState	現在のプロビジョニング状態。
PrivateEndpointServiceConnectionStatus	プライベート エンドポイント接続の状態。
PrivateLinkServiceConnectionState	サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
ProvisioningState	Redis インスタンスのプロビジョニングの状態。
PublicNetworkAccess	このキャッシュに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベート エンドポイントは排他アクセス方法です。 既定値は 'Enabled' です
RedisAccessKeys	Redis Cache アクセス キー。
RedisConfiguration	すべての Redis 設定。 考えられるキーの数: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-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 など。
RedisInstanceDetails	redis の単一インスタンスの詳細。
RedisLinkedServer	リンク サーバー ID
RedisResource	List または Get Operation の 1 つの Redis 項目。
RedisUpdateParameters	Update Redis 操作に指定されたパラメーター。
Sku	Redis の作成操作に指定された SKU パラメーター。
SkuFamily	使用する SKU ファミリ。 有効な値: (C、P)。 (C = Basic/Standard、P = Premium)。
SkuName	デプロイする Redis キャッシュの種類。 有効な値: (Basic、Standard、Premium)
TlsVersion	省略可能: クライアントは、指定された TLS バージョン (またはそれ以降) を使用して接続する必要があります (例: '1.0'、'1.1'、'1.2')
UpdateChannel	省略可能: Redis Cache が受け取る毎月の Redis 更新プログラムの更新チャネルを指定します。 "プレビュー" 更新チャネルを使用するキャッシュでは、少なくとも "安定" チャネル キャッシュの 4 週間前に最新の Redis 更新プログラムが取得されます。 既定値は 'Stable' です。
UserAssignedIdentity	ユーザー割り当て ID プロパティ

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

ManagedServiceIdentity

マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID)

名前	型	説明
principalId	string	システム割り当て ID のサービス プリンシパル ID。 このプロパティは、システム割り当て ID に対してのみ提供されます。
tenantId	string	システム割り当て ID のテナント ID。 このプロパティは、システム割り当て ID に対してのみ提供されます。
type	ManagedServiceIdentityType	マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned ID リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求で空のオブジェクト ({}) にすることができます。

ManagedServiceIdentityType

マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

名前	型	説明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

プライベート エンドポイント リソース。

名前	型	説明
id	string	プライベート エンドポイントの ARM 識別子

PrivateEndpointConnection

プライベート エンドポイント接続リソース。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /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

Redis インスタンスのプロビジョニングの状態。

名前	型	説明
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' です

名前	型	説明
Disabled	string
Enabled	string

RedisAccessKeys

Redis Cache アクセス キー。

名前	型	説明
primaryKey	string	クライアントが Redis Cache で認証するために使用できる現在の主キー。
secondaryKey	string	クライアントが Redis Cache での認証に使用できる現在のセカンダリ キー。

RedisConfiguration

すべての Redis 設定。 考えられるキーの数: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-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 など。

名前	型	説明
aad-enabled	string	キャッシュに対して AAD ベースの認証が有効か無効かを指定します
aof-backup-enabled	string	aof バックアップを有効にするかどうかを指定します
aof-storage-connection-string-0	string	最初のストレージ アカウント 接続文字列
aof-storage-connection-string-1	string	2 つ目のストレージ アカウントの接続文字列
authnotrequired	string	認証を無効にするかどうかを指定します。 このプロパティを設定することは、セキュリティの観点から強くお勧めしません。
maxclients	string	最大クライアント構成
maxfragmentationmemory-reserved	string	シャードあたりの断片化のために予約されたメガバイト単位の値
maxmemory-delta	string	フェールオーバーなど、シャードあたりのキャッシュ以外の使用のために予約されたメガバイト単位の値。
maxmemory-policy	string	データがメモリ制限内に収まらない場合に使用される削除戦略。
maxmemory-reserved	string	フェールオーバーなど、シャードあたりのキャッシュ以外の使用のために予約されたメガバイト単位の値。
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 の単一インスタンスの詳細。

名前	型	説明
isMaster	boolean	インスタンスがプライマリ ノードであるかどうかを指定します。
isPrimary	boolean	インスタンスがプライマリ ノードであるかどうかを指定します。
nonSslPort	integer	enableNonSslPort が true の場合、Redis インスタンスの非 SSL ポートが提供されます。
shardId	integer	クラスタリングが有効になっている場合、Redis Instance のシャード ID
sslPort	integer	Redis インスタンスの SSL ポート。
zone	string	キャッシュで可用性ゾーンが使用されている場合は、このインスタンスが配置されている可用性ゾーンを指定します。

RedisLinkedServer

リンク サーバー ID

名前	型	説明
id	string	リンク サーバー ID。

RedisResource

List または Get Operation の 1 つの Redis 項目。

名前	型	既定値	説明
enableNonSslPort	boolean	False	非 ssl Redis サーバー ポート (6379) を有効にするかどうかを指定します。
id	string		リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity		リソースの ID。
location	string		リソースが保存されている地理的な場所
minimumTlsVersion	TlsVersion		省略可能: クライアントが接続するために、指定された TLS バージョン (またはそれ以降) を使用する必要があります (例: '1.0'、'1.1'、'1.2')
name	string		リソースの名前
properties.accessKeys	RedisAccessKeys		Redis キャッシュのキー - このオブジェクトがCreateまたは Redis Cache の更新に対する応答でない場合は設定されません
properties.hostName	string		Redis ホスト名。
properties.instances	RedisInstanceDetails[]		キャッシュに関連付けられている Redis インスタンスの一覧
properties.linkedServers	RedisLinkedServer[]		キャッシュに関連付けられているリンク サーバーの一覧
properties.port	integer		Redis 非 SSL ポート。
properties.privateEndpointConnections	PrivateEndpointConnection[]		指定した Redis Cache に関連付けられているプライベート エンドポイント接続の一覧
properties.provisioningState	ProvisioningState		Redis インスタンスのプロビジョニングの状態。
properties.sku	Sku		デプロイする Redis キャッシュの SKU。
properties.sslPort	integer		Redis SSL ポート。
properties.staticIP	string		静的 IP アドレス。 必要に応じて、既存の Azure Virtual Network内に Redis キャッシュをデプロイするときに指定できます。既定では自動割り当てされます。
properties.subnetId	string		Redis キャッシュをデプロイする仮想ネットワーク内のサブネットの完全なリソース ID。 形式の例: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft。{Network|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-slower-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 など。
redisVersion	string		Redis のバージョン。 これは、'major[.minor]' ('major' のみが必須) または使用可能な最新の安定した Redis バージョンを参照する値 'latest' の形式である必要があります。 サポートされているバージョン: 4.0、6.0 (最新)。 既定値は 'latest' です。
replicasPerMaster	integer		プライマリごとに作成されるレプリカの数。
replicasPerPrimary	integer		プライマリごとに作成されるレプリカの数。
shardCount	integer		Premium クラスター キャッシュに作成されるシャードの数。
tags	object		リソース タグ。
tenantSettings	object		テナント設定のディクショナリ
type	string		リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"
updateChannel	UpdateChannel		省略可能: Redis Cache が受け取る毎月の Redis 更新プログラムの更新チャネルを指定します。 "プレビュー" 更新チャネルを使用するキャッシュでは、少なくとも "安定" チャネル キャッシュの 4 週間前に最新の Redis 更新プログラムが取得されます。 既定値は 'Stable' です。
zones	string[]		リソースの取得元を表す可用性ゾーンの一覧。

RedisUpdateParameters

Update Redis 操作に指定されたパラメーター。

名前	型	既定値	説明
identity	ManagedServiceIdentity		リソースの ID。
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-slower-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 など。
properties.redisVersion	string		Redis のバージョン。 これは、'major[.minor]' ('major' のみが必須) または使用可能な最新の安定した Redis バージョンを参照する値 'latest' の形式である必要があります。 サポートされているバージョン: 4.0、6.0 (最新)。 既定値は 'latest' です。
properties.replicasPerMaster	integer		プライマリごとに作成されるレプリカの数。
properties.replicasPerPrimary	integer		プライマリごとに作成されるレプリカの数。
properties.shardCount	integer		Premium クラスター キャッシュに作成されるシャードの数。
properties.sku	Sku		デプロイする Redis キャッシュの SKU。
properties.tenantSettings	object		テナント設定のディクショナリ
properties.updateChannel	UpdateChannel		省略可能: Redis Cache が受け取る毎月の Redis 更新プログラムの更新チャネルを指定します。 "プレビュー" 更新チャネルを使用するキャッシュでは、少なくとも "安定" チャネル キャッシュの 4 週間前に最新の Redis 更新プログラムが取得されます。 既定値は 'Stable' です。
tags	object		リソース タグ。

Sku

Redis の作成操作に指定された SKU パラメーター。

名前	型	説明
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 = Basic/Standard、P = Premium)。
name	SkuName	デプロイする Redis キャッシュの種類。 有効な値: (Basic、Standard、Premium)

SkuFamily

使用する SKU ファミリ。 有効な値: (C、P)。 (C = Basic/Standard、P = Premium)。

名前	型	説明
C	string
P	string

SkuName

デプロイする Redis キャッシュの種類。 有効な値: (Basic、Standard、Premium)

名前	型	説明
Basic	string
Premium	string
Standard	string

TlsVersion

省略可能: クライアントは、指定された TLS バージョン (またはそれ以降) を使用して接続する必要があります (例: '1.0'、'1.1'、'1.2')

名前	型	説明
1.0	string
1.1	string
1.2	string

UpdateChannel

省略可能: Redis Cache が受け取る毎月の Redis 更新プログラムの更新チャネルを指定します。 "プレビュー" 更新チャネルを使用するキャッシュでは、少なくとも "安定" チャネル キャッシュの 4 週間前に最新の Redis 更新プログラムが取得されます。 既定値は 'Stable' です。

名前	型	説明
Preview	string
Stable	string

UserAssignedIdentity

ユーザー割り当て ID プロパティ

名前	型	説明
clientId	string	割り当てられた ID のクライアント ID。
principalId	string	割り当てられた ID のプリンシパル ID。