Volumes - Get

服務:

Azure NetApp Files

API 版本:

2025-12-01

取得指定磁碟區的詳細資料

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

URI 參數

名稱	位於	必要	類型	Description
accountName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$	NetApp 帳戶的名稱
poolName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$	容量集區的名稱
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
volumeName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$	卷冊的名稱
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	Volume	Azure 作業已順利完成。
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

範例要求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1?api-version=2025-12-01

Java

/**
 * Samples for Volumes Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-12-01/Volumes_Get.json
     */
    /**
     * Sample code: Volumes_Get.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void volumesGet(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.volumes().getWithResponse("myRG", "account1", "pool1", "volume1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python volumes_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetAppManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.volumes.get(
        resource_group_name="myRG",
        account_name="account1",
        pool_name="pool1",
        volume_name="volume1",
    )
    print(response)


# x-ms-original-file: 2025-12-01/Volumes_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v9"
)

// Generated from example definition: 2025-12-01/Volumes_Get.json
func ExampleVolumesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVolumesClient().Get(ctx, "myRG", "account1", "pool1", "volume1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armnetapp.VolumesClientGetResponse{
	// 	Volume: &armnetapp.Volume{
	// 		Name: to.Ptr("account1/pool1/volume1"),
	// 		Type: to.Ptr("Microsoft.NetApp/netAppAccounts/capacityPools/volumes"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1"),
	// 		Location: to.Ptr("eastus"),
	// 		Properties: &armnetapp.VolumeProperties{
	// 			CreationToken: to.Ptr("my-unique-file-path"),
	// 			FileSystemID: to.Ptr("9760acf5-4638-11e7-9bdb-020073ca7778"),
	// 			NetworkFeatures: to.Ptr(armnetapp.NetworkFeaturesStandard),
	// 			NetworkSiblingSetID: to.Ptr("0f434a03-ce0b-4935-81af-d98652ffb1c4"),
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			ServiceLevel: to.Ptr(armnetapp.ServiceLevelPremium),
	// 			StorageToNetworkProximity: to.Ptr(armnetapp.VolumeStorageToNetworkProximityT2),
	// 			SubnetID: to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"),
	// 			ThroughputMibps: to.Ptr[float32](128),
	// 			UsageThreshold: to.Ptr[int64](107374182400),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get the details of the specified volume
 *
 * @summary get the details of the specified volume
 * x-ms-original-file: 2025-12-01/Volumes_Get.json
 */
async function volumesGet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.volumes.get("myRG", "account1", "pool1", "volume1");
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.NetApp.Models;
using Azure.ResourceManager.NetApp;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/NetApp/stable/2025-12-01/examples/Volumes_Get.json
// this example is just showing the usage of "Volumes_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CapacityPoolResource created on azure
// for more information of creating CapacityPoolResource, please refer to the document of CapacityPoolResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myRG";
string accountName = "account1";
string poolName = "pool1";
ResourceIdentifier capacityPoolResourceId = CapacityPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, poolName);
CapacityPoolResource capacityPool = client.GetCapacityPoolResource(capacityPoolResourceId);

// get the collection of this NetAppVolumeResource
NetAppVolumeCollection collection = capacityPool.GetNetAppVolumes();

// invoke the operation
string volumeName = "volume1";
NullableResponse<NetAppVolumeResource> response = await collection.GetIfExistsAsync(volumeName);
NetAppVolumeResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    NetAppVolumeData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

200

{
  "name": "account1/pool1/volume1",
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
  "location": "eastus",
  "properties": {
    "creationToken": "my-unique-file-path",
    "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
    "networkFeatures": "Standard",
    "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4",
    "provisioningState": "Succeeded",
    "serviceLevel": "Premium",
    "storageToNetworkProximity": "T2",
    "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3",
    "throughputMibps": 128,
    "usageThreshold": 107374182400
  }
}

定義

