Clusters class
Class representing a Clusters.
Constructors
| Clusters(Batch |
Create a Clusters. |
Methods
Constructor Details
Clusters(BatchAIManagementClientContext)
Create a Clusters.
new Clusters(client: BatchAIManagementClientContext)Parameters
Reference to the service client.
Method Details
beginCreate(string, string, string, ClusterCreateParameters, RequestOptionsBase)
Creates a Cluster in the given Workspace.
function beginCreate(resourceGroupName: string, workspaceName: string, clusterName: string, parameters: ClusterCreateParameters, options?: RequestOptionsBase): Promise<LROPoller>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- parameters
- ClusterCreateParameters
The parameters to provide for the Cluster creation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
beginDeleteMethod(string, string, string, RequestOptionsBase)
Deletes a Cluster.
function beginDeleteMethod(resourceGroupName: string, workspaceName: string, clusterName: string, options?: RequestOptionsBase): Promise<LROPoller>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
create(string, string, string, ClusterCreateParameters, RequestOptionsBase)
Creates a Cluster in the given Workspace.
function create(resourceGroupName: string, workspaceName: string, clusterName: string, parameters: ClusterCreateParameters, options?: RequestOptionsBase): Promise<ClustersCreateResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- parameters
- ClusterCreateParameters
The parameters to provide for the Cluster creation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ClustersCreateResponse>
Promise<Models.ClustersCreateResponse>
deleteMethod(string, string, string, RequestOptionsBase)
Deletes a Cluster.
function deleteMethod(resourceGroupName: string, workspaceName: string, clusterName: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
get(string, string, string, RequestOptionsBase)
Gets information about a Cluster.
function get(resourceGroupName: string, workspaceName: string, clusterName: string, options?: RequestOptionsBase): Promise<ClustersGetResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ClustersGetResponse>
Promise<Models.ClustersGetResponse>
get(string, string, string, RequestOptionsBase, ServiceCallback<Cluster>)
function get(resourceGroupName: string, workspaceName: string, clusterName: string, options: RequestOptionsBase, callback: ServiceCallback<Cluster>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
get(string, string, string, ServiceCallback<Cluster>)
function get(resourceGroupName: string, workspaceName: string, clusterName: string, callback: ServiceCallback<Cluster>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- callback
The callback
listByWorkspace(string, string, ClustersListByWorkspaceOptionalParams)
Gets information about Clusters associated with the given Workspace.
function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: ClustersListByWorkspaceOptionalParams): Promise<ClustersListByWorkspaceResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
The optional parameters
Returns
Promise<ClustersListByWorkspaceResponse>
Promise<Models.ClustersListByWorkspaceResponse>
listByWorkspace(string, string, ClustersListByWorkspaceOptionalParams, ServiceCallback<ClusterListResult>)
function listByWorkspace(resourceGroupName: string, workspaceName: string, options: ClustersListByWorkspaceOptionalParams, callback: ServiceCallback<ClusterListResult>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
The optional parameters
- callback
The callback
listByWorkspace(string, string, ServiceCallback<ClusterListResult>)
function listByWorkspace(resourceGroupName: string, workspaceName: string, callback: ServiceCallback<ClusterListResult>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- callback
The callback
listByWorkspaceNext(string, RequestOptionsBase)
Gets information about Clusters associated with the given Workspace.
function listByWorkspaceNext(nextPageLink: string, options?: RequestOptionsBase): Promise<ClustersListByWorkspaceNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ClustersListByWorkspaceNextResponse>
Promise<Models.ClustersListByWorkspaceNextResponse>
listByWorkspaceNext(string, RequestOptionsBase, ServiceCallback<ClusterListResult>)
function listByWorkspaceNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ClusterListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listByWorkspaceNext(string, ServiceCallback<ClusterListResult>)
function listByWorkspaceNext(nextPageLink: string, callback: ServiceCallback<ClusterListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
listRemoteLoginInformation(string, string, string, RequestOptionsBase)
Get the IP address, port of all the compute nodes in the Cluster.
function listRemoteLoginInformation(resourceGroupName: string, workspaceName: string, clusterName: string, options?: RequestOptionsBase): Promise<ClustersListRemoteLoginInformationResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.ClustersListRemoteLoginInformationResponse>
listRemoteLoginInformation(string, string, string, RequestOptionsBase, ServiceCallback<RemoteLoginInformationListResult>)
function listRemoteLoginInformation(resourceGroupName: string, workspaceName: string, clusterName: string, options: RequestOptionsBase, callback: ServiceCallback<RemoteLoginInformationListResult>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- RequestOptionsBase
The optional parameters
The callback
listRemoteLoginInformation(string, string, string, ServiceCallback<RemoteLoginInformationListResult>)
function listRemoteLoginInformation(resourceGroupName: string, workspaceName: string, clusterName: string, callback: ServiceCallback<RemoteLoginInformationListResult>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
The callback
listRemoteLoginInformationNext(string, RequestOptionsBase)
Get the IP address, port of all the compute nodes in the Cluster.
function listRemoteLoginInformationNext(nextPageLink: string, options?: RequestOptionsBase): Promise<ClustersListRemoteLoginInformationNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.ClustersListRemoteLoginInformationNextResponse>
listRemoteLoginInformationNext(string, RequestOptionsBase, ServiceCallback<RemoteLoginInformationListResult>)
function listRemoteLoginInformationNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<RemoteLoginInformationListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
The callback
listRemoteLoginInformationNext(string, ServiceCallback<RemoteLoginInformationListResult>)
function listRemoteLoginInformationNext(nextPageLink: string, callback: ServiceCallback<RemoteLoginInformationListResult>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
The callback
update(string, string, string, ClustersUpdateOptionalParams)
Updates properties of a Cluster.
function update(resourceGroupName: string, workspaceName: string, clusterName: string, options?: ClustersUpdateOptionalParams): Promise<ClustersUpdateResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- ClustersUpdateOptionalParams
The optional parameters
Returns
Promise<ClustersUpdateResponse>
Promise<Models.ClustersUpdateResponse>
update(string, string, string, ClustersUpdateOptionalParams, ServiceCallback<Cluster>)
function update(resourceGroupName: string, workspaceName: string, clusterName: string, options: ClustersUpdateOptionalParams, callback: ServiceCallback<Cluster>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- options
- ClustersUpdateOptionalParams
The optional parameters
- callback
The callback
update(string, string, string, ServiceCallback<Cluster>)
function update(resourceGroupName: string, workspaceName: string, clusterName: string, callback: ServiceCallback<Cluster>)Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- workspaceName
-
string
The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusterName
-
string
The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- callback
The callback