Package com.azure.resourcemanager.apimanagement.models

Interface PrivateEndpointConnections

public interface PrivateEndpointConnections
Resource collection API of PrivateEndpointConnections.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<PrivateEndpointConnection> 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<PrivateEndpointConnection> 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<PrivateEndpointConnection> 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

      PrivateEndpointConnection 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.

    • 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<PrivateLinkResourceListResult> 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

      PrivateLinkResourceListResult 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<PrivateLinkResource> 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

      PrivateLinkResource 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.

    • getById

      PrivateEndpointConnection getById(String id)
      Gets the details of the Private Endpoint Connection specified by its identifier.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<PrivateEndpointConnection> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets the details of the Private Endpoint Connection specified by its identifier.
      Parameters:
      id - the resource ID.
      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.

    • deleteById

      void deleteById(String id)
      Deletes the specified Private Endpoint Connection.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes the specified Private Endpoint Connection.
      Parameters:
      id - the resource ID.
      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.

    • define

      PrivateEndpointConnection.DefinitionStages.Blank define(String name)
      Begins definition for a new PrivateEndpointConnection resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new PrivateEndpointConnection definition.