共用方式為


Volumes - Get

描述磁碟區
取得指定磁碟區的詳細數據

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}?api-version=2024-07-01

URI 參數

名稱 位於 必要 類型 Description
accountName
path True

string

NetApp 帳戶的名稱

Regex 模式: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$

poolName
path True

string

容量集區的名稱

Regex 模式: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$

resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

subscriptionId
path True

string

uuid

目標訂用帳戶的標識碼。 此值必須是 UUID。

volumeName
path True

string

磁碟區的名稱

Regex 模式: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$

api-version
query True

string

要用於這項作業的 API 版本。

回應

名稱 類型 Description
200 OK

volume

還行

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Volumes_Get

範例要求

GET https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1?api-version=2024-07-01

範例回覆

{
  "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
  "name": "account1/pool1/volume1",
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
  "location": "eastus",
  "properties": {
    "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
    "creationToken": "some-amazing-filepath",
    "usageThreshold": 107374182400,
    "serviceLevel": "Premium",
    "provisioningState": "Succeeded",
    "throughputMibps": 128,
    "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3",
    "networkFeatures": "Standard",
    "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4",
    "storageToNetworkProximity": "T2"
  }
}

定義

名稱 Description
avsDataStore

avsDataStore

ChownMode

此參數會指定誰有權變更檔案的擁有權。 受限制 - 只有根使用者可以變更檔案的擁有權。 不受限制 - 非根使用者可以變更其擁有的檔案擁有權。

coolAccessRetrievalPolicy

coolAccessRetrievalPolicy 會根據已啟用非經常性存取的磁碟區讀取模式,決定從非經常性存取層到標準記憶體的數據擷取行為。 此欄位的可能值為:預設值 - 資料會從非經常性存取層提取到隨機讀取的標準記憶體。 此原則是預設值。 OnRead - 所有用戶端驅動數據讀取都會從非經常性存取層提取到循序和隨機讀取的標準記憶體。 永不 - 不會從非經常性存取層提取任何用戶端驅動數據到標準記憶體。

createdByType

建立資源的身分識別類型。

DataProtection

DataProtection

enableSubvolumes

指出磁碟區上是否啟用子捲作業的旗標

EncryptionKeySource

用來加密磁碟區中數據的金鑰來源。 如果 NetApp 帳戶具有 encryption.keySource = 'Microsoft.KeyVault',則適用。 可能的值(不區分大小寫)為:'Microsoft.NetApp,Microsoft.KeyVault'

EndpointType

指出本機磁碟區是磁碟區復寫的來源或目的地

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

ExportPolicy

exportPolicy

exportPolicyRule

磁碟區匯出原則規則

fileAccessLogs

旗標,指出是否根據磁碟區上存在的使用中診斷設定,為磁碟區啟用檔案存取記錄。

mountTargetProperties

掛接目標屬性

NetworkFeatures

網路功能

placementKeyValuePairs

磁碟區群組中磁碟區放置的應用程式特定參數

remotePath

要移轉至 ANF 之磁碟區的完整路徑。 移轉磁碟區的必要專案

replicationObject

複寫屬性

ReplicationSchedule

附表

SecurityStyle

磁碟區的安全性樣式,預設 unix,預設為 ntfs 的雙重通訊協定或 CIFS 通訊協定

ServiceLevel

serviceLevel

smbAccessBasedEnumeration

smbAccessBasedEnumeration

smbNonBrowsable

smbNonBrowsable

systemData

與建立和上次修改資源相關的元數據。

volume

磁碟區資源

volumeBackupProperties

磁碟區備份屬性

volumeRelocationProperties

磁碟區重新配置屬性

volumeSnapshotProperties

磁碟區快照集屬性

VolumeStorageToNetworkProximity

記憶體到網路鄰近性

avsDataStore

avsDataStore

名稱 類型 Description
Disabled

string

avsDataStore 已停用

Enabled

string

avsDataStore 已啟用

ChownMode

此參數會指定誰有權變更檔案的擁有權。 受限制 - 只有根使用者可以變更檔案的擁有權。 不受限制 - 非根使用者可以變更其擁有的檔案擁有權。

名稱 類型 Description
Restricted

string

Unrestricted

string

coolAccessRetrievalPolicy

