Package com.azure.resourcemanager.batch.models

Interface BatchAccount

public interface BatchAccount
An immutable client-side representation of BatchAccount.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • identity

      BatchAccountIdentity identity()
      Gets the identity property: The identity of the Batch account.
      Returns:
      the identity value.

    • accountEndpoint

      String accountEndpoint()
      Gets the accountEndpoint property: The account endpoint used to interact with the Batch service.
      Returns:
      the accountEndpoint value.

    • nodeManagementEndpoint

      String nodeManagementEndpoint()
      Gets the nodeManagementEndpoint property: The endpoint used by compute node to connect to the Batch node management service.
      Returns:
      the nodeManagementEndpoint value.

    • provisioningState

      ProvisioningState provisioningState()
      Gets the provisioningState property: The provisioned state of the resource.
      Returns:
      the provisioningState value.

    • poolAllocationMode

      PoolAllocationMode poolAllocationMode()
      Gets the poolAllocationMode property: The allocation mode for creating pools in the Batch account.
      Returns:
      the poolAllocationMode value.

    • keyVaultReference

      KeyVaultReference keyVaultReference()
      Gets the keyVaultReference property: Identifies the Azure key vault associated with a Batch account.
      Returns:
      the keyVaultReference value.

    • publicNetworkAccess

      PublicNetworkAccessType publicNetworkAccess()
      Gets the publicNetworkAccess property: If not specified, the default value is 'enabled'.
      Returns:
      the publicNetworkAccess value.

    • networkProfile

      NetworkProfile networkProfile()
      Gets the networkProfile property: The network profile only takes effect when publicNetworkAccess is enabled.
      Returns:
      the networkProfile value.

    • privateEndpointConnections

      List<PrivateEndpointConnection> privateEndpointConnections()
      Gets the privateEndpointConnections property: List of private endpoint connections associated with the Batch account.
      Returns:
      the privateEndpointConnections value.

    • autoStorage

      AutoStorageProperties autoStorage()
      Gets the autoStorage property: Contains information about the auto-storage account associated with a Batch account.
      Returns:
      the autoStorage value.

    • encryption

      EncryptionProperties encryption()
      Gets the encryption property: Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
      Returns:
      the encryption value.

    • dedicatedCoreQuota

      Integer dedicatedCoreQuota()
      Gets the dedicatedCoreQuota property: The dedicated core quota for the Batch account.

      For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.

      Returns:
      the dedicatedCoreQuota value.

    • lowPriorityCoreQuota

      Integer lowPriorityCoreQuota()
      Gets the lowPriorityCoreQuota property: The Spot/low-priority core quota for the Batch account.

      For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.

      Returns:
      the lowPriorityCoreQuota value.

    • dedicatedCoreQuotaPerVMFamily

      List<VirtualMachineFamilyCoreQuota> dedicatedCoreQuotaPerVMFamily()
      Gets the dedicatedCoreQuotaPerVMFamily property: A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
      Returns:
      the dedicatedCoreQuotaPerVMFamily value.

    • dedicatedCoreQuotaPerVMFamilyEnforced

      Boolean dedicatedCoreQuotaPerVMFamilyEnforced()
      Gets the dedicatedCoreQuotaPerVMFamilyEnforced property: A value indicating whether core quotas per Virtual Machine family are enforced for this account

      If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family.

      Returns:
      the dedicatedCoreQuotaPerVMFamilyEnforced value.

    • poolQuota

      Integer poolQuota()
      Gets the poolQuota property: The pool quota for the Batch account.
      Returns:
      the poolQuota value.

    • activeJobAndJobScheduleQuota

      Integer activeJobAndJobScheduleQuota()
      Gets the activeJobAndJobScheduleQuota property: The active job and job schedule quota for the Batch account.
      Returns:
      the activeJobAndJobScheduleQuota value.

    • allowedAuthenticationModes

      List<AuthenticationMode> allowedAuthenticationModes()
      Gets the allowedAuthenticationModes property: List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
      Returns:
      the allowedAuthenticationModes value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      BatchAccountInner innerModel()
      Gets the inner com.azure.resourcemanager.batch.fluent.models.BatchAccountInner object.
      Returns:
      the inner object.

    • update

      BatchAccount.Update update()
      Begins update for the BatchAccount resource.
      Returns:
      the stage of resource update.

    • refresh

      BatchAccount refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      BatchAccount refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • synchronizeAutoStorageKeysWithResponse

      com.azure.core.http.rest.Response<Void> synchronizeAutoStorageKeysWithResponse(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:
      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()
      Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.
      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.

    • regenerateKeyWithResponse

      com.azure.core.http.rest.Response<BatchAccountKeys> regenerateKeyWithResponse(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:
      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

      BatchAccountKeys regenerateKey(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:
      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<BatchAccountKeys> getKeysWithResponse(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:
      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

      BatchAccountKeys getKeys()
      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.

      Returns:
      a set of Azure Batch account keys.
      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.