How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Pools API

The Pools API from Microsoft Azure — 34 operation(s) for pools.

Microsoft Azure Pools API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pools. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 50 operations across 34 paths, and defines 178 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

50 operations 34 paths 178 schemas 6 DELETE20 GET2 HEAD4 PATCH14 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 50

Across 34 paths, the API surfaces 50 operations — 6 DELETE, 20 GET, 2 HEAD, 4 PATCH, 14 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Pools 50
GET
/pools
Microsoft Azure Lists All Of The Pools In The Specified Account
microsoftAzureBatchListpools 9 params → 200default
POST
/pools
Microsoft Azure Creates A Pool To The Specified Account
microsoftAzureBatchCreatepool 5 params body → 201default
GET
/pools/{poolId}
Microsoft Azure Get Pools Poolid
microsoftAzureBatchGetpool 12 params → 200default
PATCH
/pools/{poolId}
Microsoft Azure Updates The Properties Of The Specified Pool
microsoftAzureBatchUpdatepool 10 params body → 200default
DELETE
/pools/{poolId}
Microsoft Azure Deletes A Pool From The Specified Account
microsoftAzureBatchDeletepool 10 params → 202default
HEAD
/pools/{poolId}
Microsoft Azure Head Pools Poolid
microsoftAzureBatchPoolexists 10 params → 200404default
POST
/pools/{poolId}/disableautoscale
Microsoft Azure Disables Automatic Scaling For A Pool
microsoftAzureBatchDisablepoolautoscale 6 params → 200default
POST
/pools/{poolId}/enableautoscale
Microsoft Azure Enables Automatic Scaling For A Pool
microsoftAzureBatchEnablepoolautoscale 10 params body → 200default
POST
/pools/{poolId}/evaluateautoscale
Microsoft Azure Gets The Result Of Evaluating An Automatic Scaling Formula On The Pool
microsoftAzureBatchEvaluatepoolautoscale 6 params body → 200default
GET
/pools/{poolId}/nodes
Microsoft Azure Lists The Compute Nodes In The Specified Pool
microsoftAzureBatchListnodes 9 params → 200default
GET
/pools/{poolId}/nodes/{nodeId}
Microsoft Azure Gets Information About The Specified Compute Node
microsoftAzureBatchGetnode 8 params → 200default
POST
/pools/{poolId}/nodes/{nodeId}/disablescheduling
Microsoft Azure Disables Task Scheduling On The Specified Compute Node
microsoftAzureBatchDisablenodescheduling 7 params body → 200default
POST
/pools/{poolId}/nodes/{nodeId}/enablescheduling
Microsoft Azure Enables Task Scheduling On The Specified Compute Node
microsoftAzureBatchEnablenodescheduling 7 params → 200default
GET
/pools/{poolId}/nodes/{nodeId}/extensions
Microsoft Azure Lists The Compute Nodes Extensions In The Specified Pool
microsoftAzureBatchListnodeextensions 9 params → 200default
GET
/pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}
Microsoft Azure Gets Information About The Specified Compute Node Extension
microsoftAzureBatchGetnodeextension 9 params → 200default
GET
/pools/{poolId}/nodes/{nodeId}/files
Microsoft Azure Lists All Of The Files In Task Directories On The Specified Compute Node
microsoftAzureBatchListnodefiles 10 params → 200default
GET
/pools/{poolId}/nodes/{nodeId}/files/{filePath}
Microsoft Azure Get Pools Poolid Nodes Nodeid Files Filepath
microsoftAzureBatchGetnodefile 11 params → 200default
DELETE
/pools/{poolId}/nodes/{nodeId}/files/{filePath}
Microsoft Azure Deletes The Specified File From The Compute Node
microsoftAzureBatchDeletenodefile 9 params → 200default
HEAD
/pools/{poolId}/nodes/{nodeId}/files/{filePath}
Microsoft Azure Head Pools Poolid Nodes Nodeid Files Filepath
microsoftAzureBatchGetnodefileproperties 10 params → 200default
GET
/pools/{poolId}/nodes/{nodeId}/rdp
Microsoft Azure Gets The Remote Desktop Protocol File For The Specified Compute Node
microsoftAzureBatchGetnoderemotedesktopfile 7 params → 200default
POST
/pools/{poolId}/nodes/{nodeId}/reboot
Microsoft Azure Restarts The Specified Compute Node
microsoftAzureBatchRebootnode 7 params body → 202default
POST
/pools/{poolId}/nodes/{nodeId}/reimage
Microsoft Azure Reinstalls The Operating System On The Specified Compute Node
microsoftAzureBatchReimagenode 7 params body → 202default
GET
/pools/{poolId}/nodes/{nodeId}/remoteloginsettings
Microsoft Azure Gets The Settings Required For Remote Login To A Compute Node
microsoftAzureBatchGetnoderemoteloginsettings 7 params → 200default
POST
/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs
Microsoft Azure Upload Azure Batch Service Log Files From The Specified Compute Node To Azure blob Storage
microsoftAzureBatchUploadnodelogs 7 params body → 200default
POST
/pools/{poolId}/nodes/{nodeId}/users
Microsoft Azure Adds A User Account To The Specified Compute Node
microsoftAzureBatchCreatenodeuser 7 params body → 201default
PUT
/pools/{poolId}/nodes/{nodeId}/users/{userName}
Microsoft Azure Updates The Password And Expiration Time Of A User Account On The Specified Compute Node
microsoftAzureBatchReplacenodeuser 8 params body → 200default
DELETE
/pools/{poolId}/nodes/{nodeId}/users/{userName}
Microsoft Azure Deletes A User Account From The Specified Compute Node
microsoftAzureBatchDeletenodeuser 8 params → 200default
POST
/pools/{poolId}/removenodes
Microsoft Azure Removes Compute Nodes From The Specified Pool
microsoftAzureBatchRemovenodes 10 params body → 202default
POST
/pools/{poolId}/resize
Microsoft Azure Changes The Number Of Compute Nodes That Are Assigned To A Pool
microsoftAzureBatchResizepool 10 params body → 202default
POST
/pools/{poolId}/stopresize
Microsoft Azure Stops An Ongoing Resize Operation On The Pool
microsoftAzureBatchStoppoolresize 10 params → 202default
POST
/pools/{poolId}/updateproperties
Microsoft Azure Updates The Properties Of The Specified Pool
microsoftAzureBatchReplacepoolproperties 6 params body → 204default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.ContainerStorage/pools
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Containerstorage Pools
microsoftAzurePoolsListbysubscription 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools
microsoftAzurePoolsListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname
microsoftAzurePoolsGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname
microsoftAzurePoolsCreateorupdate 4 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname
microsoftAzurePoolsUpdate 4 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname
microsoftAzurePoolsDelete 4 params → 202204default
GET
/poolusagemetrics
Microsoft Azure Lists The Usage Metrics, Aggregated By Pool Across Individual Time Intervals, For The Specified Account
microsoftAzurePoolListusagemetrics 9 params → 200default
GET
/lifetimepoolstats
Microsoft Azure Gets Lifetime Summary Statistics For All Of The Pools In The Specified Account
microsoftAzurePoolGetalllifetimestatistics 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools
microsoftAzurePoolsListbyproject 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools Poolname
microsoftAzurePoolsGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools Poolname
microsoftAzurePoolsCreateorupdate 5 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools Poolname
microsoftAzurePoolsUpdate 5 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devcenter Projects Projectname Pools Poolname
microsoftAzurePoolsDelete 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/pools
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Devopsinfrastructure Pools
microsoftAzurePoolsListbysubscription 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools
microsoftAzurePoolsListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools Poolname
microsoftAzurePoolsGet 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools Poolname
microsoftAzurePoolsCreateorupdate 4 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools Poolname
microsoftAzurePoolsUpdate 4 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devopsinfrastructure Pools Poolname
microsoftAzurePoolsDelete 4 params → 202204default

