PrivateEndpointConnections interface

Package:

@azure/arm-redisenterprisecache

Interface representing a PrivateEndpointConnections.

Methods

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Deletes the specified private endpoint connection associated with the RedisEnterprise cluster.
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Deletes the specified private endpoint connection associated with the RedisEnterprise cluster.
beginPut(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsPutOptionalParams)	Updates the state of the specified private endpoint connection associated with the RedisEnterprise cluster.
beginPutAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsPutOptionalParams)	Updates the state of the specified private endpoint connection associated with the RedisEnterprise cluster.
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)	Gets the specified private endpoint connection associated with the RedisEnterprise cluster.
list(string, string, PrivateEndpointConnectionsListOptionalParams)	Lists all the private endpoint connections associated with the RedisEnterprise cluster.

Method Details

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes the specified private endpoint connection associated with the RedisEnterprise 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 RedisEnterprise cluster.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the Azure resource

options

PrivateEndpointConnectionsDeleteOptionalParams

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 RedisEnterprise 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 RedisEnterprise cluster.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the Azure resource

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginPut(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsPutOptionalParams)

Updates the state of the specified private endpoint connection associated with the RedisEnterprise 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 RedisEnterprise cluster.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the Azure resource

properties

PrivateEndpointConnection

The private endpoint connection properties.

options

PrivateEndpointConnectionsPutOptionalParams

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 RedisEnterprise 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 RedisEnterprise cluster.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the Azure resource

properties

PrivateEndpointConnection

The private endpoint connection properties.

options

PrivateEndpointConnectionsPutOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Gets the specified private endpoint connection associated with the RedisEnterprise 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 RedisEnterprise cluster.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the Azure resource

options

PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

list(string, string, PrivateEndpointConnectionsListOptionalParams)

Lists all the private endpoint connections associated with the RedisEnterprise 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 RedisEnterprise cluster.

options

PrivateEndpointConnectionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>