diff --git a/custom-words.txt b/custom-words.txt index ae42b648994a..58d00e90b27e 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1310,6 +1310,8 @@ recoveryservicessiterecovery recurse rediscache rediscachemanagement +RediSearch +redisenterprise Redshift Reenabled Refid diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/OperationStatusGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/OperationStatusGet.json new file mode 100644 index 000000000000..721518374210 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/OperationStatusGet.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "West US", + "operationId": "testoperationid", + "api-version": "2020-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Cache/locations/westus/operationStatus/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/preview/2020-10-01-preview/examples/RedisEnterpriseCreate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseCreate.json new file mode 100644 index 000000000000..60e9eaa42132 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseCreate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "sku": { + "name": "EnterpriseFlash_F300", + "capacity": 3 + }, + "zones": [ + "1", + "2", + "3" + ], + "properties": { + "minimumTlsVersion": "1.2" + }, + "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" + ], + "properties": { + "provisioningState": "Creating", + "resourceState": "Creating", + "hostName": "cache1.westus.something.azure.net", + "redisVersion": "5", + "minimumTlsVersion": "1.2" + }, + "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" + ], + "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/preview/2020-10-01-preview/examples/RedisEnterpriseDatabaseListKeys.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabaseListKeys.json new file mode 100644 index 000000000000..b8e3c17f187c --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabaseListKeys.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryKey": "secretkey1", + "secondaryKey": "secretKey2" + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabaseRegenerateKey.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabaseRegenerateKey.json new file mode 100644 index 000000000000..94cf4027a68f --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabaseRegenerateKey.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "subscriptionId": "subid", + "parameters": { + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryKey": "secretkey1", + "secondaryKey": "secretKey2" + } + }, + "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/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesCreate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesCreate.json new file mode 100644 index 000000000000..0d285f4b3445 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesCreate.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clientProtocol": "Encrypted", + "clusteringPolicy": "EnterpriseCluster", + "evictionPolicy": "AllKeysLRU", + "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", + "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": "Plaintext", + "clusteringPolicy": "EnterpriseCluster", + "evictionPolicy": "AllKeysLRU", + "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/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesDelete.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesDelete.json new file mode 100644 index 000000000000..21525b0dafca --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "databaseName": "db1", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "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/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesGet.json new file mode 100644 index 000000000000..bfcc755b85a7 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "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", + "port": 10000, + "modules": [ + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesList.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesList.json new file mode 100644 index 000000000000..7130cd815ca3 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "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", + "port": 10000, + "modules": [ + { + "name": "RediSearch", + "args": "", + "version": "1.0.0" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesUpdate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesUpdate.json new file mode 100644 index 000000000000..e3cc65665ae2 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDatabasesUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clientProtocol": "Encrypted", + "evictionPolicy": "AllKeysLRU", + "modules": [ + { + "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": "OSSCluster", + "evictionPolicy": "AllKeysLRU", + "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/preview/2020-10-01-preview/examples/RedisEnterpriseDelete.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDelete.json new file mode 100644 index 000000000000..91a772418f7c --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "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/preview/2020-10-01-preview/examples/RedisEnterpriseDeletePrivateEndpointConnection.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..c7ea6bd88240 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseDeletePrivateEndpointConnection.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "subscriptionId": "subid", + "privateEndpointConnectionName": "pectest01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseExportCluster.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseExportCluster.json new file mode 100644 index 000000000000..96ab6f85d754 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseExportCluster.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "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/preview/2020-10-01-preview/examples/RedisEnterpriseGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseGet.json new file mode 100644 index 000000000000..192944f3207a --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "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/preview/2020-10-01-preview/examples/RedisEnterpriseGetPrivateEndpointConnection.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..10032e9206e3 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseGetPrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "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/preview/2020-10-01-preview/examples/RedisEnterpriseImportCluster.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseImportCluster.json new file mode 100644 index 000000000000..0336ce6a7ed7 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseImportCluster.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "databaseName": "default", + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "subscriptionId": "subid", + "parameters": { + "sasUri": "https://contosostorage.blob.core.window.net/urltoBlobFile?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/preview/2020-10-01-preview/examples/RedisEnterpriseList.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseList.json new file mode 100644 index 000000000000..b9c4bfddded3 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-10-01-preview", + "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/preview/2020-10-01-preview/examples/RedisEnterpriseListByResourceGroup.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseListByResourceGroup.json new file mode 100644 index 000000000000..4d996bd5dad4 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseListByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-10-01-preview", + "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/preview/2020-10-01-preview/examples/RedisEnterpriseListPrivateEndpointConnections.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseListPrivateEndpointConnections.json new file mode 100644 index 000000000000..4776981c1763 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseListPrivateEndpointConnections.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "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" + } + } + }, + { + "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/preview/2020-10-01-preview/examples/RedisEnterpriseListPrivateLinkResources.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseListPrivateLinkResources.json new file mode 100644 index 000000000000..75bb507b9b23 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "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/preview/2020-10-01-preview/examples/RedisEnterprisePutPrivateEndpointConnection.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterprisePutPrivateEndpointConnection.json new file mode 100644 index 000000000000..4ed0654286c7 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterprisePutPrivateEndpointConnection.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "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/preview/2020-10-01-preview/examples/RedisEnterpriseUpdate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseUpdate.json new file mode 100644 index 000000000000..e8ea0df53ab9 --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/examples/RedisEnterpriseUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "clusterName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2020-10-01-preview", + "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 + }, + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "tag1": "value1" + }, + "properties": { + "hostName": "cache1.westus.something.azure.com", + "provisioningState": "Updating", + "resourceState": "Updating", + "redisVersion": "5", + "minimumTlsVersion": "1.2" + } + } + }, + "202": { + "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/preview/2020-10-01-preview/redisenterprise.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/redisenterprise.json new file mode 100644 index 000000000000..2893fed00d1d --- /dev/null +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/preview/2020-10-01-preview/redisenterprise.json @@ -0,0 +1,1600 @@ +{ + "swagger": "2.0", + "info": { + "title": "redisEnterprise", + "description": "REST API for managing Redis Enterprise resources in Azure.", + "version": "2020-10-01-preview", + "x-ms-code-generation-settings": { + "name": "redisenterpriseClient" + } + }, + "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", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/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": [ + "OperationStatus" + ], + "operationId": "Get_OperationStatus", + "x-ms-examples": { + "OperationStatusGet": { + "$ref": "./examples/OperationStatusGet.json" + } + }, + "description": "Gets the status of operation.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The region the operation is in." + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation's unique identifier." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "description": "Parameters supplied to the Create RedisEnterprise operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdate" + }, + "description": "Parameters supplied to the Update RedisEnterprise operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": { + "RedisEnterpriseDatabasesList": { + "$ref": "./examples/RedisEnterpriseDatabasesList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/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": { + "RedisEnterpriseDatabaseCreate": { + "$ref": "./examples/RedisEnterpriseDatabasesCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "RedisEnterpriseDatabase_ListKeys", + "x-ms-examples": { + "RedisEnterpriseDatabaseListKeys": { + "$ref": "./examples/RedisEnterpriseDatabaseListKeys.json" + } + }, + "description": "Retrieves the access keys for the RedisEnterprise database.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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": "RedisEnterpriseDatabase_RegenerateKey", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseDatabaseRegenerateKey": { + "$ref": "./examples/RedisEnterpriseDatabaseRegenerateKey.json" + } + }, + "description": "Regenerates the RedisEnterprise database's access keys.", + "parameters": [ + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "RedisEnterpriseDatabase_Import", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseImportCluster": { + "$ref": "./examples/RedisEnterpriseImportCluster.json" + } + }, + "description": "Imports a database file to target database.", + "parameters": [ + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/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." + }, + "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": "RedisEnterpriseDatabase_Export", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "RedisEnterpriseExportCluster": { + "$ref": "./examples/RedisEnterpriseExportCluster.json" + } + }, + "description": "Exports a database file from target database.", + "parameters": [ + { + "$ref": "#/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": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Export operation succeeded." + }, + "202": { + "description": "Export operation successfully enqueued; follow the Location header to poll for final outcome." + }, + "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": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/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": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/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": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/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/v1/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" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "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_ListByRedisEnterpriseCache", + "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": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/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 + } + } + } + }, + "definitions": { + "Sku": { + "description": "SKU parameters supplied to the create RedisEnterprise operation.", + "properties": { + "name": { + "type": "string", + "description": "The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)", + "enum": [ + "Enterprise_E10", + "Enterprise_E20", + "Enterprise_E50", + "Enterprise_E100", + "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" + ], + "x-ms-enum": { + "name": "ResourceState", + "modelAsString": true + } + }, + "Cluster": { + "description": "Describes the RedisEnterprise cluster", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU to create, which affects price, performance, and features." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The zones where this cluster will be deployed." + }, + "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", + "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." + }, + "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", + "properties": { + "minimumTlsVersion": { + "type": "string", + "description": "The minimum TLS version for the cluster to support, e.g. '1.2'" + }, + "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/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + } + }, + "ClusterList": { + "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", + "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", + "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", + "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 + } + }, + "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" + ] + } + } + }, + "DatabaseList": { + "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." + }, + "Module": { + "title": "Module settings", + "description": "Specifies configuration of a redis module", + "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.00 INITIAL_SIZE 400'." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "The version of the module, e.g. '1.0'." + } + }, + "required": [ + "name" + ] + }, + "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", + "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 an RDB file into a target database", + "properties": { + "sasUri": { + "type": "string", + "description": "SAS Uri for the target blob to import from" + } + }, + "required": [ + "sasUri" + ], + "description": "Parameters for a Redis Enterprise import operation." + }, + "ExportClusterParameters": { + "title": "Export an RDB file into a target database", + "properties": { + "sasUri": { + "type": "string", + "description": "SAS Uri for the target directory to export to" + } + }, + "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." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RedisEnterprise cluster.", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/redisenterprise/resource-manager/readme.csharp.md b/specification/redisenterprise/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..c091d56643f8 --- /dev/null +++ b/specification/redisenterprise/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.Azure.Management.RedisEnterprise + output-folder: $(csharp-sdks-folder)/redisenterprise/Microsoft.Azure.Management.RedisEnterprise/src/Generated +``` diff --git a/specification/redisenterprise/resource-manager/readme.go.md b/specification/redisenterprise/resource-manager/readme.go.md new file mode 100644 index 000000000000..a631e563ba0e --- /dev/null +++ b/specification/redisenterprise/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: redisenterprise + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2020-10-01-preview +``` + +### Tag: package-2020-10-01-preview and go + +These settings apply only when `--tag=package-2020-10-01-preview --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2020-10-01-preview' && $(go) +output-folder: $(go-sdks-folder)/services/preview/$(namespace)/mgmt/2020-10-01-preview/$(namespace) +``` diff --git a/specification/redisenterprise/resource-manager/readme.md b/specification/redisenterprise/resource-manager/readme.md new file mode 100644 index 000000000000..40b8cc61561d --- /dev/null +++ b/specification/redisenterprise/resource-manager/readme.md @@ -0,0 +1,80 @@ +# RedisEnterprise + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for redisenterprise. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the RedisEnterprise API. + +```yaml +openapi-type: arm +tag: package-2020-10-01-preview +``` + +### Tag: package-2020-10-01-preview + +These settings apply only when `--tag=package-2020-10-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2020-10-01-preview' +input-file: + - Microsoft.Cache/preview/2020-10-01-preview/redisenterprise.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_redisenterprise'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/redisenterprise/resource-manager/readme.python.md b/specification/redisenterprise/resource-manager/readme.python.md new file mode 100644 index 000000000000..ee21c8325e10 --- /dev/null +++ b/specification/redisenterprise/resource-manager/readme.python.md @@ -0,0 +1,21 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: Microsoft.Cache + package-name: redisenterprise + package-version: 2020-10-01-preview + clear-output-folder: true +``` + +```yaml $(python) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt/redisenterprise +``` diff --git a/specification/redisenterprise/resource-manager/readme.ruby.md b/specification/redisenterprise/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..cd98f4b0c38d --- /dev/null +++ b/specification/redisenterprise/resource-manager/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_redisenterprise +package-version: 2020-10-01-preview +azure-arm: true +``` + +### Tag: package-2020-10-01-preview and ruby + +These settings apply only when `--tag=package-2020-10-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2020-10-01-preview' && $(ruby) +namespace: Microsoft.Cache +output-folder: $(ruby-sdks-folder)/redisenterprise +``` diff --git a/specification/redisenterprise/resource-manager/readme.typescript.md b/specification/redisenterprise/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..79eec0c670ef --- /dev/null +++ b/specification/redisenterprise/resource-manager/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "redisenterprise" + output-folder: "$(typescript-sdks-folder)/packages/redisenterprise" + payload-flattening-threshold: 1 + generate-metadata: true +```