Share via

PrivateEndpoints interface

  • Reference
Package:
@azure/arm-network

Interface representing a PrivateEndpoints.

Methods

beginCreateOrUpdate(string, string, PrivateEndpoint, PrivateEndpointsCreateOrUpdateOptionalParams)

Creates or updates an private endpoint in the specified resource group.
beginCreateOrUpdateAndWait(string, string, PrivateEndpoint, PrivateEndpointsCreateOrUpdateOptionalParams)

Creates or updates an private endpoint in the specified resource group.
beginDelete(string, string, PrivateEndpointsDeleteOptionalParams)

Deletes the specified private endpoint.
beginDeleteAndWait(string, string, PrivateEndpointsDeleteOptionalParams)

Deletes the specified private endpoint.
get(string, string, PrivateEndpointsGetOptionalParams)

Gets the specified private endpoint by resource group.
list(string, PrivateEndpointsListOptionalParams)

Gets all private endpoints in a resource group.
listBySubscription(PrivateEndpointsListBySubscriptionOptionalParams)

Gets all private endpoints in a subscription.

Method Details

beginCreateOrUpdate(string, string, PrivateEndpoint, PrivateEndpointsCreateOrUpdateOptionalParams)

Creates or updates an private endpoint in the specified resource group.

function beginCreateOrUpdate(resourceGroupName: string, privateEndpointName: string, parameters: PrivateEndpoint, options?: PrivateEndpointsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpoint>, PrivateEndpoint>>

Parameters

resourceGroupName

string

The name of the resource group.

privateEndpointName

string

The name of the private endpoint.

parameters
PrivateEndpoint

Parameters supplied to the create or update private endpoint operation.

options
PrivateEndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<PrivateEndpoint>, PrivateEndpoint>>

beginCreateOrUpdateAndWait(string, string, PrivateEndpoint, PrivateEndpointsCreateOrUpdateOptionalParams)

Creates or updates an private endpoint in the specified resource group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, privateEndpointName: string, parameters: PrivateEndpoint, options?: PrivateEndpointsCreateOrUpdateOptionalParams): Promise<PrivateEndpoint>

Parameters

resourceGroupName

string

The name of the resource group.

privateEndpointName

string

The name of the private endpoint.

parameters
PrivateEndpoint

Parameters supplied to the create or update private endpoint operation.

options
PrivateEndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpoint>

beginDelete(string, string, PrivateEndpointsDeleteOptionalParams)

Deletes the specified private endpoint.

function beginDelete(resourceGroupName: string, privateEndpointName: string, options?: PrivateEndpointsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

privateEndpointName

string

The name of the private endpoint.

options
PrivateEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, PrivateEndpointsDeleteOptionalParams)

Deletes the specified private endpoint.

function beginDeleteAndWait(resourceGroupName: string, privateEndpointName: string, options?: PrivateEndpointsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

privateEndpointName

string

The name of the private endpoint.

options
PrivateEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, PrivateEndpointsGetOptionalParams)

Gets the specified private endpoint by resource group.

function get(resourceGroupName: string, privateEndpointName: string, options?: PrivateEndpointsGetOptionalParams): Promise<PrivateEndpoint>

Parameters

resourceGroupName

string

The name of the resource group.

privateEndpointName

string

The name of the private endpoint.

options
PrivateEndpointsGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpoint>

list(string, PrivateEndpointsListOptionalParams)

Gets all private endpoints in a resource group.

function list(resourceGroupName: string, options?: PrivateEndpointsListOptionalParams): PagedAsyncIterableIterator<PrivateEndpoint, PrivateEndpoint[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options
PrivateEndpointsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpoint, PrivateEndpoint[], PageSettings>

listBySubscription(PrivateEndpointsListBySubscriptionOptionalParams)

Gets all private endpoints in a subscription.

function listBySubscription(options?: PrivateEndpointsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<PrivateEndpoint, PrivateEndpoint[], PageSettings>

Parameters

options
PrivateEndpointsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpoint, PrivateEndpoint[], PageSettings>