Databases - Create

Referenz

Dienst:: Redis Cache

API-Version:: 2024-10-01

Erstellt eine Datenbank

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
clusterName	path	True	string	Der Name des Redis Enterprise-Clusters. Der Name muss 1 bis 60 Zeichen lang sein. Zulässige Zeichen (A-Z, a-z, 0-9) und Bindestrich(-). Es kann weder führende noch nachfolgende Bindestriche oder aufeinander folgende Bindestriche geben. RegEx-Muster: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
databaseName	path	True	string	Der Name der Redis Enterprise-Datenbank. RegEx-Muster: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Die ID des Zielabonnements.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.clientProtocol	Protocol	Gibt an, ob Redis-Clients eine Verbindung mit TLS-verschlüsselten oder Nur-Text-Redis-Protokollen herstellen können. Der Standardwert ist TLS-verschlüsselt.
properties.clusteringPolicy	ClusteringPolicy	Clustering-Richtlinie – Der Standardwert ist OSSCluster. Zur Erstellungszeit angegeben.
properties.evictionPolicy	EvictionPolicy	Redis eviction policy - default is VolatileLRU
properties.geoReplication	GeoReplication	Optionaler Satz von Eigenschaften zum Konfigurieren der Georeplikation für diese Datenbank.
properties.modules	Module[]	Optionaler Satz von Redis-Modulen, die in dieser Datenbank aktiviert werden sollen – Module können nur zur Erstellungszeit hinzugefügt werden.
properties.persistence	Persistence	Persistenzeinstellungen Persistenzeinstellungen
properties.port	integer	TCP-Port des Datenbankendpunkts. Zur Erstellungszeit angegeben. Standardmäßig wird ein verfügbarer Port verwendet.

Antworten

Name	Typ	Beschreibung
200 OK	Database	Die Datenbank wurde/wird aktualisiert. Überprüfen Sie "provisioningState" und "resourceState" auf detaillierten Status.
201 Created	Database	Die Datenbank wurde/wird erstellt. Überprüfen Sie "provisioningState" und "resourceState" auf detaillierten Status.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

RedisEnterpriseDatabasesCreate

RedisEnterpriseDatabasesCreate With Active Geo Replication

RedisEnterpriseDatabasesCreate

Beispielanforderung

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"
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 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"
      }
    ]
  }
}

Statuscode:: 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

Beispielanforderung

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"
        }
      ]
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 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"
        }
      ]
    }
  }
}

Statuscode:: 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"
        }
      ]
    }
  }
}

Definitionen

Name	Beschreibung
AofFrequency	Legt die Häufigkeit fest, mit der Daten auf den Datenträger geschrieben werden.
ClusteringPolicy	Clustering-Richtlinie – Der Standardwert ist OSSCluster. Zur Erstellungszeit angegeben.
Database	Beschreibt eine Datenbank im RedisEnterprise-Cluster
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
EvictionPolicy	Redis eviction policy - default is VolatileLRU
GeoReplication	Optionaler Satz von Eigenschaften zum Konfigurieren der Georeplikation für diese Datenbank.
LinkedDatabase	Verknüpfte Datenbank
LinkState	Der Status der Verknüpfung zwischen den Datenbankressourcen.
Module	Moduleinstellungen
Persistence	Persistenzeinstellungen
Protocol	Gibt an, ob Redis-Clients eine Verbindung mit TLS-verschlüsselten oder Nur-Text-Redis-Protokollen herstellen können. Der Standardwert ist TLS-verschlüsselt.
ProvisioningState	Aktueller Bereitstellungsstatus
RdbFrequency	Legt die Häufigkeit fest, mit der eine Momentaufnahme der Datenbank erstellt wird.
ResourceState	Aktueller Ressourcenstatus

AofFrequency

Legt die Häufigkeit fest, mit der Daten auf den Datenträger geschrieben werden.

Name	Typ	Beschreibung
1s	string
always	string

ClusteringPolicy

Clustering-Richtlinie – Der Standardwert ist OSSCluster. Zur Erstellungszeit angegeben.

Name	Typ	Beschreibung
EnterpriseCluster	string
OSSCluster	string

Database

