Azure Native v2.89.1, Mar 2 25

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.batch.getBatchAccount

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

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: The name of the Batch account.
ResourceGroupName string: The name of the resource group that contains the Batch account.

AccountName string: The name of the Batch account.
ResourceGroupName string: The name of the resource group that contains the Batch account.

accountName String: The name of the Batch account.
resourceGroupName String: The name of the resource group that contains the Batch account.

accountName string: The name of the Batch account.
resourceGroupName string: The name of the resource group that contains the Batch account.

account_name str: The name of the Batch account.
resource_group_name str: The name of the resource group that contains the Batch account.

accountName String: The name of the Batch account.
resourceGroupName String: The name of the resource group that contains the Batch account.

getBatchAccount Result

The following output properties are available:

AccountEndpoint string: The account endpoint used to interact with the Batch service.
ActiveJobAndJobScheduleQuota int
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.
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: The ID of the resource.
KeyVaultReference Pulumi.AzureNative.Batch.Outputs.KeyVaultReferenceResponse: Identifies the Azure key vault associated with a Batch account.
Location string: The location of the resource.
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
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
Tags Dictionary<string, string>: The tags of the resource.
Type string: The type of the resource.
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: If not specified, the default value is 'enabled'.

AccountEndpoint string: The account endpoint used to interact with the Batch service.
ActiveJobAndJobScheduleQuota int
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.
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: The ID of the resource.
KeyVaultReference KeyVaultReferenceResponse: Identifies the Azure key vault associated with a Batch account.
Location string: The location of the resource.
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
PrivateEndpointConnections []PrivateEndpointConnectionResponse: List of private endpoint connections associated with the Batch account
ProvisioningState string: The provisioned state of the resource
Tags map[string]string: The tags of the resource.
Type string: The type of the resource.
Identity BatchAccountIdentityResponse: The identity of the Batch account.
NetworkProfile NetworkProfileResponse: The network profile only takes effect when publicNetworkAccess is enabled.
PublicNetworkAccess string: If not specified, the default value is 'enabled'.

accountEndpoint String: The account endpoint used to interact with the Batch service.
activeJobAndJobScheduleQuota Integer
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.
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: The ID of the resource.
keyVaultReference KeyVaultReferenceResponse: Identifies the Azure key vault associated with a Batch account.
location String: The location of the resource.
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
privateEndpointConnections List<PrivateEndpointConnectionResponse>: List of private endpoint connections associated with the Batch account
provisioningState String: The provisioned state of the resource
tags Map<String,String>: The tags of the resource.
type String: The type of the resource.
identity BatchAccountIdentityResponse: The identity of the Batch account.
networkProfile NetworkProfileResponse: The network profile only takes effect when publicNetworkAccess is enabled.
publicNetworkAccess String: If not specified, the default value is 'enabled'.

accountEndpoint string: The account endpoint used to interact with the Batch service.
activeJobAndJobScheduleQuota number
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.
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: The ID of the resource.
keyVaultReference KeyVaultReferenceResponse: Identifies the Azure key vault associated with a Batch account.
location string: The location of the resource.
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
privateEndpointConnections PrivateEndpointConnectionResponse[]: List of private endpoint connections associated with the Batch account
provisioningState string: The provisioned state of the resource
tags {[key: string]: string}: The tags of the resource.
type string: The type of the resource.
identity BatchAccountIdentityResponse: The identity of the Batch account.
networkProfile NetworkProfileResponse: The network profile only takes effect when publicNetworkAccess is enabled.
publicNetworkAccess string: If not specified, the default value is 'enabled'.

account_endpoint str: The account endpoint used to interact with the Batch service.
active_job_and_job_schedule_quota int
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.
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: The ID of the resource.
key_vault_reference KeyVaultReferenceResponse: Identifies the Azure key vault associated with a Batch account.
location str: The location of the resource.
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
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]: List of private endpoint connections associated with the Batch account
provisioning_state str: The provisioned state of the resource
tags Mapping[str, str]: The tags of the resource.
type str: The type of the resource.
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: If not specified, the default value is 'enabled'.

accountEndpoint String: The account endpoint used to interact with the Batch service.
activeJobAndJobScheduleQuota Number
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.
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: The ID of the resource.
keyVaultReference Property Map: Identifies the Azure key vault associated with a Batch account.
location String: The location of the resource.
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
privateEndpointConnections List<Property Map>: List of private endpoint connections associated with the Batch account
provisioningState String: The provisioned state of the resource
tags Map<String>: The tags of the resource.
type String: The type of the resource.
identity Property Map: The identity of the Batch account.
networkProfile Property Map: The network profile only takes effect when publicNetworkAccess is enabled.
publicNetworkAccess String: If not specified, the default value is 'enabled'.

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: