Redis - Update

Служба:

Redis Cache

Версия API:

2024-11-01

Обновите существующий кэш Redis.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя кэша Redis.
resourceGroupName	path	True	string	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для этой операции.

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

Имя	Тип	Описание
identity	ManagedServiceIdentity	Удостоверение ресурса.
properties.disableAccessKeyAuthentication	boolean	Проверка подлинности в Redis с помощью ключей доступа отключена, если задано значение true. Значение по умолчанию — false.
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, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 и т. д.
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 недели перед кэшем каналов "Стабильный". Значение по умолчанию — "Стабильный".
properties.zonalAllocationPolicy	ZonalAllocationPolicy	Необязательно. Указывает, как зоны доступности выделяются кэшу Redis. Функция "Автоматически" обеспечивает избыточность зон, а Azure автоматически выбирает зоны на основе региональной доступности и емкости. UserDefined выбирает зоны доступности, переданные вами с помощью параметра "зоны". NoZones создаст незональный кэш. Если зональныйAllocationPolicy не передается, оно будет иметь значение UserDefined, если зоны передаются, в противном случае оно будет иметь значение "Automatic" в регионах, где поддерживаются зоны и "NoZones" в регионах, где зоны не поддерживаются.
tags	object	Теги ресурсов.

Ответы

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

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

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

