Redis Enterprise - Create

Ссылка

Служба:: Redis Cache

Версия API:: 2024-10-01

Создает или обновляет существующий (перезапись или повторное создание) кластера кэша с потенциальным временем простоя.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}?api-version=2024-10-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
clusterName	path	True	string	Имя кластера Redis Enterprise. Имя должно иметь длину 1–60 символов. Допустимые символы (A-Z, a-z, 0-9) и дефис(-). Не может быть ни ведущих, ни конечных, ни последовательных дефисов Шаблон регулярного выражения: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для этой операции.

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

Имя	Обязательно	Тип	Описание
location	True	string	Географическое расположение, в котором находится ресурс
sku	True	Sku	Номер SKU для создания, который влияет на цену, производительность и функции.
identity		ManagedServiceIdentity	Удостоверение ресурса.
properties.encryption		Encryption	Конфигурация шифрования неактивных данных для кластера.
properties.minimumTlsVersion		TlsVersion	Минимальная версия TLS для кластера для поддержки, например 1.2.
tags		object	Теги ресурсов.
zones		string[]	Зоны доступности, в которых будет развернут этот кластер.

Ответы

Имя	Тип	Описание
200 OK	Cluster	Кластер обновлялся или обновляется. Проверьте подготовкуState и resourceState, чтобы просмотреть подробные сведения о состоянии.
201 Created	Cluster	Кластер создан или создан. Проверьте подготовкуState и resourceState, чтобы просмотреть подробные сведения о состоянии.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

RedisEnterpriseCreate

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

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1?api-version=2024-10-01

{
  "location": "West US",
  "sku": {
    "name": "EnterpriseFlash_F300",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": {}
    }
  },
  "properties": {
    "minimumTlsVersion": "1.2",
    "encryption": {
      "customerManagedKeyEncryption": {
        "keyEncryptionKeyIdentity": {
          "identityType": "userAssignedIdentity",
          "userAssignedIdentityResourceId": "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity"
        },
        "keyEncryptionKeyUrl": "https://your-kv.vault.azure.net/keys/your-key/your-key-version"
      }
    }
  },
  "tags": {
    "tag1": "value1"
  }
}

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

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

{
  "name": "cache1",
  "type": "Microsoft.Cache/redisEnterprise",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1",
  "location": "West US",
  "sku": {
    "name": "EnterpriseFlash_F300",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "hostName": "cache1.westus.something.azure.net",
    "redisVersion": "5",
    "minimumTlsVersion": "1.2",
    "encryption": {
      "customerManagedKeyEncryption": {
        "keyEncryptionKeyIdentity": {
          "userAssignedIdentityResourceId": "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity",
          "identityType": "userAssignedIdentity"
        },
        "keyEncryptionKeyUrl": "https://your-kv.vault.azure.net/keys/your-key/your-key-version"
      }
    }
  },
  "tags": {
    "tag1": "value1"
  }
}

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

{
  "name": "cache1",
  "type": "Microsoft.Cache/redisEnterprise",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1",
  "location": "West US",
  "sku": {
    "name": "EnterpriseFlash_F300",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/your-subscription/resourceGroups/your-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/your-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "provisioningState": "Succeeded",
    "resourceState": "Running",
    "hostName": "cache1.westus.something.azure.net",
    "redisVersion": "5",
    "minimumTlsVersion": "1.2"
  },
  "tags": {
    "tag1": "value1"
  }
}

Определения

Имя	Описание
Cluster	Описание кластера RedisEnterprise
CmkIdentityType	В этой версии API поддерживается только userAssignedIdentity; Другие типы могут поддерживаться в будущем
CustomerManagedKeyEncryption	Все свойства шифрования ключей, управляемых клиентом, для ресурса. Задайте для этого пустой объект для использования шифрования ключей, управляемых Корпорацией Майкрософт.
Encryption	Конфигурация шифрования неактивных данных для кластера.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
KeyEncryptionKeyIdentity	Все настройки удостоверений для параметров ключей, управляемых клиентом, определяют, какое удостоверение следует использовать для проверки подлинности в Key Vault.
ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
PrivateEndpoint	Ресурс частной конечной точки.
PrivateEndpointConnection	Ресурс подключения к частной конечной точке.
PrivateEndpointConnectionProvisioningState	Текущее состояние подготовки.
PrivateEndpointServiceConnectionStatus	Состояние подключения к частной конечной точке.
PrivateLinkServiceConnectionState	Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.
ProvisioningState	Текущее состояние подготовки
ResourceState	Текущее состояние ресурса
Sku	Параметры SKU, предоставленные операции create RedisEnterprise.
SkuName	Тип развернутого кластера RedisEnterprise. Возможные значения: (Enterprise_E10, EnterpriseFlash_F300 и т. д.)
TlsVersion	Минимальная версия TLS для кластера для поддержки, например 1.2.
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения

