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.
The identity and technical contract details declared by the specification.
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Microsoft Azure publishes across the network.