@azure/arm-batch package

Access rule in a network security perimeter configuration profile

Properties of Access Rule

Subscription identifiers

Parameters for an activating an application package.

Contains information about an application in a Batch account.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ApplicationOperations.

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

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ApplicationPackageOperations.

Link to an application package inside the batch account

Optional parameters.

The results and errors from an execution of a pool autoscale formula.

An error that occurred when autoscaling a pool.

AutoScale settings for the pool.

The properties related to the auto-storage account.

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

Specifies the parameters for the auto user that runs a task on the Batch service.

The configuration parameters used for performing automatic OS upgrade.

Information used to connect to an Azure Storage Container using Blobfuse.

Information used to connect to an Azure Fileshare.

A definition of an Azure resource.

A definition of an Azure resource.

Contains information about an Azure Batch account.

Defines headers for BatchAccount_create operation.

Optional parameters.

Parameters supplied to the Create operation.

Defines headers for BatchAccount_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

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.

A set of Azure Batch account keys.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Values returned by the List operation.

Interface representing a BatchAccountOperations.

Optional parameters.

Parameters supplied to the RegenerateKey operation.

Optional parameters.

Optional parameters.

Parameters for updating an Azure Batch account.

Quotas associated with a Batch region for a particular subscription.

Optional parameters.

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

Contains information about a certificate.

Base certificate properties.

Defines headers for Certificate_cancelDeletion operation.

Optional parameters.

Defines headers for Certificate_create operation.

Optional parameters.

Contains information about a certificate.

Certificate properties for create operations

Defines headers for Certificate_delete operation.

Optional parameters.

Defines headers for Certificate_get operation.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a CertificateOperations.

Certificate properties.

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

Defines headers for Certificate_update operation.

Optional parameters.

Parameters for a check name availability request.

The CheckNameAvailability operation response.

Information used to connect to a CIFS file system.

An error response from the Batch service.

An error response from the Batch service.

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

The configuration for container-enabled pools.

The entry of path and mount mode you want to mount into task container.

A private container registry.

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.

An error response from the Batch service.

Deployment configuration properties.

Values returned by the List operation.

Contains the information for a detector.

Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

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.

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.

Network access profile for Batch endpoint.

A domain name and connection details used to access a dependency.

Details about the connection between the Batch service and the endpoint.

An environment variable to be set on a task process.

The resource management error additional info.

The error detail.

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Fixed scale settings for the pool.

Rule to filter client IP address.

A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation.

A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.

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

Identifies the Azure key vault associated with a Batch account.

Properties used to create a user account on a Linux node.

The result of performing list application packages.

The result of performing list applications.

Values returned by the List operation.

Values returned by the List operation.

Values returned by the List operation.

Values returned by the List operation.

Interface representing a Location.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

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

The file system to mount on each node.

Information used to connect to an NFS file system.

The network configuration for a pool.

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

A network security group rule to apply to an inbound endpoint.

Information about a network security perimeter (NSP)

Network security perimeter (NSP) configuration resource

Result of a list NSP (network security perimeter) configurations request.

Network security configuration properties.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a NetworkSecurityPerimeterOperations.

Defines headers for NetworkSecurityPerimeter_reconcileConfiguration operation.

Optional parameters.

Network security perimeter configuration profile

Allocation configuration used by Batch Service to provision the nodes.

Settings for the operating system disk of the virtual machine.

A REST API operation

The object that describes the operation.

Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.

Interface representing a Operations.

Optional parameters.

Optional parameters.

A collection of related endpoints from the same service for which the Batch service requires outbound access.

Values returned by the List operation.

Contains information about a pool.

Defines headers for Pool_create operation.

Optional parameters.

Defines headers for Pool_delete operation.

Optional parameters.

Defines headers for Pool_disableAutoScale operation.

Optional parameters.

The endpoint configuration for a pool.

Defines headers for Pool_get operation.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a PoolOperations.

Defines headers for Pool_stopResize operation.

