Package version:

Interface PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

interface PrivateEndpointConnections {
    beginDelete(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>;
    beginDeleteAndWait(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PrivateEndpointConnection>;
    get(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnection>;
    listByResource(resourceGroupName: string, vaultName: string, options?: PrivateEndpointConnectionsListByResourceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>;
    put(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsPutOptionalParams): Promise<PrivateEndpointConnectionsPutResponse>;
}

Methods

beginDelete(resourceGroupName, vaultName, privateEndpointConnectionName, options?): Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
Deletes the specified private endpoint connection associated with the key vault.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- vaultName: string
  The name of the vault.
- privateEndpointConnectionName: string
  Name of the private endpoint connection associated with the key vault.
- Optionaloptions: PrivateEndpointConnectionsDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
- Defined in operationsInterfaces/privateEndpointConnections.ts:73

beginDeleteAndWait(resourceGroupName, vaultName, privateEndpointConnectionName, options?): Promise<PrivateEndpointConnection>
Deletes the specified private endpoint connection associated with the key vault.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- vaultName: string
  The name of the vault.
- privateEndpointConnectionName: string
  Name of the private endpoint connection associated with the key vault.
- Optionaloptions: PrivateEndpointConnectionsDeleteOptionalParams
  The options parameters.
Returns Promise<PrivateEndpointConnection>
- Defined in operationsInterfaces/privateEndpointConnections.ts:92

get(resourceGroupName, vaultName, privateEndpointConnectionName, options?): Promise<PrivateEndpointConnection>
Gets the specified private endpoint connection associated with the key vault.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- vaultName: string
  The name of the vault.
- privateEndpointConnectionName: string
  Name of the private endpoint connection associated with the key vault.
- Optionaloptions: PrivateEndpointConnectionsGetOptionalParams
  The options parameters.
Returns Promise<PrivateEndpointConnection>
- Defined in operationsInterfaces/privateEndpointConnections.ts:43

listByResource(resourceGroupName, vaultName, options?): PagedAsyncIterableIterator<PrivateEndpointConnection>
The List operation gets information about the private endpoint connections associated with the vault.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- vaultName: string
  The name of the vault.
- Optionaloptions: PrivateEndpointConnectionsListByResourceOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<PrivateEndpointConnection>
- Defined in operationsInterfaces/privateEndpointConnections.ts:30

put(resourceGroupName, vaultName, privateEndpointConnectionName, properties, options?): Promise<PrivateEndpointConnectionsPutResponse>
Updates the specified private endpoint connection associated with the key vault.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- vaultName: string
  The name of the vault.
- privateEndpointConnectionName: string
  Name of the private endpoint connection associated with the key vault.
- properties: PrivateEndpointConnection
  The intended state of private endpoint connection.
- Optionaloptions: PrivateEndpointConnectionsPutOptionalParams
  The options parameters.
Returns Promise<PrivateEndpointConnectionsPutResponse>
- Defined in operationsInterfaces/privateEndpointConnections.ts:58