BatchAccountOperations interface

パッケージ:

@azure/arm-batch

バッチアカウント操作を表すインターフェース。

プロパティ

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
create	指定したパラメーターを使用して、新しい Batch アカウントを作成します。 この API では既存のアカウントを更新できないため、代わりに Batch アカウントの更新 API で更新する必要があります。
delete
get	指定した Batch アカウントに関する情報を取得します。
getDetector	特定の Batch アカウントの特定の検出機能に関する情報を取得します。
getKeys	この操作は、'SharedKey' を含む allowedAuthenticationModes を持つ Batch アカウントにのみ適用されます。 Batch アカウントに allowedAuthenticationMode に 'SharedKey' が含まれていない場合、クライアントは認証に共有キーを使用できず、代わりに別の allowedAuthenticationModes を使用する必要があります。 この場合、キーの取得は失敗します。
list	サブスクリプションに関連付けられている Batch アカウントに関する情報を取得します。
listByResourceGroup	指定したリソース グループに関連付けられている Batch アカウントに関する情報を取得します。
listDetectors	特定の Batch アカウントで使用可能な検出機能に関する情報を取得します。
listOutboundNetworkDependenciesEndpoints	この Batch アカウントの Batch コンピューティング ノードが Batch サービス管理の一部として呼び出す可能性があるエンドポイントを一覧表示します。 指定した仮想ネットワーク内にプールをデプロイする場合は、ネットワークでこれらのエンドポイントへの送信アクセスが許可されていることを確認する必要があります。 これらのエンドポイントへのアクセスを許可しないと、Batch によって影響を受けるノードが使用不能としてマークされる可能性があります。 仮想ネットワーク内でのプールの作成の詳細については、「https://learn.microsoft.com/azure/batch/batch-virtual-network」を参照してください。
regenerateKey	この操作は、'SharedKey' を含む allowedAuthenticationModes を持つ Batch アカウントにのみ適用されます。 Batch アカウントに allowedAuthenticationMode に 'SharedKey' が含まれていない場合、クライアントは認証に共有キーを使用できず、代わりに別の allowedAuthenticationModes を使用する必要があります。 この場合、キーの再生成は失敗します。
synchronizeAutoStorageKeys	ストレージ キー認証が使用されている場合にのみ、指定された Batch アカウント用に構成された自動ストレージ アカウントのアクセス キーを同期します。
update	既存の Batch アカウントのプロパティを更新します。

プロパティの詳細

beginCreate

警告

この API は非推奨になりました。

use create instead

beginCreate: (resourceGroupName: string, accountName: string, parameters: BatchAccountCreateParameters, options?: BatchAccountCreateOptionalParams) => Promise<SimplePollerLike<OperationState<BatchAccount>, BatchAccount>>

プロパティ値

(resourceGroupName: string, accountName: string, parameters: BatchAccountCreateParameters, options?: BatchAccountCreateOptionalParams) => Promise<SimplePollerLike<OperationState<BatchAccount>, BatchAccount>>

beginCreateAndWait

警告

この API は非推奨になりました。

use create instead

beginCreateAndWait: (resourceGroupName: string, accountName: string, parameters: BatchAccountCreateParameters, options?: BatchAccountCreateOptionalParams) => Promise<BatchAccount>

プロパティ値

(resourceGroupName: string, accountName: string, parameters: BatchAccountCreateParameters, options?: BatchAccountCreateOptionalParams) => Promise<BatchAccount>

beginDelete

警告

この API は非推奨になりました。

use delete instead

