PrivateEndpointConnections interface

Package:

@azure/arm-agrifood

Interface representing a PrivateEndpointConnections.

Methods

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Delete Private endpoint connection request.
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Delete Private endpoint connection request.
createOrUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)	Approves or Rejects a Private endpoint connection request.
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)	Get Private endpoint connection object.
listByResource(string, string, PrivateEndpointConnectionsListByResourceOptionalParams)	Get list of Private endpoint connections.

Method Details

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Delete Private endpoint connection request.

function beginDelete(resourceGroupName: string, farmBeatsResourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

farmBeatsResourceName

string

FarmBeats resource name.

privateEndpointConnectionName

string

Private endpoint connection name.

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Delete Private endpoint connection request.

function beginDeleteAndWait(resourceGroupName: string, farmBeatsResourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

farmBeatsResourceName

string

FarmBeats resource name.

privateEndpointConnectionName

string

Private endpoint connection name.

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)

Approves or Rejects a Private endpoint connection request.

function createOrUpdate(resourceGroupName: string, farmBeatsResourceName: string, privateEndpointConnectionName: string, body: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

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

farmBeatsResourceName

string

FarmBeats resource name.

privateEndpointConnectionName

string

Private endpoint connection name.

body

PrivateEndpointConnection

Request object.

options

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Get Private endpoint connection object.

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

Parameters

resourceGroupName

string

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

farmBeatsResourceName

string

FarmBeats resource name.

privateEndpointConnectionName

string

Private endpoint connection name.

options

PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

listByResource(string, string, PrivateEndpointConnectionsListByResourceOptionalParams)

Get list of Private endpoint connections.

function listByResource(resourceGroupName: string, farmBeatsResourceName: string, options?: PrivateEndpointConnectionsListByResourceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Parameters

resourceGroupName

string

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

farmBeatsResourceName

string

FarmBeats resource name.

options

PrivateEndpointConnectionsListByResourceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>