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

The Volumes API from Microsoft Azure — 15 operation(s) for volumes.

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

28 operations 15 paths 65 schemas 5 DELETE14 GET3 PATCH1 POST5 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 28

Across 15 paths, the API surfaces 28 operations — 5 DELETE, 14 GET, 3 PATCH, 1 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Volumes 28
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname Volumes
microsoftAzureVolumesListbypool 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname Volumes Volumename
microsoftAzureVolumesGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname Volumes Volumename
microsoftAzureVolumesCreateorupdate 5 params body → 200201default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname Volumes Volumename
microsoftAzureVolumesUpdate 5 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerStorage/pools/{poolName}/volumes/{volumeName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Containerstorage Pools Poolname Volumes Volumename
microsoftAzureVolumesDelete 5 params → 202204default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Elasticsan Elasticsans Elasticsanname Volumegroups Volumegroupname Volumes Volumename
microsoftAzureVolumesCreate 6 params body → 200202default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Elasticsan Elasticsans Elasticsanname Volumegroups Volumegroupname Volumes Volumename
microsoftAzureVolumesUpdate 6 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Elasticsan Elasticsans Elasticsanname Volumegroups Volumegroupname Volumes Volumename
microsoftAzureVolumesDelete 6 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Elasticsan Elasticsans Elasticsanname Volumegroups Volumegroupname Volumes Volumename
microsoftAzureVolumesGet 6 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Elasticsan Elasticsans Elasticsanname Volumegroups Volumegroupname Volumes
microsoftAzureVolumesListbyvolumegroup 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes
Microsoft Azure Describe All Volumes
microsoftAzureVolumesList 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
Microsoft Azure Describe A Volume
microsoftAzureVolumesGet 6 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
Microsoft Azure Create Or Update A Volume
microsoftAzureVolumesCreateorupdate 6 params body → 200201202default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
Microsoft Azure Update A Volume
microsoftAzureVolumesUpdate 6 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
Microsoft Azure Delete A Volume
microsoftAzureVolumesDelete 7 params → 202204default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/populateAvailabilityZone
Microsoft Azure Populate Availability Zone
microsoftAzureVolumesPopulateavailabilityzone 6 params → 200202default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeName}
Microsoft Azure Creates Or Updates A Volume Resource
microsoftAzureVolumeCreate 5 params → 200201default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeName}
Microsoft Azure Gets The Volume Resource
microsoftAzureVolumeGet 4 params → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeName}
Microsoft Azure Deletes The Volume Resource
microsoftAzureVolumeDelete 4 params → 200204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes
Microsoft Azure Gets All The Volume Resources In A Given Resource Group
microsoftAzureVolumeListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/volumes
Microsoft Azure Gets All The Volume Resources In A Given Subscription
microsoftAzureVolumeListbysubscription 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/volumes
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Volumecontainers Volumecontainername Volumes
microsoftAzureVolumesListbyvolumecontainer 6 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/volumes/{volumeName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Volumecontainers Volumecontainername Volumes V…
microsoftAzureVolumesGet 7 params → 200
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/volumes/{volumeName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Volumecontainers Volumecontainername Volumes V…
microsoftAzureVolumesCreateorupdate 7 params body → 200202
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/volumes/{volumeName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Volumecontainers Volumecontainername Volume…
microsoftAzureVolumesDelete 7 params → 202204
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/volumes/{volumeName}/metrics
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Volumecontainers Volumecontainername Volumes V…
microsoftAzureVolumesListmetrics 8 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumeContainers/{volumeContainerName}/volumes/{volumeName}/metricsDefinitions
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Volumecontainers Volumecontainername Volumes V…
microsoftAzureVolumesListmetricdefinition 7 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/volumes
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Volumes
microsoftAzureVolumesListbydevice 5 params → 200

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are volumeProperties (55 properties), volumePatchProperties (15 properties), exportPolicyRule (15 properties), Metrics (10 properties). Each schema is shown below with its type and property counts.

remotePath
object
The full path to a volume that is to be migrated into ANF. Required for Migration volumes
3 properties 3 required
VolumeUpdate_2
object
Response for Volume request.
2 properties
VolumeResourceDescriptionList
object
A pageable list of volume resources.
2 properties
VolumeList
object
List of Volumes
2 properties 1 required
networkFeatures
string
Network features available to the volume, or current state of update.
volumeRelocationProperties
object
Volume relocation properties
2 properties
IscsiTargetInfo
object
Iscsi target information
5 properties
ResourceOperationStatusState
string
State of the resource.
exportPolicyRule
object
Volume Export Policy Rule
15 properties
Volume_2
object
Response for Volume request.
2 properties
placementKeyValuePairs
object
Application specific parameters for the placement of volumes in the volume group
2 properties 2 required
VolumeProviderParametersAzureFile
object
This type describes a volume provided by an Azure Files file share.
3 properties 2 required
TrackedResource
object
The resource model definition for Azure Resource Manager tracked top-level resource.
2 properties 1 required
mountTargetProperties
object
Mount target properties
4 properties 1 required
Volume_3
object
The volume.
1 property 1 required
ErrorDetailsModel
object
Error model details information
2 properties 2 required
volumeBackupProperties
object
Volume Backup Properties
4 properties
Resource_2
object
The resource model definition for Azure Resource Manager resource.
4 properties
SourceCreationData
object
Data source used when creating the volume.
2 properties
ResourceOperationalStatus
object
Status of the resource
2 properties 1 required
volumeProperties
object
Volume properties
55 properties 3 required
BaseModel
object
Represents the base class for all other ARM object models
4 properties
volume
object
Volume resource
3 properties 2 required
VolumeUpdate
object
The type used for update operations of the Volume.
1 property
MetricData
object
The metric data.
6 properties
ErrorErrorModel
object
Error model information
4 properties 1 required
volumeSnapshotProperties
object
Volume Snapshot Properties
1 property
VolumeProperties_4
object
The properties of volume.
9 properties 5 required
MetricDefinitionList
object
The list of metric definitions.
1 property
Volume
object
Concrete proxy resource types can be created by aliasing this type using a specific property type.
1 property
MetricList
object
The metric list.
1 property
ErrorModel
object
The error details.
1 property 1 required
resourceTags
object
Tags are a list of key-value pairs that describe the resource
Error
object
The resource management error response.
1 property
VolumeListResult
object
The response of a Volume list operation.
2 properties 1 required
smbAccessBasedEnumeration
stringnull
Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
MetricDefinition
object
The monitoring metric definition.
8 properties
VolumeProperties_3
object
This type describes properties of a volume resource.
3 properties 1 required
OperationalStatus
string
Operational status of the resource.
coolAccessRetrievalPolicy
string
coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volum…
ProvisioningState
string
Provisioning state of the resource.
volumeList
object
List of volume resources
2 properties
VolumeType
object
Properties of the volume
1 property
VolumeProperties
object
Volume Properties
5 properties 2 required
MetricName
object
The metric name.
2 properties
ErrorAdditionalInfo
object
The resource management error additional info.
2 properties
ProvisionedResourceProperties
object
Describes common properties of a provisioned resource.
1 property
serviceLevel
string
The service level of the file system
VolumeList_2
object
The collection of volumes.
1 property 1 required
VolumeResourceProperties
Describes properties of a volume resource.
VolumeUpdateProperties
object
The updatable properties of the Volume.
2 properties
replicationObject
object
Replication properties
6 properties 1 required
VolumeResourceDescription
object
This type describes a volume resource.
1 property 1 required
MetricAvailablity
object
The metric availability.
2 properties
Resource
object
The resource model definition.
4 properties
smbNonBrowsable
string
Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
ElasticSanVolumeProperties
object
Properties of the ElasticSAN iSCSI target
3 properties 3 required
volumePatchProperties
object
Patchable volume properties
15 properties
VolumeUpdateProperties_2
object
Volume response properties.
1 property
Metrics
object
The monitoring metric.
10 properties
ProvisioningState_2
string
Provisioning state of the iSCSI Target.
ErrorResponse
object
The resource management error response.
5 properties
MetricDimension
object
The metric dimension. It indicates the source of the metric.
2 properties
VolumeProperties_2
object
Volume response properties.
4 properties
volumePatch
object
Volume patch resource
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-volumes-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 Volumes 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.