PrivateEndpointConnectionsOperations interface

Interface representing a PrivateEndpointConnections operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
createOrUpdate

Update the state of specified private endpoint connection associated with the private link. This operation is typically used to approve or reject pending private endpoint connections.

delete

Deletes the specified private endpoint connection associated with the private link. This operation will disconnect the private endpoint and remove the connection configuration.

get

Gets the specified private endpoint connection associated with the private link. Returns the connection details, status, and configuration for a specific private endpoint.

list

Gets all private endpoint connections for a private link. Returns the list of private endpoints that are connected or in the process of connecting to this private link.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Property Value

(resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams) => Promise<PrivateEndpointConnection>

Property Value

(resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams) => Promise<PrivateEndpointConnection>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams) => Promise<void>

createOrUpdate

Update the state of specified private endpoint connection associated with the private link. This operation is typically used to approve or reject pending private endpoint connections.

createOrUpdate: (resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>

Property Value

(resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams) => PollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>

delete

Deletes the specified private endpoint connection associated with the private link. This operation will disconnect the private endpoint and remove the connection configuration.

delete: (resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the specified private endpoint connection associated with the private link. Returns the connection details, status, and configuration for a specific private endpoint.

get: (resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams) => Promise<PrivateEndpointConnection>

Property Value

(resourceGroupName: string, privateLinkName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams) => Promise<PrivateEndpointConnection>

list

Gets all private endpoint connections for a private link. Returns the list of private endpoints that are connected or in the process of connecting to this private link.

list: (resourceGroupName: string, privateLinkName: string, options?: PrivateEndpointConnectionsListOptionalParams) => PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Property Value

(resourceGroupName: string, privateLinkName: string, options?: PrivateEndpointConnectionsListOptionalParams) => PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>