BatchDeployments interface

Package:

@azure/arm-machinelearning

Interface representing a BatchDeployments.

Methods

beginCreateOrUpdate(string, string, string, string, BatchDeployment, BatchDeploymentsCreateOrUpdateOptionalParams)	Creates/updates a batch inference deployment (asynchronous).
beginCreateOrUpdateAndWait(string, string, string, string, BatchDeployment, BatchDeploymentsCreateOrUpdateOptionalParams)	Creates/updates a batch inference deployment (asynchronous).
beginDelete(string, string, string, string, BatchDeploymentsDeleteOptionalParams)	Delete Batch Inference deployment (asynchronous).
beginDeleteAndWait(string, string, string, string, BatchDeploymentsDeleteOptionalParams)	Delete Batch Inference deployment (asynchronous).
beginUpdate(string, string, string, string, PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties, BatchDeploymentsUpdateOptionalParams)	Update a batch inference deployment (asynchronous).
beginUpdateAndWait(string, string, string, string, PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties, BatchDeploymentsUpdateOptionalParams)	Update a batch inference deployment (asynchronous).
get(string, string, string, string, BatchDeploymentsGetOptionalParams)	Gets a batch inference deployment by id.
list(string, string, string, BatchDeploymentsListOptionalParams)	Lists Batch inference deployments in the workspace.

Method Details

beginCreateOrUpdate(string, string, string, string, BatchDeployment, BatchDeploymentsCreateOrUpdateOptionalParams)

Creates/updates a batch inference deployment (asynchronous).

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, endpointName: string, deploymentName: string, body: BatchDeployment, options?: BatchDeploymentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BatchDeployment>, BatchDeployment>>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Inference endpoint name

deploymentName

string

The identifier for the Batch inference deployment.

body

BatchDeployment

Batch inference deployment definition object.

options

BatchDeploymentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<BatchDeployment>, BatchDeployment>>

beginCreateOrUpdateAndWait(string, string, string, string, BatchDeployment, BatchDeploymentsCreateOrUpdateOptionalParams)

Creates/updates a batch inference deployment (asynchronous).

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, deploymentName: string, body: BatchDeployment, options?: BatchDeploymentsCreateOrUpdateOptionalParams): Promise<BatchDeployment>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Inference endpoint name

deploymentName

string

The identifier for the Batch inference deployment.

body

BatchDeployment

Batch inference deployment definition object.

options

BatchDeploymentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<BatchDeployment>

beginDelete(string, string, string, string, BatchDeploymentsDeleteOptionalParams)

Delete Batch Inference deployment (asynchronous).

function beginDelete(resourceGroupName: string, workspaceName: string, endpointName: string, deploymentName: string, options?: BatchDeploymentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Endpoint name

deploymentName

string

Inference deployment identifier.

options

BatchDeploymentsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, BatchDeploymentsDeleteOptionalParams)

Delete Batch Inference deployment (asynchronous).

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, deploymentName: string, options?: BatchDeploymentsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Endpoint name

deploymentName

string

Inference deployment identifier.

options

BatchDeploymentsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties, BatchDeploymentsUpdateOptionalParams)

Update a batch inference deployment (asynchronous).

function beginUpdate(resourceGroupName: string, workspaceName: string, endpointName: string, deploymentName: string, body: PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties, options?: BatchDeploymentsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BatchDeployment>, BatchDeployment>>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Inference endpoint name

deploymentName

string

The identifier for the Batch inference deployment.

body

PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties

Batch inference deployment definition object.

options

BatchDeploymentsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<BatchDeployment>, BatchDeployment>>

beginUpdateAndWait(string, string, string, string, PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties, BatchDeploymentsUpdateOptionalParams)

Update a batch inference deployment (asynchronous).

function beginUpdateAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, deploymentName: string, body: PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties, options?: BatchDeploymentsUpdateOptionalParams): Promise<BatchDeployment>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Inference endpoint name

deploymentName

string

The identifier for the Batch inference deployment.

body

PartialBatchDeploymentPartialMinimalTrackedResourceWithProperties

Batch inference deployment definition object.

options

BatchDeploymentsUpdateOptionalParams

The options parameters.

Returns

Promise<BatchDeployment>

get(string, string, string, string, BatchDeploymentsGetOptionalParams)

Gets a batch inference deployment by id.

function get(resourceGroupName: string, workspaceName: string, endpointName: string, deploymentName: string, options?: BatchDeploymentsGetOptionalParams): Promise<BatchDeployment>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Endpoint name

deploymentName

string

The identifier for the Batch deployments.

options

BatchDeploymentsGetOptionalParams

The options parameters.

Returns

Promise<BatchDeployment>

list(string, string, string, BatchDeploymentsListOptionalParams)

Lists Batch inference deployments in the workspace.

function list(resourceGroupName: string, workspaceName: string, endpointName: string, options?: BatchDeploymentsListOptionalParams): PagedAsyncIterableIterator<BatchDeployment, BatchDeployment[], PageSettings>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Endpoint name

options

BatchDeploymentsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<BatchDeployment, BatchDeployment[], PageSettings>