Azure Native v1.102.0, May 2 23

azure-native.batch.getBatchAccount

Explore with Pulumi AI

Gets information about the specified Batch account. API Version: 2021-01-01.

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)
// Output-based functions aren't available in Java yet

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
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: Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.
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.
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
PublicNetworkAccess string: If not specified, the default value is 'enabled'.
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.

AccountEndpoint string: The account endpoint used to interact with the Batch service.
ActiveJobAndJobScheduleQuota int
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: Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.
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.
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
PublicNetworkAccess string: If not specified, the default value is 'enabled'.
Tags map[string]string: The tags of the resource.
Type string: The type of the resource.
Identity BatchAccountIdentityResponse: The identity of the Batch account.

accountEndpoint String: The account endpoint used to interact with the Batch service.
activeJobAndJobScheduleQuota Integer
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: Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.
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.
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
publicNetworkAccess String: If not specified, the default value is 'enabled'.
tags Map<String,String>: The tags of the resource.
type String: The type of the resource.
identity BatchAccountIdentityResponse: The identity of the Batch account.

accountEndpoint string: The account endpoint used to interact with the Batch service.
activeJobAndJobScheduleQuota number
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: Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.
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.
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
publicNetworkAccess string: If not specified, the default value is 'enabled'.
tags {[key: string]: string}: The tags of the resource.
type string: The type of the resource.
identity BatchAccountIdentityResponse: The identity of the Batch account.

account_endpoint str: The account endpoint used to interact with the Batch service.
active_job_and_job_schedule_quota int
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: Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.
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.
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
public_network_access str: If not specified, the default value is 'enabled'.
tags Mapping[str, str]: The tags of the resource.
type str: The type of the resource.
identity BatchAccountIdentityResponse: The identity of the Batch account.

accountEndpoint String: The account endpoint used to interact with the Batch service.
activeJobAndJobScheduleQuota Number
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: Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.
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.
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
publicNetworkAccess String: If not specified, the default value is 'enabled'.
tags Map<String>: The tags of the resource.
type String: The type of the resource.
identity Property Map: The identity of the Batch account.

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.

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.

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.

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.

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.

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.

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.BatchAccountIdentityResponseUserAssignedIdentities>: The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

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]BatchAccountIdentityResponseUserAssignedIdentities: The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

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,BatchAccountIdentityResponseUserAssignedIdentities>: The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

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]: BatchAccountIdentityResponseUserAssignedIdentities}: The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

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, BatchAccountIdentityResponseUserAssignedIdentities]: The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

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. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

BatchAccountIdentityResponseUserAssignedIdentities

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.

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

KeyVaultPropertiesResponse

KeyIdentifier string

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