Package-level declarations

Types

Link copied to clipboard
data class ApplicationPackageReferenceArgs(val id: Output<String>, val version: Output<String>? = null) : ConvertibleToJava<ApplicationPackageReferenceArgs>
Link copied to clipboard
data class AutoScaleSettingsArgs(val evaluationInterval: Output<String>? = null, val formula: Output<String>) : ConvertibleToJava<AutoScaleSettingsArgs>
Link copied to clipboard
data class AutoStorageBasePropertiesArgs(val authenticationMode: Output<AutoStorageAuthenticationMode>? = null, val nodeIdentityReference: Output<ComputeNodeIdentityReferenceArgs>? = null, val storageAccountId: Output<String>) : ConvertibleToJava<AutoStorageBasePropertiesArgs>

The properties related to the auto-storage account.

Link copied to clipboard
data class AutoUserSpecificationArgs(val elevationLevel: Output<ElevationLevel>? = null, val scope: Output<AutoUserScope>? = null) : ConvertibleToJava<AutoUserSpecificationArgs>
Link copied to clipboard
data class AzureBlobFileSystemConfigurationArgs(val accountKey: Output<String>? = null, val accountName: Output<String>, val blobfuseOptions: Output<String>? = null, val containerName: Output<String>, val identityReference: Output<ComputeNodeIdentityReferenceArgs>? = null, val relativeMountPath: Output<String>, val sasKey: Output<String>? = null) : ConvertibleToJava<AzureBlobFileSystemConfigurationArgs>
Link copied to clipboard
data class AzureFileShareConfigurationArgs(val accountKey: Output<String>, val accountName: Output<String>, val azureFileUrl: Output<String>, val mountOptions: Output<String>? = null, val relativeMountPath: Output<String>) : ConvertibleToJava<AzureFileShareConfigurationArgs>
Link copied to clipboard
data class BatchAccountIdentityArgs(val type: Output<ResourceIdentityType>, val userAssignedIdentities: Output<List<String>>? = null) : ConvertibleToJava<BatchAccountIdentityArgs>

The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when ManagedIdentity is selected as the auto-storage authentication mode.

Link copied to clipboard
data class BatchPoolIdentityArgs(val type: Output<PoolIdentityType>, val userAssignedIdentities: Output<List<String>>? = null) : ConvertibleToJava<BatchPoolIdentityArgs>

The identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities

Link copied to clipboard
data class CertificateReferenceArgs(val id: Output<String>, val storeLocation: Output<CertificateStoreLocation>? = null, val storeName: Output<String>? = null, val visibility: Output<List<CertificateVisibility>>? = null) : ConvertibleToJava<CertificateReferenceArgs>

Warning: This object is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

Link copied to clipboard
data class CIFSMountConfigurationArgs(val mountOptions: Output<String>? = null, val password: Output<String>, val relativeMountPath: Output<String>, val source: Output<String>, val userName: Output<String>) : ConvertibleToJava<CIFSMountConfigurationArgs>
Link copied to clipboard
data class CloudServiceConfigurationArgs(val osFamily: Output<String>, val osVersion: Output<String>? = null) : ConvertibleToJava<CloudServiceConfigurationArgs>
Link copied to clipboard
data class ComputeNodeIdentityReferenceArgs(val resourceId: Output<String>? = null) : ConvertibleToJava<ComputeNodeIdentityReferenceArgs>

The reference to a user assigned identity associated with the Batch pool which a compute node will use.

Link copied to clipboard
data class ContainerConfigurationArgs(val containerImageNames: Output<List<String>>? = null, val containerRegistries: Output<List<ContainerRegistryArgs>>? = null, val type: Output<Either<String, ContainerType>>) : ConvertibleToJava<ContainerConfigurationArgs>
Link copied to clipboard
data class ContainerRegistryArgs(val identityReference: Output<ComputeNodeIdentityReferenceArgs>? = null, val password: Output<String>? = null, val registryServer: Output<String>? = null, val userName: Output<String>? = null) : ConvertibleToJava<ContainerRegistryArgs>
Link copied to clipboard
data class DataDiskArgs(val caching: Output<CachingType>? = null, val diskSizeGB: Output<Int>, val lun: Output<Int>, val storageAccountType: Output<StorageAccountType>? = null) : ConvertibleToJava<DataDiskArgs>

Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.

