diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/OperationsList.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/OperationsList.json new file mode 100644 index 000000000000..7ffb8435295a --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/OperationsList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Cache/redisEnterprise/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (read)", + "description": "View the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (write)", + "description": "Modify the Redis Enterprise cache's settings and configuration in the management portal" + } + } + ] + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/OperationsStatusGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/OperationsStatusGet.json new file mode 100644 index 000000000000..8c946968fd5a --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/OperationsStatusGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "West US", + "operationId": "testoperationid", + "api-version": "2025-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Cache/locations/westus/operationsStatus/testoperationid", + "name": "testoperationid", + "startTime": "2017-01-01T13:13:13.933Z", + "endTime": "2017-01-01T16:13:13.933Z", + "status": "Succeeded" + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseCreate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseCreate.json new file mode 100644 index 000000000000..e9c325e0ede9 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseCreate.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "parameters": { + "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" + } + } + }, + "responses": { + "201": { + "body": { + "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": { + "body": { + "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" + } + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesCreate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesCreate.json new file mode 100644 index 000000000000..10571026d49f --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesCreate.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "parameters": { + "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" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "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": { + "body": { + "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" + } + ] + } + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesCreateWithGeoReplication.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesCreateWithGeoReplication.json new file mode 100644 index 000000000000..309056c64745 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesCreateWithGeoReplication.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid1", + "parameters": { + "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" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "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": { + "body": { + "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" + } + ] + } + } + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesDelete.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesDelete.json new file mode 100644 index 000000000000..c1a28a0628b3 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "databaseName": "db1", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesExport.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesExport.json new file mode 100644 index 000000000000..bfbeabbcaf02 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesExport.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "parameters": { + "sasUri": "https://contosostorage.blob.core.window.net/urlToBlobContainer?sasKeyParameters" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesFlush.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesFlush.json new file mode 100644 index 000000000000..b0bb5caed5e2 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesFlush.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "parameters": { + "ids": [ + "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus..." + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesForceLink.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesForceLink.json new file mode 100644 index 000000000000..21fe209bee11 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesForceLink.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "geoReplication": { + "groupNickname": "groupName", + "linkedDatabases": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default" + }, + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default" + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Cache/...pathToOperationStatus..." + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesForceUnlink.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesForceUnlink.json new file mode 100644 index 000000000000..b0bb5caed5e2 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesForceUnlink.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "parameters": { + "ids": [ + "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus..." + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesGet.json new file mode 100644 index 000000000000..db1aed358e45 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "name": "cache1/default", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Running", + "clientProtocol": "Encrypted", + "clusteringPolicy": "OSSCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "rdbEnabled": true, + "rdbFrequency": "12h" + }, + "port": 10000, + "modules": [ + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesImport.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesImport.json new file mode 100644 index 000000000000..f3dd4cf6dfec --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesImport.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "parameters": { + "sasUris": [ + "https://contosostorage.blob.core.window.net/urltoBlobFile1?sasKeyParameters", + "https://contosostorage.blob.core.window.net/urltoBlobFile2?sasKeyParameters" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesListByCluster.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesListByCluster.json new file mode 100644 index 000000000000..9bd27dc97c43 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesListByCluster.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default", + "name": "cache1/default", + "type": "Microsoft.Cache/redisEnterprise/databases", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Running", + "clientProtocol": "Encrypted", + "clusteringPolicy": "OSSCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "rdbEnabled": true, + "rdbFrequency": "12h" + }, + "port": 10000, + "modules": [ + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + ] + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesListKeys.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesListKeys.json new file mode 100644 index 000000000000..b4b41c361d03 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesListKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesRegenerateKey.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesRegenerateKey.json new file mode 100644 index 000000000000..84642173f041 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesRegenerateKey.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "parameters": { + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesUpdate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesUpdate.json new file mode 100644 index 000000000000..dacdd45389ac --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDatabasesUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clientProtocol": "Encrypted", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "rdbEnabled": true, + "rdbFrequency": "12h" + } + } + } + }, + "responses": { + "200": { + "body": { + "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": "OSSCluster", + "evictionPolicy": "AllKeysLRU", + "persistence": { + "rdbEnabled": true, + "rdbFrequency": "12h" + }, + "port": 10000, + "modules": [ + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDelete.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDelete.json new file mode 100644 index 000000000000..f5cae0df177c --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDeletePrivateEndpointConnection.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..a0b554fefab9 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseDeletePrivateEndpointConnection.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseGet.json new file mode 100644 index 000000000000..1221cf289fc1 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseGet.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "tags": {}, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "redisVersion": "6", + "minimumTlsVersion": "1.2", + "privateEndpointConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/cachePec", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/cachePe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Please approve my connection", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseGetPrivateEndpointConnection.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..2b2ff07f064c --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseGetPrivateEndpointConnection.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseList.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseList.json new file mode 100644 index 000000000000..624b0d894998 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "tags": {}, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "redisVersion": "6", + "minimumTlsVersion": "1.2" + } + } + ], + "nextLink": null + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseListByResourceGroup.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseListByResourceGroup.json new file mode 100644 index 000000000000..e45583196617 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseListByResourceGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2025-04-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "tags": {}, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "redisVersion": "5", + "minimumTlsVersion": "1.2" + } + } + ], + "nextLink": null + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseListPrivateEndpointConnections.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseListPrivateEndpointConnections.json new file mode 100644 index 000000000000..c50a792a4ccb --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseListPrivateEndpointConnections.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseListPrivateLinkResources.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseListPrivateLinkResources.json new file mode 100644 index 000000000000..9581845be70d --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseListPrivateLinkResources.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateLinkResources/redisEnterpriseCache", + "name": "redisEnterpriseCache", + "type": "Microsoft.Cache/redisEnterprise/privateLinkResources", + "properties": { + "groupId": "redisEnterpriseCache", + "requiredMembers": [ + "redisEnterpriseCache" + ], + "requiredZoneNames": [ + "privatelink.redisenterprise.cache.windows.net" + ] + } + } + ] + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterprisePutPrivateEndpointConnection.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterprisePutPrivateEndpointConnection.json new file mode 100644 index 000000000000..e6b10da36650 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterprisePutPrivateEndpointConnection.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/redisEnterprise/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseUpdate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseUpdate.json new file mode 100644 index 000000000000..57e806095990 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/examples/RedisEnterpriseUpdate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2025-04-01", + "subscriptionId": "subid", + "parameters": { + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 9 + }, + "properties": { + "minimumTlsVersion": "1.2" + }, + "tags": { + "tag1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1", + "name": "cache1", + "type": "Microsoft.Cache/redisEnterprise", + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 9 + }, + "identity": { + "type": "None" + }, + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "tag1": "value1" + }, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Updating", + "resourceState": "Updating", + "redisVersion": "5", + "minimumTlsVersion": "1.2", + "encryption": {} + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} + diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/redisenterprise.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/redisenterprise.json new file mode 100644 index 000000000000..9d7a49e4e239 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2025-04-01/redisenterprise.json @@ -0,0 +1,2159 @@ +{ + "swagger": "2.0", + "info": { + "version": "2025-04-01", + "title": "RedisEnterpriseManagementClient", + "description": "REST API for managing Redis Enterprise resources in Azure." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Cache/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available REST API operations of the Microsoft.Cache provider.", + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/operationsStatus/{operationId}": { + "get": { + "tags": [ + "OperationsStatus" + ], + "operationId": "OperationsStatus_Get", + "x-ms-examples": { + "OperationsStatusGet": { + "$ref": "./examples/OperationsStatusGet.json" + } + }, + "description": "Gets the status of operation.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The detailed status of the operation is in the response.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}": { + "put": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_Create", + "x-ms-examples": { + "RedisEnterpriseCreate": { + "$ref": "./examples/RedisEnterpriseCreate.json" + } + }, + "description": "Creates or updates an existing (overwrite/recreate, with potential downtime) cache cluster", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "description": "Parameters supplied to the Create RedisEnterprise operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The cluster was/is being created. Check provisioningState and resourceState to see detailed status.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "200": { + "description": "The cluster was/is being updated. Check provisioningState and resourceState to see detailed status.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseUpdate": { + "$ref": "./examples/RedisEnterpriseUpdate.json" + } + }, + "description": "Updates an existing RedisEnterprise cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdate" + }, + "description": "Parameters supplied to the Update RedisEnterprise operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The cluster was/is being updated. Check provisioningState and resourceState to see detailed status.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "The cluster update operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string", + "format": "uri" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation URI to poll for result", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDelete": { + "$ref": "./examples/RedisEnterpriseDelete.json" + } + }, + "description": "Deletes a RedisEnterprise cache cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The cluster was successfully deleted." + }, + "202": { + "description": "The cluster delete operation was successfully started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string", + "format": "uri" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation URI to poll for result", + "type": "string", + "format": "uri" + } + } + }, + "204": { + "description": "The cluster was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_Get", + "x-ms-examples": { + "RedisEnterpriseGet": { + "$ref": "./examples/RedisEnterpriseGet.json" + } + }, + "description": "Gets information about a RedisEnterprise cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded, response body contains the requested details.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise": { + "get": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_ListByResourceGroup", + "x-ms-examples": { + "RedisEnterpriseListByResourceGroup": { + "$ref": "./examples/RedisEnterpriseListByResourceGroup.json" + } + }, + "description": "Lists all RedisEnterprise clusters in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The list of RedisEnterprise clusters", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/redisEnterprise": { + "get": { + "tags": [ + "RedisEnterprise" + ], + "operationId": "RedisEnterprise_List", + "x-ms-examples": { + "RedisEnterpriseList": { + "$ref": "./examples/RedisEnterpriseList.json" + } + }, + "description": "Gets all RedisEnterprise clusters in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The list of RedisEnterprise clusters", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases": { + "get": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_ListByCluster", + "description": "Gets all databases in the specified RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseDatabasesListByCluster": { + "$ref": "./examples/RedisEnterpriseDatabasesListByCluster.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "The list of databases", + "schema": { + "$ref": "#/definitions/DatabaseList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}": { + "put": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Create", + "description": "Creates a database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesCreate": { + "$ref": "./examples/RedisEnterpriseDatabasesCreate.json" + }, + "RedisEnterpriseDatabasesCreate With Active Geo Replication": { + "$ref": "./examples/RedisEnterpriseDatabasesCreateWithGeoReplication.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Database" + }, + "description": "Parameters supplied to the create or update database operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The database was/is being updated. Check provisioningState and resourceState for detailed status.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "201": { + "description": "The database was/is being created. Check provisioningState and resourceState for detailed status.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Update", + "description": "Updates a database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesUpdate": { + "$ref": "./examples/RedisEnterpriseDatabasesUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseUpdate" + }, + "description": "Parameters supplied to the create or update database operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The database was/is being updated. Check provisioningState and resourceState for detailed status.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "202": { + "description": "The database update operation was successfully started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string", + "format": "uri" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation URI to poll for result", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Get", + "description": "Gets information about a database in a RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseDatabasesGet": { + "$ref": "./examples/RedisEnterpriseDatabasesGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully found the database", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Delete", + "description": "Deletes a single database", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesDelete": { + "$ref": "./examples/RedisEnterpriseDatabasesDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the database." + }, + "202": { + "description": "The database delete operation started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string", + "format": "uri" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation URI to poll for result", + "type": "string", + "format": "uri" + } + } + }, + "204": { + "description": "Successfully deleted the database." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/listKeys": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_ListKeys", + "x-ms-examples": { + "RedisEnterpriseDatabasesListKeys": { + "$ref": "./examples/RedisEnterpriseDatabasesListKeys.json" + } + }, + "description": "Retrieves the access keys for the RedisEnterprise database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The access keys for the specified database.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/regenerateKey": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_RegenerateKey", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesRegenerateKey": { + "$ref": "./examples/RedisEnterpriseDatabasesRegenerateKey.json" + } + }, + "description": "Regenerates the RedisEnterprise database's access keys.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + }, + "description": "Specifies which key to regenerate." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns the new access keys for the database", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "202": { + "description": "The cluster update operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string", + "format": "uri" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation URI to poll for result", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/import": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Import", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesImport": { + "$ref": "./examples/RedisEnterpriseDatabasesImport.json" + } + }, + "description": "Imports database files to target database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImportClusterParameters" + }, + "description": "Storage information for importing into the cluster" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Import operation succeeded." + }, + "202": { + "description": "The import operation was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string", + "format": "uri" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation URI to poll for result", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/export": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Export", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabasesExport": { + "$ref": "./examples/RedisEnterpriseDatabasesExport.json" + } + }, + "description": "Exports a database file from target database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExportClusterParameters" + }, + "description": "Storage information for exporting into the cluster" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Export operation succeeded." + }, + "202": { + "description": "Export operation successfully enqueued; follow the Location header to poll for final outcome.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string", + "format": "uri" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation URI to poll for result", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "description": "Lists all the private endpoint connections associated with the RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseListPrivateEndpointConnections": { + "$ref": "./examples/RedisEnterpriseListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseGetPrivateEndpointConnection": { + "$ref": "./examples/RedisEnterpriseGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Put", + "description": "Updates the state of the specified private endpoint connection associated with the RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterprisePutPrivateEndpointConnection": { + "$ref": "./examples/RedisEnterprisePutPrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "201": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseDeletePrivateEndpointConnection": { + "$ref": "./examples/RedisEnterpriseDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "202": { + "description": "Deletion of specified private endpoint connection was started. GET the URL in the Azure-AsyncOperation or Location headers to retrieve updated status.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByCluster", + "description": "Gets the private link resources that need to be created for a RedisEnterprise cluster.", + "x-ms-examples": { + "RedisEnterpriseListPrivateLinkResources": { + "$ref": "./examples/RedisEnterpriseListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/forceUnlink": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_ForceUnlink", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "How to unlink a database during a regional outage": { + "$ref": "./examples/RedisEnterpriseDatabasesForceUnlink.json" + } + }, + "description": "Forcibly removes the link to the specified database resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForceUnlinkParameters" + }, + "description": "Information identifying the database to be unlinked." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Force unlink operation succeeded. The unlinked database must be deleted before it can be recreated and linked again." + }, + "202": { + "description": "Force unlink operation successfully enqueued; follow the Azure-AsyncOperation header to poll for final outcome.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string", + "format": "uri" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation URI to poll for result", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/forceLinkToReplicationGroup": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_ForceLinkToReplicationGroup", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "How to relink a database after a regional outage": { + "$ref": "./examples/RedisEnterpriseDatabasesForceLink.json" + } + }, + "description": "Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group. **IMPORTANT NOTE:** All data in this database will be discarded, and the database will temporarily be unavailable while rejoining the replication group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForceLinkParameters" + }, + "description": "Information identifying the database to be unlinked." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Force link operation successfully enqueued; follow the Azure-AsyncOperation header to poll for final outcome.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string", + "format": "uri" + }, + "Azure-AsyncOperation": { + "description": "Azure-AsyncOperation URI to poll for result", + "type": "string", + "format": "uri" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/flush": { + "post": { + "tags": [ + "RedisEnterprise", + "Databases" + ], + "operationId": "Databases_Flush", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "How to flush all the keys in the database": { + "$ref": "./examples/RedisEnterpriseDatabasesFlush.json" + } + }, + "description": "Flushes all the keys in this database and also from its linked databases.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlushParameters" + }, + "description": "Information identifying the databases to be flushed" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Flush operation succeeded. All the keys are cleared in this and all its linked databases." + }, + "202": { + "description": "Flush operation successfully enqueued; follow the Azure-AsyncOperation header to poll for final outcome.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Sku": { + "description": "SKU parameters supplied to the create RedisEnterprise operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)", + "enum": [ + "Enterprise_E1", + "Enterprise_E5", + "Enterprise_E10", + "Enterprise_E20", + "Enterprise_E50", + "Enterprise_E100", + "Enterprise_E200", + "Enterprise_E400", + "EnterpriseFlash_F300", + "EnterpriseFlash_F700", + "EnterpriseFlash_F1500" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs." + } + }, + "required": [ + "name" + ] + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "Current provisioning status", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ResourceState": { + "type": "string", + "readOnly": true, + "description": "Current resource status", + "enum": [ + "Running", + "Creating", + "CreateFailed", + "Updating", + "UpdateFailed", + "Deleting", + "DeleteFailed", + "Enabling", + "EnableFailed", + "Disabling", + "DisableFailed", + "Disabled", + "Scaling", + "ScalingFailed" + ], + "x-ms-enum": { + "name": "ResourceState", + "modelAsString": true + } + }, + "Cluster": { + "description": "Describes the RedisEnterprise cluster", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU to create, which affects price, performance, and features." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Availability Zones where this cluster will be deployed." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties", + "description": "Other properties of the cluster." + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ] + }, + "ClusterUpdate": { + "description": "A partial update to the RedisEnterprise cluster", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU to create, which affects price, performance, and features." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties", + "description": "Other properties of the cluster." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "ClusterProperties": { + "title": "RedisEnterprise cluster properties", + "description": "Properties of RedisEnterprise clusters, as opposed to general resource properties like location, tags", + "type": "object", + "properties": { + "minimumTlsVersion": { + "type": "string", + "description": "The minimum TLS version for the cluster to support, e.g. '1.2'", + "enum": [ + "1.0", + "1.1", + "1.2" + ], + "x-ms-enum": { + "name": "TlsVersion", + "modelAsString": true + } + }, + "encryption": { + "type": "object", + "description": "Encryption-at-rest configuration for the cluster.", + "properties": { + "customerManagedKeyEncryption": { + "type": "object", + "description": "All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.", + "properties": { + "keyEncryptionKeyIdentity": { + "type": "object", + "description": "All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.", + "properties": { + "userAssignedIdentityResourceId": { + "type": "string", + "description": "User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId." + }, + "identityType": { + "type": "string", + "enum": [ + "systemAssignedIdentity", + "userAssignedIdentity" + ], + "description": "Only userAssignedIdentity is supported in this API version; other types may be supported in the future", + "x-ms-enum": { + "name": "CmkIdentityType", + "modelAsString": true + } + } + } + }, + "keyEncryptionKeyUrl": { + "type": "string", + "description": "Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78" + } + } + } + } + }, + "hostName": { + "type": "string", + "readOnly": true, + "description": "DNS name of the cluster endpoint" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "readOnly": true, + "description": "Current provisioning status of the cluster" + }, + "resourceState": { + "$ref": "#/definitions/ResourceState", + "readOnly": true, + "description": "Current resource status of the cluster" + }, + "redisVersion": { + "type": "string", + "readOnly": true, + "description": "Version of redis the cluster supports, e.g. '6'" + }, + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "description": "List of private endpoint connections associated with the specified RedisEnterprise cluster", + "items": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + } + }, + "ClusterList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + }, + "description": "List of clusters." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URI to fetch the next page of results." + } + }, + "description": "The response of a list-all operation." + }, + "Database": { + "description": "Describes a database on the RedisEnterprise cluster", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseProperties", + "description": "Other properties of the database." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "DatabaseUpdate": { + "description": "A partial update to the RedisEnterprise database", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseProperties", + "description": "Properties of the database." + } + } + }, + "DatabaseProperties": { + "title": "RedisEnterprise database properties", + "description": "Properties of RedisEnterprise databases, as opposed to general resource properties like location, tags", + "type": "object", + "properties": { + "clientProtocol": { + "type": "string", + "description": "Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.", + "enum": [ + "Encrypted", + "Plaintext" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "TCP port of the database endpoint. Specified at create time. Defaults to an available port." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "readOnly": true, + "description": "Current provisioning status of the database" + }, + "resourceState": { + "$ref": "#/definitions/ResourceState", + "readOnly": true, + "description": "Current resource status of the database" + }, + "clusteringPolicy": { + "type": "string", + "description": "Clustering policy - default is OSSCluster. Specified at create time.", + "enum": [ + "EnterpriseCluster", + "OSSCluster" + ], + "x-ms-enum": { + "name": "ClusteringPolicy", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "evictionPolicy": { + "type": "string", + "description": "Redis eviction policy - default is VolatileLRU", + "enum": [ + "AllKeysLFU", + "AllKeysLRU", + "AllKeysRandom", + "VolatileLRU", + "VolatileLFU", + "VolatileTTL", + "VolatileRandom", + "NoEviction" + ], + "x-ms-enum": { + "name": "EvictionPolicy", + "modelAsString": true + } + }, + "persistence": { + "$ref": "#/definitions/Persistence", + "description": "Persistence settings", + "x-ms-identifiers": [] + }, + "modules": { + "type": "array", + "description": "Optional set of redis modules to enable in this database - modules can only be added at creation time.", + "items": { + "$ref": "#/definitions/Module" + }, + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-identifiers": [ + "name" + ] + }, + "geoReplication": { + "type": "object", + "description": "Optional set of properties to configure geo replication for this database.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "groupNickname": { + "type": "string", + "description": "Name for the group of linked database resources", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "linkedDatabases": { + "type": "array", + "description": "List of database resources to link with this database", + "items": { + "$ref": "#/definitions/LinkedDatabase" + } + } + } + } + } + }, + "DatabaseList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Database" + }, + "description": "List of databases" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URI to fetch the next page of results." + } + }, + "description": "The response of a list-all operation." + }, + "Persistence": { + "title": "Persistence settings", + "description": "Persistence-related configuration for the RedisEnterprise database", + "type": "object", + "properties": { + "aofEnabled": { + "type": "boolean", + "description": "Sets whether AOF is enabled." + }, + "rdbEnabled": { + "type": "boolean", + "description": "Sets whether RDB is enabled." + }, + "aofFrequency": { + "type": "string", + "description": "Sets the frequency at which data is written to disk.", + "enum": [ + "1s", + "always" + ], + "x-ms-enum": { + "name": "AofFrequency", + "modelAsString": true + } + }, + "rdbFrequency": { + "type": "string", + "description": "Sets the frequency at which a snapshot of the database is created.", + "enum": [ + "1h", + "6h", + "12h" + ], + "x-ms-enum": { + "name": "RdbFrequency", + "modelAsString": true + } + } + } + }, + "Module": { + "title": "Module settings", + "description": "Specifies configuration of a redis module", + "type": "object", + "properties": { + "name": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'" + }, + "args": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "The version of the module, e.g. '1.0'." + } + }, + "required": [ + "name" + ] + }, + "LinkedDatabase": { + "title": "Linked Database", + "description": "Specifies details of a linked database resource.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Cache/redisEnterprise/databases" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource ID of a database resource to link with this database." + }, + "state": { + "type": "string", + "description": "State of the link between the database resources.", + "enum": [ + "Linked", + "Linking", + "Unlinking", + "LinkFailed", + "UnlinkFailed" + ], + "x-ms-enum": { + "name": "LinkState", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "AccessKeys": { + "title": "Access keys", + "description": "The secret access keys used for authenticating connections to redis", + "type": "object", + "properties": { + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "The current primary key that clients can use to authenticate" + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "The current secondary key that clients can use to authenticate" + } + } + }, + "RegenerateKeyParameters": { + "title": "Regenerate access keys request", + "type": "object", + "properties": { + "keyType": { + "type": "string", + "description": "Which access key to regenerate.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "AccessKeyType", + "modelAsString": false + } + } + }, + "required": [ + "keyType" + ], + "description": "Specifies which access keys to reset to a new random value." + }, + "ImportClusterParameters": { + "title": "Import RDB files into a target database", + "type": "object", + "properties": { + "sasUris": { + "type": "array", + "items": { + "type": "string" + }, + "description": "SAS URIs for the target blobs to import from", + "x-ms-secret": true + } + }, + "required": [ + "sasUris" + ], + "description": "Parameters for a Redis Enterprise import operation." + }, + "ExportClusterParameters": { + "title": "Export an RDB file into a target database", + "type": "object", + "properties": { + "sasUri": { + "type": "string", + "description": "SAS URI for the target directory to export to", + "x-ms-secret": true + } + }, + "required": [ + "sasUri" + ], + "description": "Parameters for a Redis Enterprise export operation." + }, + "OperationStatus": { + "description": "The status of a long-running operation.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The operation's unique id." + }, + "name": { + "type": "string", + "description": "The operation's name." + }, + "startTime": { + "type": "string", + "description": "The start time of the operation." + }, + "endTime": { + "type": "string", + "description": "The end time of the operation." + }, + "status": { + "type": "string", + "description": "The current status of the operation." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse", + "description": "Error response describing why the operation failed." + } + } + }, + "ForceLinkParameters": { + "type": "object", + "description": "Parameters for reconfiguring active geo-replication, of an existing database that was previously unlinked from a replication group.", + "required": [ + "geoReplication" + ], + "properties": { + "geoReplication": { + "type": "object", + "description": "Properties to configure geo replication for this database.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "groupNickname": { + "type": "string", + "description": "The name of the group of linked database resources. This should match the existing replication group name.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "linkedDatabases": { + "type": "array", + "description": "The resource IDs of the databases that are expected to be linked and included in the replication group. This parameter is used to validate that the linking is to the expected (unlinked) part of the replication group, if it is splintered.", + "items": { + "$ref": "#/definitions/LinkedDatabase" + } + } + } + } + } + }, + "ForceUnlinkParameters": { + "title": "Forcibly unlink another database from this database.", + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Cache/redisEnterprise/databases" + } + ] + } + }, + "description": "The resource IDs of the database resources to be unlinked." + } + }, + "required": [ + "ids" + ], + "description": "Parameters for a Redis Enterprise Active Geo Replication Force Unlink operation." + }, + "FlushParameters": { + "title": "Flush all the keys from the current and all its linked databases.", + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Cache/redisEnterprise/databases" + } + ] + } + }, + "description": "The identifiers of all the other database resources in the georeplication group to be flushed." + } + }, + "description": "Parameters for a Redis Enterprise active geo-replication flush operation" + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "pattern": "^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "pattern": "^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis Enterprise database.", + "x-ms-parameter-location": "method" + } + } +} + diff --git a/specification/redisenterprise/resource-manager/readme.md b/specification/redisenterprise/resource-manager/readme.md index bf9071d1e129..74b71fecbb81 100644 --- a/specification/redisenterprise/resource-manager/readme.md +++ b/specification/redisenterprise/resource-manager/readme.md @@ -26,10 +26,19 @@ These are the global settings for the RedisEnterprise API. ``` yaml openapi-type: arm -tag: package-2024-10 +tag: package-2025-04-01 ``` +### Tag: package-2025-04-01 + +These settings apply only when `--tag=package-2025-04-01` is specified on the command line. + +```yaml $(tag) == 'package-2025-04-01' +input-file: + - Microsoft.Cache/stable/2025-04-01/redisenterprise.json +``` + ### Tag: package-2024-10 These settings apply only when `--tag=package-2024-10` is specified on the command line.