PrivateEndpointConnectionOperations interface

Package:

@azure/arm-batch

Interface representing a PrivateEndpointConnectionOperations.

Methods

beginDelete(string, string, string, PrivateEndpointConnectionDeleteOptionalParams)	Deletes the specified private endpoint connection.
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionDeleteOptionalParams)	Deletes the specified private endpoint connection.
beginUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionUpdateOptionalParams)	Updates the properties of an existing private endpoint connection.
beginUpdateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionUpdateOptionalParams)	Updates the properties of an existing private endpoint connection.
get(string, string, string, PrivateEndpointConnectionGetOptionalParams)	Gets information about the specified private endpoint connection.
listByBatchAccount(string, string, PrivateEndpointConnectionListByBatchAccountOptionalParams)	Lists all of the private endpoint connections in the specified account.

Method Details

beginDelete(string, string, string, PrivateEndpointConnectionDeleteOptionalParams)

Deletes the specified private endpoint connection.

function beginDelete(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionDeleteOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnectionDeleteHeaders>, PrivateEndpointConnectionDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

privateEndpointConnectionName

string

The private endpoint connection name. This must be unique within the account.

options

PrivateEndpointConnectionDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionDeleteOptionalParams)

Deletes the specified private endpoint connection.

function beginDeleteAndWait(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionDeleteOptionalParams): Promise<PrivateEndpointConnectionDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

privateEndpointConnectionName

string

The private endpoint connection name. This must be unique within the account.

options

PrivateEndpointConnectionDeleteOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnectionDeleteHeaders>

beginUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionUpdateOptionalParams)

Updates the properties of an existing private endpoint connection.

function beginUpdate(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateEndpointConnectionUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

privateEndpointConnectionName

string

The private endpoint connection name. This must be unique within the account.

parameters

PrivateEndpointConnection

PrivateEndpointConnection properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged.

options

PrivateEndpointConnectionUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionUpdateOptionalParams)

Updates the properties of an existing private endpoint connection.

function beginUpdateAndWait(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateEndpointConnectionUpdateOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

privateEndpointConnectionName

string

The private endpoint connection name. This must be unique within the account.

parameters

PrivateEndpointConnection

PrivateEndpointConnection properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged.

options

PrivateEndpointConnectionUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

get(string, string, string, PrivateEndpointConnectionGetOptionalParams)

Gets information about the specified private endpoint connection.

function get(resourceGroupName: string, accountName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionGetOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

privateEndpointConnectionName

string

The private endpoint connection name. This must be unique within the account.

options

PrivateEndpointConnectionGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

listByBatchAccount(string, string, PrivateEndpointConnectionListByBatchAccountOptionalParams)

Lists all of the private endpoint connections in the specified account.

function listByBatchAccount(resourceGroupName: string, accountName: string, options?: PrivateEndpointConnectionListByBatchAccountOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the Batch account.

accountName

string

The name of the Batch account.

options

PrivateEndpointConnectionListByBatchAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>