Link copied to clipboard
Link copied to clipboard
data class DeploymentConfigurationArgs(val cloudServiceConfiguration: Output<CloudServiceConfigurationArgs>? = null, val virtualMachineConfiguration: Output<VirtualMachineConfigurationArgs>? = null) : ConvertibleToJava<DeploymentConfigurationArgs>
Link copied to clipboard
data class DiffDiskSettingsArgs(val placement: Output<DiffDiskPlacement>? = null) : ConvertibleToJava<DiffDiskSettingsArgs>
Link copied to clipboard
data class DiskEncryptionConfigurationArgs(val targets: Output<List<DiskEncryptionTarget>>? = null) : ConvertibleToJava<DiskEncryptionConfigurationArgs>

The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image.

Link copied to clipboard
data class EncryptionPropertiesArgs(val keySource: Output<KeySource>? = null, val keyVaultProperties: Output<KeyVaultPropertiesArgs>? = null) : ConvertibleToJava<EncryptionPropertiesArgs>

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.

Link copied to clipboard
data class EndpointAccessProfileArgs(val defaultAction: Output<EndpointAccessDefaultAction>, val ipRules: Output<List<IPRuleArgs>>? = null) : ConvertibleToJava<EndpointAccessProfileArgs>

Network access profile for Batch endpoint.

Link copied to clipboard
data class EnvironmentSettingArgs(val name: Output<String>, val value: Output<String>? = null) : ConvertibleToJava<EnvironmentSettingArgs>
Link copied to clipboard
data class FixedScaleSettingsArgs(val nodeDeallocationOption: Output<ComputeNodeDeallocationOption>? = null, val resizeTimeout: Output<String>? = null, val targetDedicatedNodes: Output<Int>? = null, val targetLowPriorityNodes: Output<Int>? = null) : ConvertibleToJava<FixedScaleSettingsArgs>
Link copied to clipboard
data class GetApplicationPackagePlainArgs(val accountName: String, val applicationName: String, val resourceGroupName: String, val versionName: String) : ConvertibleToJava<GetApplicationPackagePlainArgs>
Link copied to clipboard
data class GetApplicationPlainArgs(val accountName: String, val applicationName: String, val resourceGroupName: String) : ConvertibleToJava<GetApplicationPlainArgs>
Link copied to clipboard
data class GetBatchAccountPlainArgs(val accountName: String, val resourceGroupName: String) : ConvertibleToJava<GetBatchAccountPlainArgs>
Link copied to clipboard
data class GetPoolPlainArgs(val accountName: String, val poolName: String, val resourceGroupName: String) : ConvertibleToJava<GetPoolPlainArgs>
Link copied to clipboard
Link copied to clipboard
data class ImageReferenceArgs(val id: Output<String>? = null, val offer: Output<String>? = null, val publisher: Output<String>? = null, val sku: Output<String>? = null, val version: Output<String>? = null) : ConvertibleToJava<ImageReferenceArgs>
Link copied to clipboard
Link copied to clipboard
data class InboundNatPoolArgs(val backendPort: Output<Int>, val frontendPortRangeEnd: Output<Int>, val frontendPortRangeStart: Output<Int>, val name: Output<String>, val networkSecurityGroupRules: Output<List<NetworkSecurityGroupRuleArgs>>? = null, val protocol: Output<InboundEndpointProtocol>) : ConvertibleToJava<InboundNatPoolArgs>
Link copied to clipboard
Link copied to clipboard
data class IPRuleArgs(val action: Output<IPRuleAction>, val value: Output<String>) : ConvertibleToJava<IPRuleArgs>

Rule to filter client IP address.

Link copied to clipboard

Builder for IPRuleArgs.

Link copied to clipboard
data class KeyVaultPropertiesArgs(val keyIdentifier: Output<String>? = null) : ConvertibleToJava<KeyVaultPropertiesArgs>

KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.

Link copied to clipboard
data class KeyVaultReferenceArgs(val id: Output<String>, val url: Output<String>) : ConvertibleToJava<KeyVaultReferenceArgs>

Identifies the Azure key vault associated with a Batch account.

Link copied to clipboard
data class LinuxUserConfigurationArgs(val gid: Output<Int>? = null, val sshPrivateKey: Output<String>? = null, val uid: Output<Int>? = null) : ConvertibleToJava<LinuxUserConfigurationArgs>
Link copied to clipboard
data class ListBatchAccountKeysPlainArgs(val accountName: String, val resourceGroupName: String) : ConvertibleToJava<ListBatchAccountKeysPlainArgs>
Link copied to clipboard
data class MetadataItemArgs(val name: Output<String>, val value: Output<String>) : ConvertibleToJava<MetadataItemArgs>

The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.

Link copied to clipboard
Link copied to clipboard
data class MountConfigurationArgs(val azureBlobFileSystemConfiguration: Output<AzureBlobFileSystemConfigurationArgs>? = null, val azureFileShareConfiguration: Output<AzureFileShareConfigurationArgs>? = null, val cifsMountConfiguration: Output<CIFSMountConfigurationArgs>? = null, val nfsMountConfiguration: Output<NFSMountConfigurationArgs>? = null) : ConvertibleToJava<MountConfigurationArgs>
Link copied to clipboard
data class NetworkConfigurationArgs(val dynamicVnetAssignmentScope: Output<DynamicVNetAssignmentScope>? = null, val enableAcceleratedNetworking: Output<Boolean>? = null, val endpointConfiguration: Output<PoolEndpointConfigurationArgs>? = null, val publicIPAddressConfiguration: Output<PublicIPAddressConfigurationArgs>? = null, val subnetId: Output<String>? = null) : ConvertibleToJava<NetworkConfigurationArgs>

The network configuration for a pool.

Link copied to clipboard
data class NetworkProfileArgs(val accountAccess: Output<EndpointAccessProfileArgs>? = null, val nodeManagementAccess: Output<EndpointAccessProfileArgs>? = null) : ConvertibleToJava<NetworkProfileArgs>

Network profile for Batch account, which contains network rule settings for each endpoint.

Link copied to clipboard
Link copied to clipboard
data class NetworkSecurityGroupRuleArgs(val access: Output<NetworkSecurityGroupRuleAccess>, val priority: Output<Int>, val sourceAddressPrefix: Output<String>, val sourcePortRanges: Output<List<String>>? = null) : ConvertibleToJava<NetworkSecurityGroupRuleArgs>
Link copied to clipboard
data class NFSMountConfigurationArgs(val mountOptions: Output<String>? = null, val relativeMountPath: Output<String>, val source: Output<String>) : ConvertibleToJava<NFSMountConfigurationArgs>
Link copied to clipboard
data class NodePlacementConfigurationArgs(val policy: Output<NodePlacementPolicyType>? = null) : ConvertibleToJava<NodePlacementConfigurationArgs>

Allocation configuration used by Batch Service to provision the nodes.

Link copied to clipboard
data class OSDiskArgs(val ephemeralOSDiskSettings: Output<DiffDiskSettingsArgs>? = null) : ConvertibleToJava<OSDiskArgs>
Link copied to clipboard

Builder for OSDiskArgs.

Link copied to clipboard
data class PoolEndpointConfigurationArgs(val inboundNatPools: Output<List<InboundNatPoolArgs>>) : ConvertibleToJava<PoolEndpointConfigurationArgs>
Link copied to clipboard
data class PublicIPAddressConfigurationArgs(val ipAddressIds: Output<List<String>>? = null, val provision: Output<IPAddressProvisioningType>? = null) : ConvertibleToJava<PublicIPAddressConfigurationArgs>

The public IP Address configuration of the networking configuration of a Pool.

