BatchAccountOperations interface
Interface representing a BatchAccountOperations.
Methods
| begin |
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. |
| begin |
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. |
| begin |
Deletes the specified Batch account. |
| begin |
Deletes the specified Batch account. |
| get(string, string, Batch |
Gets information about the specified Batch account. |
| get |
Gets information about the given detector for a given Batch account. |
| get |
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(Batch |
Gets information about the Batch accounts associated with the subscription. |
| list |
Gets information about the Batch accounts associated with the specified resource group. |
| list |
Gets information about the detectors available for a given Batch account. |
| list |
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://docs.microsoft.com/en-us/azure/batch/batch-virtual-network. |
| regenerate |
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. |
| synchronize |
Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used. |
| update(string, string, Batch |
Updates the properties of an existing Batch account. |
Method Details
beginCreate(string, string, BatchAccountCreateParameters, BatchAccountCreateOptionalParams)
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.
function beginCreate(resourceGroupName: string, accountName: string, parameters: BatchAccountCreateParameters, options?: BatchAccountCreateOptionalParams): Promise<SimplePollerLike<OperationState<BatchAccount>, BatchAccount>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
- parameters
- BatchAccountCreateParameters
Additional parameters for account creation.
- options
- BatchAccountCreateOptionalParams
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<BatchAccount>, BatchAccount>>
beginCreateAndWait(string, string, BatchAccountCreateParameters, BatchAccountCreateOptionalParams)
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.
function beginCreateAndWait(resourceGroupName: string, accountName: string, parameters: BatchAccountCreateParameters, options?: BatchAccountCreateOptionalParams): Promise<BatchAccount>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
- parameters
- BatchAccountCreateParameters
Additional parameters for account creation.
- options
- BatchAccountCreateOptionalParams
The options parameters.
Returns
Promise<BatchAccount>
beginDelete(string, string, BatchAccountDeleteOptionalParams)
Deletes the specified Batch account.
function beginDelete(resourceGroupName: string, accountName: string, options?: BatchAccountDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- options
- BatchAccountDeleteOptionalParams
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, BatchAccountDeleteOptionalParams)
Deletes the specified Batch account.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, options?: BatchAccountDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- options
- BatchAccountDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, BatchAccountGetOptionalParams)
Gets information about the specified Batch account.
function get(resourceGroupName: string, accountName: string, options?: BatchAccountGetOptionalParams): Promise<BatchAccount>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- options
- BatchAccountGetOptionalParams
The options parameters.
Returns
Promise<BatchAccount>
getDetector(string, string, string, BatchAccountGetDetectorOptionalParams)
Gets information about the given detector for a given Batch account.
function getDetector(resourceGroupName: string, accountName: string, detectorId: string, options?: BatchAccountGetDetectorOptionalParams): Promise<DetectorResponse>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- detectorId
-
string
The name of the detector.
The options parameters.
Returns
Promise<DetectorResponse>
getKeys(string, string, BatchAccountGetKeysOptionalParams)
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.
function getKeys(resourceGroupName: string, accountName: string, options?: BatchAccountGetKeysOptionalParams): Promise<BatchAccountKeys>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
The options parameters.
Returns
Promise<BatchAccountKeys>
list(BatchAccountListOptionalParams)
Gets information about the Batch accounts associated with the subscription.
function list(options?: BatchAccountListOptionalParams): PagedAsyncIterableIterator<BatchAccount, BatchAccount[], PageSettings>Parameters
- options
- BatchAccountListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, BatchAccountListByResourceGroupOptionalParams)
Gets information about the Batch accounts associated with the specified resource group.
function listByResourceGroup(resourceGroupName: string, options?: BatchAccountListByResourceGroupOptionalParams): PagedAsyncIterableIterator<BatchAccount, BatchAccount[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
The options parameters.
Returns
listDetectors(string, string, BatchAccountListDetectorsOptionalParams)
Gets information about the detectors available for a given Batch account.
function listDetectors(resourceGroupName: string, accountName: string, options?: BatchAccountListDetectorsOptionalParams): PagedAsyncIterableIterator<DetectorResponse, DetectorResponse[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
The options parameters.
Returns
listOutboundNetworkDependenciesEndpoints(string, string, BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams)
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://docs.microsoft.com/en-us/azure/batch/batch-virtual-network.
function listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, accountName: string, options?: BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
The options parameters.
Returns
regenerateKey(string, string, BatchAccountRegenerateKeyParameters, BatchAccountRegenerateKeyOptionalParams)
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.
function regenerateKey(resourceGroupName: string, accountName: string, parameters: BatchAccountRegenerateKeyParameters, options?: BatchAccountRegenerateKeyOptionalParams): Promise<BatchAccountKeys>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- parameters
- BatchAccountRegenerateKeyParameters
The type of key to regenerate.
The options parameters.
Returns
Promise<BatchAccountKeys>
synchronizeAutoStorageKeys(string, string, BatchAccountSynchronizeAutoStorageKeysOptionalParams)
Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.
function synchronizeAutoStorageKeys(resourceGroupName: string, accountName: string, options?: BatchAccountSynchronizeAutoStorageKeysOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
The options parameters.
Returns
Promise<void>
update(string, string, BatchAccountUpdateParameters, BatchAccountUpdateOptionalParams)
Updates the properties of an existing Batch account.
function update(resourceGroupName: string, accountName: string, parameters: BatchAccountUpdateParameters, options?: BatchAccountUpdateOptionalParams): Promise<BatchAccount>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the Batch account.
- accountName
-
string
The name of the Batch account.
- parameters
- BatchAccountUpdateParameters
Additional parameters for account update.
- options
- BatchAccountUpdateOptionalParams
The options parameters.
Returns
Promise<BatchAccount>