Share via

PrivateEndpointConnectionOperations interface

  • Reference
Package:
@azure/arm-apimanagement

Warning

This API is now deprecated.

Interface representing a PrivateEndpointConnectionOperations.

Methods

beginCreateOrUpdate(string, string, string, PrivateEndpointConnectionRequest, PrivateEndpointConnectionCreateOrUpdateOptionalParams)

Creates a new Private Endpoint Connection or updates an existing one.
beginCreateOrUpdateAndWait(string, string, string, PrivateEndpointConnectionRequest, PrivateEndpointConnectionCreateOrUpdateOptionalParams)

Creates a new Private Endpoint Connection or updates an existing one.
beginDelete(string, string, string, PrivateEndpointConnectionDeleteOptionalParams)

Deletes the specified Private Endpoint Connection.
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionDeleteOptionalParams)

Deletes the specified Private Endpoint Connection.
getByName(string, string, string, PrivateEndpointConnectionGetByNameOptionalParams)

Gets the details of the Private Endpoint Connection specified by its identifier.
getPrivateLinkResource(string, string, string, PrivateEndpointConnectionGetPrivateLinkResourceOptionalParams)

Gets the private link resources
listByService(string, string, PrivateEndpointConnectionListByServiceOptionalParams)

Lists all private endpoint connections of the API Management service instance.
listPrivateLinkResources(string, string, PrivateEndpointConnectionListPrivateLinkResourcesOptionalParams)

Gets the private link resources

Method Details

beginCreateOrUpdate(string, string, string, PrivateEndpointConnectionRequest, PrivateEndpointConnectionCreateOrUpdateOptionalParams)

Warning

This API is now deprecated.

Creates a new Private Endpoint Connection or updates an existing one.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, privateEndpointConnectionName: string, privateEndpointConnectionRequest: PrivateEndpointConnectionRequest, options?: PrivateEndpointConnectionCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

privateEndpointConnectionName

string

Name of the private endpoint connection.

privateEndpointConnectionRequest
PrivateEndpointConnectionRequest

A request to approve or reject a private endpoint connection

options
PrivateEndpointConnectionCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginCreateOrUpdateAndWait(string, string, string, PrivateEndpointConnectionRequest, PrivateEndpointConnectionCreateOrUpdateOptionalParams)

Warning

This API is now deprecated.

Creates a new Private Endpoint Connection or updates an existing one.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, privateEndpointConnectionName: string, privateEndpointConnectionRequest: PrivateEndpointConnectionRequest, options?: PrivateEndpointConnectionCreateOrUpdateOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

privateEndpointConnectionName

string

Name of the private endpoint connection.

privateEndpointConnectionRequest
PrivateEndpointConnectionRequest

A request to approve or reject a private endpoint connection

options
PrivateEndpointConnectionCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

beginDelete(string, string, string, PrivateEndpointConnectionDeleteOptionalParams)

Warning

This API is now deprecated.

Deletes the specified Private Endpoint Connection.

function beginDelete(resourceGroupName: string, serviceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

privateEndpointConnectionName

string

Name of the private endpoint connection.

options
PrivateEndpointConnectionDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionDeleteOptionalParams)

Warning

This API is now deprecated.

Deletes the specified Private Endpoint Connection.

function beginDeleteAndWait(resourceGroupName: string, serviceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

privateEndpointConnectionName

string

Name of the private endpoint connection.

options
PrivateEndpointConnectionDeleteOptionalParams

The options parameters.

Returns

Promise<void>

getByName(string, string, string, PrivateEndpointConnectionGetByNameOptionalParams)

Warning

This API is now deprecated.

Gets the details of the Private Endpoint Connection specified by its identifier.

function getByName(resourceGroupName: string, serviceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionGetByNameOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

privateEndpointConnectionName

string

Name of the private endpoint connection.

options
PrivateEndpointConnectionGetByNameOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

getPrivateLinkResource(string, string, string, PrivateEndpointConnectionGetPrivateLinkResourceOptionalParams)

Warning

This API is now deprecated.

Gets the private link resources

function getPrivateLinkResource(resourceGroupName: string, serviceName: string, privateLinkSubResourceName: string, options?: PrivateEndpointConnectionGetPrivateLinkResourceOptionalParams): Promise<PrivateLinkResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

privateLinkSubResourceName

string

Name of the private link resource.

options
PrivateEndpointConnectionGetPrivateLinkResourceOptionalParams

The options parameters.

Returns

Promise<PrivateLinkResource>

listByService(string, string, PrivateEndpointConnectionListByServiceOptionalParams)

Warning

This API is now deprecated.

Lists all private endpoint connections of the API Management service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: PrivateEndpointConnectionListByServiceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options
PrivateEndpointConnectionListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

listPrivateLinkResources(string, string, PrivateEndpointConnectionListPrivateLinkResourcesOptionalParams)

Warning

This API is now deprecated.

Gets the private link resources

function listPrivateLinkResources(resourceGroupName: string, serviceName: string, options?: PrivateEndpointConnectionListPrivateLinkResourcesOptionalParams): Promise<PrivateLinkResourceListResult>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options
PrivateEndpointConnectionListPrivateLinkResourcesOptionalParams

The options parameters.

Returns

Promise<PrivateLinkResourceListResult>