Cluster

Описание кластера RedisEnterprise

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Удостоверение ресурса.
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.encryption	Encryption	Конфигурация шифрования неактивных данных для кластера.
properties.hostName	string	DNS-имя конечной точки кластера
properties.minimumTlsVersion	TlsVersion	Минимальная версия TLS для кластера для поддержки, например 1.2.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Список подключений частной конечной точки, связанных с указанным кластером RedisEnterprise
properties.provisioningState	ProvisioningState	Текущее состояние подготовки кластера
properties.redisVersion	string	Версия redis, которую поддерживает кластер, например "6"
properties.resourceState	ResourceState	Текущее состояние ресурса кластера
sku	Sku	Номер SKU для создания, который влияет на цену, производительность и функции.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"
zones	string[]	Зоны доступности, в которых будет развернут этот кластер.

CmkIdentityType

В этой версии API поддерживается только userAssignedIdentity; Другие типы могут поддерживаться в будущем

Имя	Тип	Описание
systemAssignedIdentity	string
userAssignedIdentity	string

CustomerManagedKeyEncryption

Все свойства шифрования ключей, управляемых клиентом, для ресурса. Задайте для этого пустой объект для использования шифрования ключей, управляемых Корпорацией Майкрософт.

Имя	Тип	Описание
keyEncryptionKeyIdentity	KeyEncryptionKeyIdentity	Все настройки удостоверений для параметров ключей, управляемых клиентом, определяют, какое удостоверение следует использовать для проверки подлинности в Key Vault.
keyEncryptionKeyUrl	string	URL-адрес ключа шифрования ключей( только версия). Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

Конфигурация шифрования неактивных данных для кластера.

Имя	Тип	Описание
customerManagedKeyEncryption	CustomerManagedKeyEncryption	Все свойства шифрования ключей, управляемых клиентом, для ресурса. Задайте для этого пустой объект для использования шифрования ключей, управляемых Корпорацией Майкрософт.

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

Ответ на ошибку

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

KeyEncryptionKeyIdentity

Все настройки удостоверений для параметров ключей, управляемых клиентом, определяют, какое удостоверение следует использовать для проверки подлинности в Key Vault.

Имя	Тип	Описание
identityType	CmkIdentityType	В этой версии API поддерживается только userAssignedIdentity; Другие типы могут поддерживаться в будущем
userAssignedIdentityResourceId	string	Назначаемое пользователем удостоверение для доступа к URL-адресу ключа шифрования ключей. Ex: /subscriptions/_{/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.}

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

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

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

ResourceState

Текущее состояние ресурса

Имя	Тип	Описание
CreateFailed	string
Creating	string
DeleteFailed	string
Deleting	string
DisableFailed	string
Disabled	string
Disabling	string
EnableFailed	string
Enabling	string
Running	string
Scaling	string
ScalingFailed	string
UpdateFailed	string
Updating	string

Sku

Параметры SKU, предоставленные операции create RedisEnterprise.

Имя	Тип	Описание
capacity	integer	Размер кластера RedisEnterprise. Значение по умолчанию — 2 или 3 в зависимости от номера SKU. Допустимые значения: (2, 4, 6, ...) для корпоративных номеров SKU и (3, 9, 15, ...) для номеров SKU Flash.
name	SkuName	Тип развернутого кластера RedisEnterprise. Возможные значения: (Enterprise_E10, EnterpriseFlash_F300 и т. д.)

SkuName

Тип развернутого кластера RedisEnterprise. Возможные значения: (Enterprise_E10, EnterpriseFlash_F300 и т. д.)

Имя	Тип	Описание
EnterpriseFlash_F1500	string
EnterpriseFlash_F300	string
EnterpriseFlash_F700	string
Enterprise_E1	string
Enterprise_E10	string
Enterprise_E100	string
Enterprise_E20	string
Enterprise_E200	string
Enterprise_E400	string
Enterprise_E5	string
Enterprise_E50	string

TlsVersion

Минимальная версия TLS для кластера для поддержки, например 1.2.

Имя	Тип	Описание
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

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

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

Поделиться через