Microsoft Azure Redis Enterprise is a fully managed, in-memory data store that enables users to build high-performance, low-latency applications at scale. With its advanced caching capabilities and support for data structures such as strings, lists, sets, and hashes, Azure Redis Enterprise provides a powerful solution for handling large volumes of data in real-time.
swagger: '2.0'
info:
title: Microsoft Azure 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: microsoftAzureOperationsList
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
summary: Microsoft Azure Get Providers Microsoft Cache Operations
/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/operationsStatus/{operationId}:
get:
tags:
- OperationStatus
operationId: microsoftAzureGetOperationstatus
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
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Cache Locations Location Operationsstatus Operationid
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}:
put:
tags:
- RedisEnterprise
operationId: microsoftAzureRedisenterpriseCreate
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:
'200':
description: >-
The cluster was/is being updated. Check provisioningState and
resourceState to see detailed status.
schema:
$ref: '#/definitions/Cluster'
'201':
description: >-
The cluster was/is being created. 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
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername
patch:
tags:
- RedisEnterprise
operationId: microsoftAzureRedisenterpriseUpdate
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
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername
delete:
tags:
- RedisEnterprise
operationId: microsoftAzureRedisenterpriseDelete
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
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername
get:
tags:
- RedisEnterprise
operationId: microsoftAzureRedisenterpriseGet
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
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise:
get:
tags:
- RedisEnterprise
operationId: microsoftAzureRedisenterpriseListbyresourcegroup
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
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise
/subscriptions/{subscriptionId}/providers/Microsoft.Cache/redisEnterprise:
get:
tags:
- RedisEnterprise
operationId: microsoftAzureRedisenterpriseList
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
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Cache Redisenterprise
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases
: get:
tags:
- Databases
- RedisEnterprise
operationId: microsoftAzureDatabasesListbycluster
description: Gets all databases in the specified RedisEnterprise cluster.
x-ms-examples:
RedisEnterpriseDatabasesListByCluster:
$ref: ./examples/RedisEnterpriseDatabasesListByCluster.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
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}
: put:
tags:
- Databases
- RedisEnterprise
operationId: microsoftAzureDatabasesCreate
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
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
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename
patch:
tags:
- Databases
- RedisEnterprise
operationId: microsoftAzureDatabasesUpdate
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
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename
get:
tags:
- Databases
- RedisEnterprise
operationId: microsoftAzureDatabasesGet
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
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename
delete:
tags:
- Databases
- RedisEnterprise
operationId: microsoftAzureDatabasesDelete
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
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/listKeys
: post:
tags:
- Databases
- RedisEnterprise
operationId: microsoftAzureDatabasesListkeys
x-ms-examples:
RedisEnterpriseDatabasesListKeys:
$ref: ./examples/RedisEnterpriseDatabasesListKeys.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
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Listkeys
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/regenerateKey
: post:
tags:
- Databases
- RedisEnterprise
operationId: microsoftAzureDatabasesRegeneratekey
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: '#/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
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Regeneratekey
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/import
: post:
tags:
- Databases
- RedisEnterprise
operationId: microsoftAzureDatabasesImport
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 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
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Import
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}/export
: post:
tags:
- Databases
- RedisEnterprise
operationId: microsoftAzureDatabasesExport
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: '#/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
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Databases Databasename Export
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections
: get:
tags:
- PrivateEndpointConnections
operationId: microsoftAzurePrivateendpointconnectionsList
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:
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Privateendpointconnections
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}
: get:
tags:
- PrivateEndpointConnections
operationId: microsoftAzurePrivateendpointconnectionsGet
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
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Privateendpointconnections Privateendpointconnectionname
put:
tags:
- PrivateEndpointConnections
operationId: microsoftAzurePrivateendpointconnectionsPut
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
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Privateendpointconnections Privateendpointconnectionname
delete:
tags:
- PrivateEndpointConnections
operationId: microsoftAzurePrivateendpointconnectionsDelete
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
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cache Redisenterprise Clustername Privateendpointconnections Privateendpointconnectionname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/privateLinkResources
: get:
tags:
- PrivateLinkResources
operationId: microsoftAzurePrivatelinkresourcesListbyredisenterprisecache
description:
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/redisenterprise-openapi-original.yml