Interface PrivateEndpoints


  • public interface PrivateEndpoints
    Resource collection API of PrivateEndpoints.
    • Method Detail

      • get

        PrivateEndpoint get​(String resourceGroupName,
                            String clusterName,
                            String privateEndpointName)
        Gets information about the specified Private Endpoint.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        clusterName - The name of the cluster.
        privateEndpointName - The name of the private endpoint.
        Returns:
        information about the specified Private Endpoint.
        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.
      • getWithResponse

        com.azure.core.http.rest.Response<PrivateEndpoint> getWithResponse​(String resourceGroupName,
                                                                           String clusterName,
                                                                           String privateEndpointName,
                                                                           com.azure.core.util.Context context)
        Gets information about the specified Private Endpoint.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        clusterName - The name of the cluster.
        privateEndpointName - The name of the private endpoint.
        context - The context to associate with this operation.
        Returns:
        information about the specified Private Endpoint.
        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 clusterName,
                    String privateEndpointName)
        Delete the specified private endpoint.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        clusterName - The name of the cluster.
        privateEndpointName - The name of the private endpoint.
        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 clusterName,
                    String privateEndpointName,
                    com.azure.core.util.Context context)
        Delete the specified private endpoint.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        clusterName - The name of the cluster.
        privateEndpointName - The name of the private endpoint.
        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.
      • listByCluster

        com.azure.core.http.rest.PagedIterable<PrivateEndpoint> listByCluster​(String resourceGroupName,
                                                                              String clusterName)
        Lists the private endpoints in the cluster.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        clusterName - The name of the cluster.
        Returns:
        a list of private endpoints.
        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.
      • listByCluster

        com.azure.core.http.rest.PagedIterable<PrivateEndpoint> listByCluster​(String resourceGroupName,
                                                                              String clusterName,
                                                                              com.azure.core.util.Context context)
        Lists the private endpoints in the cluster.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        clusterName - The name of the cluster.
        context - The context to associate with this operation.
        Returns:
        a list of private endpoints.
        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

        PrivateEndpoint getById​(String id)
        Gets information about the specified Private Endpoint.
        Parameters:
        id - the resource ID.
        Returns:
        information about the specified Private Endpoint.
        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<PrivateEndpoint> getByIdWithResponse​(String id,
                                                                               com.azure.core.util.Context context)
        Gets information about the specified Private Endpoint.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        information about the specified Private Endpoint.
        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)
        Delete the specified private endpoint.
        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)
        Delete the specified private endpoint.
        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

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