Package com.azure.resourcemanager.machinelearning.models

Interface OnlineEndpoints

public interface OnlineEndpoints

Resource collection API of OnlineEndpoints.

Method Summary

Modifier and Type	Method	Description
OnlineEndpointData.DefinitionStages.Blank	define(String name)	Begins definition for a new OnlineEndpointData resource.
void	delete(String resourceGroupName, String workspaceName, String endpointName)	Delete Online Endpoint (asynchronous).
void	delete(String resourceGroupName, String workspaceName, String endpointName, com.azure.core.util.Context context)	Delete Online Endpoint (asynchronous).
void	deleteById(String id)	Delete Online Endpoint (asynchronous).
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete Online Endpoint (asynchronous).
OnlineEndpointData	get(String resourceGroupName, String workspaceName, String endpointName)	Get Online Endpoint.
OnlineEndpointData	getById(String id)	Get Online Endpoint.
com.azure.core.http.rest.Response<OnlineEndpointData>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get Online Endpoint.
EndpointAuthToken	getToken(String resourceGroupName, String workspaceName, String endpointName)	Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.
com.azure.core.http.rest.Response<EndpointAuthToken>	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.
com.azure.core.http.rest.Response<OnlineEndpointData>	getWithResponse(String resourceGroupName, String workspaceName, String endpointName, com.azure.core.util.Context context)	Get Online Endpoint.
com.azure.core.http.rest.PagedIterable<OnlineEndpointData>	list(String resourceGroupName, String workspaceName)	List Online Endpoints.
com.azure.core.http.rest.PagedIterable<OnlineEndpointData>	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.
EndpointAuthKeys	listKeys(String resourceGroupName, String workspaceName, String endpointName)	List EndpointAuthKeys for an Endpoint using Key-based authentication.
com.azure.core.http.rest.Response<EndpointAuthKeys>	listKeysWithResponse(String resourceGroupName, String workspaceName, String endpointName, com.azure.core.util.Context context)	List EndpointAuthKeys for an Endpoint using Key-based authentication.
void	regenerateKeys(String resourceGroupName, String workspaceName, String endpointName, RegenerateEndpointKeysRequest body)	Regenerate EndpointAuthKeys for an Endpoint using Key-based authentication (asynchronous).
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).

Method Detail

list

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

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

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

listKeys

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

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

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

getById

OnlineEndpointData getById(String id)

Get Online Endpoint.

Parameters:

id - the resource ID.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<OnlineEndpointData> getByIdWithResponse(String id,
                                                                          com.azure.core.util.Context context)

Get Online Endpoint.

Parameters:

id - the resource ID.

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.

deleteById

void deleteById(String id)

Delete Online 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 Online 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

OnlineEndpointData.DefinitionStages.Blank define(String name)

Begins definition for a new OnlineEndpointData resource.

Parameters:

name - resource name.

Returns:

the first stage of the new OnlineEndpointData definition.