名稱	Description
AcceptGrowCapacityPoolForShortTermCloneSplit	當自動分割短期複製磁碟區時，如果父集區沒有足夠的空間來容納分割之後的磁碟區，它會自動重設大小，這會導致計費增加。 若要接受容量集區大小自動成長並建立短期複製磁碟區，請將 屬性設定為已接受。
ActualRansomwareProtectionState	進階勒索軟體防護功能的實際狀態
AvsDataStore	指定磁碟區是否已啟用 Azure VMware 解決方案 （AVS） 資料存放區用途
ChownMode	此參數會指定誰有權變更檔案的擁有權。 受限制 - 只有根使用者可以變更檔案的擁有權。 不受限制 - 非根使用者可以變更其擁有的檔案擁有權。
CoolAccessRetrievalPolicy	coolAccessRetrievalPolicy 會根據已啟用非經常性存取的磁碟區讀取模式，決定從非經常性存取層到標準記憶體的數據擷取行為。 此欄位的可能值為：預設值 - 資料將在隨機讀取時從冷層提取至標準儲存體。 此原則是預設值。 OnRead - 所有用戶端驅動數據讀取都會從非經常性存取層提取到循序和隨機讀取的標準記憶體。 永不 - 不會從非經常性存取層提取任何用戶端驅動數據到標準記憶體。
CoolAccessTieringPolicy	coolAccessTieringPolicy 會決定哪些冷數據區塊會移至非經常性存取層。 此欄位的可能值為：自動 - 將快照集復本和作用中文件系統中的冷用戶數據區塊移至非經常性存取層層。 此原則是預設值。 SnapshotOnly - 將與作用中文件系統沒有關聯的磁碟區快照集用戶數據區塊移至非經常性存取層。
createdByType	建立資源的身分識別類型。
DesiredRansomwareProtectionState	進階勒索軟體防護功能所需的狀態
DestinationReplication	目的地復寫屬性
EnableSubvolumes	指出磁碟區上是否啟用子捲作業的旗標
EncryptionKeySource	用來加密磁碟區中數據的金鑰來源。 如果 NetApp 帳戶具有 encryption.keySource = 'Microsoft.KeyVault'，則適用。 可能的值（不區分大小寫）為：'Microsoft.NetApp，Microsoft.KeyVault'
EndpointType	指出本機磁碟區是磁碟區復寫的來源或目的地
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ExportPolicyRule	磁碟區匯出原則規則
FileAccessLogs	旗標，指出是否根據磁碟區上存在的使用中診斷設定，為磁碟區啟用檔案存取記錄。
MountTargetProperties	掛接目標屬性
NetworkFeatures	磁碟區可用的網路功能，或更新的目前狀態。
PlacementKeyValuePairs	磁碟區群組中磁碟區放置的應用程式特定參數
RansomwareProtectionSettings	進階勒索軟體防護報告 （ARP） 設定
RemotePath	要移轉至 ANF 之磁碟區的完整路徑。 移轉磁碟區的必要專案
ReplicationObject	複寫屬性
ReplicationSchedule	排程
ReplicationType	指出複寫是跨區域還是跨區域。
SecurityStyle	磁碟區的安全性樣式，預設 unix，預設為 ntfs 的雙重通訊協定或 CIFS 通訊協定
ServiceLevel	檔系統的服務等級
SmbAccessBasedEnumeration	啟用SMB共用的存取型列舉共享屬性。 僅適用於SMB/DualProtocol磁碟區
SmbNonBrowsable	啟用SMB共用不可瀏覽的屬性。 僅適用於SMB/DualProtocol磁碟區
systemData	與建立和上次修改資源相關的元數據。
Volume	磁碟區資源
VolumeBackupProperties	磁碟區備份屬性
VolumePropertiesDataProtection	DataProtection 類型磁碟區包含包含複寫詳細數據的物件
VolumePropertiesExportPolicy	一組導出原則規則
VolumeRelocationProperties	磁碟區重新配置屬性
VolumeSnapshotProperties	磁碟區快照集屬性
VolumeStorageToNetworkProximity	提供磁碟區網路鄰近資訊的記憶體。

