BatchAccountOperations interface
代表 BatchAccountOperations 的介面。
方法
方法詳細資料
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 個字元之間，而且只能使用數位和小寫字母。 此名稱會用來做為 DNS 名稱的一部分，用來存取帳戶建立所在區域中的 Batch 服務。 例如：http://accountname.region.batch.azure.com/。
- parameters
- BatchAccountCreateParameters
帳戶建立的其他參數。
- options
- BatchAccountCreateOptionalParams
選項參數。
傳回
Promise<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 個字元之間，而且只能使用數位和小寫字母。 此名稱會用來做為 DNS 名稱的一部分，用來存取帳戶建立所在區域中的 Batch 服務。 例如：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<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/en-us/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>