PrivateEndpointConnections interface
Interface representing a PrivateEndpointConnections.
Methods
Method Details
beginCreateOrUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)
Approve or reject a private endpoint connection with a given name.
function beginCreateOrUpdate(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- privateEndpointConnectionName
-
string
- parameters
- PrivateEndpointConnection
A private endpoint connection
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginCreateOrUpdateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)
Approve or reject a private endpoint connection with a given name.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PrivateEndpointConnection>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- privateEndpointConnectionName
-
string
- parameters
- PrivateEndpointConnection
A private endpoint connection
The options parameters.
Returns
Promise<PrivateEndpointConnection>
beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)
Deletes a private endpoint connection with a given name.
function beginDelete(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- privateEndpointConnectionName
-
string
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)
Deletes a private endpoint connection with a given name.
function beginDeleteAndWait(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- privateEndpointConnectionName
-
string
The options parameters.
Returns
Promise<void>
beginUpdateTags(string, string, string, TagsObject, PrivateEndpointConnectionsUpdateTagsOptionalParams)
Updates private endpoint connection with the specified tags.
function beginUpdateTags(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, parameters: TagsObject, options?: PrivateEndpointConnectionsUpdateTagsOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- privateEndpointConnectionName
-
string
- parameters
- TagsObject
Parameters supplied to the Update private endpoint connection Tags operation.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginUpdateTagsAndWait(string, string, string, TagsObject, PrivateEndpointConnectionsUpdateTagsOptionalParams)
Updates private endpoint connection with the specified tags.
function beginUpdateTagsAndWait(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, parameters: TagsObject, options?: PrivateEndpointConnectionsUpdateTagsOptionalParams): Promise<PrivateEndpointConnection>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- privateEndpointConnectionName
-
string
- parameters
- TagsObject
Parameters supplied to the Update private endpoint connection Tags operation.
The options parameters.
Returns
Promise<PrivateEndpointConnection>
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)
Gets a private endpoint connection.
function get(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnection>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- privateEndpointConnectionName
-
string
The name of the private endpoint connection.
The options parameters.
Returns
Promise<PrivateEndpointConnection>
listByServer(string, string, PrivateEndpointConnectionsListByServerOptionalParams)
Gets all private endpoint connections on a server.
function listByServer(resourceGroupName: string, serverName: string, options?: PrivateEndpointConnectionsListByServerOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], 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.