VirtualEndpoints interface
Interface representing a VirtualEndpoints.
Methods
Method Details
beginCreate(string, string, string, VirtualEndpoint, VirtualEndpointsCreateOptionalParams)
Creates a pair of virtual endpoints for a server.
function beginCreate(resourceGroupName: string, serverName: string, virtualEndpointName: string, parameters: VirtualEndpoint, options?: VirtualEndpointsCreateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualEndpoint>, VirtualEndpoint>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- virtualEndpointName
-
string
Base name of the virtual endpoints.
- parameters
- VirtualEndpoint
Parameters required to create or update a pair of virtual endpoints.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualEndpoint>, VirtualEndpoint>>
beginCreateAndWait(string, string, string, VirtualEndpoint, VirtualEndpointsCreateOptionalParams)
Creates a pair of virtual endpoints for a server.
function beginCreateAndWait(resourceGroupName: string, serverName: string, virtualEndpointName: string, parameters: VirtualEndpoint, options?: VirtualEndpointsCreateOptionalParams): Promise<VirtualEndpoint>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- virtualEndpointName
-
string
Base name of the virtual endpoints.
- parameters
- VirtualEndpoint
Parameters required to create or update a pair of virtual endpoints.
The options parameters.
Returns
Promise<VirtualEndpoint>
beginDelete(string, string, string, VirtualEndpointsDeleteOptionalParams)
Deletes a pair of virtual endpoints.
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
Base name of the virtual endpoints.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualEndpointsDeleteHeaders>, VirtualEndpointsDeleteHeaders>>
beginDeleteAndWait(string, string, string, VirtualEndpointsDeleteOptionalParams)
Deletes a pair of virtual endpoints.
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
Base name of the virtual endpoints.
The options parameters.
Returns
Promise<VirtualEndpointsDeleteHeaders>
beginUpdate(string, string, string, VirtualEndpointResourceForPatch, VirtualEndpointsUpdateOptionalParams)
Updates a pair of virtual endpoints for a server.
function beginUpdate(resourceGroupName: string, serverName: string, virtualEndpointName: string, parameters: VirtualEndpointResourceForPatch, options?: VirtualEndpointsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualEndpoint>, VirtualEndpoint>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- virtualEndpointName
-
string
Base name of the virtual endpoints.
- parameters
- VirtualEndpointResourceForPatch
Parameters required to update a pair of virtual endpoints.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<VirtualEndpoint>, VirtualEndpoint>>
beginUpdateAndWait(string, string, string, VirtualEndpointResourceForPatch, VirtualEndpointsUpdateOptionalParams)
Updates a pair of virtual endpoints for a server.
function beginUpdateAndWait(resourceGroupName: string, serverName: string, virtualEndpointName: string, parameters: VirtualEndpointResourceForPatch, options?: VirtualEndpointsUpdateOptionalParams): Promise<VirtualEndpoint>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- virtualEndpointName
-
string
Base name of the virtual endpoints.
- parameters
- VirtualEndpointResourceForPatch
Parameters required to update a pair of virtual endpoints.
The options parameters.
Returns
Promise<VirtualEndpoint>
get(string, string, string, VirtualEndpointsGetOptionalParams)
Gets information about a pair of virtual endpoints.
function get(resourceGroupName: string, serverName: string, virtualEndpointName: string, options?: VirtualEndpointsGetOptionalParams): Promise<VirtualEndpoint>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- virtualEndpointName
-
string
Base name of the virtual endpoints.
The options parameters.
Returns
Promise<VirtualEndpoint>
listByServer(string, string, VirtualEndpointsListByServerOptionalParams)
Lists pair of virtual endpoints associated to a server.
function listByServer(resourceGroupName: string, serverName: string, options?: VirtualEndpointsListByServerOptionalParams): PagedAsyncIterableIterator<VirtualEndpoint, VirtualEndpoint[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
The options parameters.