BatchEndpoints interface

Package:

@azure/arm-machinelearning

Interface representing a BatchEndpoints.

Methods

beginCreateOrUpdate(string, string, string, BatchEndpoint, BatchEndpointsCreateOrUpdateOptionalParams)	Creates a batch inference endpoint (asynchronous).
beginCreateOrUpdateAndWait(string, string, string, BatchEndpoint, BatchEndpointsCreateOrUpdateOptionalParams)	Creates a batch inference endpoint (asynchronous).
beginDelete(string, string, string, BatchEndpointsDeleteOptionalParams)	Delete Batch Inference Endpoint (asynchronous).
beginDeleteAndWait(string, string, string, BatchEndpointsDeleteOptionalParams)	Delete Batch Inference Endpoint (asynchronous).
beginUpdate(string, string, string, PartialMinimalTrackedResourceWithIdentity, BatchEndpointsUpdateOptionalParams)	Update a batch inference endpoint (asynchronous).
beginUpdateAndWait(string, string, string, PartialMinimalTrackedResourceWithIdentity, BatchEndpointsUpdateOptionalParams)	Update a batch inference endpoint (asynchronous).
get(string, string, string, BatchEndpointsGetOptionalParams)	Gets a batch inference endpoint by name.
list(string, string, BatchEndpointsListOptionalParams)	Lists Batch inference endpoint in the workspace.
listKeys(string, string, string, BatchEndpointsListKeysOptionalParams)	Lists batch Inference Endpoint keys.

Method Details

beginCreateOrUpdate(string, string, string, BatchEndpoint, BatchEndpointsCreateOrUpdateOptionalParams)

Creates a batch inference endpoint (asynchronous).

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, endpointName: string, body: BatchEndpoint, options?: BatchEndpointsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BatchEndpoint>, BatchEndpoint>>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Name for the Batch inference endpoint.

body

BatchEndpoint

Batch inference endpoint definition object.

options

BatchEndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, BatchEndpoint, BatchEndpointsCreateOrUpdateOptionalParams)

Creates a batch inference endpoint (asynchronous).

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, body: BatchEndpoint, options?: BatchEndpointsCreateOrUpdateOptionalParams): Promise<BatchEndpoint>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Name for the Batch inference endpoint.

body

BatchEndpoint

Batch inference endpoint definition object.

options

BatchEndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<BatchEndpoint>

beginDelete(string, string, string, BatchEndpointsDeleteOptionalParams)

Delete Batch Inference Endpoint (asynchronous).

function beginDelete(resourceGroupName: string, workspaceName: string, endpointName: string, options?: BatchEndpointsDeleteOptionalParams): 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

Inference Endpoint name.

options

BatchEndpointsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, BatchEndpointsDeleteOptionalParams)

Delete Batch Inference Endpoint (asynchronous).

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, options?: BatchEndpointsDeleteOptionalParams): 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

Inference Endpoint name.

options

BatchEndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, PartialMinimalTrackedResourceWithIdentity, BatchEndpointsUpdateOptionalParams)

Update a batch inference endpoint (asynchronous).

function beginUpdate(resourceGroupName: string, workspaceName: string, endpointName: string, body: PartialMinimalTrackedResourceWithIdentity, options?: BatchEndpointsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BatchEndpoint>, BatchEndpoint>>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Name for the Batch inference endpoint.

body

PartialMinimalTrackedResourceWithIdentity

Mutable batch inference endpoint definition object.

options

BatchEndpointsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, PartialMinimalTrackedResourceWithIdentity, BatchEndpointsUpdateOptionalParams)

Update a batch inference endpoint (asynchronous).

function beginUpdateAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, body: PartialMinimalTrackedResourceWithIdentity, options?: BatchEndpointsUpdateOptionalParams): Promise<BatchEndpoint>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Name for the Batch inference endpoint.

body

PartialMinimalTrackedResourceWithIdentity

Mutable batch inference endpoint definition object.

options

BatchEndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<BatchEndpoint>

get(string, string, string, BatchEndpointsGetOptionalParams)

Gets a batch inference endpoint by name.

function get(resourceGroupName: string, workspaceName: string, endpointName: string, options?: BatchEndpointsGetOptionalParams): Promise<BatchEndpoint>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

endpointName

string

Name for the Batch Endpoint.

options

BatchEndpointsGetOptionalParams

The options parameters.

Returns

Promise<BatchEndpoint>

list(string, string, BatchEndpointsListOptionalParams)

Lists Batch inference endpoint in the workspace.

function list(resourceGroupName: string, workspaceName: string, options?: BatchEndpointsListOptionalParams): PagedAsyncIterableIterator<BatchEndpoint, BatchEndpoint[], PageSettings>

Parameters

resourceGroupName

string

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

workspaceName

string

Name of Azure Machine Learning workspace.

options

BatchEndpointsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<BatchEndpoint, BatchEndpoint[], PageSettings>

listKeys(string, string, string, BatchEndpointsListKeysOptionalParams)

Lists batch Inference Endpoint keys.

function listKeys(resourceGroupName: string, workspaceName: string, endpointName: string, options?: BatchEndpointsListKeysOptionalParams): Promise<EndpointAuthKeys>

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.

options

BatchEndpointsListKeysOptionalParams

The options parameters.

Returns

Promise<EndpointAuthKeys>