VirtualEndpoints interface

Package:

@azure/arm-postgresql-flexible

Interface representing a VirtualEndpoints.

Methods

beginCreate(string, string, string, VirtualEndpointResource, VirtualEndpointsCreateOptionalParams)	Creates a new virtual endpoint for PostgreSQL flexible server.
beginCreateAndWait(string, string, string, VirtualEndpointResource, VirtualEndpointsCreateOptionalParams)	Creates a new virtual endpoint for PostgreSQL flexible server.
beginDelete(string, string, string, VirtualEndpointsDeleteOptionalParams)	Deletes a virtual endpoint.
beginDeleteAndWait(string, string, string, VirtualEndpointsDeleteOptionalParams)	Deletes a virtual endpoint.
beginUpdate(string, string, string, VirtualEndpointResourceForPatch, VirtualEndpointsUpdateOptionalParams)	Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.
beginUpdateAndWait(string, string, string, VirtualEndpointResourceForPatch, VirtualEndpointsUpdateOptionalParams)	Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.
get(string, string, string, VirtualEndpointsGetOptionalParams)	Gets information about a virtual endpoint.
listByServer(string, string, VirtualEndpointsListByServerOptionalParams)	List all the servers in a given resource group.

Method Details

beginCreate(string, string, string, VirtualEndpointResource, VirtualEndpointsCreateOptionalParams)

Creates a new virtual endpoint for PostgreSQL flexible server.

function beginCreate(resourceGroupName: string, serverName: string, virtualEndpointName: string, parameters: VirtualEndpointResource, options?: VirtualEndpointsCreateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualEndpointResource>, VirtualEndpointResource>>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

virtualEndpointName

string

The name of the virtual endpoint.

parameters

VirtualEndpointResource

The required parameters for creating or updating virtual endpoints.

options

VirtualEndpointsCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, VirtualEndpointResource, VirtualEndpointsCreateOptionalParams)

Creates a new virtual endpoint for PostgreSQL flexible server.

function beginCreateAndWait(resourceGroupName: string, serverName: string, virtualEndpointName: string, parameters: VirtualEndpointResource, options?: VirtualEndpointsCreateOptionalParams): Promise<VirtualEndpointResource>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

virtualEndpointName

string

The name of the virtual endpoint.

parameters

VirtualEndpointResource

The required parameters for creating or updating virtual endpoints.

options

VirtualEndpointsCreateOptionalParams

The options parameters.

Returns

Promise<VirtualEndpointResource>

beginDelete(string, string, string, VirtualEndpointsDeleteOptionalParams)

Deletes a virtual endpoint.

function beginDelete(resourceGroupName: string, serverName: string, virtualEndpointName: string, options?: VirtualEndpointsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<VirtualEndpointsDeleteHeaders>, VirtualEndpointsDeleteHeaders>>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

virtualEndpointName

string

The name of the virtual endpoint.

options

VirtualEndpointsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, VirtualEndpointsDeleteOptionalParams)

Deletes a virtual endpoint.

function beginDeleteAndWait(resourceGroupName: string, serverName: string, virtualEndpointName: string, options?: VirtualEndpointsDeleteOptionalParams): Promise<VirtualEndpointsDeleteHeaders>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

virtualEndpointName

string

The name of the virtual endpoint.

options

VirtualEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<VirtualEndpointsDeleteHeaders>

beginUpdate(string, string, string, VirtualEndpointResourceForPatch, VirtualEndpointsUpdateOptionalParams)

Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.

function beginUpdate(resourceGroupName: string, serverName: string, virtualEndpointName: string, parameters: VirtualEndpointResourceForPatch, options?: VirtualEndpointsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualEndpointResource>, VirtualEndpointResource>>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

virtualEndpointName

string

The name of the virtual endpoint.

parameters

VirtualEndpointResourceForPatch

The required parameters for updating a server.

options

VirtualEndpointsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, VirtualEndpointResourceForPatch, VirtualEndpointsUpdateOptionalParams)

Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.

function beginUpdateAndWait(resourceGroupName: string, serverName: string, virtualEndpointName: string, parameters: VirtualEndpointResourceForPatch, options?: VirtualEndpointsUpdateOptionalParams): Promise<VirtualEndpointResource>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

virtualEndpointName

string

The name of the virtual endpoint.

parameters

VirtualEndpointResourceForPatch

The required parameters for updating a server.

options

VirtualEndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<VirtualEndpointResource>

get(string, string, string, VirtualEndpointsGetOptionalParams)

Gets information about a virtual endpoint.

function get(resourceGroupName: string, serverName: string, virtualEndpointName: string, options?: VirtualEndpointsGetOptionalParams): Promise<VirtualEndpointResource>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

virtualEndpointName

string

The name of the virtual endpoint.

options

VirtualEndpointsGetOptionalParams

The options parameters.

Returns

Promise<VirtualEndpointResource>

listByServer(string, string, VirtualEndpointsListByServerOptionalParams)

List all the servers in a given resource group.

function listByServer(resourceGroupName: string, serverName: string, options?: VirtualEndpointsListByServerOptionalParams): PagedAsyncIterableIterator<VirtualEndpointResource, VirtualEndpointResource[], PageSettings>

Parameters

resourceGroupName

string

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

serverName

string

The name of the server.

options

VirtualEndpointsListByServerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualEndpointResource, VirtualEndpointResource[], PageSettings>