pulumi-azure-native-kotlin/com.pulumi.azurenative.batch.kotlin.outputs

Package-level declarations

Types

data class ApplicationPackageReferenceResponse(val id: String, val version: String? = null)

data class AutomaticOSUpgradePolicyResponse(val disableAutomaticRollback: Boolean? = null, val enableAutomaticOSUpgrade: Boolean? = null, val osRollingUpgradeDeferral: Boolean? = null, val useRollingUpgradePolicy: Boolean? = null)

The configuration parameters used for performing automatic OS upgrade.

AutoScaleRunErrorResponse

data class AutoScaleRunErrorResponse(val code: String, val details: List<AutoScaleRunErrorResponse>? = null, val message: String)

AutoScaleRunResponse

data class AutoScaleRunResponse(val error: AutoScaleRunErrorResponse? = null, val evaluationTime: String, val results: String? = null)

AutoScaleSettingsResponse

data class AutoScaleSettingsResponse(val evaluationInterval: String? = null, val formula: String)

AutoStoragePropertiesResponse

data class AutoStoragePropertiesResponse(val authenticationMode: String? = null, val lastKeySync: String, val nodeIdentityReference: ComputeNodeIdentityReferenceResponse? = null, val storageAccountId: String)

Contains information about the auto-storage account associated with a Batch account.

AutoUserSpecificationResponse

data class AutoUserSpecificationResponse(val elevationLevel: String? = null, val scope: String? = null)

AzureBlobFileSystemConfigurationResponse

data class AzureBlobFileSystemConfigurationResponse(val accountKey: String? = null, val accountName: String, val blobfuseOptions: String? = null, val containerName: String, val identityReference: ComputeNodeIdentityReferenceResponse? = null, val relativeMountPath: String, val sasKey: String? = null)

AzureFileShareConfigurationResponse

data class AzureFileShareConfigurationResponse(val accountKey: String, val accountName: String, val azureFileUrl: String, val mountOptions: String? = null, val relativeMountPath: String)

BatchAccountIdentityResponse

data class BatchAccountIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentitiesResponse>? = null)

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.

BatchPoolIdentityResponse

data class BatchPoolIdentityResponse(val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentitiesResponse>? = null)

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

CertificateReferenceResponse

data class CertificateReferenceResponse(val id: String, val storeLocation: String? = null, val storeName: String? = null, val visibility: List<String>? = null)

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

CIFSMountConfigurationResponse

data class CIFSMountConfigurationResponse(val mountOptions: String? = null, val password: String, val relativeMountPath: String, val source: String, val userName: String)

ComputeNodeIdentityReferenceResponse

data class ComputeNodeIdentityReferenceResponse(val resourceId: String? = null)

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

ContainerConfigurationResponse

data class ContainerConfigurationResponse(val containerImageNames: List<String>? = null, val containerRegistries: List<ContainerRegistryResponse>? = null, val type: String)

ContainerHostBatchBindMountEntryResponse

data class ContainerHostBatchBindMountEntryResponse(val isReadOnly: Boolean? = null, val source: String? = null)

ContainerRegistryResponse

data class ContainerRegistryResponse(val identityReference: ComputeNodeIdentityReferenceResponse? = null, val password: String? = null, val registryServer: String? = null, val userName: String? = null)

DataDiskResponse

data class DataDiskResponse(val caching: String? = null, val diskSizeGB: Int, val lun: Int, val storageAccountType: String? = null)

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.

DeploymentConfigurationResponse

data class DeploymentConfigurationResponse(val virtualMachineConfiguration: VirtualMachineConfigurationResponse? = null)

DiffDiskSettingsResponse

data class DiffDiskSettingsResponse(val placement: String? = null)

DiskEncryptionConfigurationResponse

data class DiskEncryptionConfigurationResponse(val targets: List<String>? = null)

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 Azure Compute Gallery Image.

EncryptionPropertiesResponse

data class EncryptionPropertiesResponse(val keySource: String? = null, val keyVaultProperties: KeyVaultPropertiesResponse? = null)

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.

EndpointAccessProfileResponse

data class EndpointAccessProfileResponse(val defaultAction: String, val ipRules: List<IPRuleResponse>? = null)

Network access profile for Batch endpoint.

EnvironmentSettingResponse

data class EnvironmentSettingResponse(val name: String, val value: String? = null)

