ComputeOperationsOperations interface

Package:

@azure/arm-machinelearning

Interface representing a ComputeOperations operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginResize
beginResizeAndWait
beginRestart
beginRestartAndWait
beginStart
beginStartAndWait
beginStop
beginStopAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate	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.
delete	Deletes specified Machine Learning compute.
get	Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.
getAllowedResizeSizes	Returns supported virtual machine sizes for resize.
list	Gets computes in specified workspace.
listKeys	Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
listNodes	Get the details (e.g IP address, port etc) of all the compute nodes in the compute.
resize	Updates the size of a Compute Instance.
restart	Posts a restart action to a compute instance
start	Posts a start action to a compute instance
stop	Posts a stop action to a compute instance
update	Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.
updateCustomServices	Updates the custom services list. The list of custom services provided shall be overwritten.
updateDataMounts	Update Data Mounts of a Machine Learning compute.
updateIdleShutdownSetting	Updates the idle shutdown setting of a compute instance.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, workspaceName: string, computeName: string, parameters: ComputeResource, options?: ComputeOperationsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ComputeResource>, ComputeResource>>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ComputeResource, options?: ComputeOperationsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ComputeResource>, ComputeResource>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ComputeResource, options?: ComputeOperationsCreateOrUpdateOptionalParams) => Promise<ComputeResource>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, workspaceName: string, computeName: string, underlyingResourceAction: string, options?: ComputeOperationsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, underlyingResourceAction: string, options?: ComputeOperationsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, underlyingResourceAction: string, options?: ComputeOperationsDeleteOptionalParams) => Promise<void>

beginResize

Warning

This API is now deprecated.

use resize instead

beginResize: (resourceGroupName: string, workspaceName: string, computeName: string, parameters: ResizeSchema, options?: ComputeOperationsResizeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ResizeSchema, options?: ComputeOperationsResizeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginResizeAndWait

Warning

This API is now deprecated.

use resize instead

beginResizeAndWait: (resourceGroupName: string, workspaceName: string, computeName: string, parameters: ResizeSchema, options?: ComputeOperationsResizeOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ResizeSchema, options?: ComputeOperationsResizeOptionalParams) => Promise<void>

beginRestart

Warning

This API is now deprecated.

use restart instead

beginRestart: (resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsRestartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsRestartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait

Warning

This API is now deprecated.

use restart instead

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

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsRestartOptionalParams) => Promise<void>

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

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

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsStartOptionalParams) => Promise<void>

beginStop

Warning

This API is now deprecated.

use stop instead

beginStop: (resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStopAndWait

Warning

This API is now deprecated.

use stop instead

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

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsStopOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, workspaceName: string, computeName: string, parameters: ClusterUpdateParameters, options?: ComputeOperationsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ComputeResource>, ComputeResource>>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ClusterUpdateParameters, options?: ComputeOperationsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ComputeResource>, ComputeResource>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, workspaceName: string, computeName: string, parameters: ClusterUpdateParameters, options?: ComputeOperationsUpdateOptionalParams) => Promise<ComputeResource>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ClusterUpdateParameters, options?: ComputeOperationsUpdateOptionalParams) => Promise<ComputeResource>

createOrUpdate

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.

createOrUpdate: (resourceGroupName: string, workspaceName: string, computeName: string, parameters: ComputeResource, options?: ComputeOperationsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ComputeResource>, ComputeResource>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ComputeResource, options?: ComputeOperationsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ComputeResource>, ComputeResource>

delete

Deletes specified Machine Learning compute.

delete: (resourceGroupName: string, workspaceName: string, computeName: string, underlyingResourceAction: string, options?: ComputeOperationsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, underlyingResourceAction: string, options?: ComputeOperationsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.

get: (resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsGetOptionalParams) => Promise<ComputeResource>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsGetOptionalParams) => Promise<ComputeResource>

getAllowedResizeSizes

Returns supported virtual machine sizes for resize.

getAllowedResizeSizes: (resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsGetAllowedResizeSizesOptionalParams) => Promise<VirtualMachineSizeListResult>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsGetAllowedResizeSizesOptionalParams) => Promise<VirtualMachineSizeListResult>

list

Gets computes in specified workspace.

list: (resourceGroupName: string, workspaceName: string, options?: ComputeOperationsListOptionalParams) => PagedAsyncIterableIterator<ComputeResource, ComputeResource[], PageSettings>

Property Value

(resourceGroupName: string, workspaceName: string, options?: ComputeOperationsListOptionalParams) => PagedAsyncIterableIterator<ComputeResource, ComputeResource[], PageSettings>

listKeys

Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).

listKeys: (resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsListKeysOptionalParams) => Promise<ComputeSecretsUnion>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsListKeysOptionalParams) => Promise<ComputeSecretsUnion>

listNodes

Get the details (e.g IP address, port etc) of all the compute nodes in the compute.

listNodes: (resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsListNodesOptionalParams) => PagedAsyncIterableIterator<AmlComputeNodeInformation, AmlComputeNodeInformation[], PageSettings>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsListNodesOptionalParams) => PagedAsyncIterableIterator<AmlComputeNodeInformation, AmlComputeNodeInformation[], PageSettings>

resize

Updates the size of a Compute Instance.

resize: (resourceGroupName: string, workspaceName: string, computeName: string, parameters: ResizeSchema, options?: ComputeOperationsResizeOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ResizeSchema, options?: ComputeOperationsResizeOptionalParams) => PollerLike<OperationState<void>, void>

restart

Posts a restart action to a compute instance

restart: (resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsRestartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsRestartOptionalParams) => PollerLike<OperationState<void>, void>

start

Posts a start action to a compute instance

start: (resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsStartOptionalParams) => PollerLike<OperationState<void>, void>

stop

Posts a stop action to a compute instance

stop: (resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsStopOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeOperationsStopOptionalParams) => PollerLike<OperationState<void>, void>

update

Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.

update: (resourceGroupName: string, workspaceName: string, computeName: string, parameters: ClusterUpdateParameters, options?: ComputeOperationsUpdateOptionalParams) => PollerLike<OperationState<ComputeResource>, ComputeResource>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ClusterUpdateParameters, options?: ComputeOperationsUpdateOptionalParams) => PollerLike<OperationState<ComputeResource>, ComputeResource>

updateCustomServices

Updates the custom services list. The list of custom services provided shall be overwritten.

updateCustomServices: (resourceGroupName: string, workspaceName: string, computeName: string, customServices: CustomService[], options?: ComputeOperationsUpdateCustomServicesOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, customServices: CustomService[], options?: ComputeOperationsUpdateCustomServicesOptionalParams) => Promise<void>

updateDataMounts

Update Data Mounts of a Machine Learning compute.

updateDataMounts: (resourceGroupName: string, workspaceName: string, computeName: string, dataMounts: ComputeInstanceDataMount[], options?: ComputeOperationsUpdateDataMountsOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, dataMounts: ComputeInstanceDataMount[], options?: ComputeOperationsUpdateDataMountsOptionalParams) => Promise<void>

updateIdleShutdownSetting

Updates the idle shutdown setting of a compute instance.

updateIdleShutdownSetting: (resourceGroupName: string, workspaceName: string, computeName: string, parameters: IdleShutdownSetting, options?: ComputeOperationsUpdateIdleShutdownSettingOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, workspaceName: string, computeName: string, parameters: IdleShutdownSetting, options?: ComputeOperationsUpdateIdleShutdownSettingOptionalParams) => Promise<void>