Package version:

Interface PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

Hierarchy

PrivateEndpointConnections

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait get listByServer

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
Approve or reject a private endpoint connection with a given name.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- privateEndpointConnectionName: string
- parameters: PrivateEndpointConnection
  
  A private endpoint connection
- Optional options: PrivateEndpointConnectionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
- Defined in operationsInterfaces/privateEndpointConnections.ts:59

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, parameters: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PrivateEndpointConnection>
Approve or reject a private endpoint connection with a given name.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- privateEndpointConnectionName: string
- parameters: PrivateEndpointConnection
  
  A private endpoint connection
- Optional options: PrivateEndpointConnectionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PrivateEndpointConnection>
- Defined in operationsInterfaces/privateEndpointConnections.ts:80

beginDelete

beginDelete(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a private endpoint connection with a given name.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- privateEndpointConnectionName: string
- Optional options: PrivateEndpointConnectionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/privateEndpointConnections.ts:95

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>
Deletes a private endpoint connection with a given name.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- privateEndpointConnectionName: string
- Optional options: PrivateEndpointConnectionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/privateEndpointConnections.ts:109

get

get(resourceGroupName: string, serverName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnection>
Gets a private endpoint connection.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- privateEndpointConnectionName: string
  
  The name of the private endpoint connection.
- Optional options: PrivateEndpointConnectionsGetOptionalParams
  
  The options parameters.
Returns Promise<PrivateEndpointConnection>
- Defined in operationsInterfaces/privateEndpointConnections.ts:44

listByServer

listByServer(resourceGroupName: string, serverName: string, options?: PrivateEndpointConnectionsListByServerOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>
Gets all private endpoint connections on a server.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName: string
  
  The name of the server.
- Optional options: PrivateEndpointConnectionsListByServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PrivateEndpointConnection>
- Defined in operationsInterfaces/privateEndpointConnections.ts:31

Interface PrivateEndpointConnections

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

privateEndpointConnectionName: string

parameters: PrivateEndpointConnection

Optional options: PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

privateEndpointConnectionName: string

parameters: PrivateEndpointConnection

Optional options: PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Returns Promise<PrivateEndpointConnection>

beginDelete

Parameters

resourceGroupName: string

serverName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionsDeleteOptionalParams

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serverName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionsGetOptionalParams

Returns Promise<PrivateEndpointConnection>

listByServer

Parameters

resourceGroupName: string

serverName: string

Optional options: PrivateEndpointConnectionsListByServerOptionalParams

Returns PagedAsyncIterableIterator<PrivateEndpointConnection>

Settings

Member Visibility

Theme

`Optional` options: PrivateEndpointConnectionsCreateOrUpdateOptionalParams

`Optional` options: PrivateEndpointConnectionsCreateOrUpdateOptionalParams

`Optional` options: PrivateEndpointConnectionsDeleteOptionalParams

`Optional` options: PrivateEndpointConnectionsDeleteOptionalParams

`Optional` options: PrivateEndpointConnectionsGetOptionalParams

`Optional` options: PrivateEndpointConnectionsListByServerOptionalParams