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>
Promise<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>
Promise<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>
Promise<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>
Promise<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>
Promise<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>
Promise<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>
Promise<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>
Promise<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
コールバック