FixedScaleSettingsResponse

data class FixedScaleSettingsResponse(val resizeTimeout: String? = null, val targetDedicatedNodes: Int? = null, val targetLowPriorityNodes: Int? = null)

GetApplicationPackageResult

data class GetApplicationPackageResult(val azureApiVersion: String, val etag: String, val format: String, val id: String, val lastActivationTime: String, val name: String, val state: String, val storageUrl: String, val storageUrlExpiry: String, val tags: Map<String, String>? = null, val type: String)

An application package which represents a particular version of an application.

GetApplicationResult

data class GetApplicationResult(val allowUpdates: Boolean? = null, val azureApiVersion: String, val defaultVersion: String? = null, val displayName: String? = null, val etag: String, val id: String, val name: String, val tags: Map<String, String>? = null, val type: String)

Contains information about an application in a Batch account.

GetBatchAccountResult

data class GetBatchAccountResult(val accountEndpoint: String, val activeJobAndJobScheduleQuota: Int, val allowedAuthenticationModes: List<String>, val autoStorage: AutoStoragePropertiesResponse, val azureApiVersion: String, val dedicatedCoreQuota: Int, val dedicatedCoreQuotaPerVMFamily: List<VirtualMachineFamilyCoreQuotaResponse>, val dedicatedCoreQuotaPerVMFamilyEnforced: Boolean, val encryption: EncryptionPropertiesResponse, val id: String, val identity: BatchAccountIdentityResponse? = null, val keyVaultReference: KeyVaultReferenceResponse, val location: String, val lowPriorityCoreQuota: Int, val name: String, val networkProfile: NetworkProfileResponse? = null, val nodeManagementEndpoint: String, val poolAllocationMode: String, val poolQuota: Int, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val tags: Map<String, String>, val type: String)

Contains information about an Azure Batch account.

GetPoolResult

data class GetPoolResult(val allocationState: String, val allocationStateTransitionTime: String, val applicationLicenses: List<String>? = null, val applicationPackages: List<ApplicationPackageReferenceResponse>? = null, val autoScaleRun: AutoScaleRunResponse, val azureApiVersion: String, val certificates: List<CertificateReferenceResponse>? = null, val creationTime: String, val currentDedicatedNodes: Int, val currentLowPriorityNodes: Int, val currentNodeCommunicationMode: String, val deploymentConfiguration: DeploymentConfigurationResponse? = null, val displayName: String? = null, val etag: String, val id: String, val identity: BatchPoolIdentityResponse? = null, val interNodeCommunication: String? = null, val lastModified: String, val metadata: List<MetadataItemResponse>? = null, val mountConfiguration: List<MountConfigurationResponse>? = null, val name: String, val networkConfiguration: NetworkConfigurationResponse? = null, val provisioningState: String, val provisioningStateTransitionTime: String, val resizeOperationStatus: ResizeOperationStatusResponse, val resourceTags: Map<String, String>? = null, val scaleSettings: ScaleSettingsResponse? = null, val startTask: StartTaskResponse? = null, val tags: Map<String, String>? = null, val targetNodeCommunicationMode: String? = null, val taskSchedulingPolicy: TaskSchedulingPolicyResponse? = null, val taskSlotsPerNode: Int? = null, val type: String, val upgradePolicy: UpgradePolicyResponse? = null, val userAccounts: List<UserAccountResponse>? = null, val vmSize: String? = null)

Contains information about a pool.

ImageReferenceResponse

data class ImageReferenceResponse(val communityGalleryImageId: String? = null, val id: String? = null, val offer: String? = null, val publisher: String? = null, val sharedGalleryImageId: String? = null, val sku: String? = null, val version: String? = null)

InboundNatPoolResponse

data class InboundNatPoolResponse(val backendPort: Int, val frontendPortRangeEnd: Int, val frontendPortRangeStart: Int, val name: String, val networkSecurityGroupRules: List<NetworkSecurityGroupRuleResponse>? = null, val protocol: String)

IPRuleResponse

data class IPRuleResponse(val action: String, val value: String)

Rule to filter client IP address.

KeyVaultPropertiesResponse

data class KeyVaultPropertiesResponse(val keyIdentifier: String? = null)

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

KeyVaultReferenceResponse

data class KeyVaultReferenceResponse(val id: String, val url: String)

Identifies the Azure key vault associated with a Batch account.

