BatchAccountOperations interface
BatchAccountOperations を表すインターフェイス。
メソッド
| begin |
指定したパラメーターを使用して、新しい Batch アカウントを作成します。 この API では既存のアカウントを更新できないため、代わりに Batch アカウントの更新 API で更新する必要があります。 |
| begin |
指定したパラメーターを使用して、新しい Batch アカウントを作成します。 この API では既存のアカウントを更新できないため、代わりに Batch アカウントの更新 API で更新する必要があります。 |
| begin |
指定した Batch アカウントを削除します。 |
| begin |
指定した Batch アカウントを削除します。 |
| get(string, string, Batch |
指定した Batch アカウントに関する情報を取得します。 |
| get |
特定の Batch アカウントの特定の検出機能に関する情報を取得します。 |
| get |
この操作は、'SharedKey' を含む allowedAuthenticationModes を持つ Batch アカウントにのみ適用されます。 Batch アカウントに allowedAuthenticationMode に 'SharedKey' が含まれていない場合、クライアントは認証に共有キーを使用できず、代わりに別の allowedAuthenticationModes を使用する必要があります。 この場合、キーの取得は失敗します。 |
| list(Batch |
サブスクリプションに関連付けられている Batch アカウントに関する情報を取得します。 |
| list |
指定したリソース グループに関連付けられている Batch アカウントに関する情報を取得します。 |
| list |
特定の Batch アカウントで使用可能な検出機能に関する情報を取得します。 |
| list |
この Batch アカウントの Batch コンピューティング ノードが Batch サービス管理の一部として呼び出す可能性があるエンドポイントを一覧表示します。 指定した仮想ネットワーク内にプールをデプロイする場合は、ネットワークでこれらのエンドポイントへの送信アクセスが許可されていることを確認する必要があります。 これらのエンドポイントへのアクセスを許可しないと、Batch によって影響を受けるノードが使用不能としてマークされる可能性があります。 仮想ネットワーク内でのプールの作成の詳細については、「https://docs.microsoft.com/azure/batch/batch-virtual-network」を参照してください。 |
| regenerate |
この操作は、'SharedKey' を含む allowedAuthenticationModes を持つ Batch アカウントにのみ適用されます。 Batch アカウントに allowedAuthenticationMode に 'SharedKey' が含まれていない場合、クライアントは認証に共有キーを使用できず、代わりに別の allowedAuthenticationModes を使用する必要があります。 この場合、キーの再生成は失敗します。 |
| synchronize |
ストレージ キー認証が使用されている場合にのみ、指定された Batch アカウント用に構成された自動ストレージ アカウントのアクセス キーを同期します。 |
| update(string, string, Batch |
既存の Batch アカウントのプロパティを更新します。 |
メソッドの詳細
beginCreate(string, string, BatchAccountCreateParameters, BatchAccountCreateOptionalParams)
指定したパラメーターを使用して、新しい Batch アカウントを作成します。 この API では既存のアカウントを更新できないため、代わりに Batch アカウントの更新 API で更新する必要があります。
function beginCreate(resourceGroupName: string, accountName: string, parameters: BatchAccountCreateParameters, options?: BatchAccountCreateOptionalParams): Promise<SimplePollerLike<OperationState<BatchAccount>, BatchAccount>>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
- accountName
-
string
リージョン内で一意である必要がある Batch アカウントの名前。 バッチ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 この名前は、アカウントが作成されたリージョンの Batch サービスへのアクセスに使用される DNS 名の一部として使用されます。 例: http://accountname.region.batch.azure.com/.
- parameters
- BatchAccountCreateParameters
アカウント作成用の追加パラメーター。
- options
- BatchAccountCreateOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<BatchAccount>, BatchAccount>>
beginCreateAndWait(string, string, BatchAccountCreateParameters, BatchAccountCreateOptionalParams)
指定したパラメーターを使用して、新しい Batch アカウントを作成します。 この API では既存のアカウントを更新できないため、代わりに Batch アカウントの更新 API で更新する必要があります。
function beginCreateAndWait(resourceGroupName: string, accountName: string, parameters: BatchAccountCreateParameters, options?: BatchAccountCreateOptionalParams): Promise<BatchAccount>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
- accountName
-
string
リージョン内で一意である必要がある Batch アカウントの名前。 バッチ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 この名前は、アカウントが作成されたリージョンの Batch サービスへのアクセスに使用される DNS 名の一部として使用されます。 例: http://accountname.region.batch.azure.com/.
- parameters
- BatchAccountCreateParameters
アカウント作成用の追加パラメーター。
- options
- BatchAccountCreateOptionalParams
オプション パラメーター。
戻り値
Promise<BatchAccount>
beginDelete(string, string, BatchAccountDeleteOptionalParams)
指定した Batch アカウントを削除します。
function beginDelete(resourceGroupName: string, accountName: string, options?: BatchAccountDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
- accountName
-
string
Batch アカウントの名前。
- options
- BatchAccountDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, BatchAccountDeleteOptionalParams)
指定した Batch アカウントを削除します。
function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: BatchAccountDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
- accountName
-
string
Batch アカウントの名前。
- options
- BatchAccountDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<void>
get(string, string, BatchAccountGetOptionalParams)
指定した Batch アカウントに関する情報を取得します。
function get(resourceGroupName: string, accountName: string, options?: BatchAccountGetOptionalParams): Promise<BatchAccount>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
- accountName
-
string
Batch アカウントの名前。
- options
- BatchAccountGetOptionalParams
オプション パラメーター。
戻り値
Promise<BatchAccount>
getDetector(string, string, string, BatchAccountGetDetectorOptionalParams)
特定の Batch アカウントの特定の検出機能に関する情報を取得します。
function getDetector(resourceGroupName: string, accountName: string, detectorId: string, options?: BatchAccountGetDetectorOptionalParams): Promise<DetectorResponse>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
- accountName
-
string
Batch アカウントの名前。
- detectorId
-
string
検出器の名前。
オプション パラメーター。
戻り値
Promise<DetectorResponse>
getKeys(string, string, BatchAccountGetKeysOptionalParams)
この操作は、'SharedKey' を含む allowedAuthenticationModes を持つ Batch アカウントにのみ適用されます。 Batch アカウントに allowedAuthenticationMode に 'SharedKey' が含まれていない場合、クライアントは認証に共有キーを使用できず、代わりに別の allowedAuthenticationModes を使用する必要があります。 この場合、キーの取得は失敗します。
function getKeys(resourceGroupName: string, accountName: string, options?: BatchAccountGetKeysOptionalParams): Promise<BatchAccountKeys>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
- accountName
-
string
Batch アカウントの名前。
オプション パラメーター。
戻り値
Promise<BatchAccountKeys>
list(BatchAccountListOptionalParams)
サブスクリプションに関連付けられている Batch アカウントに関する情報を取得します。
function list(options?: BatchAccountListOptionalParams): PagedAsyncIterableIterator<BatchAccount, BatchAccount[], PageSettings>パラメーター
- options
- BatchAccountListOptionalParams
オプション パラメーター。
戻り値
listByResourceGroup(string, BatchAccountListByResourceGroupOptionalParams)
指定したリソース グループに関連付けられている Batch アカウントに関する情報を取得します。
function listByResourceGroup(resourceGroupName: string, options?: BatchAccountListByResourceGroupOptionalParams): PagedAsyncIterableIterator<BatchAccount, BatchAccount[], PageSettings>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
オプション パラメーター。
戻り値
listDetectors(string, string, BatchAccountListDetectorsOptionalParams)
特定の Batch アカウントで使用可能な検出機能に関する情報を取得します。
function listDetectors(resourceGroupName: string, accountName: string, options?: BatchAccountListDetectorsOptionalParams): PagedAsyncIterableIterator<DetectorResponse, DetectorResponse[], PageSettings>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
- accountName
-
string
Batch アカウントの名前。
オプション パラメーター。
戻り値
listOutboundNetworkDependenciesEndpoints(string, string, BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams)
この Batch アカウントの Batch コンピューティング ノードが Batch サービス管理の一部として呼び出す可能性があるエンドポイントを一覧表示します。 指定した仮想ネットワーク内にプールをデプロイする場合は、ネットワークでこれらのエンドポイントへの送信アクセスが許可されていることを確認する必要があります。 これらのエンドポイントへのアクセスを許可しないと、Batch によって影響を受けるノードが使用不能としてマークされる可能性があります。 仮想ネットワーク内でのプールの作成の詳細については、「https://docs.microsoft.com/azure/batch/batch-virtual-network」を参照してください。
function listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, accountName: string, options?: BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
- accountName
-
string
Batch アカウントの名前。
オプション パラメーター。
戻り値
regenerateKey(string, string, BatchAccountRegenerateKeyParameters, BatchAccountRegenerateKeyOptionalParams)
この操作は、'SharedKey' を含む allowedAuthenticationModes を持つ Batch アカウントにのみ適用されます。 Batch アカウントに allowedAuthenticationMode に 'SharedKey' が含まれていない場合、クライアントは認証に共有キーを使用できず、代わりに別の allowedAuthenticationModes を使用する必要があります。 この場合、キーの再生成は失敗します。
function regenerateKey(resourceGroupName: string, accountName: string, parameters: BatchAccountRegenerateKeyParameters, options?: BatchAccountRegenerateKeyOptionalParams): Promise<BatchAccountKeys>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
- accountName
-
string
Batch アカウントの名前。
- parameters
- BatchAccountRegenerateKeyParameters
再生成するキーの種類。
オプション パラメーター。
戻り値
Promise<BatchAccountKeys>
synchronizeAutoStorageKeys(string, string, BatchAccountSynchronizeAutoStorageKeysOptionalParams)
ストレージ キー認証が使用されている場合にのみ、指定された Batch アカウント用に構成された自動ストレージ アカウントのアクセス キーを同期します。
function synchronizeAutoStorageKeys(resourceGroupName: string, accountName: string, options?: BatchAccountSynchronizeAutoStorageKeysOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
- accountName
-
string
Batch アカウントの名前。
オプション パラメーター。
戻り値
Promise<void>
update(string, string, BatchAccountUpdateParameters, BatchAccountUpdateOptionalParams)
既存の Batch アカウントのプロパティを更新します。
function update(resourceGroupName: string, accountName: string, parameters: BatchAccountUpdateParameters, options?: BatchAccountUpdateOptionalParams): Promise<BatchAccount>パラメーター
- resourceGroupName
-
string
Batch アカウントを含むリソース グループの名前。
- accountName
-
string
Batch アカウントの名前。
- parameters
- BatchAccountUpdateParameters
アカウント更新の追加パラメーター。
- options
- BatchAccountUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<BatchAccount>