beginDelete: (resourceGroupName: string, accountName: string, options?: BatchAccountDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

プロパティ値

(resourceGroupName: string, accountName: string, options?: BatchAccountDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

警告

この API は非推奨になりました。

use delete instead

beginDeleteAndWait: (resourceGroupName: string, accountName: string, options?: BatchAccountDeleteOptionalParams) => Promise<void>

プロパティ値

(resourceGroupName: string, accountName: string, options?: BatchAccountDeleteOptionalParams) => Promise<void>

create

指定したパラメーターを使用して、新しい Batch アカウントを作成します。 この API では既存のアカウントを更新できないため、代わりに Batch アカウントの更新 API で更新する必要があります。

create: (resourceGroupName: string, accountName: string, parameters: BatchAccountCreateParameters, options?: BatchAccountCreateOptionalParams) => PollerLike<OperationState<BatchAccount>, BatchAccount>

プロパティ値

(resourceGroupName: string, accountName: string, parameters: BatchAccountCreateParameters, options?: BatchAccountCreateOptionalParams) => PollerLike<OperationState<BatchAccount>, BatchAccount>

delete

delete: (resourceGroupName: string, accountName: string, options?: BatchAccountDeleteOptionalParams) => PollerLike<OperationState<void>, void>

プロパティ値

(resourceGroupName: string, accountName: string, options?: BatchAccountDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

指定した Batch アカウントに関する情報を取得します。

get: (resourceGroupName: string, accountName: string, options?: BatchAccountGetOptionalParams) => Promise<BatchAccount>

プロパティ値

(resourceGroupName: string, accountName: string, options?: BatchAccountGetOptionalParams) => Promise<BatchAccount>

getDetector

特定の Batch アカウントの特定の検出機能に関する情報を取得します。

getDetector: (resourceGroupName: string, accountName: string, detectorId: string, options?: BatchAccountGetDetectorOptionalParams) => Promise<DetectorResponse>

プロパティ値

(resourceGroupName: string, accountName: string, detectorId: string, options?: BatchAccountGetDetectorOptionalParams) => Promise<DetectorResponse>

getKeys

この操作は、'SharedKey' を含む allowedAuthenticationModes を持つ Batch アカウントにのみ適用されます。 Batch アカウントに allowedAuthenticationMode に 'SharedKey' が含まれていない場合、クライアントは認証に共有キーを使用できず、代わりに別の allowedAuthenticationModes を使用する必要があります。 この場合、キーの取得は失敗します。

getKeys: (resourceGroupName: string, accountName: string, options?: BatchAccountGetKeysOptionalParams) => Promise<BatchAccountKeys>

プロパティ値

(resourceGroupName: string, accountName: string, options?: BatchAccountGetKeysOptionalParams) => Promise<BatchAccountKeys>

list

サブスクリプションに関連付けられている Batch アカウントに関する情報を取得します。

list: (options?: BatchAccountListOptionalParams) => PagedAsyncIterableIterator<BatchAccount, BatchAccount[], PageSettings>

プロパティ値

(options?: BatchAccountListOptionalParams) => PagedAsyncIterableIterator<BatchAccount, BatchAccount[], PageSettings>

listByResourceGroup

指定したリソース グループに関連付けられている Batch アカウントに関する情報を取得します。

listByResourceGroup: (resourceGroupName: string, options?: BatchAccountListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<BatchAccount, BatchAccount[], PageSettings>

プロパティ値

(resourceGroupName: string, options?: BatchAccountListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<BatchAccount, BatchAccount[], PageSettings>

listDetectors

特定の Batch アカウントで使用可能な検出機能に関する情報を取得します。

listDetectors: (resourceGroupName: string, accountName: string, options?: BatchAccountListDetectorsOptionalParams) => PagedAsyncIterableIterator<DetectorResponse, DetectorResponse[], PageSettings>

プロパティ値

(resourceGroupName: string, accountName: string, options?: BatchAccountListDetectorsOptionalParams) => PagedAsyncIterableIterator<DetectorResponse, DetectorResponse[], PageSettings>

listOutboundNetworkDependenciesEndpoints

この Batch アカウントの Batch コンピューティング ノードが Batch サービス管理の一部として呼び出す可能性があるエンドポイントを一覧表示します。 指定した仮想ネットワーク内にプールをデプロイする場合は、ネットワークでこれらのエンドポイントへの送信アクセスが許可されていることを確認する必要があります。 これらのエンドポイントへのアクセスを許可しないと、Batch によって影響を受けるノードが使用不能としてマークされる可能性があります。 仮想ネットワーク内でのプールの作成の詳細については、「https://learn.microsoft.com/azure/batch/batch-virtual-network」を参照してください。

listOutboundNetworkDependenciesEndpoints: (resourceGroupName: string, accountName: string, options?: BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams) => PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>

プロパティ値

(resourceGroupName: string, accountName: string, options?: BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams) => PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>

regenerateKey

この操作は、'SharedKey' を含む allowedAuthenticationModes を持つ Batch アカウントにのみ適用されます。 Batch アカウントに allowedAuthenticationMode に 'SharedKey' が含まれていない場合、クライアントは認証に共有キーを使用できず、代わりに別の allowedAuthenticationModes を使用する必要があります。 この場合、キーの再生成は失敗します。

regenerateKey: (resourceGroupName: string, accountName: string, parameters: BatchAccountRegenerateKeyParameters, options?: BatchAccountRegenerateKeyOptionalParams) => Promise<BatchAccountKeys>

プロパティ値

(resourceGroupName: string, accountName: string, parameters: BatchAccountRegenerateKeyParameters, options?: BatchAccountRegenerateKeyOptionalParams) => Promise<BatchAccountKeys>

synchronizeAutoStorageKeys

ストレージ キー認証が使用されている場合にのみ、指定された Batch アカウント用に構成された自動ストレージ アカウントのアクセス キーを同期します。

synchronizeAutoStorageKeys: (resourceGroupName: string, accountName: string, options?: BatchAccountSynchronizeAutoStorageKeysOptionalParams) => Promise<void>

プロパティ値

(resourceGroupName: string, accountName: string, options?: BatchAccountSynchronizeAutoStorageKeysOptionalParams) => Promise<void>

update

既存の Batch アカウントのプロパティを更新します。

update: (resourceGroupName: string, accountName: string, parameters: BatchAccountUpdateParameters, options?: BatchAccountUpdateOptionalParams) => Promise<BatchAccount>

プロパティ値

(resourceGroupName: string, accountName: string, parameters: BatchAccountUpdateParameters, options?: BatchAccountUpdateOptionalParams) => Promise<BatchAccount>