Package com.azure.resourcemanager.apimanagement.fluent

Interface PrivateEndpointConnectionsClient

public interface PrivateEndpointConnectionsClient
An instance of this class provides access to all the operations defined in PrivateEndpointConnectionsClient.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<PrivateEndpointConnectionInner> listByService(String resourceGroupName, String serviceName)
      Lists all private endpoint connections of the API Management service instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      Returns:
      list of private endpoint connection associated with the specified storage account as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByService

      com.azure.core.http.rest.PagedIterable<PrivateEndpointConnectionInner> listByService(String resourceGroupName, String serviceName, com.azure.core.util.Context context)
      Lists all private endpoint connections of the API Management service instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      context - The context to associate with this operation.
      Returns:
      list of private endpoint connection associated with the specified storage account as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByNameWithResponse

      com.azure.core.http.rest.Response<PrivateEndpointConnectionInner> getByNameWithResponse(String resourceGroupName, String serviceName, String privateEndpointConnectionName, com.azure.core.util.Context context)
      Gets the details of the Private Endpoint Connection specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      privateEndpointConnectionName - Name of the private endpoint connection.
      context - The context to associate with this operation.
      Returns:
      the details of the Private Endpoint Connection specified by its identifier along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByName

      PrivateEndpointConnectionInner getByName(String resourceGroupName, String serviceName, String privateEndpointConnectionName)
      Gets the details of the Private Endpoint Connection specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      privateEndpointConnectionName - Name of the private endpoint connection.
      Returns:
      the details of the Private Endpoint Connection specified by its identifier.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PrivateEndpointConnectionInner>,PrivateEndpointConnectionInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String privateEndpointConnectionName, PrivateEndpointConnectionRequest privateEndpointConnectionRequest)
      Creates a new Private Endpoint Connection or updates an existing one.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      privateEndpointConnectionName - Name of the private endpoint connection.
      privateEndpointConnectionRequest - The privateEndpointConnectionRequest parameter.
      Returns:
      the SyncPoller for polling of the Private Endpoint Connection resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PrivateEndpointConnectionInner>,PrivateEndpointConnectionInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String privateEndpointConnectionName, PrivateEndpointConnectionRequest privateEndpointConnectionRequest, com.azure.core.util.Context context)
      Creates a new Private Endpoint Connection or updates an existing one.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      privateEndpointConnectionName - Name of the private endpoint connection.
      privateEndpointConnectionRequest - The privateEndpointConnectionRequest parameter.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of the Private Endpoint Connection resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdate

      PrivateEndpointConnectionInner createOrUpdate(String resourceGroupName, String serviceName, String privateEndpointConnectionName, PrivateEndpointConnectionRequest privateEndpointConnectionRequest)
      Creates a new Private Endpoint Connection or updates an existing one.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      privateEndpointConnectionName - Name of the private endpoint connection.
      privateEndpointConnectionRequest - The privateEndpointConnectionRequest parameter.
      Returns:
      the Private Endpoint Connection resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdate

      PrivateEndpointConnectionInner createOrUpdate(String resourceGroupName, String serviceName, String privateEndpointConnectionName, PrivateEndpointConnectionRequest privateEndpointConnectionRequest, com.azure.core.util.Context context)
      Creates a new Private Endpoint Connection or updates an existing one.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      privateEndpointConnectionName - Name of the private endpoint connection.
      privateEndpointConnectionRequest - The privateEndpointConnectionRequest parameter.
      context - The context to associate with this operation.
      Returns:
      the Private Endpoint Connection resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String serviceName, String privateEndpointConnectionName)
      Deletes the specified Private Endpoint Connection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      privateEndpointConnectionName - Name of the private endpoint connection.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String serviceName, String privateEndpointConnectionName, com.azure.core.util.Context context)
      Deletes the specified Private Endpoint Connection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      privateEndpointConnectionName - Name of the private endpoint connection.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String serviceName, String privateEndpointConnectionName)
      Deletes the specified Private Endpoint Connection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      privateEndpointConnectionName - Name of the private endpoint connection.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String serviceName, String privateEndpointConnectionName, com.azure.core.util.Context context)
      Deletes the specified Private Endpoint Connection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      privateEndpointConnectionName - Name of the private endpoint connection.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listPrivateLinkResourcesWithResponse

      com.azure.core.http.rest.Response<PrivateLinkResourceListResultInner> listPrivateLinkResourcesWithResponse(String resourceGroupName, String serviceName, com.azure.core.util.Context context)
      Gets the private link resources.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      context - The context to associate with this operation.
      Returns:
      the private link resources along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listPrivateLinkResources

      PrivateLinkResourceListResultInner listPrivateLinkResources(String resourceGroupName, String serviceName)
      Gets the private link resources.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      Returns:
      the private link resources.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getPrivateLinkResourceWithResponse

      com.azure.core.http.rest.Response<PrivateLinkResourceInner> getPrivateLinkResourceWithResponse(String resourceGroupName, String serviceName, String privateLinkSubResourceName, com.azure.core.util.Context context)
      Gets the private link resources.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      privateLinkSubResourceName - Name of the private link resource.
      context - The context to associate with this operation.
      Returns:
      the private link resources along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getPrivateLinkResource

      PrivateLinkResourceInner getPrivateLinkResource(String resourceGroupName, String serviceName, String privateLinkSubResourceName)
      Gets the private link resources.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      privateLinkSubResourceName - Name of the private link resource.
      Returns:
      the private link resources.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.