Link copied to clipboard
data class ResourceFileArgs(val autoStorageContainerName: Output<String>? = null, val blobPrefix: Output<String>? = null, val fileMode: Output<String>? = null, val filePath: Output<String>? = null, val httpUrl: Output<String>? = null, val identityReference: Output<ComputeNodeIdentityReferenceArgs>? = null, val storageContainerUrl: Output<String>? = null) : ConvertibleToJava<ResourceFileArgs>
Link copied to clipboard
Link copied to clipboard
data class ScaleSettingsArgs(val autoScale: Output<AutoScaleSettingsArgs>? = null, val fixedScale: Output<FixedScaleSettingsArgs>? = null) : ConvertibleToJava<ScaleSettingsArgs>

Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.

Link copied to clipboard
Link copied to clipboard
data class StartTaskArgs(val commandLine: Output<String>? = null, val containerSettings: Output<TaskContainerSettingsArgs>? = null, val environmentSettings: Output<List<EnvironmentSettingArgs>>? = null, val maxTaskRetryCount: Output<Int>? = null, val resourceFiles: Output<List<ResourceFileArgs>>? = null, val userIdentity: Output<UserIdentityArgs>? = null, val waitForSuccess: Output<Boolean>? = null) : ConvertibleToJava<StartTaskArgs>

In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task.

Link copied to clipboard
Link copied to clipboard
data class TaskContainerSettingsArgs(val containerRunOptions: Output<String>? = null, val imageName: Output<String>, val registry: Output<ContainerRegistryArgs>? = null, val workingDirectory: Output<ContainerWorkingDirectory>? = null) : ConvertibleToJava<TaskContainerSettingsArgs>
Link copied to clipboard
data class TaskSchedulingPolicyArgs(val nodeFillType: Output<ComputeNodeFillType>) : ConvertibleToJava<TaskSchedulingPolicyArgs>
Link copied to clipboard
data class UserAccountArgs(val elevationLevel: Output<ElevationLevel>? = null, val linuxUserConfiguration: Output<LinuxUserConfigurationArgs>? = null, val name: Output<String>, val password: Output<String>, val windowsUserConfiguration: Output<WindowsUserConfigurationArgs>? = null) : ConvertibleToJava<UserAccountArgs>
Link copied to clipboard
Link copied to clipboard
data class UserIdentityArgs(val autoUser: Output<AutoUserSpecificationArgs>? = null, val userName: Output<String>? = null) : ConvertibleToJava<UserIdentityArgs>

Specify either the userName or autoUser property, but not both.

Link copied to clipboard
Link copied to clipboard
data class VirtualMachineConfigurationArgs(val containerConfiguration: Output<ContainerConfigurationArgs>? = null, val dataDisks: Output<List<DataDiskArgs>>? = null, val diskEncryptionConfiguration: Output<DiskEncryptionConfigurationArgs>? = null, val extensions: Output<List<VMExtensionArgs>>? = null, val imageReference: Output<ImageReferenceArgs>, val licenseType: Output<String>? = null, val nodeAgentSkuId: Output<String>, val nodePlacementConfiguration: Output<NodePlacementConfigurationArgs>? = null, val osDisk: Output<OSDiskArgs>? = null, val windowsConfiguration: Output<WindowsConfigurationArgs>? = null) : ConvertibleToJava<VirtualMachineConfigurationArgs>
Link copied to clipboard
data class VMExtensionArgs(val autoUpgradeMinorVersion: Output<Boolean>? = null, val enableAutomaticUpgrade: Output<Boolean>? = null, val name: Output<String>, val protectedSettings: Output<Any>? = null, val provisionAfterExtensions: Output<List<String>>? = null, val publisher: Output<String>, val settings: Output<Any>? = null, val type: Output<String>, val typeHandlerVersion: Output<String>? = null) : ConvertibleToJava<VMExtensionArgs>
Link copied to clipboard
Link copied to clipboard
data class WindowsConfigurationArgs(val enableAutomaticUpdates: Output<Boolean>? = null) : ConvertibleToJava<WindowsConfigurationArgs>
Link copied to clipboard
data class WindowsUserConfigurationArgs(val loginMode: Output<LoginMode>? = null) : ConvertibleToJava<WindowsUserConfigurationArgs>