1. Packages
  2. Azure Native
  3. API Docs
  4. batch
  5. getBatchAccount
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi

    Gets information about the specified Batch account.

    Uses Azure REST API version 2024-07-01.

    Other available API versions: 2023-05-01, 2023-11-01, 2024-02-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native batch [ApiVersion]. See the version guide for details.

    Using getBatchAccount

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBatchAccount(args: GetBatchAccountArgs, opts?: InvokeOptions): Promise<GetBatchAccountResult>
    function getBatchAccountOutput(args: GetBatchAccountOutputArgs, opts?: InvokeOptions): Output<GetBatchAccountResult>
    def get_batch_account(account_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetBatchAccountResult
    def get_batch_account_output(account_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetBatchAccountResult]
    func LookupBatchAccount(ctx *Context, args *LookupBatchAccountArgs, opts ...InvokeOption) (*LookupBatchAccountResult, error)
    func LookupBatchAccountOutput(ctx *Context, args *LookupBatchAccountOutputArgs, opts ...InvokeOption) LookupBatchAccountResultOutput

    > Note: This function is named LookupBatchAccount in the Go SDK.

    public static class GetBatchAccount 
    {
        public static Task<GetBatchAccountResult> InvokeAsync(GetBatchAccountArgs args, InvokeOptions? opts = null)
        public static Output<GetBatchAccountResult> Invoke(GetBatchAccountInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBatchAccountResult> getBatchAccount(GetBatchAccountArgs args, InvokeOptions options)
    public static Output<GetBatchAccountResult> getBatchAccount(GetBatchAccountArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:batch:getBatchAccount
      arguments:
        # arguments dictionary

    The following arguments are supported:

    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/.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    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/.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    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/.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    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/.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    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/.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    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/.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getBatchAccount Result

    The following output properties are available:

    AccountEndpoint string
    The account endpoint used to interact with the Batch service.
    ActiveJobAndJobScheduleQuota int
    The active job and job schedule quota for the Batch account.
    AllowedAuthenticationModes List<string>
    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.
    AutoStorage Pulumi.AzureNative.Batch.Outputs.AutoStoragePropertiesResponse
    Contains information about the auto-storage account associated with a Batch account.
    AzureApiVersion string
    The Azure API version of the resource.
    DedicatedCoreQuota int
    For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
    DedicatedCoreQuotaPerVMFamily List<Pulumi.AzureNative.Batch.Outputs.VirtualMachineFamilyCoreQuotaResponse>
    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.
    DedicatedCoreQuotaPerVMFamilyEnforced bool
    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.
    Encryption Pulumi.AzureNative.Batch.Outputs.EncryptionPropertiesResponse
    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.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    KeyVaultReference Pulumi.AzureNative.Batch.Outputs.KeyVaultReferenceResponse
    Identifies the Azure key vault associated with a Batch account.
    Location string
    The geo-location where the resource lives
    LowPriorityCoreQuota int
    For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
    Name string
    The name of the resource
    NodeManagementEndpoint string
    The endpoint used by compute node to connect to the Batch node management service.
    PoolAllocationMode string
    The allocation mode for creating pools in the Batch account.
    PoolQuota int
    The pool quota for the Batch account.
    PrivateEndpointConnections List<Pulumi.AzureNative.Batch.Outputs.PrivateEndpointConnectionResponse>
    List of private endpoint connections associated with the Batch account
    ProvisioningState string
    The provisioned state of the resource
    SystemData Pulumi.AzureNative.Batch.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Identity Pulumi.AzureNative.Batch.Outputs.BatchAccountIdentityResponse
    The identity of the Batch account.
    NetworkProfile Pulumi.AzureNative.Batch.Outputs.NetworkProfileResponse
    The network profile only takes effect when publicNetworkAccess is enabled.
    PublicNetworkAccess string
    The network access type for operating on the resources in the Batch account.
    Tags Dictionary<string, string>
    Resource tags.
    AccountEndpoint string
    The account endpoint used to interact with the Batch service.
    ActiveJobAndJobScheduleQuota int
    The active job and job schedule quota for the Batch account.
    AllowedAuthenticationModes []string
    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.
    AutoStorage AutoStoragePropertiesResponse
    Contains information about the auto-storage account associated with a Batch account.
    AzureApiVersion string
    The Azure API version of the resource.
    DedicatedCoreQuota int
    For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
    DedicatedCoreQuotaPerVMFamily []VirtualMachineFamilyCoreQuotaResponse
    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.
    DedicatedCoreQuotaPerVMFamilyEnforced bool
    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.
    Encryption EncryptionPropertiesResponse
    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.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    KeyVaultReference KeyVaultReferenceResponse
    Identifies the Azure key vault associated with a Batch account.
    Location string
    The geo-location where the resource lives
    LowPriorityCoreQuota int
    For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
    Name string
    The name of the resource
    NodeManagementEndpoint string
    The endpoint used by compute node to connect to the Batch node management service.
    PoolAllocationMode string
    The allocation mode for creating pools in the Batch account.
    PoolQuota int
    The pool quota for the Batch account.
    PrivateEndpointConnections []PrivateEndpointConnectionResponse
    List of private endpoint connections associated with the Batch account
    ProvisioningState string
    The provisioned state of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Identity BatchAccountIdentityResponse
    The identity of the Batch account.
    NetworkProfile NetworkProfileResponse
    The network profile only takes effect when publicNetworkAccess is enabled.
    PublicNetworkAccess string
    The network access type for operating on the resources in the Batch account.
    Tags map[string]string
    Resource tags.
    accountEndpoint String
    The account endpoint used to interact with the Batch service.
    activeJobAndJobScheduleQuota Integer
    The active job and job schedule quota for the Batch account.
    allowedAuthenticationModes List<String>
    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.
    autoStorage AutoStoragePropertiesResponse
    Contains information about the auto-storage account associated with a Batch account.
    azureApiVersion String
    The Azure API version of the resource.
    dedicatedCoreQuota Integer
    For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
    dedicatedCoreQuotaPerVMFamily List<VirtualMachineFamilyCoreQuotaResponse>
    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.
    dedicatedCoreQuotaPerVMFamilyEnforced Boolean
    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.
    encryption EncryptionPropertiesResponse
    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.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    keyVaultReference KeyVaultReferenceResponse
    Identifies the Azure key vault associated with a Batch account.
    location String
    The geo-location where the resource lives
    lowPriorityCoreQuota Integer
    For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
    name String
    The name of the resource
    nodeManagementEndpoint String
    The endpoint used by compute node to connect to the Batch node management service.
    poolAllocationMode String
    The allocation mode for creating pools in the Batch account.
    poolQuota Integer
    The pool quota for the Batch account.
    privateEndpointConnections List<PrivateEndpointConnectionResponse>
    List of private endpoint connections associated with the Batch account
    provisioningState String
    The provisioned state of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    identity BatchAccountIdentityResponse
    The identity of the Batch account.
    networkProfile NetworkProfileResponse
    The network profile only takes effect when publicNetworkAccess is enabled.
    publicNetworkAccess String
    The network access type for operating on the resources in the Batch account.
    tags Map<String,String>
    Resource tags.
    accountEndpoint string
    The account endpoint used to interact with the Batch service.
    activeJobAndJobScheduleQuota number
    The active job and job schedule quota for the Batch account.
    allowedAuthenticationModes string[]
    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.
    autoStorage AutoStoragePropertiesResponse
    Contains information about the auto-storage account associated with a Batch account.
    azureApiVersion string
    The Azure API version of the resource.
    dedicatedCoreQuota number
    For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
    dedicatedCoreQuotaPerVMFamily VirtualMachineFamilyCoreQuotaResponse[]
    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.
    dedicatedCoreQuotaPerVMFamilyEnforced boolean
    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.
    encryption EncryptionPropertiesResponse
    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.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    keyVaultReference KeyVaultReferenceResponse
    Identifies the Azure key vault associated with a Batch account.
    location string
    The geo-location where the resource lives
    lowPriorityCoreQuota number
    For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
    name string
    The name of the resource
    nodeManagementEndpoint string
    The endpoint used by compute node to connect to the Batch node management service.
    poolAllocationMode string
    The allocation mode for creating pools in the Batch account.
    poolQuota number
    The pool quota for the Batch account.
    privateEndpointConnections PrivateEndpointConnectionResponse[]
    List of private endpoint connections associated with the Batch account
    provisioningState string
    The provisioned state of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    identity BatchAccountIdentityResponse
    The identity of the Batch account.
    networkProfile NetworkProfileResponse
    The network profile only takes effect when publicNetworkAccess is enabled.
    publicNetworkAccess string
    The network access type for operating on the resources in the Batch account.
    tags {[key: string]: string}
    Resource tags.
    account_endpoint str
    The account endpoint used to interact with the Batch service.
    active_job_and_job_schedule_quota int
    The active job and job schedule quota for the Batch account.
    allowed_authentication_modes Sequence[str]
    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.
    auto_storage AutoStoragePropertiesResponse
    Contains information about the auto-storage account associated with a Batch account.
    azure_api_version str
    The Azure API version of the resource.
    dedicated_core_quota int
    For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
    dedicated_core_quota_per_vm_family Sequence[VirtualMachineFamilyCoreQuotaResponse]
    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.
    dedicated_core_quota_per_vm_family_enforced bool
    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.
    encryption EncryptionPropertiesResponse
    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.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    key_vault_reference KeyVaultReferenceResponse
    Identifies the Azure key vault associated with a Batch account.
    location str
    The geo-location where the resource lives
    low_priority_core_quota int
    For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
    name str
    The name of the resource
    node_management_endpoint str
    The endpoint used by compute node to connect to the Batch node management service.
    pool_allocation_mode str
    The allocation mode for creating pools in the Batch account.
    pool_quota int
    The pool quota for the Batch account.
    private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
    List of private endpoint connections associated with the Batch account
    provisioning_state str
    The provisioned state of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    identity BatchAccountIdentityResponse
    The identity of the Batch account.
    network_profile NetworkProfileResponse
    The network profile only takes effect when publicNetworkAccess is enabled.
    public_network_access str
    The network access type for operating on the resources in the Batch account.
    tags Mapping[str, str]
    Resource tags.
    accountEndpoint String
    The account endpoint used to interact with the Batch service.
    activeJobAndJobScheduleQuota Number
    The active job and job schedule quota for the Batch account.
    allowedAuthenticationModes List<String>
    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.
    autoStorage Property Map
    Contains information about the auto-storage account associated with a Batch account.
    azureApiVersion String
    The Azure API version of the resource.
    dedicatedCoreQuota Number
    For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
    dedicatedCoreQuotaPerVMFamily List<Property Map>
    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.
    dedicatedCoreQuotaPerVMFamilyEnforced Boolean
    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.
    encryption Property Map
    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.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    keyVaultReference Property Map
    Identifies the Azure key vault associated with a Batch account.
    location String
    The geo-location where the resource lives
    lowPriorityCoreQuota Number
    For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
    name String
    The name of the resource
    nodeManagementEndpoint String
    The endpoint used by compute node to connect to the Batch node management service.
    poolAllocationMode String
    The allocation mode for creating pools in the Batch account.
    poolQuota Number
    The pool quota for the Batch account.
    privateEndpointConnections List<Property Map>
    List of private endpoint connections associated with the Batch account
    provisioningState String
    The provisioned state of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    identity Property Map
    The identity of the Batch account.
    networkProfile Property Map
    The network profile only takes effect when publicNetworkAccess is enabled.
    publicNetworkAccess String
    The network access type for operating on the resources in the Batch account.
    tags Map<String>
    Resource tags.

    Supporting Types

    AutoStoragePropertiesResponse

    LastKeySync string
    The UTC time at which storage keys were last synchronized with the Batch account.
    StorageAccountId string
    The resource ID of the storage account to be used for auto-storage account.
    AuthenticationMode string
    The authentication mode which the Batch service will use to manage the auto-storage account.
    NodeIdentityReference Pulumi.AzureNative.Batch.Inputs.ComputeNodeIdentityReferenceResponse
    The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
    LastKeySync string
    The UTC time at which storage keys were last synchronized with the Batch account.
    StorageAccountId string
    The resource ID of the storage account to be used for auto-storage account.
    AuthenticationMode string
    The authentication mode which the Batch service will use to manage the auto-storage account.
    NodeIdentityReference ComputeNodeIdentityReferenceResponse
    The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
    lastKeySync String
    The UTC time at which storage keys were last synchronized with the Batch account.
    storageAccountId String
    The resource ID of the storage account to be used for auto-storage account.
    authenticationMode String
    The authentication mode which the Batch service will use to manage the auto-storage account.
    nodeIdentityReference ComputeNodeIdentityReferenceResponse
    The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
    lastKeySync string
    The UTC time at which storage keys were last synchronized with the Batch account.
    storageAccountId string
    The resource ID of the storage account to be used for auto-storage account.
    authenticationMode string
    The authentication mode which the Batch service will use to manage the auto-storage account.
    nodeIdentityReference ComputeNodeIdentityReferenceResponse
    The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
    last_key_sync str
    The UTC time at which storage keys were last synchronized with the Batch account.
    storage_account_id str
    The resource ID of the storage account to be used for auto-storage account.
    authentication_mode str
    The authentication mode which the Batch service will use to manage the auto-storage account.
    node_identity_reference ComputeNodeIdentityReferenceResponse
    The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.
    lastKeySync String
    The UTC time at which storage keys were last synchronized with the Batch account.
    storageAccountId String
    The resource ID of the storage account to be used for auto-storage account.
    authenticationMode String
    The authentication mode which the Batch service will use to manage the auto-storage account.
    nodeIdentityReference Property Map
    The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.

    BatchAccountIdentityResponse

    PrincipalId string
    The principal id of the Batch account. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
    Type string
    The type of identity used for the Batch account.
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Batch.Inputs.UserAssignedIdentitiesResponse>
    The list of user identities associated with the Batch account.
    PrincipalId string
    The principal id of the Batch account. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
    Type string
    The type of identity used for the Batch account.
    UserAssignedIdentities map[string]UserAssignedIdentitiesResponse
    The list of user identities associated with the Batch account.
    principalId String
    The principal id of the Batch account. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
    type String
    The type of identity used for the Batch account.
    userAssignedIdentities Map<String,UserAssignedIdentitiesResponse>
    The list of user identities associated with the Batch account.
    principalId string
    The principal id of the Batch account. This property will only be provided for a system assigned identity.
    tenantId string
    The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
    type string
    The type of identity used for the Batch account.
    userAssignedIdentities {[key: string]: UserAssignedIdentitiesResponse}
    The list of user identities associated with the Batch account.
    principal_id str
    The principal id of the Batch account. This property will only be provided for a system assigned identity.
    tenant_id str
    The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
    type str
    The type of identity used for the Batch account.
    user_assigned_identities Mapping[str, UserAssignedIdentitiesResponse]
    The list of user identities associated with the Batch account.
    principalId String
    The principal id of the Batch account. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
    type String
    The type of identity used for the Batch account.
    userAssignedIdentities Map<Property Map>
    The list of user identities associated with the Batch account.

    ComputeNodeIdentityReferenceResponse

    ResourceId string
    The ARM resource id of the user assigned identity.
    ResourceId string
    The ARM resource id of the user assigned identity.
    resourceId String
    The ARM resource id of the user assigned identity.
    resourceId string
    The ARM resource id of the user assigned identity.
    resource_id str
    The ARM resource id of the user assigned identity.
    resourceId String
    The ARM resource id of the user assigned identity.

    EncryptionPropertiesResponse

    KeySource string
    Type of the key source.
    KeyVaultProperties Pulumi.AzureNative.Batch.Inputs.KeyVaultPropertiesResponse
    Additional details when using Microsoft.KeyVault
    KeySource string
    Type of the key source.
    KeyVaultProperties KeyVaultPropertiesResponse
    Additional details when using Microsoft.KeyVault
    keySource String
    Type of the key source.
    keyVaultProperties KeyVaultPropertiesResponse
    Additional details when using Microsoft.KeyVault
    keySource string
    Type of the key source.
    keyVaultProperties KeyVaultPropertiesResponse
    Additional details when using Microsoft.KeyVault
    key_source str
    Type of the key source.
    key_vault_properties KeyVaultPropertiesResponse
    Additional details when using Microsoft.KeyVault
    keySource String
    Type of the key source.
    keyVaultProperties Property Map
    Additional details when using Microsoft.KeyVault

    EndpointAccessProfileResponse

    DefaultAction string
    Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
    IpRules List<Pulumi.AzureNative.Batch.Inputs.IPRuleResponse>
    Array of IP ranges to filter client IP address.
    DefaultAction string
    Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
    IpRules []IPRuleResponse
    Array of IP ranges to filter client IP address.
    defaultAction String
    Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
    ipRules List<IPRuleResponse>
    Array of IP ranges to filter client IP address.
    defaultAction string
    Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
    ipRules IPRuleResponse[]
    Array of IP ranges to filter client IP address.
    default_action str
    Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
    ip_rules Sequence[IPRuleResponse]
    Array of IP ranges to filter client IP address.
    defaultAction String
    Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.
    ipRules List<Property Map>
    Array of IP ranges to filter client IP address.

    IPRuleResponse

    Action string
    Action when client IP address is matched.
    Value string
    IPv4 address, or IPv4 address range in CIDR format.
    Action string
    Action when client IP address is matched.
    Value string
    IPv4 address, or IPv4 address range in CIDR format.
    action String
    Action when client IP address is matched.
    value String
    IPv4 address, or IPv4 address range in CIDR format.
    action string
    Action when client IP address is matched.
    value string
    IPv4 address, or IPv4 address range in CIDR format.
    action str
    Action when client IP address is matched.
    value str
    IPv4 address, or IPv4 address range in CIDR format.
    action String
    Action when client IP address is matched.
    value String
    IPv4 address, or IPv4 address range in CIDR format.

    KeyVaultPropertiesResponse

    KeyIdentifier string

    Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

    The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

    KeyIdentifier string

    Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

    The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

    keyIdentifier String

    Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

    The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

    keyIdentifier string

    Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

    The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

    key_identifier str

    Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

    The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

    keyIdentifier String

    Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:

    The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled

    KeyVaultReferenceResponse

    Id string
    The resource ID of the Azure key vault associated with the Batch account.
    Url string
    The URL of the Azure key vault associated with the Batch account.
    Id string
    The resource ID of the Azure key vault associated with the Batch account.
    Url string
    The URL of the Azure key vault associated with the Batch account.
    id String
    The resource ID of the Azure key vault associated with the Batch account.
    url String
    The URL of the Azure key vault associated with the Batch account.
    id string
    The resource ID of the Azure key vault associated with the Batch account.
    url string
    The URL of the Azure key vault associated with the Batch account.
    id str
    The resource ID of the Azure key vault associated with the Batch account.
    url str
    The URL of the Azure key vault associated with the Batch account.
    id String
    The resource ID of the Azure key vault associated with the Batch account.
    url String
    The URL of the Azure key vault associated with the Batch account.

    NetworkProfileResponse

    AccountAccess Pulumi.AzureNative.Batch.Inputs.EndpointAccessProfileResponse
    Network access profile for batchAccount endpoint (Batch account data plane API).
    NodeManagementAccess Pulumi.AzureNative.Batch.Inputs.EndpointAccessProfileResponse
    Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
    AccountAccess EndpointAccessProfileResponse
    Network access profile for batchAccount endpoint (Batch account data plane API).
    NodeManagementAccess EndpointAccessProfileResponse
    Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
    accountAccess EndpointAccessProfileResponse
    Network access profile for batchAccount endpoint (Batch account data plane API).
    nodeManagementAccess EndpointAccessProfileResponse
    Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
    accountAccess EndpointAccessProfileResponse
    Network access profile for batchAccount endpoint (Batch account data plane API).
    nodeManagementAccess EndpointAccessProfileResponse
    Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
    account_access EndpointAccessProfileResponse
    Network access profile for batchAccount endpoint (Batch account data plane API).
    node_management_access EndpointAccessProfileResponse
    Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).
    accountAccess Property Map
    Network access profile for batchAccount endpoint (Batch account data plane API).
    nodeManagementAccess Property Map
    Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools).

    PrivateEndpointConnectionResponse

    Etag string
    The ETag of the resource, used for concurrency statements.
    GroupIds List<string>
    The value has one and only one group id.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    PrivateEndpoint Pulumi.AzureNative.Batch.Inputs.PrivateEndpointResponse
    The private endpoint of the private endpoint connection.
    ProvisioningState string
    The provisioning state of the private endpoint connection.
    SystemData Pulumi.AzureNative.Batch.Inputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Batch.Inputs.PrivateLinkServiceConnectionStateResponse
    The private link service connection state of the private endpoint connection.
    Tags Dictionary<string, string>
    The tags of the resource.
    Etag string
    The ETag of the resource, used for concurrency statements.
    GroupIds []string
    The value has one and only one group id.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    PrivateEndpoint PrivateEndpointResponse
    The private endpoint of the private endpoint connection.
    ProvisioningState string
    The provisioning state of the private endpoint connection.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    The private link service connection state of the private endpoint connection.
    Tags map[string]string
    The tags of the resource.
    etag String
    The ETag of the resource, used for concurrency statements.
    groupIds List<String>
    The value has one and only one group id.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    privateEndpoint PrivateEndpointResponse
    The private endpoint of the private endpoint connection.
    provisioningState String
    The provisioning state of the private endpoint connection.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    The private link service connection state of the private endpoint connection.
    tags Map<String,String>
    The tags of the resource.
    etag string
    The ETag of the resource, used for concurrency statements.
    groupIds string[]
    The value has one and only one group id.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    privateEndpoint PrivateEndpointResponse
    The private endpoint of the private endpoint connection.
    provisioningState string
    The provisioning state of the private endpoint connection.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    The private link service connection state of the private endpoint connection.
    tags {[key: string]: string}
    The tags of the resource.
    etag str
    The ETag of the resource, used for concurrency statements.
    group_ids Sequence[str]
    The value has one and only one group id.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    private_endpoint PrivateEndpointResponse
    The private endpoint of the private endpoint connection.
    provisioning_state str
    The provisioning state of the private endpoint connection.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
    The private link service connection state of the private endpoint connection.
    tags Mapping[str, str]
    The tags of the resource.
    etag String
    The ETag of the resource, used for concurrency statements.
    groupIds List<String>
    The value has one and only one group id.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    privateEndpoint Property Map
    The private endpoint of the private endpoint connection.
    provisioningState String
    The provisioning state of the private endpoint connection.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateLinkServiceConnectionState Property Map
    The private link service connection state of the private endpoint connection.
    tags Map<String>
    The tags of the resource.

    PrivateEndpointResponse

    Id string
    The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.
    Id string
    The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.
    id String
    The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.
    id string
    The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.
    id str
    The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.
    id String
    The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

    PrivateLinkServiceConnectionStateResponse

    ActionsRequired string
    Action required on the private connection state
    Status string
    The status of the Batch private endpoint connection
    Description string
    Description of the private Connection state
    ActionsRequired string
    Action required on the private connection state
    Status string
    The status of the Batch private endpoint connection
    Description string
    Description of the private Connection state
    actionsRequired String
    Action required on the private connection state
    status String
    The status of the Batch private endpoint connection
    description String
    Description of the private Connection state
    actionsRequired string
    Action required on the private connection state
    status string
    The status of the Batch private endpoint connection
    description string
    Description of the private Connection state
    actions_required str
    Action required on the private connection state
    status str
    The status of the Batch private endpoint connection
    description str
    Description of the private Connection state
    actionsRequired String
    Action required on the private connection state
    status String
    The status of the Batch private endpoint connection
    description String
    Description of the private Connection state

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    UserAssignedIdentitiesResponse

    ClientId string
    The client id of user assigned identity.
    PrincipalId string
    The principal id of user assigned identity.
    ClientId string
    The client id of user assigned identity.
    PrincipalId string
    The principal id of user assigned identity.
    clientId String
    The client id of user assigned identity.
    principalId String
    The principal id of user assigned identity.
    clientId string
    The client id of user assigned identity.
    principalId string
    The principal id of user assigned identity.
    client_id str
    The client id of user assigned identity.
    principal_id str
    The principal id of user assigned identity.
    clientId String
    The client id of user assigned identity.
    principalId String
    The principal id of user assigned identity.

    VirtualMachineFamilyCoreQuotaResponse

    CoreQuota int
    The core quota for the VM family for the Batch account.
    Name string
    The Virtual Machine family name.
    CoreQuota int
    The core quota for the VM family for the Batch account.
    Name string
    The Virtual Machine family name.
    coreQuota Integer
    The core quota for the VM family for the Batch account.
    name String
    The Virtual Machine family name.
    coreQuota number
    The core quota for the VM family for the Batch account.
    name string
    The Virtual Machine family name.
    core_quota int
    The core quota for the VM family for the Batch account.
    name str
    The Virtual Machine family name.
    coreQuota Number
    The core quota for the VM family for the Batch account.
    name String
    The Virtual Machine family name.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate