Package com.azure.resourcemanager.machinelearning.fluent

Interface OnlineEndpointsClient

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

    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<OnlineEndpointDataInner> list​(String resourceGroupName,
                                                                     String workspaceName)
        List Online Endpoints.
        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 OnlineEndpoint 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<OnlineEndpointDataInner> list​(String resourceGroupName,
                                                                     String workspaceName,
                                                                     String name,
                                                                     Integer count,
                                                                     EndpointComputeType computeType,
                                                                     String skip,
                                                                     String tags,
                                                                     String properties,
                                                                     OrderString orderBy,
                                                                     com.azure.core.util.Context context)
        List Online Endpoints.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        name - Name of the endpoint.
        count - Number of endpoints to be retrieved in a page of results.
        computeType - EndpointComputeType to be filtered by.
        skip - Continuation token for pagination.
        tags - A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .
        properties - A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .
        orderBy - The option to order the response.
        context - The context to associate with this operation.
        Returns:
        a paginated list of OnlineEndpoint 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 Online Endpoint (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online 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 Online Endpoint (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online 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 Online Endpoint (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online 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 Online Endpoint (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online 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

        OnlineEndpointDataInner get​(String resourceGroupName,
                            String workspaceName,
                            String endpointName)
        Get Online Endpoint.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        Returns:
        online 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<OnlineEndpointDataInner> getWithResponse​(String resourceGroupName,
                                                                           String workspaceName,
                                                                           String endpointName,
                                                                           com.azure.core.util.Context context)
        Get Online Endpoint.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        context - The context to associate with this operation.
        Returns:
        online Endpoint 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<OnlineEndpointDataInner>,​OnlineEndpointDataInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                        String workspaceName,
                                                                                                                                                        String endpointName,
                                                                                                                                                        PartialOnlineEndpointPartialTrackedResource body)
        Update Online Endpoint (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        body - Online Endpoint entity to apply during 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.

      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<OnlineEndpointDataInner>,​OnlineEndpointDataInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                        String workspaceName,
                                                                                                                                                        String endpointName,
                                                                                                                                                        PartialOnlineEndpointPartialTrackedResource body,
                                                                                                                                                        com.azure.core.util.Context context)
        Update Online Endpoint (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        body - Online Endpoint entity to apply during operation.
        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

        OnlineEndpointDataInner update​(String resourceGroupName,
                               String workspaceName,
                               String endpointName,
                               PartialOnlineEndpointPartialTrackedResource body)
        Update Online Endpoint (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        body - Online Endpoint entity to apply during 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.

      • update

        OnlineEndpointDataInner update​(String resourceGroupName,
                               String workspaceName,
                               String endpointName,
                               PartialOnlineEndpointPartialTrackedResource body,
                               com.azure.core.util.Context context)
        Update Online Endpoint (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        body - Online Endpoint entity to apply during operation.
        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<OnlineEndpointDataInner>,​OnlineEndpointDataInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                String workspaceName,
                                                                                                                                                                String endpointName,
                                                                                                                                                                OnlineEndpointDataInner body)
        Create or update Online Endpoint (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        body - Online Endpoint entity to apply during 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.

      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<OnlineEndpointDataInner>,​OnlineEndpointDataInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                String workspaceName,
                                                                                                                                                                String endpointName,
                                                                                                                                                                OnlineEndpointDataInner body,
                                                                                                                                                                com.azure.core.util.Context context)
        Create or update Online Endpoint (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        body - Online Endpoint entity to apply during operation.
        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

        OnlineEndpointDataInner createOrUpdate​(String resourceGroupName,
                                       String workspaceName,
                                       String endpointName,
                                       OnlineEndpointDataInner body)
        Create or update Online Endpoint (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        body - Online Endpoint entity to apply during 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.

      • createOrUpdate

        OnlineEndpointDataInner createOrUpdate​(String resourceGroupName,
                                       String workspaceName,
                                       String endpointName,
                                       OnlineEndpointDataInner body,
                                       com.azure.core.util.Context context)
        Create or update Online Endpoint (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        body - Online Endpoint entity to apply during operation.
        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)
        List EndpointAuthKeys for an Endpoint using Key-based authentication.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online 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)
        List EndpointAuthKeys for an Endpoint using Key-based authentication.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online 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.

      • beginRegenerateKeys

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginRegenerateKeys​(String resourceGroupName,
                                                                                                                          String workspaceName,
                                                                                                                          String endpointName,
                                                                                                                          RegenerateEndpointKeysRequest body)
        Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        body - RegenerateKeys request .
        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.

      • beginRegenerateKeys

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginRegenerateKeys​(String resourceGroupName,
                                                                                                                          String workspaceName,
                                                                                                                          String endpointName,
                                                                                                                          RegenerateEndpointKeysRequest body,
                                                                                                                          com.azure.core.util.Context context)
        Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        body - RegenerateKeys request .
        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.

      • regenerateKeys

        void regenerateKeys​(String resourceGroupName,
                    String workspaceName,
                    String endpointName,
                    RegenerateEndpointKeysRequest body)
        Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        body - RegenerateKeys request .
        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.

      • regenerateKeys

        void regenerateKeys​(String resourceGroupName,
                    String workspaceName,
                    String endpointName,
                    RegenerateEndpointKeysRequest body,
                    com.azure.core.util.Context context)
        Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        body - RegenerateKeys request .
        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.

      • getToken

        EndpointAuthTokenInner getToken​(String resourceGroupName,
                                String workspaceName,
                                String endpointName)
        Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        Returns:
        service Token.
        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.

      • getTokenWithResponse

        com.azure.core.http.rest.Response<EndpointAuthTokenInner> getTokenWithResponse​(String resourceGroupName,
                                                                               String workspaceName,
                                                                               String endpointName,
                                                                               com.azure.core.util.Context context)
        Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        endpointName - Online Endpoint name.
        context - The context to associate with this operation.
        Returns:
        service Token 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.