RedisCacheUpdate

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1?api-version=2024-11-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/2024-11-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/2024-11-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/45374f48f560b3337ed55735038f1e9bf8cbea65/specification/redis/resource-manager/Microsoft.Cache/stable/2024-11-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("East 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),
	// 		ZonalAllocationPolicy: to.Ptr(armredis.ZonalAllocationPolicyAutomatic),
	// 		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");
require("dotenv/config");

/**
 * 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/2024-11-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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Redis.Models;
using Azure.ResourceManager.Redis;

// Generated from example definition: specification/redis/resource-manager/Microsoft.Cache/stable/2024-11-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

Пример ответа

Код состояния:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
  "location": "East 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",
    "zonalAllocationPolicy": "Automatic",
    "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
      }
    ]
  }
}

Код состояния:

202

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

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
  "location": "East 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",
    "zonalAllocationPolicy": "Automatic",
    "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, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 и т. д.
RedisInstanceDetails	Сведения об одном экземпляре redis.
RedisLinkedServer	Идентификатор связанного сервера
RedisResource	Один элемент Redis в списке или операции получения.
RedisUpdateParameters	Параметры, предоставленные операции Update Redis.
Sku	Параметры SKU, предоставленные операции создания Redis.
SkuFamily	Семейство SKU для использования. Допустимые значения: (C, P). (C = Basic/Standard, P = Premium).
SkuName	Тип кэша Redis для развертывания. Допустимые значения: (Базовый, Стандартный, Премиум)
TlsVersion	Необязательно: требует от клиентов использовать указанную версию TLS (или более позднюю) для подключения (например, 1.0, 1.1, 1.2).
UpdateChannel	Необязательно. Указывает канал обновления для ежемесячного обновления Redis, который будет получать кэш Redis. Кэши с помощью канала обновления "Предварительная версия" получают последние обновления Redis по крайней мере через 4 недели перед кэшем каналов "Стабильный". Значение по умолчанию — "Стабильный".
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения
ZonalAllocationPolicy	Необязательно. Указывает, как зоны доступности выделяются кэшу Redis. Функция "Автоматически" обеспечивает избыточность зон, а Azure автоматически выбирает зоны на основе региональной доступности и емкости. UserDefined выбирает зоны доступности, переданные вами с помощью параметра "зоны". NoZones создаст незональный кэш. Если зональныйAllocationPolicy не передается, оно будет иметь значение UserDefined, если зоны передаются, в противном случае оно будет иметь значение "Automatic" в регионах, где поддерживаются зоны и "NoZones" в регионах, где зоны не поддерживаются.

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	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.privateEndpoint	PrivateEndpoint	Ресурс частной конечной точки.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Состояние подготовки ресурса подключения частной конечной точки.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

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

Имя	Тип	Описание
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

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

Имя	Тип	Описание
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.

Имя	Тип	Описание
actionsRequired	string	Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя.
description	string	Причина утверждения или отклонения подключения.
status	PrivateEndpointServiceConnectionStatus	Указывает, утверждено ли подключение, отклонено или удалено владельцем службы.

ProvisioningState

Состояние подготовки экземпляра 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, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 и т. д.

Имя	Тип	Описание
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	Значение в мегабайтах, зарезервированное для фрагментации на сегмент
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, предоставляет порт Redis, отличный от SSL.
shardId	integer	Если кластеризация включена, идентификатор сегмента экземпляра Redis
sslPort	integer	SSL-порт экземпляра Redis.
zone	string	Если кэш использует зоны доступности, указывает зону доступности, в которой находится этот экземпляр.

RedisLinkedServer

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

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

RedisResource

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

Имя	Тип	Default value	Описание
disableAccessKeyAuthentication	boolean	False	Проверка подлинности в Redis с помощью ключей доступа отключена, если задано значение true. Значение по умолчанию — false.
enableNonSslPort	boolean	False	Указывает, включен ли порт сервера Redis без ssl (6379).
id	string		Полный идентификатор ресурса для ресурса. Ex - /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 or Update 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/subnet1
publicNetworkAccess	PublicNetworkAccess	Enabled	Допускается ли доступ к общедоступной конечной точке для этого кэша. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено". Если значение "Отключено", частные конечные точки являются эксклюзивным методом доступа. Значение по умолчанию — "Включено"
redisConfiguration	RedisConfiguration		Все параметры Redis. Несколько возможных ключей: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 и т. д.
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 недели перед кэшем каналов "Стабильный". Значение по умолчанию — "Стабильный".
zonalAllocationPolicy	ZonalAllocationPolicy		Необязательно. Указывает, как зоны доступности выделяются кэшу Redis. Функция "Автоматически" обеспечивает избыточность зон, а Azure автоматически выбирает зоны на основе региональной доступности и емкости. UserDefined выбирает зоны доступности, переданные вами с помощью параметра "зоны". NoZones создаст незональный кэш. Если зональныйAllocationPolicy не передается, оно будет иметь значение UserDefined, если зоны передаются, в противном случае оно будет иметь значение "Automatic" в регионах, где поддерживаются зоны и "NoZones" в регионах, где зоны не поддерживаются.
zones	string[]		Список зон доступности, обозначающих, откуда должен поступать ресурс.

RedisUpdateParameters

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

Имя	Тип	Default value	Описание
identity	ManagedServiceIdentity		Удостоверение ресурса.
properties.disableAccessKeyAuthentication	boolean	False	Проверка подлинности в Redis с помощью ключей доступа отключена, если задано значение true. Значение по умолчанию — false.
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, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 и т. д.
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 недели перед кэшем каналов "Стабильный". Значение по умолчанию — "Стабильный".
properties.zonalAllocationPolicy	ZonalAllocationPolicy		Необязательно. Указывает, как зоны доступности выделяются кэшу Redis. Функция "Автоматически" обеспечивает избыточность зон, а Azure автоматически выбирает зоны на основе региональной доступности и емкости. UserDefined выбирает зоны доступности, переданные вами с помощью параметра "зоны". NoZones создаст незональный кэш. Если зональныйAllocationPolicy не передается, оно будет иметь значение UserDefined, если зоны передаются, в противном случае оно будет иметь значение "Automatic" в регионах, где поддерживаются зоны и "NoZones" в регионах, где зоны не поддерживаются.
tags	object		Теги ресурсов.

Sku

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

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

SkuFamily

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

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

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

UserAssignedIdentity

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

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

ZonalAllocationPolicy

Необязательно. Указывает, как зоны доступности выделяются кэшу Redis. Функция "Автоматически" обеспечивает избыточность зон, а Azure автоматически выбирает зоны на основе региональной доступности и емкости. UserDefined выбирает зоны доступности, переданные вами с помощью параметра "зоны". NoZones создаст незональный кэш. Если зональныйAllocationPolicy не передается, оно будет иметь значение UserDefined, если зоны передаются, в противном случае оно будет иметь значение "Automatic" в регионах, где поддерживаются зоны и "NoZones" в регионах, где зоны не поддерживаются.

Имя	Тип	Описание
Automatic	string
NoZones	string
UserDefined	string