ComputeOperations interface
Interface representing a ComputeOperations.
Methods
| begin |
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. |
| begin |
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. |
| begin |
Deletes specified Machine Learning compute. |
| begin |
Deletes specified Machine Learning compute. |
| begin |
Posts a restart action to a compute instance |
| begin |
Posts a restart action to a compute instance |
| begin |
Posts a start action to a compute instance |
| begin |
Posts a start action to a compute instance |
| begin |
Posts a stop action to a compute instance |
| begin |
Posts a stop action to a compute instance |
| begin |
Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. |
| begin |
Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. |
| get(string, string, string, Compute |
Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them. |
| list(string, string, Compute |
Gets computes in specified workspace. |
| list |
Gets secrets related to Machine Learning compute (storage keys, service credentials, etc). |
| list |
Get the details (e.g IP address, port etc) of all the compute nodes in the compute. |
Method Details
beginCreateOrUpdate(string, string, string, ComputeResource, ComputeCreateOrUpdateOptionalParams)
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.
function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ComputeResource, options?: ComputeCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ComputeResource>, ComputeResource>>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.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<ComputeResource>, ComputeResource>>
beginCreateOrUpdateAndWait(string, string, string, ComputeResource, ComputeCreateOrUpdateOptionalParams)
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.
function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ComputeResource, options?: ComputeCreateOrUpdateOptionalParams): Promise<ComputeResource>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.
The options parameters.
Returns
Promise<ComputeResource>
beginDelete(string, string, string, string, ComputeDeleteOptionalParams)
Deletes specified Machine Learning compute.
function beginDelete(resourceGroupName: string, workspaceName: string, computeName: string, underlyingResourceAction: string, options?: ComputeDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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
-
string
Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.
- options
- ComputeDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, ComputeDeleteOptionalParams)
Deletes specified Machine Learning compute.
function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, computeName: string, underlyingResourceAction: string, options?: ComputeDeleteOptionalParams): Promise<void>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
-
string
Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.
- options
- ComputeDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginRestart(string, string, string, ComputeRestartOptionalParams)
Posts a restart action to a compute instance
function beginRestart(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
- options
- ComputeRestartOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRestartAndWait(string, string, string, ComputeRestartOptionalParams)
Posts a restart action to a compute instance
function beginRestartAndWait(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeRestartOptionalParams): Promise<void>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.
- options
- ComputeRestartOptionalParams
The options parameters.
Returns
Promise<void>
beginStart(string, string, string, ComputeStartOptionalParams)
Posts a start action to a compute instance
function beginStart(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
- options
- ComputeStartOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStartAndWait(string, string, string, ComputeStartOptionalParams)
Posts a start action to a compute instance
function beginStartAndWait(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeStartOptionalParams): Promise<void>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.
- options
- ComputeStartOptionalParams
The options parameters.
Returns
Promise<void>
beginStop(string, string, string, ComputeStopOptionalParams)
Posts a stop action to a compute instance
function beginStop(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
- options
- ComputeStopOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStopAndWait(string, string, string, ComputeStopOptionalParams)
Posts a stop action to a compute instance
function beginStopAndWait(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeStopOptionalParams): Promise<void>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.
- options
- ComputeStopOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, ClusterUpdateParameters, ComputeUpdateOptionalParams)
Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.
function beginUpdate(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ClusterUpdateParameters, options?: ComputeUpdateOptionalParams): Promise<PollerLike<PollOperationState<ComputeResource>, ComputeResource>>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.
- options
- ComputeUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<ComputeResource>, ComputeResource>>
beginUpdateAndWait(string, string, string, ClusterUpdateParameters, ComputeUpdateOptionalParams)
Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.
function beginUpdateAndWait(resourceGroupName: string, workspaceName: string, computeName: string, parameters: ClusterUpdateParameters, options?: ComputeUpdateOptionalParams): Promise<ComputeResource>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.
- options
- ComputeUpdateOptionalParams
The options parameters.
Returns
Promise<ComputeResource>
get(string, string, string, ComputeGetOptionalParams)
Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.
function get(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeGetOptionalParams): Promise<ComputeResource>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.
- options
- ComputeGetOptionalParams
The options parameters.
Returns
Promise<ComputeResource>
list(string, string, ComputeListOptionalParams)
Gets computes in specified workspace.
function list(resourceGroupName: string, workspaceName: string, options?: ComputeListOptionalParams): PagedAsyncIterableIterator<ComputeResource, ComputeResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- workspaceName
-
string
Name of Azure Machine Learning workspace.
- options
- ComputeListOptionalParams
The options parameters.
Returns
listKeys(string, string, string, ComputeListKeysOptionalParams)
Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).
function listKeys(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeListKeysOptionalParams): Promise<ComputeSecretsUnion>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.
- options
- ComputeListKeysOptionalParams
The options parameters.
Returns
Promise<ComputeSecretsUnion>
listNodes(string, string, string, ComputeListNodesOptionalParams)
Get the details (e.g IP address, port etc) of all the compute nodes in the compute.
function listNodes(resourceGroupName: string, workspaceName: string, computeName: string, options?: ComputeListNodesOptionalParams): PagedAsyncIterableIterator<AmlComputeNodeInformation, AmlComputeNodeInformation[], PageSettings>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.
- options
- ComputeListNodesOptionalParams
The options parameters.