Interface BatchEndpointsClient


  • public interface BatchEndpointsClient
    An instance of this class provides access to all the operations defined in BatchEndpointsClient.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<BatchEndpointDataInner> 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<BatchEndpointDataInner> 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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(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.
        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 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.
        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 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.
      • get

        BatchEndpointDataInner 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.
      • getWithResponse

        com.azure.core.http.rest.Response<BatchEndpointDataInner> 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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<BatchEndpointDataInner>,​BatchEndpointDataInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                              String workspaceName,
                                                                                                                                                              String endpointName,
                                                                                                                                                              PartialBatchEndpointPartialTrackedResource body)
        Update a 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 - Name for the Batch inference endpoint.
        body - Mutable batch inference endpoint definition object.
        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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<BatchEndpointDataInner>,​BatchEndpointDataInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                              String workspaceName,
                                                                                                                                                              String endpointName,
                                                                                                                                                              PartialBatchEndpointPartialTrackedResource body,
                                                                                                                                                              com.azure.core.util.Context context)
        Update a 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 - Name for the Batch inference endpoint.
        body - Mutable batch inference endpoint definition object.
        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.
      • update

        BatchEndpointDataInner update​(String resourceGroupName,
                                      String workspaceName,
                                      String endpointName,
                                      PartialBatchEndpointPartialTrackedResource body)
        Update a 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 - Name for the Batch inference endpoint.
        body - Mutable batch inference endpoint definition object.
        Returns:
        the 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.
      • update

        BatchEndpointDataInner update​(String resourceGroupName,
                                      String workspaceName,
                                      String endpointName,
                                      PartialBatchEndpointPartialTrackedResource body,
                                      com.azure.core.util.Context context)
        Update a 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 - Name for the Batch inference endpoint.
        body - Mutable batch inference endpoint definition object.
        context - The context to associate with this operation.
        Returns:
        the 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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<BatchEndpointDataInner>,​BatchEndpointDataInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                      String workspaceName,
                                                                                                                                                                      String endpointName,
                                                                                                                                                                      BatchEndpointDataInner body)
        Creates a 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 - Name for the Batch inference endpoint.
        body - Batch inference endpoint definition object.
        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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<BatchEndpointDataInner>,​BatchEndpointDataInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                      String workspaceName,
                                                                                                                                                                      String endpointName,
                                                                                                                                                                      BatchEndpointDataInner body,
                                                                                                                                                                      com.azure.core.util.Context context)
        Creates a 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 - Name for the Batch inference endpoint.
        body - Batch inference endpoint definition object.
        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.
      • createOrUpdate

        BatchEndpointDataInner createOrUpdate​(String resourceGroupName,
                                              String workspaceName,
                                              String endpointName,
                                              BatchEndpointDataInner body)
        Creates a 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 - Name for the Batch inference endpoint.
        body - Batch inference endpoint definition object.
        Returns:
        the 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.
      • createOrUpdate

        BatchEndpointDataInner createOrUpdate​(String resourceGroupName,
                                              String workspaceName,
                                              String endpointName,
                                              BatchEndpointDataInner body,
                                              com.azure.core.util.Context context)
        Creates a 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 - Name for the Batch inference endpoint.
        body - Batch inference endpoint definition object.
        context - The context to associate with this operation.
        Returns:
        the 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

        EndpointAuthKeysInner 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.
      • listKeysWithResponse

        com.azure.core.http.rest.Response<EndpointAuthKeysInner> 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.