coolAccessRetrievalPolicy 會根據已啟用非經常性存取的磁碟區讀取模式,決定從非經常性存取層到標準記憶體的數據擷取行為。 此欄位的可能值為:預設值 - 資料會從非經常性存取層提取到隨機讀取的標準記憶體。 此原則是預設值。 OnRead - 所有用戶端驅動數據讀取都會從非經常性存取層提取到循序和隨機讀取的標準記憶體。 永不 - 不會從非經常性存取層提取任何用戶端驅動數據到標準記憶體。

名稱 類型 Description
Default

string

Never

string

OnRead

string

createdByType

建立資源的身分識別類型。

名稱 類型 Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataProtection

DataProtection

名稱 類型 Description
backup

volumeBackupProperties

備份
備份屬性

replication

replicationObject

複製
複寫屬性

snapshot

volumeSnapshotProperties

快照
快照集屬性。

volumeRelocation

volumeRelocationProperties

VolumeRelocation
VolumeRelocation 屬性

enableSubvolumes

指出磁碟區上是否啟用子捲作業的旗標

名稱 類型 Description
Disabled

string

未啟用子卷

Enabled

string

子卷已啟用

EncryptionKeySource

用來加密磁碟區中數據的金鑰來源。 如果 NetApp 帳戶具有 encryption.keySource = 'Microsoft.KeyVault',則適用。 可能的值(不區分大小寫)為:'Microsoft.NetApp,Microsoft.KeyVault'

名稱 類型 Description
Microsoft.KeyVault

string

客戶管理的金鑰加密

Microsoft.NetApp

string

Microsoft管理的金鑰加密

EndpointType

指出本機磁碟區是磁碟區復寫的來源或目的地

名稱 類型 Description
dst

string

src

string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細數據。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

ExportPolicy

exportPolicy

名稱 類型 Description
rules

exportPolicyRule[]

匯出原則規則
匯出原則規則

exportPolicyRule

磁碟區匯出原則規則

名稱 類型 預設值 Description
allowedClients

string

用戶端輸入規格以逗號分隔字串,其中包含IPv4CIDR、IPv4 主機名和主機名

chownMode

ChownMode

Restricted

此參數會指定誰有權變更檔案的擁有權。 受限制 - 只有根使用者可以變更檔案的擁有權。 不受限制 - 非根使用者可以變更其擁有的檔案擁有權。

cifs

boolean

允許 CIFS 通訊協定

hasRootAccess

boolean

True

具有磁碟區的根存取權

kerberos5ReadOnly

boolean

False

Kerberos5 只讀存取權。 與 Swagger 版本 2020-05-01 或更新版本搭配使用

kerberos5ReadWrite

boolean

False

Kerberos5 讀取和寫入存取權。 與 Swagger 版本 2020-05-01 或更新版本搭配使用

kerberos5iReadOnly

boolean

False

Kerberos5i 唯讀存取權。 與 Swagger 版本 2020-05-01 或更新版本搭配使用

kerberos5iReadWrite

boolean

False

Kerberos5i 讀取和寫入存取權。 與 Swagger 版本 2020-05-01 或更新版本搭配使用

kerberos5pReadOnly

boolean

False

Kerberos5p 唯讀存取權。 與 Swagger 版本 2020-05-01 或更新版本搭配使用

kerberos5pReadWrite

boolean

False

Kerberos5p 讀取和寫入存取權。 與 Swagger 版本 2020-05-01 或更新版本搭配使用

nfsv3

boolean

允許 NFSv3 通訊協定。 僅針對 NFSv3 類型磁碟區啟用

nfsv41

boolean

允許 NFSv4.1 通訊協定。 僅針對 NFSv4.1 類型磁碟區啟用

ruleIndex

integer

訂單索引

unixReadOnly

boolean

唯讀存取

unixReadWrite

boolean

讀取和寫入存取權

fileAccessLogs

旗標,指出是否根據磁碟區上存在的使用中診斷設定,為磁碟區啟用檔案存取記錄。

名稱 類型 Description
Disabled

string

fileAccessLogs 未啟用

Enabled

string

fileAccessLogs 已啟用

mountTargetProperties

掛接目標屬性

名稱 類型 Description
fileSystemId

string

fileSystemId
用來識別 MountTarget 的 UUID v4

ipAddress

string

ipAddress
掛接目標的 IPv4 位址

mountTargetId

string

mountTargetId
用來識別 MountTarget 的 UUID v4

smbServerFqdn

string

