PrivateEndpointConnections interface

Package:

@azure/arm-rediscache

Interface representing a PrivateEndpointConnections.

Methods

beginPut(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsPutOptionalParams)	Update the state of specified private endpoint connection associated with the redis cache.
beginPutAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsPutOptionalParams)	Update the state of specified private endpoint connection associated with the redis cache.
delete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Deletes the specified private endpoint connection associated with the redis cache.
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)	Gets the specified private endpoint connection associated with the redis cache.
list(string, string, PrivateEndpointConnectionsListOptionalParams)	List all the private endpoint connections associated with the redis cache.

Method Details

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

Update the state of specified private endpoint connection associated with the redis cache.

function beginPut(resourceGroupName: string, cacheName: 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.

cacheName

string

The name of the Redis cache.

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)

Update the state of specified private endpoint connection associated with the redis cache.

function beginPutAndWait(resourceGroupName: string, cacheName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsPutOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

string

The name of the Redis cache.

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>

delete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes the specified private endpoint connection associated with the redis cache.

function delete(resourceGroupName: string, cacheName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

string

The name of the Redis cache.

privateEndpointConnectionName

string

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

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Gets the specified private endpoint connection associated with the redis cache.

function get(resourceGroupName: string, cacheName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

string

The name of the Redis cache.

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)

List all the private endpoint connections associated with the redis cache.

function list(resourceGroupName: string, cacheName: string, options?: PrivateEndpointConnectionsListOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

string

The name of the Redis cache.

options

PrivateEndpointConnectionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>