AcceptGrowCapacityPoolForShortTermCloneSplit

列舉型別

當自動分割短期複製磁碟區時，如果父集區沒有足夠的空間來容納分割之後的磁碟區，它會自動重設大小，這會導致計費增加。 若要接受容量集區大小自動成長並建立短期複製磁碟區，請將 屬性設定為已接受。

值	Description
Accepted	接受短期複製分割的自動成長容量集區。
Declined	短期複製分割的自動成長容量集區會遭到拒絕。 不允許短期複製磁碟區建立，以建立短期複製磁碟區接受自動成長容量集區。

ActualRansomwareProtectionState

列舉型別

進階勒索軟體防護功能的實際狀態

值	Description
Disabled	進階勒索軟體防護已停用
Enabled	啟用進階勒索軟體防護
Learning	進階勒索軟體防護處於學習模式
Paused	進階勒索軟體防護處於暫停狀態

AvsDataStore

列舉型別

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

值	Description
Enabled	avsDataStore 已啟用
Disabled	avsDataStore 已停用

ChownMode

列舉型別

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

值	Description
Restricted
Unrestricted

CoolAccessRetrievalPolicy

列舉型別

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

值	Description
Default
OnRead
Never

CoolAccessTieringPolicy

列舉型別

coolAccessTieringPolicy 會決定哪些冷數據區塊會移至非經常性存取層。 此欄位的可能值為：自動 - 將快照集復本和作用中文件系統中的冷用戶數據區塊移至非經常性存取層層。 此原則是預設值。 SnapshotOnly - 將與作用中文件系統沒有關聯的磁碟區快照集用戶數據區塊移至非經常性存取層。

值	Description
Auto
SnapshotOnly

createdByType

列舉型別

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

值	Description
User
Application
ManagedIdentity
Key

DesiredRansomwareProtectionState

列舉型別

進階勒索軟體防護功能所需的狀態

值	Description
Disabled	進階勒索軟體防護已停用
Enabled	啟用進階勒索軟體防護

DestinationReplication

Object

目的地復寫屬性

名稱	類型	Description
region	string	目的地磁碟區的遠端區域。
replicationType	ReplicationType	指出複寫是跨區域還是跨區域。
resourceId	string (arm-id)	遠端磁碟區的資源識別碼
zone	string	目的地磁碟區的遠端區域。

EnableSubvolumes

列舉型別

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

值	Description
Enabled	子卷已啟用
Disabled	未啟用子卷

EncryptionKeySource

列舉型別

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

值	Description
Microsoft.NetApp	Microsoft管理的金鑰加密
Microsoft.KeyVault	客戶管理的金鑰加密

EndpointType

列舉型別

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

值	Description
src
dst

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	附加資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

ExportPolicyRule

Object

磁碟區匯出原則規則

名稱	類型	預設值	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 (int32)		訂單索引
unixReadOnly	boolean		唯讀存取
unixReadWrite	boolean		讀取和寫入存取權

FileAccessLogs

列舉型別

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

值	Description
Enabled	fileAccessLogs 已啟用
Disabled	fileAccessLogs 未啟用

MountTargetProperties

Object

掛接目標屬性

名稱	類型	Description
fileSystemId	string minLength: 36 maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$	用來識別 MountTarget 的 UUID v4
ipAddress	string	掛載目標的 IPv4 位址
mountTargetId	string minLength: 36 maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$	用來識別 MountTarget 的 UUID v4
smbServerFqdn	string	SMB 伺服器的完整功能變數名稱 FQDN

NetworkFeatures

列舉型別

磁碟區可用的網路功能，或更新的目前狀態。

值	Description
Basic	基本網路功能。
Standard	標準網路功能。
Basic_Standard	從基本網路功能更新為標準網路功能。
Standard_Basic	從標準更新至基本網路功能。

PlacementKeyValuePairs

Object

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

名稱	類型	Description
key	string	磁碟區群組中磁碟區放置的應用程式特定參數索引鍵
value	string	磁碟區群組中磁碟區放置的應用程式特定參數值

