Package com.azure.resourcemanager.machinelearning.models

Interface BatchDeployments

public interface BatchDeployments

Resource collection API of BatchDeployments.

Method Summary

Modifier and Type	Method	Description
BatchDeploymentData.DefinitionStages.Blank	define(String name)	Begins definition for a new BatchDeploymentData resource.
void	delete(String resourceGroupName, String workspaceName, String endpointName, String deploymentName)	Delete Batch Inference deployment (asynchronous).
void	delete(String resourceGroupName, String workspaceName, String endpointName, String deploymentName, com.azure.core.util.Context context)	Delete Batch Inference deployment (asynchronous).
void	deleteById(String id)	Delete Batch Inference deployment (asynchronous).
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete Batch Inference deployment (asynchronous).
BatchDeploymentData	get(String resourceGroupName, String workspaceName, String endpointName, String deploymentName)	Gets a batch inference deployment by id.
BatchDeploymentData	getById(String id)	Gets a batch inference deployment by id.
com.azure.core.http.rest.Response<BatchDeploymentData>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets a batch inference deployment by id.
com.azure.core.http.rest.Response<BatchDeploymentData>	getWithResponse(String resourceGroupName, String workspaceName, String endpointName, String deploymentName, com.azure.core.util.Context context)	Gets a batch inference deployment by id.
com.azure.core.http.rest.PagedIterable<BatchDeploymentData>	list(String resourceGroupName, String workspaceName, String endpointName)	Lists Batch inference deployments in the workspace.
com.azure.core.http.rest.PagedIterable<BatchDeploymentData>	list(String resourceGroupName, String workspaceName, String endpointName, String orderBy, Integer top, String skip, com.azure.core.util.Context context)	Lists Batch inference deployments in the workspace.

Method Detail

list

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

Lists Batch inference deployments in the workspace.

Parameters:

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

workspaceName - Name of Azure Machine Learning workspace.

endpointName - Endpoint name.

Returns:

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

Lists Batch inference deployments in the workspace.

Parameters:

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

workspaceName - Name of Azure Machine Learning workspace.

endpointName - 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 BatchDeployment 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 Batch Inference deployment (asynchronous).

Parameters:

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

workspaceName - Name of Azure Machine Learning workspace.

endpointName - Endpoint name.

deploymentName - Inference deployment identifier.

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 Batch Inference deployment (asynchronous).

Parameters:

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

workspaceName - Name of Azure Machine Learning workspace.

endpointName - Endpoint name.

deploymentName - Inference deployment identifier.

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

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

Gets a batch inference deployment by id.

Parameters:

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

workspaceName - Name of Azure Machine Learning workspace.

endpointName - Endpoint name.

deploymentName - The identifier for the Batch deployments.

Returns:

a batch inference deployment by 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.

getWithResponse

com.azure.core.http.rest.Response<BatchDeploymentData> getWithResponse(String resourceGroupName,
                                                                       String workspaceName,
                                                                       String endpointName,
                                                                       String deploymentName,
                                                                       com.azure.core.util.Context context)

Gets a batch inference deployment by id.

Parameters:

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

workspaceName - Name of Azure Machine Learning workspace.

endpointName - Endpoint name.

deploymentName - The identifier for the Batch deployments.

context - The context to associate with this operation.

Returns:

a batch inference deployment by id 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

BatchDeploymentData getById(String id)

Gets a batch inference deployment by id.

Parameters:

id - the resource ID.

Returns:

a batch inference deployment by id 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<BatchDeploymentData> getByIdWithResponse(String id,
                                                                           com.azure.core.util.Context context)

Gets a batch inference deployment by id.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a batch inference deployment by id 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 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 Batch Inference 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

BatchDeploymentData.DefinitionStages.Blank define(String name)

Begins definition for a new BatchDeploymentData resource.

Parameters:

name - resource name.

Returns:

the first stage of the new BatchDeploymentData definition.