Clusters class
表示群集的类。
构造函数
| Clusters(Batch |
创建群集。 |
方法
构造函数详细信息
Clusters(BatchAIManagementClientContext)
创建群集。
new Clusters(client: BatchAIManagementClientContext)参数
对服务客户端的引用。
方法详细信息
beginCreate(string, string, string, ClusterCreateParameters, RequestOptionsBase)
在给定工作区中创建群集。
function beginCreate(resourceGroupName: string, workspaceName: string, clusterName: string, parameters: ClusterCreateParameters, options?: RequestOptionsBase): Promise<LROPoller>参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- parameters
- ClusterCreateParameters
用于创建群集的参数。
- options
- RequestOptionsBase
可选参数
返回
Promise<@azure/ms-rest-azure-js.LROPoller>
承诺<msRestAzure.LROPoller>
beginDeleteMethod(string, string, string, RequestOptionsBase)
删除群集。
function beginDeleteMethod(resourceGroupName: string, workspaceName: string, clusterName: string, options?: RequestOptionsBase): Promise<LROPoller>参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- options
- RequestOptionsBase
可选参数
返回
Promise<@azure/ms-rest-azure-js.LROPoller>
承诺<msRestAzure.LROPoller>
create(string, string, string, ClusterCreateParameters, RequestOptionsBase)
在给定工作区中创建群集。
function create(resourceGroupName: string, workspaceName: string, clusterName: string, parameters: ClusterCreateParameters, options?: RequestOptionsBase): Promise<ClustersCreateResponse>参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- parameters
- ClusterCreateParameters
用于创建群集的参数。
- options
- RequestOptionsBase
可选参数
返回
Promise<ClustersCreateResponse>
承诺<Models.ClustersCreateResponse>
deleteMethod(string, string, string, RequestOptionsBase)
删除群集。
function deleteMethod(resourceGroupName: string, workspaceName: string, clusterName: string, options?: RequestOptionsBase): Promise<RestResponse>参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- options
- RequestOptionsBase
可选参数
返回
Promise<RestResponse>
承诺<msRest.RestResponse>
get(string, string, string, RequestOptionsBase)
获取有关群集的信息。
function get(resourceGroupName: string, workspaceName: string, clusterName: string, options?: RequestOptionsBase): Promise<ClustersGetResponse>参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- options
- RequestOptionsBase
可选参数
返回
Promise<ClustersGetResponse>
承诺<Models.ClustersGetResponse>
get(string, string, string, RequestOptionsBase, ServiceCallback<Cluster>)
function get(resourceGroupName: string, workspaceName: string, clusterName: string, options: RequestOptionsBase, callback: ServiceCallback<Cluster>)参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- options
- RequestOptionsBase
可选参数
- callback
回调
get(string, string, string, ServiceCallback<Cluster>)
function get(resourceGroupName: string, workspaceName: string, clusterName: string, callback: ServiceCallback<Cluster>)参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- callback
回调
listByWorkspace(string, string, ClustersListByWorkspaceOptionalParams)
获取与给定工作区关联的群集的相关信息。
function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: ClustersListByWorkspaceOptionalParams): Promise<ClustersListByWorkspaceResponse>参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
可选参数
返回
Promise<ClustersListByWorkspaceResponse>
承诺<Models.ClustersListByWorkspaceResponse>
listByWorkspace(string, string, ClustersListByWorkspaceOptionalParams, ServiceCallback<ClusterListResult>)
function listByWorkspace(resourceGroupName: string, workspaceName: string, options: ClustersListByWorkspaceOptionalParams, callback: ServiceCallback<ClusterListResult>)参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
可选参数
- callback
回调
listByWorkspace(string, string, ServiceCallback<ClusterListResult>)
function listByWorkspace(resourceGroupName: string, workspaceName: string, callback: ServiceCallback<ClusterListResult>)参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- callback
回调
listByWorkspaceNext(string, RequestOptionsBase)
获取与给定工作区关联的群集的相关信息。
function listByWorkspaceNext(nextPageLink: string, options?: RequestOptionsBase): Promise<ClustersListByWorkspaceNextResponse>参数
- nextPageLink
-
string
上一次成功调用 List作的 NextLink。
- options
- RequestOptionsBase
可选参数
返回
Promise<ClustersListByWorkspaceNextResponse>
承诺<Models.ClustersListByWorkspaceNextResponse>
listByWorkspaceNext(string, RequestOptionsBase, ServiceCallback<ClusterListResult>)
function listByWorkspaceNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ClusterListResult>)参数
- nextPageLink
-
string
上一次成功调用 List作的 NextLink。
- options
- RequestOptionsBase
可选参数
- callback
回调
listByWorkspaceNext(string, ServiceCallback<ClusterListResult>)
function listByWorkspaceNext(nextPageLink: string, callback: ServiceCallback<ClusterListResult>)参数
- nextPageLink
-
string
上一次成功调用 List作的 NextLink。
- callback
回调
listRemoteLoginInformation(string, string, string, RequestOptionsBase)
获取群集中所有计算节点的 IP 地址、端口。
function listRemoteLoginInformation(resourceGroupName: string, workspaceName: string, clusterName: string, options?: RequestOptionsBase): Promise<ClustersListRemoteLoginInformationResponse>参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- options
- RequestOptionsBase
可选参数
返回
Promise<Models.ClustersListRemoteLoginInformationResponse>
listRemoteLoginInformation(string, string, string, RequestOptionsBase, ServiceCallback<RemoteLoginInformationListResult>)
function listRemoteLoginInformation(resourceGroupName: string, workspaceName: string, clusterName: string, options: RequestOptionsBase, callback: ServiceCallback<RemoteLoginInformationListResult>)参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- options
- RequestOptionsBase
可选参数
回调
listRemoteLoginInformation(string, string, string, ServiceCallback<RemoteLoginInformationListResult>)
function listRemoteLoginInformation(resourceGroupName: string, workspaceName: string, clusterName: string, callback: ServiceCallback<RemoteLoginInformationListResult>)参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
回调
listRemoteLoginInformationNext(string, RequestOptionsBase)
获取群集中所有计算节点的 IP 地址、端口。
function listRemoteLoginInformationNext(nextPageLink: string, options?: RequestOptionsBase): Promise<ClustersListRemoteLoginInformationNextResponse>参数
- nextPageLink
-
string
上一次成功调用 List作的 NextLink。
- options
- RequestOptionsBase
可选参数
返回
Promise<Models.ClustersListRemoteLoginInformationNext响应>
listRemoteLoginInformationNext(string, RequestOptionsBase, ServiceCallback<RemoteLoginInformationListResult>)
function listRemoteLoginInformationNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<RemoteLoginInformationListResult>)参数
- nextPageLink
-
string
上一次成功调用 List作的 NextLink。
- options
- RequestOptionsBase
可选参数
回调
listRemoteLoginInformationNext(string, ServiceCallback<RemoteLoginInformationListResult>)
function listRemoteLoginInformationNext(nextPageLink: string, callback: ServiceCallback<RemoteLoginInformationListResult>)参数
- nextPageLink
-
string
上一次成功调用 List作的 NextLink。
回调
update(string, string, string, ClustersUpdateOptionalParams)
更新群集的属性。
function update(resourceGroupName: string, workspaceName: string, clusterName: string, options?: ClustersUpdateOptionalParams): Promise<ClustersUpdateResponse>参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- options
- ClustersUpdateOptionalParams
可选参数
返回
Promise<ClustersUpdateResponse>
承诺<Models.ClustersUpdateResponse>
update(string, string, string, ClustersUpdateOptionalParams, ServiceCallback<Cluster>)
function update(resourceGroupName: string, workspaceName: string, clusterName: string, options: ClustersUpdateOptionalParams, callback: ServiceCallback<Cluster>)参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- options
- ClustersUpdateOptionalParams
可选参数
- callback
回调
update(string, string, string, ServiceCallback<Cluster>)
function update(resourceGroupName: string, workspaceName: string, clusterName: string, callback: ServiceCallback<Cluster>)参数
- resourceGroupName
-
string
资源所属的资源组的名称。
- workspaceName
-
string
工作区的名称。 工作区名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- clusterName
-
string
指定资源组中群集的名称。 群集名称只能包含字母数字字符和短划线（-）和下划线（_）的组合。 名称长度必须为 1 到 64 个字符。
- callback
回调