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	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
identity	ManagedServiceIdentity	Удостоверение ресурса.
properties.enableNonSslPort	boolean	Указывает, включен ли порт сервера Redis без ssl (6379).
properties.minimumTlsVersion	TlsVersion	Необязательно: требует, чтобы клиенты использовали указанную версию TLS (или более позднюю) для подключения (например, "1.0", "1.1", "1.2")
properties.publicNetworkAccess	PublicNetworkAccess	Разрешен ли доступ к общедоступной конечной точке для этого кэша. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". При отключении частные конечные точки являются монопольным методом доступа. Значение по умолчанию — "Включено".
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]" (требуется только "основной") или значение "latest", которое относится к последней стабильной доступной версии Redis. Поддерживаемые версии: 4.0, 6.0 (последняя версия). Значение по умолчанию — latest.
properties.replicasPerMaster	integer	Количество создаваемых реплик на одну первичную.
properties.replicasPerPrimary	integer	Количество создаваемых реплик на одну первичную.
properties.shardCount	integer	Количество сегментов, создаваемых в кэше кластера класса Premium.
properties.sku	Sku	Номер SKU развертываемого кэша Redis.
properties.tenantSettings	object	Словарь параметров клиента
properties.updateChannel	UpdateChannel	Необязательно. Указывает канал обновления для ежемесячных обновлений Redis, которые будет получать кэш Redis. Кэши, использующие канал обновления "Предварительная версия", получают последние обновления Redis по крайней мере за 4 недели до кэшей канала "Стабильный". Значение по умолчанию — Stable.
tags	object	Теги ресурсов.

Ответы

Имя	Тип	Описание
200 OK	RedisResource	Существующий кэш Redis успешно обновлен. Проверьте состояние provisioningState, чтобы просмотреть подробные сведения о состоянии.
202 Accepted	RedisResource	Существующий кэш Redis успешно обновлен. Проверьте Azure-AsyncOperation заголовки, чтобы опросить подробное состояние.
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

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	Управляемое удостоверение службы (назначаемые системой и /или назначенные пользователем удостоверения)
ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
PrivateEndpoint	Ресурс частной конечной точки.
PrivateEndpointConnection	Ресурс подключения к частной конечной точке.
PrivateEndpointConnectionProvisioningState	Текущее состояние подготовки.
PrivateEndpointServiceConnectionStatus	Состояние подключения к частной конечной точке.
PrivateLinkServiceConnectionState	Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.
ProvisioningState	Состояние подготовки экземпляра Redis.
PublicNetworkAccess	Разрешен ли доступ к общедоступной конечной точке для этого кэша. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". При отключении частные конечные точки являются монопольным методом доступа. Значение по умолчанию — "Включено".
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-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	Идентификатор связанного сервера
RedisResource	Один элемент Redis в списке или операции получения.
RedisUpdateParameters	Параметры, предоставленные операции Обновления Redis.
Sku	Параметры SKU, предоставленные для операции создания Redis.
SkuFamily	Используемое семейство номеров SKU. Допустимые значения: (C, P). (C = Базовый/Стандартный, P = Премиум).
SkuName	Тип развертываемого кэша Redis. Допустимые значения: (Базовый, Стандартный, Премиум)
TlsVersion	Необязательно: требует, чтобы клиенты использовали указанную версию TLS (или более позднюю) для подключения (например, "1.0", "1.1", "1.2")
UpdateChannel	Необязательно. Указывает канал обновления для ежемесячных обновлений Redis, которые будет получать кэш Redis. Кэши, использующие канал обновления "Предварительная версия", получают последние обновления Redis по крайней мере за 4 недели до кэшей канала "Стабильный". Значение по умолчанию — Stable.
UserAssignedIdentity	Свойства удостоверения, назначаемого пользователем

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ManagedServiceIdentity

Управляемое удостоверение службы (назначаемые системой и /или назначенные пользователем удостоверения)

Имя	Тип	Описание
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).

Имя	Тип	Описание
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

Ресурс частной конечной точки.

Имя	Тип	Описание
id	string	Идентификатор ARM для частной конечной точки

PrivateEndpointConnection

Ресурс подключения к частной конечной точке.

Имя	Тип	Описание
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

Текущее состояние подготовки.

Имя	Тип	Описание
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

Разрешен ли доступ к общедоступной конечной точке для этого кэша. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". При отключении частные конечные точки являются монопольным методом доступа. Значение по умолчанию — "Включено".

Имя	Тип	Описание
Disabled	string
Enabled	string

RedisAccessKeys

Ключи доступа к кэшу Redis.

Имя	Тип	Описание
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-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	Вторая учетная запись хранения строка подключения
authnotrequired	string	Указывает, отключена ли проверка подлинности. Установка этого свойства крайне не рекомендуется с точки зрения безопасности.
maxclients	string	Конфигурация max clients
maxfragmentationmemory-reserved	string	Значение в мегабайтах, зарезервированное для фрагментации на сегмент
maxmemory-delta	string	Значение в мегабайтах, зарезервированное для использования без кэша на сегмент, например для отработки отказа.
maxmemory-policy	string	Стратегия вытеснения, используемая, когда данные не помещаются в пределы памяти.
maxmemory-reserved	string	Значение в мегабайтах, зарезервированное для использования без кэша на сегмент, например для отработки отказа.
notify-keyspace-events	string	События пространства ключей, которые необходимо отслеживать.
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	SubscriptionId учетной записи хранения для сохраняемости (aof/rdb) с помощью ManagedIdentity.
zonal-configuration	string	Зональная конфигурация