RansomwareProtectionSettings

Object

進階勒索軟體防護報告 （ARP） 設定

名稱	類型	Description
actualRansomwareProtectionState	ActualRansomwareProtectionState	磁碟區上目前作用中的進階勒索軟體防護功能的實際狀態
desiredRansomwareProtectionState	DesiredRansomwareProtectionState	磁碟區可用的進階勒索軟體防護功能狀態的所需值

RemotePath

Object

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

名稱	類型	Description
externalHostName	string	ONTAP 主機的路徑
serverName	string	ONTAP 主機上的伺服器名稱
volumeName	string	伺服器上的磁碟區名稱

ReplicationObject

Object

複寫屬性

名稱	類型	Description
destinationReplications	DestinationReplication[]	目的地複寫清單
endpointType	EndpointType	指出本機磁碟區是磁碟區復寫的來源或目的地
remotePath	RemotePath	要移轉至 ANF 之磁碟區的完整路徑。 移轉磁碟區的必要專案
remoteVolumeRegion	string	磁碟區復寫另一端的遠端區域。
remoteVolumeResourceId	string	遠端磁碟區的資源標識碼。 跨區域和跨區域複寫的必要專案
replicationId	string	身份識別碼
replicationSchedule	ReplicationSchedule	排程

ReplicationSchedule

列舉型別

排程

值	Description
_10minutely
hourly
daily

ReplicationType

列舉型別

指出複寫是跨區域還是跨區域。

值	Description
CrossRegionReplication	跨區域複寫
CrossZoneReplication	跨區域複寫

SecurityStyle

列舉型別

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

值	Description
ntfs
unix

ServiceLevel

列舉型別

檔系統的服務等級

值	Description
Standard	標準服務等級
Premium	進階服務等級
Ultra	Ultra 服務等級
StandardZRS	區域備援記憶體服務等級。 這很快就會被取代。
Flexible	靈活的服務水平

SmbAccessBasedEnumeration

列舉型別

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

值	Description
Disabled	smbAccessBasedEnumeration 共用設定已停用
Enabled	smbAccessBasedEnumeration 共用設定已啟用

SmbNonBrowsable

列舉型別

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

值	Description
Disabled	smbNonBrowsable 共用設定已停用
Enabled	smbNonBrowsable 共用設定已啟用

systemData

Object

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

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	資源上次修改的時間戳記 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

Volume

Object

磁碟區資源