Beschreibt eine Datenbank im RedisEnterprise-Cluster

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.clientProtocol	Protocol	Gibt an, ob Redis-Clients eine Verbindung mit TLS-verschlüsselten oder Nur-Text-Redis-Protokollen herstellen können. Der Standardwert ist TLS-verschlüsselt.
properties.clusteringPolicy	ClusteringPolicy	Clustering-Richtlinie – Der Standardwert ist OSSCluster. Zur Erstellungszeit angegeben.
properties.evictionPolicy	EvictionPolicy	Redis eviction policy - default is VolatileLRU
properties.geoReplication	GeoReplication	Optionaler Satz von Eigenschaften zum Konfigurieren der Georeplikation für diese Datenbank.
properties.modules	Module[]	Optionaler Satz von Redis-Modulen, die in dieser Datenbank aktiviert werden sollen – Module können nur zur Erstellungszeit hinzugefügt werden.
properties.persistence	Persistence	Persistenzeinstellungen Persistenzeinstellungen
properties.port	integer	TCP-Port des Datenbankendpunkts. Zur Erstellungszeit angegeben. Standardmäßig wird ein verfügbarer Port verwendet.
properties.provisioningState	ProvisioningState	Aktueller Bereitstellungsstatus der Datenbank
properties.resourceState	ResourceState	Aktueller Ressourcenstatus der Datenbank
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

EvictionPolicy

Redis eviction policy - default is VolatileLRU

Name	Typ	Beschreibung
AllKeysLFU	string
AllKeysLRU	string
AllKeysRandom	string
NoEviction	string
VolatileLFU	string
VolatileLRU	string
VolatileRandom	string
VolatileTTL	string

GeoReplication

Optionaler Satz von Eigenschaften zum Konfigurieren der Georeplikation für diese Datenbank.

Name	Typ	Beschreibung
groupNickname	string	Name für die Gruppe der verknüpften Datenbankressourcen
linkedDatabases	LinkedDatabase[]	Liste der Datenbankressourcen, die mit dieser Datenbank verknüpft werden sollen

LinkedDatabase

Verknüpfte Datenbank

Name	Typ	Beschreibung
id	string	Ressourcen-ID einer Datenbankressource, die mit dieser Datenbank verknüpft werden soll.
state	LinkState	Der Status der Verknüpfung zwischen den Datenbankressourcen.

LinkState

Der Status der Verknüpfung zwischen den Datenbankressourcen.

Name	Typ	Beschreibung
LinkFailed	string
Linked	string
Linking	string
UnlinkFailed	string
Unlinking	string

Module

Moduleinstellungen

Name	Typ	Beschreibung
args	string	Konfigurationsoptionen für das Modul, z. B. "ERROR_RATE 0,01 INITIAL_SIZE 400".
name	string	Der Name des Moduls, z. B. "RedisBloom", "RediSearch", "RedisTimeSeries"
version	string	Die Version des Moduls, z. B. "1.0".

Persistence

Persistenzeinstellungen

Name	Typ	Beschreibung
aofEnabled	boolean	Legt fest, ob AOF aktiviert ist.
aofFrequency	AofFrequency	Legt die Häufigkeit fest, mit der Daten auf den Datenträger geschrieben werden.
rdbEnabled	boolean	Legt fest, ob RDB aktiviert ist.
rdbFrequency	RdbFrequency	Legt die Häufigkeit fest, mit der eine Momentaufnahme der Datenbank erstellt wird.

Protocol

Gibt an, ob Redis-Clients eine Verbindung mit TLS-verschlüsselten oder Nur-Text-Redis-Protokollen herstellen können. Der Standardwert ist TLS-verschlüsselt.

Name	Typ	Beschreibung
Encrypted	string
Plaintext	string

ProvisioningState

Aktueller Bereitstellungsstatus

Name	Typ	Beschreibung
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

RdbFrequency

Legt die Häufigkeit fest, mit der eine Momentaufnahme der Datenbank erstellt wird.

Name	Typ	Beschreibung
12h	string
1h	string
6h	string

ResourceState

Aktueller Ressourcenstatus

Name	Typ	Beschreibung
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

Freigeben über

Databases - Create

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

RedisEnterpriseDatabasesCreate

Beispielanforderung

Beispiel für eine Antwort

RedisEnterpriseDatabasesCreate With Active Geo Replication

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AofFrequency

ClusteringPolicy

Database

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState

Zusätzliche Ressourcen