Schemas 178

The contract defines 178 schemas that model the data the API accepts and returns. The most detailed are BatchPool (40 properties), BatchPoolCreateContent (25 properties), BatchNode (23 properties), BatchPoolResourceStatistics (13 properties). Each schema is shown below with its type and property counts.

BatchCertificateStoreLocation
string
BatchCertificateStoreLocation enums
WindowsConfiguration
object
Windows operating system settings to apply to the virtual machine.
1 property
NetworkSecurityGroupRule
object
A network security group rule to apply to an inbound endpoint.
4 properties 3 required
ErrorMessage
object
2 properties
BatchStartTaskState
string
BatchStartTaskState enums
BatchStartTaskInfo
object
Information about a StartTask running on a Compute Node.
9 properties 3 required
AzureDiskUpdate
object
Azure Disk Pool Properties
1 property
FileProperties
object
The properties of a file on a Compute Node.
5 properties 2 required
BatchNodeDeallocationOption
string
BatchNodeDeallocationOption enums
BatchNodeAgentInfo
object
The Batch Compute Node agent is a program that runs on each Compute Node in the Pool and provides Batch capability on the Compute Node.
2 properties 2 required
AssignmentId
string
A type definition that refers the id to an Azure Resource Manager resource.
ResourceOperationStatusState
string
State of the resource.
BatchNodeError
object
An error encountered by a Compute Node.
3 properties
BatchNodeUserUpdateContent
object
Parameters for updating a user account for RDP or SSH access on an Azure Batch Compute Node.
3 properties
SecurityProfile
object
Specifies the security profile settings for the virtual machine or virtual machine scale set.
3 properties 3 required
LocalAdminStatus
string
OrganizationProfile
object
Defines the organization in which the pool will be used.
1 property 1 required
LinuxUserConfiguration
object
Properties used to create a user Account on a Linux Compute Node.
3 properties
IpAddressProvisioningType
string
IPAddressProvisioningType enums
BatchNodeEndpointConfiguration
object
The endpoint configuration for the Compute Node.
1 property 1 required
StatusLevelTypes
string
Level code.
UefiSettings
object
Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
2 properties
AutoScaleRunError
object
An error that occurred when executing or evaluating a Pool autoscale formula.
3 properties
UpgradePolicy
object
Describes an upgrade policy - automatic, manual, or rolling.
3 properties 1 required
BatchCertificateReference
object
A reference to a Certificate to be installed on Compute Nodes in a Pool. Warning: This object is deprecated and will be removed after February, 2024. Please us…
5 properties 2 required
ContainerType
string
ContainerType enums
NameValuePair
object
Represents a name-value pair.
2 properties
UserAccount
object
Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.
5 properties 2 required
BatchTaskContainerSettingsUpdate
object
The container settings for a Task.
4 properties
DynamicVNetAssignmentScope
string
DynamicVNetAssignmentScope enums
PoolProperties
object
Pool Properties
7 properties 1 required
BatchTaskContainerExecutionInfo
object
Contains information about the container which a Task is executing.
3 properties
BatchErrorDetail_2
object
2 properties
PoolTypeUpdate
object
Type of the Pool: ephemeralDisk, azureDisk, or elasticsan
3 properties
BatchNodeReimageContent
object
Parameters for reimaging an Azure Batch Compute Node.
1 property
DataDisk
object
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 f…
4 properties 2 required
BatchNodeRemoveContent
object
Parameters for removing nodes from an Azure Batch Pool.
3 properties 1 required
BatchTaskFailureInfo
object
Information about a Task failure.
4 properties 1 required
AzureDiskSkuName
string
SKU of the underlying managed disk
ResourceOperationalStatus
object
Status of the resource
2 properties 1 required
BatchStartTaskUpdate
object
Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Nod…
7 properties
CloudServiceConfiguration
object
The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform.
2 properties 1 required
ContainerConfiguration
object
The configuration for container-enabled Pools.
3 properties 1 required
AutoUserSpecification
object
Specifies the options for the auto user that runs an Azure Batch Task.
2 properties
BatchNodeState
string
BatchNodeState enums
ContainerRegistry
object
A private container registry.
4 properties
BatchPool
object
A Pool in the Azure Batch service.
40 properties
BatchPoolReplaceContent
object
Parameters for replacing properties on an Azure Batch Pool.
5 properties 3 required
BatchPoolEvaluateAutoScaleContent
object
Parameters for evaluating an automatic scaling formula on an Azure Batch Pool.
1 property 1 required
PoolStatistics
object
5 properties 3 required
BatchNodeRebootContent
object
Parameters for rebooting an Azure Batch Compute Node.
1 property
UploadBatchServiceLogsResult
object
The result of uploading Batch service log files from a specific Compute Node.
2 properties 2 required
ReclaimPolicy
string
Reclaim policy
AzureDisk
object
Azure Disk Pool Properties
4 properties
Encryption
object
Encryption key properties for the pool.
3 properties 2 required
BatchPoolUsageStatistics
object
Statistics related to Pool usage information.
3 properties 3 required
BatchNodeFile
object
Information about a file or directory on a Compute Node.
4 properties
SecurityTypes
string
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
ResourceFile
object
A single file or multiple files to be downloaded to a Compute Node.
7 properties
RollingUpgradePolicy
object
The configuration parameters used while performing a rolling upgrade.
7 properties
Resources
object
Resource Requests for the pool.
1 property
PoolListResult
object
The response of a Pool list operation.
2 properties 1 required
VMExtension
object
The configuration for virtual machine extensions.
9 properties 3 required
BatchErrorMessage
object
An error message received in an Azure Batch error response.
2 properties
InstanceViewStatus
object
The instance view status.
5 properties
FabricProfile
object
Defines the type of fabric the agent will run on.
1 property 1 required
LoginMode
string
LoginMode enums
Assignment
object
Assignment Properties
2 properties 1 required
Requests
object
Requests for capacity for the pool.
1 property
ElevationLevel
string
ElevationLevel enums
PoolType
object
Type of the Pool: ephemeralDisk, azureDisk, or elasticsan
3 properties
ResourceStatistics
object
13 properties 13 required
InboundNATPool
object
A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.
6 properties 5 required
BatchNodeRebootOption
string
BatchNodeRebootOption enums
CifsMountConfiguration
object
Information used to connect to a CIFS file system.
5 properties 4 required
ElasticSanUpdate
object
Elastic San Pool Properties
VirtualMachineConfiguration
object
The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.
12 properties 2 required
BatchPoolEnableAutoScaleContent
object
Parameters for enabling automatic scaling on an Azure Batch Pool.
2 properties
AgentProfile
object
The agent profile of the machines in the pool.
2 properties 1 required
InboundEndpointProtocol
string
InboundEndpointProtocol enums
UsageStatistics
object
3 properties 3 required
BatchPoolResourceStatistics
object
Statistics related to resource consumption by Compute Nodes in a Pool.
13 properties 13 required
ManagedDisk
object
The managed disk parameters.
1 property 1 required
BatchTaskExecutionInfo
object
Information about the execution of a Task.
10 properties 2 required
AutomaticOsUpgradePolicy
object
The configuration parameters used for performing automatic OS upgrade.
4 properties
DiffDiskPlacement
string
AccessDiffDiskPlacementScope enums
AzureFileShareConfiguration
object
Information used to connect to an Azure Fileshare.
5 properties 4 required
AutoScaleRun
object
The results and errors from an execution of a Pool autoscale formula.
3 properties 1 required
BatchNodeUserCreateContent
object
Parameters for creating a user account for RDP or SSH access on an Azure Batch Compute Node.
5 properties 1 required
StorageAccountType
string
StorageAccountType enums
PoolUpdateProperties
object
The updatable properties of the Pool.
3 properties
LicenseType
string
License Types
VirtualMachineInfo
object
Info about the current state of the virtual machine.
2 properties
BatchPoolIdentityType
string
BatchPoolIdentityType enums
BatchNodeVMExtension
object
The configuration for virtual machine extension instance view.
3 properties
AssignmentStatus
object
Status of the assignment resource
2 properties 1 required
BatchError_2
object
3 properties
Pool_3
object
Concrete tracked resource types can be created by aliasing this type using a specific property type.
2 properties
WindowsUserConfiguration
object
Properties used to create a user Account on a Windows Compute Node.
1 property
BatchPoolUpdateContent
object
Parameters for updating an Azure Batch Pool.
5 properties
BatchError
object
An error response received from the Azure Batch service.
3 properties 1 required
AllocationState
string
AllocationState enums
BatchCertificateVisibility
string
BatchCertificateVisibility enums
PoolProperties_3
object
Pool properties
6 properties 5 required
BatchNodeCommunicationMode
string
BatchNodeCommunicationMode enums
ElasticSanSkuName
string
ElasticSAN SKUs
UserIdentity
object
The definition of the user identity under which the Task is run. Specify either the userName or autoUser property, but not both.
2 properties
ProvisioningState
string
Provisioning state of the resource.
DiffDiskSettings
object
Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).
1 property
PoolListResult_2
object
Results of the machine pool list operation.
2 properties
BatchApplicationPackageReference
object
A reference to an Package to be deployed to Compute Nodes.
2 properties 1 required
DiskEncryptionTarget
string
DiskEncryptionTarget enums
PoolProperties_2
object
Properties of a Pool
1 property 4 required
ErrorCategory
string
ErrorCategory enums
AutoUserScope
string
AutoUserScope enums
DiskEncryptionConfiguration
object
The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Azure Compute…
1 property
PoolUpdateProperties_2
object
Properties of a Pool. These properties can be updated after the resource has been created.
4 properties
AssignmentStatusState
string
Status of the assignment resource
BatchTaskInfo
object
Information about a Task running on a Compute Node.
6 properties 1 required
NetworkSecurityGroupRuleAccess
string
NetworkSecurityGroupRuleAccess enums
BatchErrorDetail
object
An item of additional information included in an Azure Batch error response.
2 properties
BatchStartTask
object
Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Nod…
7 properties 1 required
BatchPoolStatistics
object
Contains utilization and resource usage statistics for the lifetime of a Pool.
5 properties 3 required
BatchNodePlacementPolicyType
string
BatchNodePlacementPolicyType enums
SchedulingState
string
SchedulingState enums
ImageReference
object
A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified…
6 properties
BatchNodeReimageOption
string
BatchNodeReimageOption enums
BatchPoolResizeContent
object
Parameters for changing the size of an Azure Batch Pool.
4 properties
BatchNodeFillType
string
BatchNodeFillType enums
BatchTaskExecutionResult
string
BatchTaskExecutionResult enums
UserAssignedIdentity
object
The user assigned Identity
3 properties 1 required
UpgradeMode
string
UpgradeMode enums
MountConfiguration
object
The file system to mount on each node.
4 properties
BatchNodeIdentityReference
object
The reference to a user assigned identity associated with the Batch pool which a compute node will use.
1 property
BatchPoolIdentity
object
The identity of the Batch pool, if configured.
2 properties 1 required
BatchPoolListResult
object
The result of listing the Pools in an Account.
2 properties
BatchPoolCreateContent
object
Parameters for creating an Azure Batch Pool.
25 properties 2 required
PoolListUsageMetricsResult
object
2 properties
ServiceArtifactReference
object
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.
1 property 1 required
PoolUpdate_2
object
The pool properties for partial update. Properties not provided in the update request will not be changed.
1 property
BatchNodeListResult
object
The result of listing the Compute Nodes in a Pool.
2 properties
PoolUsageMetrics
object
5 properties 5 required
PoolUpdate_3
object
The type used for update operations of the Pool.
3 properties
Zone
string
Availability Zones
ResourcePredictions
object
Defines pool buffer.
PoolUpdate
object
The type used for update operations of the Pool.
2 properties
EnvironmentSetting
object
An environment variable to be set on a Task process.
2 properties 1 required
BatchNodeDisableSchedulingContent
object
Parameters for disabling scheduling on an Azure Batch Compute Node.
1 property
NetworkConfiguration
object
The network configuration for a Pool.
5 properties
VMExtensionInstanceView
object
The vm extension instance view.
3 properties
BatchNodeVMExtensionListResult
object
The result of listing the Compute Node extensions in a Node.
2 properties
BatchNodeDisableSchedulingOption
string
BatchNodeDisableSchedulingOption enums
CachingType
string
CachingType enums
Pool_2
object
A pool of Virtual Machines.
1 property
BatchTaskState
string
BatchTaskState enums
BatchNodeFileListResult
object
The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node.
2 properties
PoolUpdateProperties_3
object
The updatable properties of the Pool.
6 properties
PublicIpAddressConfiguration
object
The public IP Address configuration of the networking configuration of a Pool.
2 properties
UploadBatchServiceLogsContent
object
The Azure Batch service log files upload parameters for a Compute Node.
4 properties 2 required
ProvisioningState_2
string
The status of the current operation.
ResizeError
object
An error that occurred when resizing a Pool.
3 properties
Pool
object
Pool resource
1 property
BatchNodePlacementConfiguration
object
For regional placement, nodes in the pool will be allocated in the same region. For zonal placement, nodes in the pool will be spread across different zones wi…
1 property
BatchTaskSchedulingPolicy
object
Specifies how Tasks should be distributed across Compute Nodes.
1 property 1 required
BatchNodeRemoteLoginSettings
object
The remote login settings for a Compute Node.
2 properties 2 required
EphemeralDisk
object
Ephemeral Disk Pool Properties
2 properties
BatchNode
object
A Compute Node in the Batch service.
23 properties
ElasticSan
object
Elastic San Pool Properties
3 properties
ContainerWorkingDirectory
string
ContainerWorkingDirectory enums
NfsMountConfiguration
object
Information used to connect to an NFS file system.
3 properties 2 required
BatchPoolState
string
BatchPoolState enums
BatchPoolEndpointConfiguration
object
The endpoint configuration for a Pool.
1 property 1 required
MetadataItem
object
The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.
2 properties 2 required
BatchTaskContainerSettings
object
The container settings for a Task.
4 properties 1 required
OSDisk
object
Settings for the operating system disk of the compute node (VM).
5 properties
InboundEndpoint
object
An inbound endpoint on a Compute Node.
6 properties 6 required
AzureBlobFileSystemConfiguration
object
Information used to connect to an Azure Storage Container using Blobfuse.
7 properties 3 required
Disk
object
Model for disk for that pool is using
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-pools-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Pools API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.