LinuxUserConfigurationResponse

data class LinuxUserConfigurationResponse(val gid: Int? = null, val sshPrivateKey: String? = null, val uid: Int? = null)

ListBatchAccountKeysResult

data class ListBatchAccountKeysResult(val accountName: String, val primary: String, val secondary: String)

A set of Azure Batch account keys.

ManagedDiskResponse

data class ManagedDiskResponse(val securityProfile: VMDiskSecurityProfileResponse? = null, val storageAccountType: String? = null)

MetadataItemResponse

data class MetadataItemResponse(val name: String, val value: String)

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

MountConfigurationResponse

data class MountConfigurationResponse(val azureBlobFileSystemConfiguration: AzureBlobFileSystemConfigurationResponse? = null, val azureFileShareConfiguration: AzureFileShareConfigurationResponse? = null, val cifsMountConfiguration: CIFSMountConfigurationResponse? = null, val nfsMountConfiguration: NFSMountConfigurationResponse? = null)

NetworkConfigurationResponse

data class NetworkConfigurationResponse(val dynamicVnetAssignmentScope: String? = null, val enableAcceleratedNetworking: Boolean? = null, val endpointConfiguration: PoolEndpointConfigurationResponse? = null, val publicIPAddressConfiguration: PublicIPAddressConfigurationResponse? = null, val subnetId: String? = null)

The network configuration for a pool.

NetworkProfileResponse

data class NetworkProfileResponse(val accountAccess: EndpointAccessProfileResponse? = null, val nodeManagementAccess: EndpointAccessProfileResponse? = null)

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

NetworkSecurityGroupRuleResponse

data class NetworkSecurityGroupRuleResponse(val access: String, val priority: Int, val sourceAddressPrefix: String, val sourcePortRanges: List<String>? = null)

NFSMountConfigurationResponse

data class NFSMountConfigurationResponse(val mountOptions: String? = null, val relativeMountPath: String, val source: String)

NodePlacementConfigurationResponse

data class NodePlacementConfigurationResponse(val policy: String? = null)

Allocation configuration used by Batch Service to provision the nodes.

OSDiskResponse

data class OSDiskResponse(val caching: String? = null, val diskSizeGB: Int? = null, val ephemeralOSDiskSettings: DiffDiskSettingsResponse? = null, val managedDisk: ManagedDiskResponse? = null, val writeAcceleratorEnabled: Boolean? = null)

PoolEndpointConfigurationResponse

data class PoolEndpointConfigurationResponse(val inboundNatPools: List<InboundNatPoolResponse>)

PrivateEndpointConnectionResponse

data class PrivateEndpointConnectionResponse(val etag: String, val groupIds: List<String>, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String, val tags: Map<String, String>? = null, val type: String)

Contains information about a private link resource.

PrivateEndpointResponse

data class PrivateEndpointResponse(val id: String)

The private endpoint of the private endpoint connection.

PrivateLinkServiceConnectionStateResponse

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String, val description: String? = null, val status: String)

The private link service connection state of the private endpoint connection

PublicIPAddressConfigurationResponse

data class PublicIPAddressConfigurationResponse(val ipAddressIds: List<String>? = null, val provision: String? = null)

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

ResizeErrorResponse

data class ResizeErrorResponse(val code: String, val details: List<ResizeErrorResponse>? = null, val message: String)

ResizeOperationStatusResponse

data class ResizeOperationStatusResponse(val errors: List<ResizeErrorResponse>? = null, val nodeDeallocationOption: String? = null, val resizeTimeout: String? = null, val startTime: String? = null, val targetDedicatedNodes: Int? = null, val targetLowPriorityNodes: Int? = null)

Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).

ResourceFileResponse

data class ResourceFileResponse(val autoStorageContainerName: String? = null, val blobPrefix: String? = null, val fileMode: String? = null, val filePath: String? = null, val httpUrl: String? = null, val identityReference: ComputeNodeIdentityReferenceResponse? = null, val storageContainerUrl: String? = null)

RollingUpgradePolicyResponse

data class RollingUpgradePolicyResponse(val enableCrossZoneUpgrade: Boolean? = null, val maxBatchInstancePercent: Int? = null, val maxUnhealthyInstancePercent: Int? = null, val maxUnhealthyUpgradedInstancePercent: Int? = null, val pauseTimeBetweenBatches: String? = null, val prioritizeUnhealthyInstances: Boolean? = null, val rollbackFailedInstancesOnPolicyBreach: Boolean? = null)