smbServerFQDN
SMB 伺服器的完整功能變數名稱 FQDN

NetworkFeatures

網路功能

名稱 類型 Description
Basic

string

基本網路功能。

Basic_Standard

string

從基本網路功能更新為標準網路功能。

Standard

string

標準網路功能。

Standard_Basic

string

從標準更新至基本網路功能。

placementKeyValuePairs

磁碟區群組中磁碟區放置的應用程式特定參數

名稱 類型 Description
key

string

磁碟區群組中磁碟區放置的應用程式特定參數索引鍵

value

string

磁碟區群組中磁碟區放置的應用程式特定參數值

remotePath

要移轉至 ANF 之磁碟區的完整路徑。 移轉磁碟區的必要專案

名稱 類型 Description
externalHostName

string

ONTAP 主機的路徑

serverName

string

ONTAP 主機上的伺服器名稱

volumeName

string

伺服器上的磁碟區名稱

replicationObject

複寫屬性

名稱 類型 Description
endpointType

EndpointType

指出本機磁碟區是磁碟區復寫的來源或目的地

remotePath

remotePath

要移轉至 ANF 之磁碟區的完整路徑。 移轉磁碟區的必要專案

remoteVolumeRegion

string

磁碟區復寫另一端的遠端區域。

remoteVolumeResourceId

string

遠端磁碟區的資源標識碼。 跨區域和跨區域複寫的必要專案

replicationId

string

標識碼

replicationSchedule

ReplicationSchedule

附表

ReplicationSchedule

附表

名稱 類型 Description
_10minutely

string

daily

string

hourly

string

SecurityStyle

磁碟區的安全性樣式,預設 unix,預設為 ntfs 的雙重通訊協定或 CIFS 通訊協定

名稱 類型 Description
ntfs

string

unix

string

ServiceLevel

serviceLevel

名稱 類型 Description
Premium

string

進階服務等級

Standard

string

標準服務等級

StandardZRS

string

區域備援記憶體服務等級

Ultra

string

Ultra 服務等級

smbAccessBasedEnumeration

smbAccessBasedEnumeration

名稱 類型 Description
Disabled

string

smbAccessBasedEnumeration 共用設定已停用

Enabled

string

smbAccessBasedEnumeration 共用設定已啟用

smbNonBrowsable

smbNonBrowsable

名稱 類型 Description
Disabled

string

smbNonBrowsable 共用設定已停用

Enabled

string

smbNonBrowsable 共用設定已啟用

systemData

與建立和上次修改資源相關的元數據。

名稱 類型 Description
createdAt

string

資源建立的時間戳(UTC)。

createdBy

string

建立資源的身分識別。

createdByType

createdByType

建立資源的身分識別類型。

lastModifiedAt

string

上次修改的資源時間戳 (UTC)

lastModifiedBy

string

上次修改資源的身分識別。

lastModifiedByType

createdByType

上次修改資源的身分識別類型。

volume

磁碟區資源

名稱 類型 預設值 Description
etag

string

每當更新資源時變更的唯一隻讀字串。

id

string

資源的完整資源標識碼。 例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

location

string

資源所在的地理位置

name

string

資源的名稱

properties.actualThroughputMibps

number

根據大小和 serviceLevel 計算之自動 qosType 磁碟區 MiB/秒的實際輸送量

properties.avsDataStore

avsDataStore

Disabled

avsDataStore
指定磁碟區是否已啟用 Azure VMware 解決方案 (AVS) 資料存放區用途

properties.backupId

string

備份標識碼
用來識別備份的資源標識碼。

properties.baremetalTenantId

string

裸機租用戶標識碼
唯一裸機租用戶標識碼。

properties.capacityPoolResourceId

string

透過磁碟區群組建立磁碟區時所使用的集區資源標識碼

properties.cloneProgress

integer

從另一個磁碟區的快照集還原磁碟區時,會顯示此複製程式的完成百分比。 當這個值是空的/Null 時,此磁碟區目前沒有任何複製程序發生。 此值會在複製期間每隔 5 分鐘更新一次。

properties.coolAccess

boolean

False

指定是否為磁碟區啟用非經常性存取(階層處理)。

properties.coolAccessRetrievalPolicy

coolAccessRetrievalPolicy

