Share via

BatchAccountOperations interface

Package:
@azure/arm-batch

Interface representing a BatchAccount operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
create

Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
delete
get

Gets information about the specified Batch account.
getDetector

Gets information about the given detector for a given Batch account.
getKeys

This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail.
list

Gets information about the Batch accounts associated with the subscription.
listByResourceGroup

Gets information about the Batch accounts associated with the specified resource group.
listDetectors

Gets information about the detectors available for a given Batch account.
listOutboundNetworkDependenciesEndpoints

Lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://dori-uw-1.kuma-moon.com/azure/batch/batch-virtual-network.
regenerateKey

This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, regenerating the keys will fail.
synchronizeAutoStorageKeys

Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.
update

Updates the properties of an existing Batch account.

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

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

Property Value

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

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

create

Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.

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

Property Value

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

delete 

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

Property Value

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

get

Gets information about the specified Batch account.

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

Property Value

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

getDetector

Gets information about the given detector for a given Batch account.

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

Property Value

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

getKeys

This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail.

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

Property Value

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

list

Gets information about the Batch accounts associated with the subscription.

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

Property Value

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

listByResourceGroup

Gets information about the Batch accounts associated with the specified resource group.

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

Property Value

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

listDetectors

Gets information about the detectors available for a given Batch account.

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

Property Value

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

listOutboundNetworkDependenciesEndpoints

Lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://dori-uw-1.kuma-moon.com/azure/batch/batch-virtual-network.

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

Property Value

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

regenerateKey

This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, regenerating the keys will fail.

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

Property Value

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

synchronizeAutoStorageKeys

Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.

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

Property Value

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

update

Updates the properties of an existing Batch account.

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

Property Value

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