The configuration parameters used while performing a rolling upgrade.

ScaleSettingsResponse

data class ScaleSettingsResponse(val autoScale: AutoScaleSettingsResponse? = null, val fixedScale: FixedScaleSettingsResponse? = null)

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.

SecurityProfileResponse

data class SecurityProfileResponse(val encryptionAtHost: Boolean? = null, val securityType: String? = null, val uefiSettings: UefiSettingsResponse? = null)

Specifies the security profile settings for the virtual machine or virtual machine scale set.

ServiceArtifactReferenceResponse

data class ServiceArtifactReferenceResponse(val id: String)

Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.

StartTaskResponse

data class StartTaskResponse(val commandLine: String? = null, val containerSettings: TaskContainerSettingsResponse? = null, val environmentSettings: List<EnvironmentSettingResponse>? = null, val maxTaskRetryCount: Int? = null, val resourceFiles: List<ResourceFileResponse>? = null, val userIdentity: UserIdentityResponse? = null, val waitForSuccess: Boolean? = null)

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.

TaskContainerSettingsResponse

data class TaskContainerSettingsResponse(val containerHostBatchBindMounts: List<ContainerHostBatchBindMountEntryResponse>? = null, val containerRunOptions: String? = null, val imageName: String, val registry: ContainerRegistryResponse? = null, val workingDirectory: String? = null)

TaskSchedulingPolicyResponse

data class TaskSchedulingPolicyResponse(val nodeFillType: String)

UefiSettingsResponse

data class UefiSettingsResponse(val secureBootEnabled: Boolean? = null, val vTpmEnabled: Boolean? = null)

Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

UpgradePolicyResponse

data class UpgradePolicyResponse(val automaticOSUpgradePolicy: AutomaticOSUpgradePolicyResponse? = null, val mode: String, val rollingUpgradePolicy: RollingUpgradePolicyResponse? = null)

Describes an upgrade policy - automatic, manual, or rolling.

UserAccountResponse

data class UserAccountResponse(val elevationLevel: String? = null, val linuxUserConfiguration: LinuxUserConfigurationResponse? = null, val name: String, val password: String, val windowsUserConfiguration: WindowsUserConfigurationResponse? = null)

UserAssignedIdentitiesResponse

data class UserAssignedIdentitiesResponse(val clientId: String, val principalId: String)

The list of associated user identities.

UserIdentityResponse

data class UserIdentityResponse(val autoUser: AutoUserSpecificationResponse? = null, val userName: String? = null)

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

VirtualMachineConfigurationResponse

data class VirtualMachineConfigurationResponse(val containerConfiguration: ContainerConfigurationResponse? = null, val dataDisks: List<DataDiskResponse>? = null, val diskEncryptionConfiguration: DiskEncryptionConfigurationResponse? = null, val extensions: List<VMExtensionResponse>? = null, val imageReference: ImageReferenceResponse, val licenseType: String? = null, val nodeAgentSkuId: String, val nodePlacementConfiguration: NodePlacementConfigurationResponse? = null, val osDisk: OSDiskResponse? = null, val securityProfile: SecurityProfileResponse? = null, val serviceArtifactReference: ServiceArtifactReferenceResponse? = null, val windowsConfiguration: WindowsConfigurationResponse? = null)

VirtualMachineFamilyCoreQuotaResponse

data class VirtualMachineFamilyCoreQuotaResponse(val coreQuota: Int, val name: String)

A VM Family and its associated core quota for the Batch account.

VMDiskSecurityProfileResponse

data class VMDiskSecurityProfileResponse(val securityEncryptionType: String? = null)

Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs and is required when using Confidential VMs.

VMExtensionResponse

data class VMExtensionResponse(val autoUpgradeMinorVersion: Boolean? = null, val enableAutomaticUpgrade: Boolean? = null, val name: String, val protectedSettings: Any? = null, val provisionAfterExtensions: List<String>? = null, val publisher: String, val settings: Any? = null, val type: String, val typeHandlerVersion: String? = null)

WindowsConfigurationResponse

data class WindowsConfigurationResponse(val enableAutomaticUpdates: Boolean? = null)

WindowsUserConfigurationResponse

data class WindowsUserConfigurationResponse(val loginMode: String? = null)