coolAccessRetrievalPolicy 會根據已啟用非經常性存取的磁碟區讀取模式,決定從非經常性存取層到標準記憶體的數據擷取行為。 此欄位的可能值為:預設值 - 資料會從非經常性存取層提取到隨機讀取的標準記憶體。 此原則是預設值。 OnRead - 所有用戶端驅動數據讀取都會從非經常性存取層提取到循序和隨機讀取的標準記憶體。 永不 - 不會從非經常性存取層提取任何用戶端驅動數據到標準記憶體。

properties.coolnessPeriod

integer

指定用戶端不會存取資料的天數。

properties.creationToken

string

建立令牌或檔案路徑
磁碟區的唯一檔案路徑。 建立掛接目標時使用

properties.dataProtection

DataProtection

DataProtection
DataProtection 類型磁碟區包含包含複寫詳細數據的物件

properties.dataStoreResourceId

string[]

dataStoreResourceId
數據存放區資源唯一標識符

properties.defaultGroupQuotaInKiBs

integer

0

KiB 中磁碟區的預設群組配額。 如果已設定 isDefaultQuotaEnabled,則會套用 4 KiBs 的最小值。

properties.defaultUserQuotaInKiBs

integer

0

KiBs 中磁碟區的預設使用者配額。 如果已設定 isDefaultQuotaEnabled,則會套用 4 KiBs 的最小值。

properties.deleteBaseSnapshot

boolean

如果已啟用 (true),則磁碟區建立的快照集會在磁碟區建立作業完成之後自動刪除。 默認值為 false

properties.effectiveNetworkFeatures

NetworkFeatures

Basic

網路功能
可供磁碟區使用之網路功能類型的有效值,或目前有效的更新狀態。

properties.enableSubvolumes

enableSubvolumes

Disabled

指出磁碟區上是否啟用子捲作業的旗標

properties.encrypted

boolean

指定磁碟區是否已加密。 僅適用於在 2022-01-01 之後建立或更新的磁碟區。

properties.encryptionKeySource

EncryptionKeySource

Microsoft.NetApp

用來加密磁碟區中數據的金鑰來源。 如果 NetApp 帳戶具有 encryption.keySource = 'Microsoft.KeyVault',則適用。 可能的值(不區分大小寫)為:'Microsoft.NetApp,Microsoft.KeyVault'

properties.exportPolicy

ExportPolicy

exportPolicy
一組導出原則規則

properties.fileAccessLogs

fileAccessLogs

Disabled

旗標,指出是否根據磁碟區上存在的使用中診斷設定,為磁碟區啟用檔案存取記錄。

properties.fileSystemId

string

FileSystem 標識符
唯一的 FileSystem 識別符。

properties.isDefaultQuotaEnabled

boolean

False

指定磁碟區是否啟用預設配額。

properties.isLargeVolume

boolean

False

是大型磁碟區
指定磁碟區是大型磁碟區還是一般磁碟區。

properties.isRestoring

boolean

恢復

properties.kerberosEnabled

boolean

False

描述磁碟區是否為 KerberosEnabled。 與 Swagger 版本 2020-05-01 或更新版本搭配使用

properties.keyVaultPrivateEndpointResourceId

string

KeyVault 私人端點的資源標識碼。 它必須位於與磁碟區相同的 VNET 中。 只有在 encryptionKeySource = 'Microsoft.KeyVault' 時才適用。

properties.ldapEnabled

boolean

False

指定指定的NFS磁碟區是否啟用LDAP。

properties.maximumNumberOfFiles

integer

允許的檔案數目上限。 需要服務要求才能變更。 只有在磁碟區配額超過 4TiB 時,才允許變更。

properties.mountTargets

mountTargetProperties[]

mountTargets
掛接目標清單

properties.networkFeatures

NetworkFeatures

Basic

網路功能
網路功能類型在建立時可供磁碟區使用的原始值。

properties.networkSiblingSetId

string

網路同層級集標識碼
共用網路資源的磁碟區群組的網路同層級設定標識碼。

properties.originatingResourceId

string

原始資源標識碼
從中還原磁碟區之快照集或備份的標識碼。

properties.placementRules

placementKeyValuePairs[]

磁碟區放置規則
特定磁碟區的應用程式特定放置規則

properties.protocolTypes

string[]

protocolTypes
一組通訊協定類型、預設的 NFSv3、SMB 通訊協定的 CIFS

properties.provisionedAvailabilityZone

string

