PrivateEndpointConnectionsOperations interface

Interface representing a PrivateEndpointConnections operations.

Properties

approveOrReject

Approves or rejects an existing private endpoint connection. Approval requires the parent Cluster to contain at least one Pool. An approval attempt when the Cluster has no Pools fails with 409 Conflict and the stable error code PrivateEndpointRequiresPool. Rejection remains allowed when the Cluster has no Pools so that existing connections can be cleaned up.

beginApproveOrReject
beginApproveOrRejectAndWait
beginDelete
beginDeleteAndWait
delete

Deletes a private endpoint connection.

get

Gets a private endpoint connection.

list

Lists private endpoint connections in a HorizonDB cluster.

Property Details

approveOrReject

Approves or rejects an existing private endpoint connection. Approval requires the parent Cluster to contain at least one Pool. An approval attempt when the Cluster has no Pools fails with 409 Conflict and the stable error code PrivateEndpointRequiresPool. Rejection remains allowed when the Cluster has no Pools so that existing connections can be cleaned up.

approveOrReject: (resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, resource: PrivateEndpointConnectionResourceCreateOrUpdate, options?: PrivateEndpointConnectionsApproveOrRejectOptionalParams) => PollerLike<OperationState<PrivateEndpointConnectionResource>, PrivateEndpointConnectionResource>

Property Value

(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, resource: PrivateEndpointConnectionResourceCreateOrUpdate, options?: PrivateEndpointConnectionsApproveOrRejectOptionalParams) => PollerLike<OperationState<PrivateEndpointConnectionResource>, PrivateEndpointConnectionResource>

beginApproveOrReject

Warning

This API is now deprecated.

use approveOrReject instead

beginApproveOrReject: (resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, resource: PrivateEndpointConnectionResourceCreateOrUpdate, options?: PrivateEndpointConnectionsApproveOrRejectOptionalParams) => Promise<SimplePollerLike<OperationState<PrivateEndpointConnectionResource>, PrivateEndpointConnectionResource>>

Property Value

(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, resource: PrivateEndpointConnectionResourceCreateOrUpdate, options?: PrivateEndpointConnectionsApproveOrRejectOptionalParams) => Promise<SimplePollerLike<OperationState<PrivateEndpointConnectionResource>, PrivateEndpointConnectionResource>>

beginApproveOrRejectAndWait

Warning

This API is now deprecated.

use approveOrReject instead

beginApproveOrRejectAndWait: (resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, resource: PrivateEndpointConnectionResourceCreateOrUpdate, options?: PrivateEndpointConnectionsApproveOrRejectOptionalParams) => Promise<PrivateEndpointConnectionResource>

Property Value

(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, resource: PrivateEndpointConnectionResourceCreateOrUpdate, options?: PrivateEndpointConnectionsApproveOrRejectOptionalParams) => Promise<PrivateEndpointConnectionResource>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

delete

Deletes a private endpoint connection.

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

Property Value

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

get

Gets a private endpoint connection.

get: (resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams) => Promise<PrivateEndpointConnectionResource>

Property Value

(resourceGroupName: string, clusterName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams) => Promise<PrivateEndpointConnectionResource>

list

Lists private endpoint connections in a HorizonDB cluster.

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

Property Value

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