Optional parameters.

Defines headers for Pool_update operation.

Optional parameters.

The private endpoint of the private endpoint connection.

Contains information about a private link resource.

Defines headers for PrivateEndpointConnection_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a PrivateEndpointConnectionOperations.

Defines headers for PrivateEndpointConnection_update operation.

Optional parameters.

Contains information about a private link resource.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a PrivateLinkResourceOperations.

The private link service connection state of the private endpoint connection

Describes a provisioning issue for a network security perimeter configuration

Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

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

An error that occurred when resizing a pool.

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

Common fields that are returned in the response for all Azure Resource Manager resources

Information about resource association

A single file or multiple files to be downloaded to a compute node.

The configuration parameters used while performing a rolling upgrade.

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.

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

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.

A SKU capability, such as the number of cores.

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.

Describes a Batch supported SKU.

The Batch List supported SKUs operation response.

Metadata pertaining to creation and last modification of the resource.

The container settings for a task.

Specifies how tasks should be distributed across compute nodes.

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

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

Properties used to create a user on an Azure Batch node.

The list of associated user identities.

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

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.

The configuration for virtual machine extensions.

The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.

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

Windows operating system settings to apply to the virtual machine.

Properties used to create a user account on a Windows node.

Defines values for AccessRuleDirection.
KnownAccessRuleDirection can be used interchangeably with AccessRuleDirection, this enum contains the known values that the service supports.

Known values supported by the service

Inbound: Applies to inbound network traffic to the secured resources.
Outbound: Applies to outbound network traffic from the secured resources

Defines values for AccountKeyType.

Defines values for AllocationState.

Contains response data for the create operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the activate operation.

Contains response data for the create operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Defines values for AuthenticationMode.

Defines values for AutoStorageAuthenticationMode.

Defines values for AutoUserScope.

Contains response data for the create operation.

Contains response data for the getDetector operation.

Contains response data for the getKeys operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listDetectorsNext operation.

Contains response data for the listDetectors operation.

Contains response data for the listNext operation.

Contains response data for the listOutboundNetworkDependenciesEndpointsNext operation.

Contains response data for the listOutboundNetworkDependenciesEndpoints operation.

Contains response data for the list operation.

Contains response data for the regenerateKey operation.

Contains response data for the update operation.

Defines values for CachingType.

Contains response data for the cancelDeletion operation.

Contains response data for the create operation.

Defines values for CertificateFormat.

Contains response data for the get operation.

Contains response data for the listByBatchAccountNext operation.

Contains response data for the listByBatchAccount operation.

Defines values for CertificateProvisioningState.

Defines values for CertificateStoreLocation.

Contains response data for the update operation.

Defines values for CertificateVisibility.

Defines values for ComputeNodeDeallocationOption.

Defines values for ComputeNodeFillType.

Defines values for ContainerHostDataPath.
KnownContainerHostDataPath can be used interchangeably with ContainerHostDataPath, this enum contains the known values that the service supports.

Known values supported by the service

Shared: The path for multi-instances task to shared their files.
Startup: The path for start task.
VfsMounts: The path contains all virtual file systems are mounted on this node.
Task: The task path.
JobPrep: The job-prep task path.
Applications: The applications path.

Defines values for ContainerType.
KnownContainerType can be used interchangeably with ContainerType, this enum contains the known values that the service supports.

Known values supported by the service

DockerCompatible: A Docker compatible container technology will be used to launch the containers.
CriCompatible: A CRI based technology will be used to launch the containers.

Defines values for ContainerWorkingDirectory.

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Defines values for DiskEncryptionTarget.

Defines values for DynamicVNetAssignmentScope.

Defines values for ElevationLevel.

Defines values for EndpointAccessDefaultAction.

Defines values for IPAddressProvisioningType.

Defines values for InboundEndpointProtocol.

Defines values for InterNodeCommunicationState.