RedisInstanceDetails

Сведения об одном экземпляре redis.

Имя	Тип	Описание
isMaster	boolean	Указывает, является ли экземпляр основным узлом.
isPrimary	boolean	Указывает, является ли экземпляр основным узлом.
nonSslPort	integer	Если параметру enableNonSslPort присвоено значение true, предоставляется не SSL-порт экземпляра Redis.
shardId	integer	Если кластеризация включен, идентификатор сегмента экземпляра Redis
sslPort	integer	SSL-порт экземпляра Redis.
zone	string	Если кэш использует зоны доступности, указывает зону доступности, в которой находится этот экземпляр.

RedisLinkedServer

Идентификатор связанного сервера

Имя	Тип	Описание
id	string	Идентификатор связанного сервера.

RedisResource

Один элемент Redis в списке или операции получения.

Имя	Тип	Значение по умолчанию	Описание
enableNonSslPort	boolean	False	Указывает, включен ли порт сервера Redis без ssl (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		Номер SKU кэша Redis для развертывания.
properties.sslPort	integer		SSL-порт Redis.
properties.staticIP	string		Статический IP-адрес. При необходимости может быть указан при развертывании кэша Redis в существующем виртуальная сеть Azure; автоматически назначается по умолчанию.
properties.subnetId	string		Полный идентификатор ресурса подсети в виртуальной сети для развертывания кэша Redis. Пример формата: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft. {Сеть|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1
publicNetworkAccess	PublicNetworkAccess	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]" (требуется только "основной") или значение "latest", которое относится к последней стабильной версии Redis, которая доступна. Поддерживаемые версии: 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, которые будет получать кэш Redis. Кэши, использующие канал обновления "Предварительная версия", получают последние обновления Redis по крайней мере за 4 недели до кэшей стабильного канала. Значение по умолчанию — "Стабильный".
zones	string[]		Список зон доступности, обозначающих, откуда должен поступать ресурс.

RedisUpdateParameters

Параметры, предоставленные операции Обновления Redis.

Имя	Тип	Значение по умолчанию	Описание
identity	ManagedServiceIdentity		Удостоверение ресурса.
properties.enableNonSslPort	boolean	False	Указывает, включен ли порт сервера Redis без ssl (6379).
properties.minimumTlsVersion	TlsVersion		Необязательно: требует, чтобы клиенты использовали указанную версию TLS (или более позднюю) для подключения (например, "1.0", "1.1", "1.2")
properties.publicNetworkAccess	PublicNetworkAccess	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]" (требуется только "основной") или значение "latest", которое относится к последней стабильной версии Redis, которая доступна. Поддерживаемые версии: 4.0, 6.0 (последняя версия). Значение по умолчанию — latest.
properties.replicasPerMaster	integer		Количество реплик, создаваемых на одну первичную.
properties.replicasPerPrimary	integer		Количество реплик, создаваемых на одну первичную.
properties.shardCount	integer		Количество сегментов, создаваемых в кэше кластера класса Premium.
properties.sku	Sku		Номер SKU кэша Redis для развертывания.
properties.tenantSettings	object		Словарь параметров клиента
properties.updateChannel	UpdateChannel		Необязательно. Указывает канал обновления для ежемесячных обновлений Redis, которые будет получать кэш Redis. Кэши, использующие канал обновления "Предварительная версия", получают последние обновления Redis по крайней мере за 4 недели до кэшей канала "Стабильный". Значение по умолчанию — Stable.
tags	object		Теги ресурсов.

Sku

Параметры SKU, предоставленные для операции создания Redis.

Имя	Тип	Описание
capacity	integer	Размер развертываемого кэша Redis. Допустимые значения: для семейства C (базовый или стандартный) (0, 1, 2, 3, 4, 5, 6), для семейства P (премиум) (1, 2, 3, 4).
family	SkuFamily	Используемое семейство номеров SKU. Допустимые значения: (C, P). (C = Базовый/Стандартный, P = Премиум).
name	SkuName	Тип развертываемого кэша Redis. Допустимые значения: (Базовый, Стандартный, Премиум)

SkuFamily

Используемое семейство номеров SKU. Допустимые значения: (C, P). (C = Базовый/Стандартный, P = Премиум).

Имя	Тип	Описание
C	string
P	string

SkuName

Тип развертываемого кэша Redis. Допустимые значения: (Базовый, Стандартный, Премиум)

Имя	Тип	Описание
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, которые будет получать кэш Redis. Кэши, использующие канал обновления "Предварительная версия", получают последние обновления Redis по крайней мере за 4 недели до кэшей канала "Стабильный". Значение по умолчанию — Stable.

Имя	Тип	Описание
Preview	string
Stable	string

UserAssignedIdentity

Свойства удостоверения, назначаемого пользователем

Имя	Тип	Описание
clientId	string	Идентификатор клиента назначенного удостоверения.
principalId	string	Идентификатор субъекта назначенного удостоверения.