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 Pool API

The Pool API from Microsoft Azure — 4 operation(s) for pool.

Microsoft Azure Pool 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 Pool. 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 7 operations across 4 paths, and defines 54 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

7 operations 4 paths 54 schemas 1 DELETE2 GET1 PATCH2 POST1 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 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Pool 7
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Pools
microsoftAzurePoolListbybatchaccount 7 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Pools Poolname
microsoftAzurePoolCreate 7 params body → 200default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Pools Poolname
microsoftAzurePoolUpdate 6 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Pools Poolname
microsoftAzurePoolDelete 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Pools Poolname
microsoftAzurePoolGet 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/disableAutoScale
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Pools Poolname Disableautoscale
microsoftAzurePoolDisableautoscale 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/stopResize
Microsoft Azure Stops An Ongoing Resize Operation On The Pool
microsoftAzurePoolStopresize 5 params → 200default

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are PoolProperties (25 properties), VirtualMachineConfiguration (9 properties), VMExtension (8 properties), StartTask (7 properties). Each schema is shown below with its type and property counts.

TaskSchedulingPolicy
object
1 property 1 required
WindowsConfiguration
object
1 property
VirtualMachineConfiguration
object
9 properties 2 required
ResizeOperationStatus
object
Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).
6 properties
NetworkSecurityGroupRule
object
4 properties 3 required
ComputeNodeDeallocationOption
string
AutoScaleSettings
object
2 properties 1 required
MountConfiguration
object
4 properties
ListPoolsResult
object
Values returned by the List operation.
2 properties
BatchPoolIdentity
object
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 poo…
2 properties 1 required
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
AzureFileShareConfiguration
object
5 properties 4 required
AutoScaleRun
object
3 properties 1 required
NFSMountConfiguration
object
3 properties 2 required
ContainerConfiguration
object
3 properties 1 required
CloudServiceConfiguration
object
2 properties 1 required
AutoUserSpecification
object
2 properties
StartTask
object
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 setu…
7 properties
StorageAccountType
string
ContainerRegistry
object
3 properties 2 required
FixedScaleSettings
object
4 properties
CertificateReference
object
4 properties 1 required
PoolEndpointConfiguration
object
1 property 1 required
DeploymentConfiguration
object
2 properties
AzureBlobFileSystemConfiguration
object
6 properties 3 required
WindowsUserConfiguration
object
1 property
EnvironmentSetting
object
2 properties 1 required
NetworkConfiguration
object
The network configuration for a pool.
3 properties
LinuxUserConfiguration
object
3 properties
NodePlacementConfiguration
object
Allocation configuration used by Batch Service to provision the nodes.
1 property
TaskContainerSettings
object
4 properties 1 required
CachingType
string
ProxyResource
object
A definition of an Azure resource.
4 properties
ResourceFile
object
6 properties
UserIdentity
object
Specify either the userName or autoUser property, but not both.
2 properties
AutoScaleRunError
object
3 properties 2 required
NodePlacementPolicyType
string
The default value is regional.
ScaleSettings
object
Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a for…
2 properties
ResizeError
object
3 properties 2 required
VMExtension
object
8 properties 3 required
ApplicationPackageReference
object
2 properties 1 required
CIFSMountConfiguration
object
5 properties 4 required
Pool
object
Contains information about a pool.
2 properties
DiskEncryptionConfiguration
object
The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machi…
1 property
CloudErrorBody
object
An error response from the Batch service.
4 properties
CloudError
object
An error response from the Batch service.
1 property
IPAddressProvisioningType
string
PublicIPAddressConfiguration
object
The public IP Address configuration of the networking configuration of a Pool.
2 properties
UserAccount
object
5 properties 2 required
InboundNatPool
object
6 properties 5 required
ElevationLevel
string
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
ImageReference
object
5 properties
PoolProperties
object
Pool properties.
25 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-pool-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 Pool 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.