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
回呼