PrivateEndpointConnectionOperations | @azure/arm-apimanagement

Interface representing a PrivateEndpointConnectionOperations.

Hierarchy

PrivateEndpointConnectionOperations

Implemented by

PrivateEndpointConnectionOperationsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, privateEndpointConnectionName: string, privateEndpointConnectionRequest: PrivateEndpointConnectionRequest, options?: PrivateEndpointConnectionCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionCreateOrUpdateResponse>, PrivateEndpointConnectionCreateOrUpdateResponse>>

- Defined in operationsInterfaces/privateEndpointConnectionOperations.ts:61
Creates a new Private Endpoint Connection or updates an existing one.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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
- Optional options: PrivateEndpointConnectionCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<PrivateEndpointConnectionCreateOrUpdateResponse>, PrivateEndpointConnectionCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/privateEndpointConnectionOperations.ts:81
Creates a new Private Endpoint Connection or updates an existing one.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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
- Optional options: PrivateEndpointConnectionCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PrivateEndpointConnectionCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, serviceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/privateEndpointConnectionOperations.ts:95
Deletes the specified Private Endpoint Connection.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- privateEndpointConnectionName: string
  
  Name of the private endpoint connection.
- Optional options: PrivateEndpointConnectionDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/privateEndpointConnectionOperations.ts:108
Deletes the specified Private Endpoint Connection.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- privateEndpointConnectionName: string
  
  Name of the private endpoint connection.
- Optional options: PrivateEndpointConnectionDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

getByName

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

- Defined in operationsInterfaces/privateEndpointConnectionOperations.ts:47
Gets the details of the Private Endpoint Connection specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- privateEndpointConnectionName: string
  
  Name of the private endpoint connection.
- Optional options: PrivateEndpointConnectionGetByNameOptionalParams
  
  The options parameters.
Returns Promise<PrivateEndpointConnectionGetByNameResponse>

getPrivateLinkResource

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

- Defined in operationsInterfaces/privateEndpointConnectionOperations.ts:132
Description for Gets the private link resources

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- privateLinkSubResourceName: string
  
  Name of the private link resource.
- Optional options: PrivateEndpointConnectionGetPrivateLinkResourceOptionalParams
  
  The options parameters.
Returns Promise<PrivateEndpointConnectionGetPrivateLinkResourceResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: PrivateEndpointConnectionListByServiceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>

- Defined in operationsInterfaces/privateEndpointConnectionOperations.ts:35
Lists all private endpoint connections of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: PrivateEndpointConnectionListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PrivateEndpointConnection>

listPrivateLinkResources

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

- Defined in operationsInterfaces/privateEndpointConnectionOperations.ts:120
Description for Gets the private link resources

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: PrivateEndpointConnectionListPrivateLinkResourcesOptionalParams
  
  The options parameters.
Returns Promise<PrivateEndpointConnectionListPrivateLinkResourcesResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

privateEndpointConnectionName: string

privateEndpointConnectionRequest: PrivateEndpointConnectionRequest

Optional options: PrivateEndpointConnectionCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<PrivateEndpointConnectionCreateOrUpdateResponse>, PrivateEndpointConnectionCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

privateEndpointConnectionName: string

privateEndpointConnectionRequest: PrivateEndpointConnectionRequest

Optional options: PrivateEndpointConnectionCreateOrUpdateOptionalParams

Returns Promise<PrivateEndpointConnectionCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

serviceName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serviceName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionDeleteOptionalParams

Returns Promise<void>

getByName

Parameters

resourceGroupName: string

serviceName: string

privateEndpointConnectionName: string

Optional options: PrivateEndpointConnectionGetByNameOptionalParams

Returns Promise<PrivateEndpointConnectionGetByNameResponse>

getPrivateLinkResource

Parameters

resourceGroupName: string

serviceName: string

privateLinkSubResourceName: string

Optional options: PrivateEndpointConnectionGetPrivateLinkResourceOptionalParams

Returns Promise<PrivateEndpointConnectionGetPrivateLinkResourceResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: PrivateEndpointConnectionListByServiceOptionalParams

Returns PagedAsyncIterableIterator<PrivateEndpointConnection>

listPrivateLinkResources

Parameters

resourceGroupName: string

serviceName: string

Optional options: PrivateEndpointConnectionListPrivateLinkResourcesOptionalParams

Returns Promise<PrivateEndpointConnectionListPrivateLinkResourcesResponse>