布建的可用性區域
布建磁碟區的可用性區域。 這是指磁碟區所在的邏輯可用性區域。

properties.provisioningState

string

Azure 生命週期管理

properties.proximityPlacementGroup

string

與磁碟區相關聯的鄰近放置群組

properties.securityStyle

SecurityStyle

unix

磁碟區的安全性樣式,預設 unix,預設為 ntfs 的雙重通訊協定或 CIFS 通訊協定

properties.serviceLevel

ServiceLevel

Premium

serviceLevel
檔系統的服務等級

properties.smbAccessBasedEnumeration

smbAccessBasedEnumeration

smbAccessBasedEnumeration
啟用SMB共用的存取型列舉共享屬性。 僅適用於SMB/DualProtocol磁碟區

properties.smbContinuouslyAvailable

boolean

False

為smb磁碟區啟用持續可用的共享屬性。 僅適用於SMB磁碟區

properties.smbEncryption

boolean

False

啟用內部 smb3 資料的加密。 僅適用於SMB/DualProtocol磁碟區。 與 Swagger 版本 2020-08-01 或更新版本搭配使用

properties.smbNonBrowsable

smbNonBrowsable

smbNonBrowsable
啟用SMB共用不可瀏覽的屬性。 僅適用於SMB/DualProtocol磁碟區

properties.snapshotDirectoryVisible

boolean

True

如果啟用 (true), 磁碟區將包含唯讀快照集目錄,可提供每個磁碟區快照集的存取權(預設值為 true)。

properties.snapshotId

string

快照集標識碼
用來識別快照集的資源標識碼。

properties.storageToNetworkProximity

VolumeStorageToNetworkProximity

記憶體到網路鄰近性
提供磁碟區網路鄰近資訊的記憶體。

properties.subnetId

string

委派子網的 Azure 資源 URI。 必須有委派Microsoft.NetApp/volumes

properties.t2Network

string

T2 網路資訊

properties.throughputMibps

number

MiB/s 中可透過此磁碟區達到的最大輸送量,這隻會接受為手動 qosType 磁碟區的輸入

properties.unixPermissions

string

以八進位 4 位數格式接受的 NFS 磁碟區 UNIX 許可權。 第一個數字會選取設定的使用者標識元(4)、設定群組標識碼 (2) 和黏性 (1) 屬性。 第二位數會選取檔案擁有者的許可權:讀取 (4)、寫入 (2) 和執行 (1)。 第三個會選取相同群組中其他用戶的許可權。 群組中其他使用者的第四個。 0755 - 提供擁有者讀取/寫入/執行許可權給群組和其他使用者。

properties.usageThreshold

integer

0

usageThreshold
文件系統允許的記憶體配額上限,以位元組為單位。 這是僅用於警示的軟配額。 針對一般磁碟區,有效值介於 50GiB 到 100TiB 的範圍內。 對於大型磁碟區,有效值的範圍是 100TiB 到 500TiB,且以例外為基礎,從 2400GiB 到 2400TiB。 以位元組表示為1 GiB倍數的值。

properties.volumeGroupName

string

磁碟區組名

properties.volumeSpecName

string

磁碟區規格名稱是磁碟區群組中特定磁碟區的應用程式特定指定或標識元,例如數據、記錄

properties.volumeType

string

此磁碟區的類型為何。 針對跨區域復寫中的目的地磁碟區,請將類型設定為 DataProtection

systemData

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。

tags

object

資源標籤。

type

string

資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

zones

string[]

可用性區域

volumeBackupProperties

磁碟區備份屬性

名稱 類型 Description
backupPolicyId

string

備份原則資源標識碼

backupVaultId

string

備份保存庫資源標識碼

policyEnforced

boolean

強制執行原則

volumeRelocationProperties

磁碟區重新配置屬性

名稱 類型 Description
readyToBeFinalized

boolean

搬遷完成,並準備清理

relocationRequested

boolean

已要求重新配置此磁碟區

volumeSnapshotProperties

磁碟區快照集屬性

名稱 類型 Description
snapshotPolicyId

string

快照集原則 ResourceId

VolumeStorageToNetworkProximity

記憶體到網路鄰近性

名稱 類型 Description
AcrossT2

string

標準跨T2記憶體與網路連線能力。

Default

string

網路連線的基本記憶體。

T1

string

標準 T1 記憶體與網路連線能力。

T2

string

標準 T2 記憶體與網路連線能力。