ComputeOperations | @azure/arm-machinelearning

Interface representing a ComputeOperations.

Hierarchy

ComputeOperations

Implemented by

ComputeOperationsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ComputeResource, options?: ComputeCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ComputeCreateOrUpdateResponse>, ComputeCreateOrUpdateResponse>>

- Defined in operationsInterfaces/computeOperations.ts:83
Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- parameters: ComputeResource
  
  Payload with Machine Learning compute definition.
- Optional options: ComputeCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ComputeCreateOrUpdateResponse>, ComputeCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ComputeResource, options?: ComputeCreateOrUpdateOptionalParams): Promise<ComputeCreateOrUpdateResponse>

- Defined in operationsInterfaces/computeOperations.ts:105
Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- parameters: ComputeResource
  
  Payload with Machine Learning compute definition.
- Optional options: ComputeCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ComputeCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, workspaceName: string, computeName: string, underlyingResourceAction: UnderlyingResourceAction, options?: ComputeDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/computeOperations.ts:155
Deletes specified Machine Learning compute.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- underlyingResourceAction: UnderlyingResourceAction
  
  Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.
- Optional options: ComputeDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, workspaceName: string, computeName: string, underlyingResourceAction: UnderlyingResourceAction, options?: ComputeDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/computeOperations.ts:171
Deletes specified Machine Learning compute.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- underlyingResourceAction: UnderlyingResourceAction
  
  Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.
- Optional options: ComputeDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRestart

beginRestart(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/computeOperations.ts:250
Posts a restart action to a compute instance

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- Optional options: ComputeRestartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRestartAndWait

beginRestartAndWait(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeRestartOptionalParams): Promise<void>

- Defined in operationsInterfaces/computeOperations.ts:263
Posts a restart action to a compute instance

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- Optional options: ComputeRestartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginStart

beginStart(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/computeOperations.ts:198
Posts a start action to a compute instance

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- Optional options: ComputeStartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartAndWait

beginStartAndWait(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeStartOptionalParams): Promise<void>

- Defined in operationsInterfaces/computeOperations.ts:211
Posts a start action to a compute instance

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- Optional options: ComputeStartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginStop

beginStop(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/computeOperations.ts:224
Posts a stop action to a compute instance

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- Optional options: ComputeStopOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStopAndWait

beginStopAndWait(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeStopOptionalParams): Promise<void>

- Defined in operationsInterfaces/computeOperations.ts:237
Posts a stop action to a compute instance

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- Optional options: ComputeStopOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ClusterUpdateParameters, options?: ComputeUpdateOptionalParams): Promise<PollerLike<PollOperationState<ComputeUpdateResponse>, ComputeUpdateResponse>>

- Defined in operationsInterfaces/computeOperations.ts:121
Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- parameters: ClusterUpdateParameters
  
  Additional parameters for cluster update.
- Optional options: ComputeUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ComputeUpdateResponse>, ComputeUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ClusterUpdateParameters, options?: ComputeUpdateOptionalParams): Promise<ComputeUpdateResponse>

- Defined in operationsInterfaces/computeOperations.ts:139
Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- parameters: ClusterUpdateParameters
  
  Additional parameters for cluster update.
- Optional options: ComputeUpdateOptionalParams
  
  The options parameters.
Returns Promise<ComputeUpdateResponse>

get

get(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeGetOptionalParams): Promise<ComputeGetResponse>

- Defined in operationsInterfaces/computeOperations.ts:67
Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- Optional options: ComputeGetOptionalParams
  
  The options parameters.
Returns Promise<ComputeGetResponse>

list

list(resourceGroupName: string, workspaceName: string, options?: ComputeListOptionalParams): PagedAsyncIterableIterator<ComputeResource>

- Defined in operationsInterfaces/computeOperations.ts:41
Gets computes in specified 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: ComputeListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ComputeResource>

listKeys

listKeys(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeListKeysOptionalParams): Promise<ComputeListKeysResponse>

- Defined in operationsInterfaces/computeOperations.ts:185
Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  Name of Azure Machine Learning workspace.
- computeName: string
  
  Name of the Azure Machine Learning compute.
- Optional options: ComputeListKeysOptionalParams
  
  The options parameters.
Returns Promise<ComputeListKeysResponse>

listNodes

listNodes(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeListNodesOptionalParams): PagedAsyncIterableIterator<AmlComputeNodeInformation>

- Defined in operationsInterfaces/computeOperations.ts:53
Get the details (e.g IP address, port etc) of all the compute nodes in the compute.

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

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

computeName: string

parameters: ComputeResource

Optional options: ComputeCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ComputeCreateOrUpdateResponse>, ComputeCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

computeName: string

parameters: ComputeResource

Optional options: ComputeCreateOrUpdateOptionalParams

Returns Promise<ComputeCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

computeName: string

underlyingResourceAction: UnderlyingResourceAction

Optional options: ComputeDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

computeName: string

underlyingResourceAction: UnderlyingResourceAction

Optional options: ComputeDeleteOptionalParams

Returns Promise<void>

beginRestart

Parameters

resourceGroupName: string

workspaceName: string

computeName: string

Optional options: ComputeRestartOptionalParams

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

beginRestartAndWait

Parameters

resourceGroupName: string

workspaceName: string

computeName: string

Optional options: ComputeRestartOptionalParams

Returns Promise<void>

beginStart

Parameters

resourceGroupName: string

workspaceName: string

computeName: string

Optional options: ComputeStartOptionalParams

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

beginStartAndWait

Parameters

resourceGroupName: string

workspaceName: string

computeName: string

Optional options: ComputeStartOptionalParams

Returns Promise<void>

beginStop

Parameters

resourceGroupName: string

workspaceName: string

computeName: string

Optional options: ComputeStopOptionalParams

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

beginStopAndWait

Parameters

resourceGroupName: string

workspaceName: string

computeName: string

Optional options: ComputeStopOptionalParams

Returns Promise<void>

beginUpdate