Volumes - Get
ボリュームについて説明する
指定したボリュームの詳細を取得する
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}?api-version=2023-11-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
account
|
path | True |
string |
NetApp アカウントの名前 Regex pattern: |
pool
|
path | True |
string |
容量プールの名前 Regex pattern: |
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
subscription
|
path | True |
string uuid |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
volume
|
path | True |
string |
ボリュームの名前 Regex pattern: |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Volumes_Get
Sample Request
GET https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1?api-version=2023-11-01
Sample Response
{
"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"
}
}
定義
名前 | 説明 |
---|---|
avs |
avsDataStore |
Chown |
このパラメーターは、ファイルの所有権を変更する権限を持つユーザーを指定します。 restricted - ルート ユーザーのみがファイルの所有権を変更できます。 unrestricted - 非ルート ユーザーは、所有するファイルの所有権を変更できます。 |
cool |
coolAccessRetrievalPolicy は、クール アクセスが有効なボリュームの読み取りパターンに基づいて、クール層から Standard ストレージへのデータ取得動作を決定します。 このフィールドに指定できる値は次のとおりです。Default - データは、ランダム読み取り時にクール層から Standard ストレージにプルされます。 このポリシーが既定です。 OnRead - すべてのクライアント駆動型データ読み取りは、順次読み取りとランダム読み取りの両方でクール層から標準ストレージにプルされます。 [なし] - クライアント駆動型データはクール層から Standard ストレージにプルされません。 |
created |
リソースを作成した ID の種類。 |
Data |
DataProtection |
enable |
ボリュームでサブボリューム操作が有効かどうかを示すフラグ |
Encryption |
ボリューム内のデータを暗号化するために使用されるキーのソース。 NetApp アカウントに encryption.keySource = 'Microsoft.KeyVault' がある場合に適用されます。 指定できる値 (大文字と小文字は区別されません) は、'Microsoft.NetApp, Microsoft.KeyVault' です。 |
Endpoint |
ローカル ボリュームがボリューム レプリケーションのソースか宛先かを示します |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Export |
exportPolicy |
export |
ボリューム エクスポート ポリシー規則 |
file |
ボリュームに存在するアクティブな診断設定に基づいて、ボリュームに対してファイル アクセス ログが有効になっているかどうかを示すフラグ。 |
mount |
ターゲット プロパティをマウントする |
Network |
ネットワーク機能 |
placement |
ボリューム グループ内のボリュームの配置に関するアプリケーション固有のパラメーター |
replication |
レプリケーションのプロパティ |
Replication |
スケジュール |
Security |
ボリュームのセキュリティ スタイル (既定の unix)、デュアル プロトコルまたは CIFS プロトコルの場合、既定値は ntfs です |
Service |
serviceLevel |
smb |
smbAccessBasedEnumeration |
smb |
smbNonBrowsable |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
volume |
ボリューム リソース |
volume |
ボリューム バックアップのプロパティ |
volume |
ボリューム再配置プロパティ |
volume |
ボリューム スナップショットのプロパティ |
Volume |
記憶域からネットワークへの近接性 |
avsDataStore
avsDataStore
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
avsDataStore が無効になっている |
Enabled |
string |
avsDataStore が有効になっている |
ChownMode
このパラメーターは、ファイルの所有権を変更する権限を持つユーザーを指定します。 restricted - ルート ユーザーのみがファイルの所有権を変更できます。 unrestricted - 非ルート ユーザーは、所有するファイルの所有権を変更できます。
名前 | 型 | 説明 |
---|---|---|
Restricted |
string |
|
Unrestricted |
string |
coolAccessRetrievalPolicy
coolAccessRetrievalPolicy は、クール アクセスが有効なボリュームの読み取りパターンに基づいて、クール層から Standard ストレージへのデータ取得動作を決定します。 このフィールドに指定できる値は次のとおりです。Default - データは、ランダム読み取り時にクール層から Standard ストレージにプルされます。 このポリシーが既定です。 OnRead - すべてのクライアント駆動型データ読み取りは、順次読み取りとランダム読み取りの両方でクール層から標準ストレージにプルされます。 [なし] - クライアント駆動型データはクール層から Standard ストレージにプルされません。
名前 | 型 | 説明 |
---|---|---|
Default |
string |
|
Never |
string |
|
OnRead |
string |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataProtection
DataProtection
名前 | 型 | 説明 |
---|---|---|
backup |
Backup |
|
replication |
レプリケーション |
|
snapshot |
スナップショット |
|
volumeRelocation |
VolumeRelocation |
enableSubvolumes
ボリュームでサブボリューム操作が有効かどうかを示すフラグ
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
サブボリュームが有効になっていない |
Enabled |
string |
サブボリュームが有効になっている |
EncryptionKeySource
ボリューム内のデータを暗号化するために使用されるキーのソース。 NetApp アカウントに encryption.keySource = 'Microsoft.KeyVault' がある場合に適用されます。 指定できる値 (大文字と小文字は区別されません) は、'Microsoft.NetApp, Microsoft.KeyVault' です。
名前 | 型 | 説明 |
---|---|---|
Microsoft.KeyVault |
string |
カスタマー マネージド キー暗号化 |
Microsoft.NetApp |
string |
Microsoft マネージド キーの暗号化 |
EndpointType
ローカル ボリュームがボリューム レプリケーションのソースか宛先かを示します
名前 | 型 | 説明 |
---|---|---|
dst |
string |
|
src |
string |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
ExportPolicy
exportPolicy
名前 | 型 | 説明 |
---|---|---|
rules |
ポリシー ルールをエクスポートする |
exportPolicyRule
ボリューム エクスポート ポリシー規則
名前 | 型 | 既定値 | 説明 |
---|---|---|---|
allowedClients |
string |
IPv4 CIDR、IPv4 ホスト アドレス、ホスト名を使用したコンマ区切り文字列としてのクライアント イングレス仕様 |
|
chownMode | Restricted |
このパラメーターは、ファイルの所有権を変更する権限を持つユーザーを指定します。 restricted - ルート ユーザーのみがファイルの所有権を変更できます。 unrestricted - 非ルート ユーザーは、所有するファイルの所有権を変更できます。 |
|
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
ボリュームに存在するアクティブな診断設定に基づいて、ボリュームに対してファイル アクセス ログが有効になっているかどうかを示すフラグ。
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
fileAccessLogs が有効になっていません |
Enabled |
string |
fileAccessLogs が有効になっている |
mountTargetProperties
ターゲット プロパティをマウントする
名前 | 型 | 説明 |
---|---|---|
fileSystemId |
string |
fileSystemId |
ipAddress |
string |
ipAddress |
mountTargetId |
string |
mountTargetId |
smbServerFqdn |
string |
smbServerFQDN |
NetworkFeatures
ネットワーク機能
名前 | 型 | 説明 |
---|---|---|
Basic |
string |
基本的なネットワーク機能。 |
Basic_Standard |
string |
Basic から Standard ネットワーク機能への更新。 |
Standard |
string |
標準ネットワーク機能。 |
Standard_Basic |
string |
Standard から Basic のネットワーク機能への更新。 |
placementKeyValuePairs
ボリューム グループ内のボリュームの配置に関するアプリケーション固有のパラメーター
名前 | 型 | 説明 |
---|---|---|
key |
string |
ボリューム グループにボリュームを配置するためのアプリケーション固有のパラメーターのキー |
value |
string |
ボリューム グループ内のボリュームの配置に対するアプリケーション固有のパラメーターの値 |
replicationObject
レプリケーションのプロパティ
名前 | 型 | 説明 |
---|---|---|
endpointType |
ローカル ボリュームがボリューム レプリケーションのソースか宛先かを示します |
|
remoteVolumeRegion |
string |
ボリューム レプリケーションのもう一方の端のリモート リージョン。 |
remoteVolumeResourceId |
string |
リモート ボリュームのリソース ID。 |
replicationId |
string |
Id |
replicationSchedule |
スケジュール |
ReplicationSchedule
スケジュール
名前 | 型 | 説明 |
---|---|---|
_10minutely |
string |
|
daily |
string |
|
hourly |
string |
SecurityStyle
ボリュームのセキュリティ スタイル (既定の unix)、デュアル プロトコルまたは CIFS プロトコルの場合、既定値は ntfs です
名前 | 型 | 説明 |
---|---|---|
ntfs |
string |
|
unix |
string |
ServiceLevel
serviceLevel
名前 | 型 | 説明 |
---|---|---|
Premium |
string |
Premium サービス レベル |
Standard |
string |
Standard サービス レベル |
StandardZRS |
string |
ゾーン冗長ストレージ サービス レベル |
Ultra |
string |
Ultra サービス レベル |
smbAccessBasedEnumeration
smbAccessBasedEnumeration
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
smbAccessBasedEnumeration 共有設定が無効になっている |
Enabled |
string |
smbAccessBasedEnumeration 共有設定が有効になっている |
smbNonBrowsable
smbNonBrowsable
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
smbNonBrowsable 共有設定が無効になっている |
Enabled |
string |
smbNonBrowsable 共有設定が有効になっている |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
volume
ボリューム リソース
名前 | 型 | 既定値 | 説明 |
---|---|---|---|
etag |
string |
リソースが更新されるたびに変更される一意の読み取り専用文字列。 |
|
id |
string |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
|
location |
string |
リソースが保存されている地理的な場所 |
|
name |
string |
リソースの名前 |
|
properties.actualThroughputMibps |
number |
size と serviceLevel に基づいて計算された自動 qosType ボリュームの実際のスループット (MiB/秒) |
|
properties.avsDataStore | Disabled |
avsDataStore |
|
properties.backupId |
string |
バックアップ ID |
|
properties.baremetalTenantId |
string |
Baremetal テナント ID |
|
properties.capacityPoolResourceId |
string |
ボリューム グループを使用してボリュームを作成する場合に使用されるプール リソース ID |
|
properties.cloneProgress |
integer |
ボリュームが別のボリュームのスナップショットから復元されている場合、この複製プロセスの完了率が表示されます。 この値が空または null の場合、このボリュームで現在発生している複製プロセスはありません。 この値は、複製中に 5 分ごとに更新されます。 |
|
properties.coolAccess |
boolean |
False |
ボリュームに対してクール アクセス (階層化) を有効にするかどうかを指定します。 |
properties.coolAccessRetrievalPolicy |
coolAccessRetrievalPolicy は、クール アクセスが有効なボリュームの読み取りパターンに基づいて、クール層から Standard ストレージへのデータ取得動作を決定します。 このフィールドに使用できる値は次のとおりです。既定値 - データはランダム読み取り時にクール 層から Standard ストレージにプルされます。 このポリシーが既定です。 OnRead - すべてのクライアント駆動型データ読み取りは、シーケンシャル読み取りとランダム読み取りの両方でクール層から Standard ストレージにプルされます。 [なし] - クライアント駆動型データはクール 層から Standard ストレージにプルされません。 |
||
properties.coolnessPeriod |
integer |
クライアントがアクセスしないデータを階層化するまでの日数を指定します。 |
|
properties.creationToken |
string |
作成トークンまたはファイル パス |
|
properties.dataProtection |
DataProtection |
||
properties.dataStoreResourceId |
string[] |
dataStoreResourceId |
|
properties.defaultGroupQuotaInKiBs |
integer |
0 |
KiB のボリュームの既定のグループ クォータ。 isDefaultQuotaEnabled が設定されている場合、最小値の 4 KiB が適用されます。 |
properties.defaultUserQuotaInKiBs |
integer |
0 |
KiB のボリュームの既定のユーザー クォータ。 isDefaultQuotaEnabled が設定されている場合、最小値の 4 KiB が適用されます。 |
properties.deleteBaseSnapshot |
boolean |
有効 (true) の場合、ボリュームの作成操作が完了した後、ボリュームが作成されたスナップショットは自動的に削除されます。 既定値は false |
|
properties.enableSubvolumes | Disabled |
ボリュームでサブボリューム操作が有効かどうかを示すフラグ |
|
properties.encrypted |
boolean |
ボリュームが暗号化されているかどうかを指定します。 2022-01-01 以降に作成または更新されたボリュームでのみ使用できます。 |
|
properties.encryptionKeySource | Microsoft.NetApp |
ボリューム内のデータを暗号化するために使用されるキーのソース。 NetApp アカウントに encryption.keySource = 'Microsoft.KeyVault' がある場合に適用されます。 使用できる値 (大文字と小文字は区別されません) は、'Microsoft.NetApp, Microsoft.KeyVault' です。 |
|
properties.exportPolicy |
exportPolicy |
||
properties.fileAccessLogs | Disabled |
ボリュームに存在するアクティブな診断設定に基づいて、ボリュームに対してファイル アクセス ログが有効かどうかを示すフラグ。 |
|
properties.fileSystemId |
string |
FileSystem ID |
|
properties.isDefaultQuotaEnabled |
boolean |
False |
ボリュームに対して既定のクォータを有効にするかどうかを指定します。 |
properties.isLargeVolume |
boolean |
False |
ボリュームが大きい |
properties.isRestoring |
boolean |
Restoring |
|
properties.kerberosEnabled |
boolean |
False |
ボリュームが KerberosEnabled であるかどうかを説明します。 swagger バージョン 2020-05-01 以降で使用する |
properties.keyVaultPrivateEndpointResourceId |
string |
KeyVault のプライベート エンドポイントのリソース ID。 ボリュームと同じ VNET に存在する必要があります。 encryptionKeySource = 'Microsoft.KeyVault' の場合にのみ適用されます。 |
|
properties.ldapEnabled |
boolean |
False |
特定の NFS ボリュームに対して LDAP を有効にするかどうかを指定します。 |
properties.maximumNumberOfFiles |
integer |
許可されるファイルの最大数。 変更するにはサービス要求が必要です。 ボリューム クォータが 4TiB を超える場合にのみ変更できます。 |
|
properties.mountTargets |
mountTargets |
||
properties.networkFeatures | Basic |
ネットワーク機能 |
|
properties.networkSiblingSetId |
string |
ネットワーク 兄弟セット ID |
|
properties.originatingResourceId |
string |
発信元リソース ID |
|
properties.placementRules |
ボリューム配置ルール |
||
properties.protocolTypes |
string[] |
protocolTypes |
|
properties.provisionedAvailabilityZone |
string |
プロビジョニングされた可用性ゾーン |
|
properties.provisioningState |
string |
Azure ライフサイクル管理 |
|
properties.proximityPlacementGroup |
string |
ボリュームに関連付けられている近接配置グループ |
|
properties.securityStyle | unix |
ボリュームのセキュリティ スタイル (既定の unix)、デュアル プロトコルまたは CIFS プロトコルの場合、既定値は ntfs です |
|
properties.serviceLevel | Premium |
serviceLevel |
|
properties.smbAccessBasedEnumeration |
smbAccessBasedEnumeration |
||
properties.smbContinuouslyAvailable |
boolean |
False |
smb ボリュームに対して継続的に使用可能な共有プロパティを有効にします。 SMB ボリュームにのみ適用されます |
properties.smbEncryption |
boolean |
False |
転送中の smb3 データの暗号化を有効にします。 SMB/DualProtocol ボリュームにのみ適用されます。 swagger バージョン 2020-08-01 以降で使用する |
properties.smbNonBrowsable |
smbNonBrowsable |
||
properties.snapshotDirectoryVisible |
boolean |
True |
有効 (true) の場合、ボリュームには、各ボリュームのスナップショットへのアクセスを提供する読み取り専用のスナップショット ディレクトリが含まれます (既定値は true)。 |
properties.snapshotId |
string |
スナップショット ID |
|
properties.storageToNetworkProximity |
記憶域からネットワークへの近接 |
||
properties.subnetId |
string |
委任されたサブネットの Azure リソース URI。 委任 Microsoft.NetApp/ボリュームが必要です |
|
properties.t2Network |
string |
T2 ネットワーク情報 |
|
properties.throughputMibps |
number |
このボリュームで実現できる MiB/秒の最大スループット。これは手動 qosType ボリュームの入力としてのみ受け入れられます |
|
properties.unixPermissions |
string |
NFS ボリュームに対する UNIX アクセス許可を 8 進数の 4 桁の形式で受け入れます。 最初の桁は、設定されたユーザー ID (4)、グループ ID (2) およびスティッキー (1) 属性を選択します。 2 番目の桁は、ファイルの所有者のアクセス許可を選択します。read (4)、write (2)、execute (1)。 3 番目は、同じグループ内の他のユーザーのアクセス許可を選択します。 グループに含まれていない他のユーザーの 4 番目のユーザー。 0755 - 所有者に対する読み取り/書き込み/実行アクセス許可を付与し、グループやその他のユーザーに対して読み取り/実行を行います。 |
|
properties.usageThreshold |
integer |
0 |
usageThreshold |
properties.volumeGroupName |
string |
ボリューム グループ名 |
|
properties.volumeSpecName |
string |
ボリューム スペック名は、データ、ログなどのボリューム グループ内の特定のボリュームのアプリケーション固有の指定または識別子です |
|
properties.volumeType |
string |
ボリュームの種類は何ですか。 リージョン間レプリケーションの宛先ボリュームの場合は、種類を DataProtection に設定します |
|
systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
||
tags |
object |
リソース タグ。 |
|
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
|
zones |
string[] |
可用性ゾーン |
volumeBackupProperties
ボリューム バックアップのプロパティ
名前 | 型 | 説明 |
---|---|---|
backupPolicyId |
string |
バックアップ ポリシー リソース ID |
backupVaultId |
string |
Backup Vault リソース ID |
policyEnforced |
boolean |
ポリシーの適用 |
volumeRelocationProperties
ボリューム再配置プロパティ
名前 | 型 | 説明 |
---|---|---|
readyToBeFinalized |
boolean |
再配置が完了し、クリーンアップする準備が整いました |
relocationRequested |
boolean |
このボリュームの再配置が要求されました |
volumeSnapshotProperties
ボリューム スナップショットのプロパティ
名前 | 型 | 説明 |
---|---|---|
snapshotPolicyId |
string |
スナップショット ポリシー ResourceId |
VolumeStorageToNetworkProximity
記憶域からネットワークへの近接性
名前 | 型 | 説明 |
---|---|---|
AcrossT2 |
string |
ネットワーク接続への Standard AcrossT2 ストレージ。 |
Default |
string |
ネットワーク接続への基本的なストレージ。 |
T1 |
string |
Standard T1 Storage からネットワークへの接続。 |
T2 |
string |
Standard T2 Storage からネットワークへの接続。 |