Package com.azure.resourcemanager.machinelearning.models

Interface OnlineDeployments

public interface OnlineDeployments

Resource collection API of OnlineDeployments.

Method Summary

Modifier and Type	Method	Description
OnlineDeploymentData.DefinitionStages.Blank	define(String name)	Begins definition for a new OnlineDeploymentData resource.
void	delete(String resourceGroupName, String workspaceName, String endpointName, String deploymentName)	Delete Inference Endpoint Deployment (asynchronous).
void	delete(String resourceGroupName, String workspaceName, String endpointName, String deploymentName, com.azure.core.util.Context context)	Delete Inference Endpoint Deployment (asynchronous).
void	deleteById(String id)	Delete Inference Endpoint Deployment (asynchronous).
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete Inference Endpoint Deployment (asynchronous).
OnlineDeploymentData	get(String resourceGroupName, String workspaceName, String endpointName, String deploymentName)	Get Inference Deployment Deployment.
OnlineDeploymentData	getById(String id)	Get Inference Deployment Deployment.
com.azure.core.http.rest.Response<OnlineDeploymentData>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get Inference Deployment Deployment.
DeploymentLogs	getLogs(String resourceGroupName, String workspaceName, String endpointName, String deploymentName, DeploymentLogsRequest body)	Polls an Endpoint operation.
com.azure.core.http.rest.Response<DeploymentLogs>	getLogsWithResponse(String resourceGroupName, String workspaceName, String endpointName, String deploymentName, DeploymentLogsRequest body, com.azure.core.util.Context context)	Polls an Endpoint operation.
com.azure.core.http.rest.Response<OnlineDeploymentData>	getWithResponse(String resourceGroupName, String workspaceName, String endpointName, String deploymentName, com.azure.core.util.Context context)	Get Inference Deployment Deployment.
com.azure.core.http.rest.PagedIterable<OnlineDeploymentData>	list(String resourceGroupName, String workspaceName, String endpointName)	List Inference Endpoint Deployments.
com.azure.core.http.rest.PagedIterable<OnlineDeploymentData>	list(String resourceGroupName, String workspaceName, String endpointName, String orderBy, Integer top, String skip, com.azure.core.util.Context context)	List Inference Endpoint Deployments.
com.azure.core.http.rest.PagedIterable<SkuResource>	listSkus(String resourceGroupName, String workspaceName, String endpointName, String deploymentName)	List Inference Endpoint Deployment Skus.
com.azure.core.http.rest.PagedIterable<SkuResource>	listSkus(String resourceGroupName, String workspaceName, String endpointName, String deploymentName, Integer count, String skip, com.azure.core.util.Context context)	List Inference Endpoint Deployment Skus.

Method Detail

list

com.azure.core.http.rest.PagedIterable<OnlineDeploymentData> list(String resourceGroupName,
                                                                  String workspaceName,
                                                                  String endpointName)

List Inference Endpoint Deployments.

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:

a paginated list of OnlineDeployment 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<OnlineDeploymentData> list(String resourceGroupName,
                                                                  String workspaceName,
                                                                  String endpointName,
                                                                  String orderBy,
                                                                  Integer top,
                                                                  String skip,
                                                                  com.azure.core.util.Context context)

List Inference Endpoint Deployments.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

endpointName - Inference endpoint name.

orderBy - Ordering of list.

top - Top of list.

skip - Continuation token for pagination.

context - The context to associate with this operation.

Returns:

a paginated list of OnlineDeployment 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,
            String deploymentName)

Delete Inference Endpoint Deployment (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.

deploymentName - Inference Endpoint Deployment 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,
            String deploymentName,
            com.azure.core.util.Context context)

Delete Inference Endpoint Deployment (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.

deploymentName - Inference Endpoint Deployment 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

OnlineDeploymentData get(String resourceGroupName,
                         String workspaceName,
                         String endpointName,
                         String deploymentName)

Get Inference Deployment Deployment.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

endpointName - Inference endpoint name.

deploymentName - Inference Endpoint Deployment name.

Returns:

inference Deployment Deployment.

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<OnlineDeploymentData> getWithResponse(String resourceGroupName,
                                                                        String workspaceName,
                                                                        String endpointName,
                                                                        String deploymentName,
                                                                        com.azure.core.util.Context context)

Get Inference Deployment Deployment.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

endpointName - Inference endpoint name.

deploymentName - Inference Endpoint Deployment name.

context - The context to associate with this operation.

Returns:

inference Deployment Deployment 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.

getLogs

DeploymentLogs getLogs(String resourceGroupName,
                       String workspaceName,
                       String endpointName,
                       String deploymentName,
                       DeploymentLogsRequest body)

Polls an Endpoint operation.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

endpointName - Inference endpoint name.

deploymentName - The name and identifier for the endpoint.

body - The request containing parameters for retrieving logs.

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.

getLogsWithResponse

com.azure.core.http.rest.Response<DeploymentLogs> getLogsWithResponse(String resourceGroupName,
                                                                      String workspaceName,
                                                                      String endpointName,
                                                                      String deploymentName,
                                                                      DeploymentLogsRequest body,
                                                                      com.azure.core.util.Context context)

Polls an Endpoint operation.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

endpointName - Inference endpoint name.

deploymentName - The name and identifier for the endpoint.

body - The request containing parameters for retrieving logs.

context - The context to associate with this operation.

Returns:

the response body 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.

listSkus

com.azure.core.http.rest.PagedIterable<SkuResource> listSkus(String resourceGroupName,
                                                             String workspaceName,
                                                             String endpointName,
                                                             String deploymentName)

List Inference Endpoint Deployment Skus.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

endpointName - Inference endpoint name.

deploymentName - Inference Endpoint Deployment name.

Returns:

a paginated list of SkuResource 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.

listSkus

com.azure.core.http.rest.PagedIterable<SkuResource> listSkus(String resourceGroupName,
                                                             String workspaceName,
                                                             String endpointName,
                                                             String deploymentName,
                                                             Integer count,
                                                             String skip,
                                                             com.azure.core.util.Context context)

List Inference Endpoint Deployment Skus.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - Name of Azure Machine Learning workspace.

endpointName - Inference endpoint name.

deploymentName - Inference Endpoint Deployment name.

count - Number of Skus 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 SkuResource 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.

getById

OnlineDeploymentData getById(String id)

Get Inference Deployment Deployment.

Parameters:

id - the resource ID.

Returns:

inference Deployment Deployment 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<OnlineDeploymentData> getByIdWithResponse(String id,
                                                                            com.azure.core.util.Context context)

Get Inference Deployment Deployment.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

inference Deployment Deployment 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 Inference Endpoint Deployment (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 Inference Endpoint Deployment (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

OnlineDeploymentData.DefinitionStages.Blank define(String name)

Begins definition for a new OnlineDeploymentData resource.

Parameters:

name - resource name.

Returns:

the first stage of the new OnlineDeploymentData definition.