Defines values for IssueType.
KnownIssueType can be used interchangeably with IssueType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown issue type
ConfigurationPropagationFailure: An error occurred while applying the network security perimeter (NSP) configuration.
MissingPerimeterConfiguration: A network connectivity issue is happening on the resource which could be addressed either by adding new resources to the network security perimeter (NSP) or by modifying access rules.
MissingIdentityConfiguration: An managed identity hasn't been associated with the resource. The resource will still be able to validate inbound traffic from the network security perimeter (NSP) or matching inbound access rules, but it won't be able to perform outbound access as a member of the NSP.

Defines values for KeySource.

Contains response data for the checkNameAvailability operation.

Contains response data for the getQuotas operation.

Contains response data for the listSupportedVirtualMachineSkusNext operation.

Contains response data for the listSupportedVirtualMachineSkus operation.

Defines values for LoginMode.

Defines values for NameAvailabilityReason.

Defines values for NetworkSecurityGroupRuleAccess.

Defines values for NetworkSecurityPerimeterConfigurationProvisioningState.
KnownNetworkSecurityPerimeterConfigurationProvisioningState can be used interchangeably with NetworkSecurityPerimeterConfigurationProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

Contains response data for the getConfiguration operation.

Contains response data for the listConfigurationsNext operation.

Contains response data for the listConfigurations operation.

Contains response data for the reconcileConfiguration operation.

Defines values for NodeCommunicationMode.

Defines values for NodePlacementPolicyType.

Contains response data for the listNext operation.

Contains response data for the list operation.

Defines values for PackageState.

Defines values for PoolAllocationMode.

Contains response data for the create operation.

Contains response data for the disableAutoScale operation.

Contains response data for the get operation.

Defines values for PoolIdentityType.

Contains response data for the listByBatchAccountNext operation.

Contains response data for the listByBatchAccount operation.

Defines values for PoolProvisioningState.

Contains response data for the stopResize operation.

Contains response data for the update operation.

Contains response data for the delete operation.

Contains response data for the get operation.

Contains response data for the listByBatchAccountNext operation.

Contains response data for the listByBatchAccount operation.

Defines values for PrivateEndpointConnectionProvisioningState.

Contains response data for the update operation.

Contains response data for the get operation.

Contains response data for the listByBatchAccountNext operation.

Contains response data for the listByBatchAccount operation.

Defines values for PrivateLinkServiceConnectionStatus.

Defines values for ProvisioningState.

Defines values for PublicNetworkAccessType.

Defines values for ResourceAssociationAccessMode.
KnownResourceAssociationAccessMode can be used interchangeably with ResourceAssociationAccessMode, this enum contains the known values that the service supports.

Known values supported by the service

Enforced: Enforced access mode - traffic to the resource that failed access checks is blocked
Learning: Learning access mode - traffic to the resource is enabled for analysis but not blocked
Audit: Audit access mode - traffic to the resource that fails access checks is logged but not blocked

Defines values for ResourceIdentityType.

Defines values for SecurityEncryptionTypes.
KnownSecurityEncryptionTypes can be used interchangeably with SecurityEncryptionTypes, this enum contains the known values that the service supports.

Known values supported by the service

NonPersistedTPM
VMGuestStateOnly

Defines values for SecurityTypes.

Defines values for Severity.
KnownSeverity can be used interchangeably with Severity, this enum contains the known values that the service supports.

Known values supported by the service

Warning
Error

Defines values for StorageAccountType.

Defines values for UpgradeMode.

Known values of AccessRuleDirection that the service accepts.

Known values of ContainerHostDataPath that the service accepts.

Known values of ContainerType that the service accepts.

Known values of CreatedByType that the service accepts.

Known values of IssueType that the service accepts.

Known values of NetworkSecurityPerimeterConfigurationProvisioningState that the service accepts.

Known values of ResourceAssociationAccessMode that the service accepts.

Known values of SecurityEncryptionTypes that the service accepts.

Known values of Severity that the service accepts.

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.