Interface BatchEndpoints


public interface BatchEndpoints
Resource collection API of BatchEndpoints.
  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<BatchEndpoint> list(String resourceGroupName, String workspaceName)
      Lists Batch inference endpoint in the workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      Returns:
      a paginated list of BatchEndpoint entities 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.
    • list

      com.azure.core.http.rest.PagedIterable<BatchEndpoint> list(String resourceGroupName, String workspaceName, Integer count, String skip, com.azure.core.util.Context context)
      Lists Batch inference endpoint in the workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      count - Number of endpoints to be retrieved in a page of results.
      skip - Continuation token for pagination.
      context - The context to associate with this operation.
      Returns:
      a paginated list of BatchEndpoint entities 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.
    • delete

      void delete(String resourceGroupName, String workspaceName, String endpointName)
      Delete Batch Inference Endpoint (asynchronous).
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      endpointName - Inference Endpoint name.
      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 workspaceName, String endpointName, com.azure.core.util.Context context)
      Delete Batch Inference Endpoint (asynchronous).
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      endpointName - Inference Endpoint name.
      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.
    • getWithResponse

      com.azure.core.http.rest.Response<BatchEndpoint> getWithResponse(String resourceGroupName, String workspaceName, String endpointName, com.azure.core.util.Context context)
      Gets a batch inference endpoint by name.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      endpointName - Name for the Batch Endpoint.
      context - The context to associate with this operation.
      Returns:
      a batch inference endpoint by name 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.
    • get

      BatchEndpoint get(String resourceGroupName, String workspaceName, String endpointName)
      Gets a batch inference endpoint by name.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      endpointName - Name for the Batch Endpoint.
      Returns:
      a batch inference endpoint by name.
      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.
    • listKeysWithResponse

      com.azure.core.http.rest.Response<EndpointAuthKeys> listKeysWithResponse(String resourceGroupName, String workspaceName, String endpointName, com.azure.core.util.Context context)
      Lists batch Inference Endpoint keys.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      endpointName - Inference Endpoint name.
      context - The context to associate with this operation.
      Returns:
      keys for endpoint authentication 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.
    • listKeys

      EndpointAuthKeys listKeys(String resourceGroupName, String workspaceName, String endpointName)
      Lists batch Inference Endpoint keys.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - Name of Azure Machine Learning workspace.
      endpointName - Inference Endpoint name.
      Returns:
      keys for endpoint authentication.
      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

      BatchEndpoint getById(String id)
      Gets a batch inference endpoint by name.
      Parameters:
      id - the resource ID.
      Returns:
      a batch inference endpoint by name 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<BatchEndpoint> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets a batch inference endpoint by name.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      a batch inference endpoint by name 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)
      Delete Batch Inference Endpoint (asynchronous).
      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 Batch Inference Endpoint (asynchronous).
      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

      Begins definition for a new BatchEndpoint resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new BatchEndpoint definition.