Databases - Create

Ссылка

Служба:: Redis Cache

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

Создание базы данных

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}?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]+)*$`
databaseName	path	True	string	Имя базы данных Redis Enterprise. Шаблон регулярного выражения: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для этой операции.

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

Имя	Тип	Описание
properties.clientProtocol	Protocol	Указывает, могут ли клиенты redis подключаться с помощью протоколов redis с шифрованием TLS или с открытым текстом. По умолчанию используется шифрование TLS.
properties.clusteringPolicy	ClusteringPolicy	Политика кластеризации — по умолчанию — OSSCluster. Указан во время создания.
properties.evictionPolicy	EvictionPolicy	Политика вытеснения Redis — по умолчанию — VolatileLRU
properties.geoReplication	GeoReplication	Необязательный набор свойств для настройки георепликации для этой базы данных.
properties.modules	Module[]	Необязательный набор модулей Redis для включения в этой базе данных — модули можно добавлять только во время создания.
properties.persistence	Persistence	Параметры сохраняемости Параметры сохраняемости
properties.port	integer	TCP-порт конечной точки базы данных. Указан во время создания. По умолчанию используется доступный порт.

Ответы

Имя	Тип	Описание
200 OK	Database	База данных была или обновляется. Проверьте состояние подготовкиState и resourceState.
201 Created	Database	База данных была или создана. Проверьте состояние подготовки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	олицетворения учетной записи пользователя

Примеры

RedisEnterpriseDatabasesCreate

RedisEnterpriseDatabasesCreate With Active Geo Replication

RedisEnterpriseDatabasesCreate

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

HTTP

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

{
  "properties": {
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "AllKeysLRU",
    "persistence": {
      "aofEnabled": true,
      "aofFrequency": "1s"
    },
    "port": 10000,
    "modules": [
      {
        "name": "RedisBloom",
        "args": "ERROR_RATE 0.00 INITIAL_SIZE 400"
      },
      {
        "name": "RedisTimeSeries",
        "args": "RETENTION_POLICY 20"
      },
      {
        "name": "RediSearch"
      }
    ]
  }
}

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

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

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
  "name": "cache1/default",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "provisioningState": "Updating",
    "resourceState": "Updating",
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "AllKeysLRU",
    "persistence": {
      "aofEnabled": true,
      "aofFrequency": "1s"
    },
    "port": 10000,
    "modules": [
      {
        "name": "RedisBloom",
        "args": "ERROR_RATE 0.00 INITIAL_SIZE 400",
        "version": "1.0.0"
      },
      {
        "name": "RedisTimeSeries",
        "args": "RETENTION_POLICY 20",
        "version": "1.0.0"
      },
      {
        "name": "RediSearch",
        "args": "",
        "version": "1.0.0"
      }
    ]
  }
}

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

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1",
  "name": "cache1/db1",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "AllKeysLRU",
    "persistence": {
      "aofEnabled": true,
      "aofFrequency": "1s"
    },
    "port": 10000,
    "modules": [
      {
        "name": "RedisBloom",
        "args": "ERROR_RATE 0.00 INITIAL_SIZE 400",
        "version": "1.0.0"
      },
      {
        "name": "RedisTimeSeries",
        "args": "RETENTION_POLICY 20",
        "version": "1.0.0"
      },
      {
        "name": "RediSearch",
        "args": "",
        "version": "1.0.0"
      }
    ]
  }
}

RedisEnterpriseDatabasesCreate With Active Geo Replication

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

HTTP

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

{
  "properties": {
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000,
    "geoReplication": {
      "groupNickname": "groupName",
      "linkedDatabases": [
        {
          "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default"
        },
        {
          "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default"
        }
      ]
    }
  }
}

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

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

{
  "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
  "name": "cache1/default",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "provisioningState": "Updating",
    "resourceState": "Updating",
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000,
    "geoReplication": {
      "groupNickname": "groupName",
      "linkedDatabases": [
        {
          "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
          "state": "Linking"
        },
        {
          "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
          "state": "Linking"
        }
      ]
    }
  }
}

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

{
  "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1",
  "name": "cache1/db1",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "clientProtocol": "Plaintext",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000,
    "geoReplication": {
      "groupNickname": "groupName",
      "linkedDatabases": [
        {
          "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
          "state": "Linking"
        },
        {
          "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
          "state": "Linking"
        }
      ]
    }
  }
}

Определения

Имя	Описание
AofFrequency	Задает частоту записи данных на диск.
ClusteringPolicy	Политика кластеризации — по умолчанию — OSSCluster. Указан во время создания.
Database	Описание базы данных в кластере RedisEnterprise
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
EvictionPolicy	Политика вытеснения Redis — по умолчанию — VolatileLRU
GeoReplication	Необязательный набор свойств для настройки георепликации для этой базы данных.
LinkedDatabase	Связанная база данных
LinkState	Состояние связи между ресурсами базы данных.
Module	Параметры модуля
Persistence	Параметры сохраняемости
Protocol	Указывает, могут ли клиенты redis подключаться с помощью протоколов redis с шифрованием TLS или с открытым текстом. По умолчанию используется шифрование TLS.
ProvisioningState	Текущее состояние подготовки
RdbFrequency	Задает частоту создания моментального снимка базы данных.
ResourceState	Текущее состояние ресурса

AofFrequency

Задает частоту записи данных на диск.

Имя	Тип	Описание
1s	string
always	string

ClusteringPolicy

Политика кластеризации — по умолчанию — OSSCluster. Указан во время создания.

Имя	Тип	Описание
EnterpriseCluster	string
OSSCluster	string

Database

Описание базы данных в кластере RedisEnterprise

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.clientProtocol	Protocol	Указывает, могут ли клиенты redis подключаться с помощью протоколов redis с шифрованием TLS или с открытым текстом. По умолчанию используется шифрование TLS.
properties.clusteringPolicy	ClusteringPolicy	Политика кластеризации — по умолчанию — OSSCluster. Указан во время создания.
properties.evictionPolicy	EvictionPolicy	Политика вытеснения Redis — по умолчанию — VolatileLRU
properties.geoReplication	GeoReplication	Необязательный набор свойств для настройки георепликации для этой базы данных.
properties.modules	Module[]	Необязательный набор модулей Redis для включения в этой базе данных — модули можно добавлять только во время создания.
properties.persistence	Persistence	Параметры сохраняемости Параметры сохраняемости
properties.port	integer	TCP-порт конечной точки базы данных. Указан во время создания. По умолчанию используется доступный порт.
properties.provisioningState	ProvisioningState	Текущее состояние подготовки базы данных
properties.resourceState	ResourceState	Текущее состояние ресурса базы данных
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

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

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

EvictionPolicy

Политика вытеснения Redis — по умолчанию — VolatileLRU

Имя	Тип	Описание
AllKeysLFU	string
AllKeysLRU	string
AllKeysRandom	string
NoEviction	string
VolatileLFU	string
VolatileLRU	string
VolatileRandom	string
VolatileTTL	string

GeoReplication

Необязательный набор свойств для настройки георепликации для этой базы данных.

Имя	Тип	Описание
groupNickname	string	Имя группы ресурсов связанной базы данных
linkedDatabases	LinkedDatabase[]	Список ресурсов базы данных для связи с этой базой данных

LinkedDatabase

Связанная база данных

Имя	Тип	Описание
id	string	Идентификатор ресурса базы данных для связи с этой базой данных.
state	LinkState	Состояние связи между ресурсами базы данных.

LinkState

Состояние связи между ресурсами базы данных.

Имя	Тип	Описание
LinkFailed	string
Linked	string
Linking	string
UnlinkFailed	string
Unlinking	string

Module

Параметры модуля

Имя	Тип	Описание
args	string	Параметры конфигурации модуля, например "ERROR_RATE 0.01 INITIAL_SIZE 400".
name	string	Имя модуля, например RedisBloom, RediSearch, RedisTimeSeries.
version	string	Версия модуля, например "1.0".

Persistence

Параметры сохраняемости

Имя	Тип	Описание
aofEnabled	boolean	Задает, включен ли AOF.
aofFrequency	AofFrequency	Задает частоту записи данных на диск.
rdbEnabled	boolean	Задает, включен ли RDB.
rdbFrequency	RdbFrequency	Задает частоту создания моментального снимка базы данных.

Protocol

Указывает, могут ли клиенты redis подключаться с помощью протоколов redis с шифрованием TLS или с открытым текстом. По умолчанию используется шифрование TLS.

Имя	Тип	Описание
Encrypted	string
Plaintext	string

ProvisioningState

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

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

RdbFrequency

Задает частоту создания моментального снимка базы данных.

Имя	Тип	Описание
12h	string
1h	string
6h	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

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

Databases - Create

Параметры URI

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

Ответы

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

azure_auth

Области

Примеры

RedisEnterpriseDatabasesCreate

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

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

RedisEnterpriseDatabasesCreate With Active Geo Replication

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

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

Определения

AofFrequency

ClusteringPolicy

Database

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState

Дополнительные ресурсы