PrivateEndpointConnections interface
Interface representing a PrivateEndpointConnections.
Methods
| begin |
Deletes the specified private endpoint connection associated with the Redis Enterprise cluster. |
| begin |
Deletes the specified private endpoint connection associated with the Redis Enterprise cluster. |
| begin |
Updates the state of the specified private endpoint connection associated with the Redis Enterprise cluster. |
| begin |
Updates the state of the specified private endpoint connection associated with the Redis Enterprise cluster. |
| get(string, string, string, Private |
Gets the specified private endpoint connection associated with the Redis Enterprise cluster. |
| list(string, string, Private |
Lists all the private endpoint connections associated with the Redis Enterprise cluster. |
Method Details
beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)
Deletes the specified private endpoint connection associated with the Redis Enterprise cluster.
function beginDelete(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)
Deletes the specified private endpoint connection associated with the Redis Enterprise cluster.
function beginDeleteAndWait(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource
The options parameters.
Returns
Promise<void>
beginPut(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsPutOptionalParams)
Updates the state of the specified private endpoint connection associated with the Redis Enterprise cluster.
function beginPut(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsPutOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource
- properties
- PrivateEndpointConnection
The private endpoint connection properties.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginPutAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsPutOptionalParams)
Updates the state of the specified private endpoint connection associated with the Redis Enterprise cluster.
function beginPutAndWait(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsPutOptionalParams): Promise<PrivateEndpointConnection>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource
- properties
- PrivateEndpointConnection
The private endpoint connection properties.
The options parameters.
Returns
Promise<PrivateEndpointConnection>
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)
Gets the specified private endpoint connection associated with the Redis Enterprise cluster.
function get(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnection>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource
The options parameters.
Returns
Promise<PrivateEndpointConnection>
list(string, string, PrivateEndpointConnectionsListOptionalParams)
Lists all the private endpoint connections associated with the Redis Enterprise cluster.
function list(resourceGroupName: string, clusterName: string, options?: PrivateEndpointConnectionsListOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens
The options parameters.