名稱	類型	預設值	Description
etag	string		“如果在響應本文中提供了 etag，它也可以根據正常的 etag 約定作為標頭提供。 實體標籤用於比較來自相同要求資源的兩個或多個實體。 HTTP/1.1 在 etag（第 14.19 節）、If-Match（第 14.24 節）、If-None-Match（第 14.26 節）和 If-Range（第 14.27 節）標頭欄位中使用實體標籤。
id	string (arm-id)		資源的完整資源標識碼。 例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string		資源所在的地理位置
name	string		資源的名稱
properties.acceptGrowCapacityPoolForShortTermCloneSplit	AcceptGrowCapacityPoolForShortTermCloneSplit		當自動分割短期複製磁碟區時，如果父集區沒有足夠的空間來容納分割之後的磁碟區，它會自動重設大小，這會導致計費增加。 若要接受容量集區大小自動成長並建立短期複製磁碟區，請將 屬性設定為已接受。
properties.actualThroughputMibps	number (float)		根據大小和服務層級計算的自動 qosType 磁碟區的實際輸送量 （以 MiB/s 為單位）
properties.avsDataStore	AvsDataStore	Disabled	指定磁碟區是否已啟用 Azure VMware 解決方案 （AVS） 資料存放區用途
properties.backupId	string (arm-id)		用來識別備份的資源標識碼。
properties.baremetalTenantId	string		唯一裸機租用戶標識碼。
properties.capacityPoolResourceId	string		透過磁碟區群組建立磁碟區時所使用的集區資源標識碼
properties.cloneProgress	integer (int32)		從另一個磁碟區的快照集還原磁碟區時，會顯示此複製程式的完成百分比。 當這個值是空的/Null 時，此磁碟區目前沒有任何複製程序發生。 此值會在複製期間每隔 5 分鐘更新一次。
properties.coolAccess	boolean	False	指定是否為磁碟區啟用非經常性存取（階層處理）。
properties.coolAccessRetrievalPolicy	CoolAccessRetrievalPolicy		coolAccessRetrievalPolicy 會根據已啟用非經常性存取的磁碟區讀取模式，決定從非經常性存取層到標準記憶體的數據擷取行為。 此欄位的可能值為：預設值 - 資料將在隨機讀取時從冷層提取至標準儲存體。 此原則是預設值。 OnRead - 所有用戶端驅動數據讀取都會從非經常性存取層提取到循序和隨機讀取的標準記憶體。 永不 - 不會從非經常性存取層提取任何用戶端驅動數據到標準記憶體。
properties.coolAccessTieringPolicy	CoolAccessTieringPolicy		coolAccessTieringPolicy 會決定哪些冷數據區塊會移至非經常性存取層。 此欄位的可能值為：自動 - 將快照集復本和作用中文件系統中的冷用戶數據區塊移至非經常性存取層層。 此原則是預設值。 SnapshotOnly - 將與作用中文件系統沒有關聯的磁碟區快照集用戶數據區塊移至非經常性存取層。
properties.coolnessPeriod	integer (int32) minimum: 2 maximum: 183		指定用戶端不會存取資料的天數。
properties.creationToken	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$		磁碟區的唯一檔案路徑。 建立掛接目標時使用
properties.dataProtection	VolumePropertiesDataProtection		DataProtection 類型磁碟區包含包含複寫詳細數據的物件
properties.dataStoreResourceId	string[]		資料存放區資源唯一識別碼
properties.defaultGroupQuotaInKiBs	integer (int64)	0	KiB 中磁碟區的預設群組配額。 如果已設定 isDefaultQuotaEnabled，則會套用 4 KiBs 的最小值。
properties.defaultUserQuotaInKiBs	integer (int64)	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	VolumePropertiesExportPolicy		一組導出原則規則
properties.fileAccessLogs	FileAccessLogs	Disabled	旗標，指出是否根據磁碟區上存在的使用中診斷設定，為磁碟區啟用檔案存取記錄。
properties.fileSystemId	string minLength: 36 maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$		唯一的 FileSystem 識別符。
properties.inheritedSizeInBytes	integer (int64)		短期複製磁碟區與父磁碟區共用的空間（以位元組為單位）。
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 (int64)		允許的檔案數目上限。 需要服務要求才能變更。 只有在磁碟區配額超過 4TiB 時，才允許變更。
properties.mountTargets	MountTargetProperties[]		掛接目標清單
properties.networkFeatures	NetworkFeatures	Basic	網路功能類型在建立時可供磁碟區使用的原始值。
properties.networkSiblingSetId	string minLength: 36 maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$		共用網路資源的磁碟區群組的網路同層級設定標識碼。
properties.originatingResourceId	string		從中還原磁碟區之快照集或備份的標識碼。
properties.placementRules	PlacementKeyValuePairs[]		特定磁碟區的應用程式特定放置規則
properties.protocolTypes	string[]		一組通訊協定類型、預設的 NFSv3、SMB 通訊協定的 CIFS
properties.provisionedAvailabilityZone	string		布建磁碟區的可用性區域。 這是指磁碟區所在的邏輯可用性區域。
properties.provisioningState	string		Azure 生命週期管理
properties.proximityPlacementGroup	string		與磁碟區相關聯的鄰近放置群組
properties.securityStyle	SecurityStyle	unix	磁碟區的安全性樣式，預設 unix，預設為 ntfs 的雙重通訊協定或 CIFS 通訊協定
properties.serviceLevel	ServiceLevel	Premium	檔系統的服務等級
properties.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		啟用SMB共用不可瀏覽的屬性。 僅適用於SMB/DualProtocol磁碟區
properties.snapshotDirectoryVisible	boolean	True	如果啟用 （true）， 磁碟區將包含唯讀快照集目錄，可提供每個磁碟區快照集的存取權（預設值為 true）。
properties.snapshotId	string (arm-id)		用來識別快照集的資源標識碼。
properties.storageToNetworkProximity	VolumeStorageToNetworkProximity		提供磁碟區網路鄰近資訊的記憶體。
properties.subnetId	string		委派子網的 Azure 資源 URI。 必須有委派Microsoft.NetApp/volumes
properties.t2Network	string		T2 網路資訊
properties.throughputMibps	number (float)		MiB/s 中可透過此磁碟區達到的最大輸送量，這隻會接受為手動 qosType 磁碟區的輸入
properties.unixPermissions	string minLength: 4 maxLength: 4		以八進位 4 位數格式接受的 NFS 磁碟區 UNIX 許可權。 第一個數字會選取設定的使用者標識元（4）、設定群組標識碼 （2） 和黏性 （1） 屬性。 第二位數會選取檔案擁有者的許可權：讀取 （4）、寫入 （2） 和執行 （1）。 第三個會選取相同群組中其他用戶的許可權。 群組中其他使用者的第四個。 0755 - 提供擁有者讀取/寫入/執行許可權給群組和其他使用者。
properties.usageThreshold	integer (int64) minimum: 53687091200 maximum: 2638827906662400	0	文件系統允許的記憶體配額上限，以位元組為單位。 這是僅用於警示的軟配額。 針對一般磁碟區，有效值介於 50GiB 到 100TiB 的範圍內。 對於大型磁碟區，有效值的範圍是 100TiB 到 500TiB，且以例外為基礎，從 2400GiB 到 2400TiB。 以位元組表示為1 GiB倍數的值。
properties.volumeGroupName	string		磁碟區群組名稱
properties.volumeSpecName	string		磁碟區規格名稱是磁碟區群組中特定磁碟區的應用程式特定指定或標識元，例如數據、記錄
properties.volumeType	string		此磁碟區的類型為何。 針對跨區域復寫中的目的地磁碟區，請將類型設定為 DataProtection。 若要建立複製磁碟區，請將類型設定為ShortTermClone
systemData	systemData		包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
tags	object		資源標籤。
type	string		資源的類型。 例如「Microsoft.Compute/virtualMachines」或「Microsoft.Storage/storageAccounts」
zones	string[]		可用性區域。

