BatchEndpoints | @azure/arm-machinelearning

Interface representing a BatchEndpoints.

Hierarchy

BatchEndpoints

Implemented by

BatchEndpointsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, endpointName: string, body: BatchEndpointData, options?: BatchEndpointsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<BatchEndpointsCreateOrUpdateResponse>, BatchEndpointsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/batchEndpoints.ts:122
Creates a batch inference endpoint (asynchronous).

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: BatchEndpointData
  
  Batch inference endpoint definition object.
- Optional options: BatchEndpointsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<BatchEndpointsCreateOrUpdateResponse>, BatchEndpointsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/batchEndpoints.ts:142
Creates a batch inference endpoint (asynchronous).

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: BatchEndpointData
  
  Batch inference endpoint definition object.
- Optional options: BatchEndpointsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<BatchEndpointsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, workspaceName: string, endpointName: string, options?: BatchEndpointsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/batchEndpoints.ts:47
Delete Batch Inference Endpoint (asynchronous).

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.
- Optional options: BatchEndpointsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, options?: BatchEndpointsDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/batchEndpoints.ts:60
Delete Batch Inference Endpoint (asynchronous).

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.
- Optional options: BatchEndpointsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, workspaceName: string, endpointName: string, body: PartialBatchEndpointPartialTrackedResource, options?: BatchEndpointsUpdateOptionalParams): Promise<PollerLike<PollOperationState<BatchEndpointsUpdateResponse>, BatchEndpointsUpdateResponse>>

- Defined in operationsInterfaces/batchEndpoints.ts:87
Update a batch inference endpoint (asynchronous).

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: PartialBatchEndpointPartialTrackedResource
  
  Mutable batch inference endpoint definition object.
- Optional options: BatchEndpointsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<BatchEndpointsUpdateResponse>, BatchEndpointsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, workspaceName: string, endpointName: string, body: PartialBatchEndpointPartialTrackedResource, options?: BatchEndpointsUpdateOptionalParams): Promise<BatchEndpointsUpdateResponse>

- Defined in operationsInterfaces/batchEndpoints.ts:107
Update a batch inference endpoint (asynchronous).

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: PartialBatchEndpointPartialTrackedResource
  
  Mutable batch inference endpoint definition object.
- Optional options: BatchEndpointsUpdateOptionalParams
  
  The options parameters.
Returns Promise<BatchEndpointsUpdateResponse>

get

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

- Defined in operationsInterfaces/batchEndpoints.ts:73
Gets a batch inference endpoint by name.

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.
- Optional options: BatchEndpointsGetOptionalParams
  
  The options parameters.
Returns Promise<BatchEndpointsGetResponse>

list

list(resourceGroupName: string, workspaceName: string, options?: BatchEndpointsListOptionalParams): PagedAsyncIterableIterator<BatchEndpointData>

- Defined in operationsInterfaces/batchEndpoints.ts:35
Lists Batch inference endpoint in the workspace.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- Optional options: BatchEndpointsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<BatchEndpointData>

listKeys

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

- Defined in operationsInterfaces/batchEndpoints.ts:156
Lists batch Inference Endpoint keys.

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.
- Optional options: BatchEndpointsListKeysOptionalParams
  
  The options parameters.
Returns Promise<BatchEndpointsListKeysResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

body: BatchEndpointData

Optional options: BatchEndpointsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<BatchEndpointsCreateOrUpdateResponse>, BatchEndpointsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

body: BatchEndpointData

Optional options: BatchEndpointsCreateOrUpdateOptionalParams

Returns Promise<BatchEndpointsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

Optional options: BatchEndpointsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

Optional options: BatchEndpointsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

body: PartialBatchEndpointPartialTrackedResource

Optional options: BatchEndpointsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<BatchEndpointsUpdateResponse>, BatchEndpointsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

body: PartialBatchEndpointPartialTrackedResource

Optional options: BatchEndpointsUpdateOptionalParams

Returns Promise<BatchEndpointsUpdateResponse>

get

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

Optional options: BatchEndpointsGetOptionalParams

Returns Promise<BatchEndpointsGetResponse>

list

Parameters

resourceGroupName: string

workspaceName: string

Optional options: BatchEndpointsListOptionalParams

Returns PagedAsyncIterableIterator<BatchEndpointData>

listKeys

Parameters

resourceGroupName: string

workspaceName: string

endpointName: string

Optional options: BatchEndpointsListKeysOptionalParams

Returns Promise<BatchEndpointsListKeysResponse>