Package com.azure.resourcemanager.batch.fluent

Interface BatchAccountsClient

public interface BatchAccountsClient
An instance of this class provides access to all the operations defined in BatchAccountsClient.

  • Method Details

    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<BatchAccountInner>,BatchAccountInner> beginCreate(String resourceGroupName, String accountName, BatchAccountCreateParameters parameters)
      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.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - 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 - Additional parameters for account creation.
      Returns:
      the SyncPoller for polling of contains information about an Azure Batch account.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<BatchAccountInner>,BatchAccountInner> beginCreate(String resourceGroupName, String accountName, BatchAccountCreateParameters parameters, com.azure.core.util.Context context)
      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.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - 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 - Additional parameters for account creation.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of contains information about an Azure Batch account.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • create

      BatchAccountInner create(String resourceGroupName, String accountName, BatchAccountCreateParameters parameters)
      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.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - 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 - Additional parameters for account creation.
      Returns:
      contains information about an Azure Batch account.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • create

      BatchAccountInner create(String resourceGroupName, String accountName, BatchAccountCreateParameters parameters, com.azure.core.util.Context context)
      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.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - 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 - Additional parameters for account creation.
      context - The context to associate with this operation.
      Returns:
      contains information about an Azure Batch account.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updateWithResponse

      com.azure.core.http.rest.Response<BatchAccountInner> updateWithResponse(String resourceGroupName, String accountName, BatchAccountUpdateParameters parameters, com.azure.core.util.Context context)
      Updates the properties of an existing Batch account.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      parameters - Additional parameters for account update.
      context - The context to associate with this operation.
      Returns:
      contains information about an Azure Batch account along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • update

      BatchAccountInner update(String resourceGroupName, String accountName, BatchAccountUpdateParameters parameters)
      Updates the properties of an existing Batch account.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      parameters - Additional parameters for account update.
      Returns:
      contains information about an Azure Batch account.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName)
      Deletes the specified Batch account.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      Deletes the specified Batch account.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String accountName)
      Deletes the specified Batch account.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      Deletes the specified Batch account.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<BatchAccountInner> getByResourceGroupWithResponse(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      Gets information about the specified Batch account.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      context - The context to associate with this operation.
      Returns:
      information about the specified Batch account along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByResourceGroup

      BatchAccountInner getByResourceGroup(String resourceGroupName, String accountName)
      Gets information about the specified Batch account.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      Returns:
      information about the specified Batch account.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<BatchAccountInner> list()
      Gets information about the Batch accounts associated with the subscription.
      Returns:
      information about the Batch accounts associated with the subscription as paginated response with PagedIterable.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<BatchAccountInner> list(com.azure.core.util.Context context)
      Gets information about the Batch accounts associated with the subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      information about the Batch accounts associated with the subscription as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<BatchAccountInner> listByResourceGroup(String resourceGroupName)
      Gets information about the Batch accounts associated with the specified resource group.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      Returns:
      information about the Batch accounts associated with the specified resource group as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<BatchAccountInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Gets information about the Batch accounts associated with the specified resource group.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      context - The context to associate with this operation.
      Returns:
      information about the Batch accounts associated with the specified resource group as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • synchronizeAutoStorageKeysWithResponse

      com.azure.core.http.rest.Response<Void> synchronizeAutoStorageKeysWithResponse(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • synchronizeAutoStorageKeys

      void synchronizeAutoStorageKeys(String resourceGroupName, String accountName)
      Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • regenerateKeyWithResponse

      com.azure.core.http.rest.Response<BatchAccountKeysInner> regenerateKeyWithResponse(String resourceGroupName, String accountName, BatchAccountRegenerateKeyParameters parameters, com.azure.core.util.Context context)
      Regenerates the specified account key for the Batch account.

      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      parameters - The type of key to regenerate.
      context - The context to associate with this operation.
      Returns:
      a set of Azure Batch account keys along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • regenerateKey

      BatchAccountKeysInner regenerateKey(String resourceGroupName, String accountName, BatchAccountRegenerateKeyParameters parameters)
      Regenerates the specified account key for the Batch account.

      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      parameters - The type of key to regenerate.
      Returns:
      a set of Azure Batch account keys.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getKeysWithResponse

      com.azure.core.http.rest.Response<BatchAccountKeysInner> getKeysWithResponse(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      Gets the account keys for the specified Batch account.

      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      context - The context to associate with this operation.
      Returns:
      a set of Azure Batch account keys along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getKeys

      BatchAccountKeysInner getKeys(String resourceGroupName, String accountName)
      Gets the account keys for the specified Batch account.

      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.

      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      Returns:
      a set of Azure Batch account keys.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listDetectors

      com.azure.core.http.rest.PagedIterable<DetectorResponseInner> listDetectors(String resourceGroupName, String accountName)
      Gets information about the detectors available for a given Batch account.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      Returns:
      information about the detectors available for a given Batch account as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listDetectors

      com.azure.core.http.rest.PagedIterable<DetectorResponseInner> listDetectors(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      Gets information about the detectors available for a given Batch account.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      context - The context to associate with this operation.
      Returns:
      information about the detectors available for a given Batch account as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getDetectorWithResponse

      com.azure.core.http.rest.Response<DetectorResponseInner> getDetectorWithResponse(String resourceGroupName, String accountName, String detectorId, com.azure.core.util.Context context)
      Gets information about the given detector for a given Batch account.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      detectorId - The name of the detector.
      context - The context to associate with this operation.
      Returns:
      information about the given detector for a given Batch account along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getDetector

      DetectorResponseInner getDetector(String resourceGroupName, String accountName, String detectorId)
      Gets information about the given detector for a given Batch account.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      detectorId - The name of the detector.
      Returns:
      information about the given detector for a given Batch account.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listOutboundNetworkDependenciesEndpoints

      com.azure.core.http.rest.PagedIterable<OutboundEnvironmentEndpointInner> listOutboundNetworkDependenciesEndpoints(String resourceGroupName, String accountName)
      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.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      Returns:
      values returned by the List operation as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listOutboundNetworkDependenciesEndpoints

      com.azure.core.http.rest.PagedIterable<OutboundEnvironmentEndpointInner> listOutboundNetworkDependenciesEndpoints(String resourceGroupName, String accountName, com.azure.core.util.Context context)
      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.
      Parameters:
      resourceGroupName - The name of the resource group that contains the Batch account.
      accountName - The name of the Batch account.
      context - The context to associate with this operation.
      Returns:
      values returned by the List operation as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.