VolumeBackupProperties

Object

磁碟區備份屬性

名稱	類型	Description
backupPolicyId	string (arm-id)	備份原則資源標識碼
backupVaultId	string (arm-id)	備份保存庫資源標識碼
policyEnforced	boolean	強制執行原則

VolumePropertiesDataProtection

Object

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

名稱	類型	Description
backup	VolumeBackupProperties	備份屬性
ransomwareProtection	RansomwareProtectionSettings	進階勒索軟體防護設定
replication	ReplicationObject	複寫屬性
snapshot	VolumeSnapshotProperties	快照集屬性。
volumeRelocation	VolumeRelocationProperties	VolumeRelocation 屬性

VolumePropertiesExportPolicy

Object

一組導出原則規則

名稱	類型	Description
rules	ExportPolicyRule[]	匯出原則規則

VolumeRelocationProperties

Object

磁碟區重新配置屬性

名稱	類型	Description
readyToBeFinalized	boolean	搬遷已完成並準備清理
relocationRequested	boolean	已要求重新配置此磁碟區

VolumeSnapshotProperties

Object

磁碟區快照集屬性

名稱	類型	Description
snapshotPolicyId	string	快照集原則 ResourceId

VolumeStorageToNetworkProximity

列舉型別

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

值	Description
Default	網路連線的基本記憶體。
T1	標準 T1 記憶體與網路連線能力。
T2	標準 T2 記憶體與網路連線能力。
AcrossT2	標準跨T2記憶體與網路連線能力。