Volumes - Get
Décrire un volume
Obtenir les détails du volume spécifié
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}?api-version=2023-07-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
Nom du compte NetApp Regex pattern: |
pool
|
path | True |
string |
Nom du pool de capacités Regex pattern: |
resource
|
path | True |
string |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
subscription
|
path | True |
string uuid |
ID de l’abonnement cible. La valeur doit être un UUID. |
volume
|
path | True |
string |
Nom du volume Regex pattern: |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Ok |
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
Volumes_Get
Sample Request
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"
}
}
Définitions
Nom | Description |
---|---|
avs |
avsDataStore |
Chown |
Ce paramètre spécifie qui est autorisé à modifier la propriété d’un fichier. restricted : seul l’utilisateur racine peut modifier la propriété du fichier. sans restriction : les utilisateurs non racines peuvent modifier la propriété des fichiers qu’ils possèdent. |
cool |
coolAccessRetrievalPolicy détermine le comportement de récupération des données du niveau froid vers le stockage standard en fonction du modèle de lecture pour les volumes activés pour l’accès froid. Les valeurs possibles pour ce champ sont les suivantes : Par défaut : les données seront extraites du niveau froid au stockage standard lors de lectures aléatoires. Cette stratégie est la stratégie par défaut. OnRead : toutes les données lues par le client sont extraites du niveau froid au stockage standard sur les lectures séquentielles et aléatoires. Jamais : aucune donnée pilotée par le client n’est extraite du niveau froid vers le stockage standard. |
created |
Type d’identité qui a créé la ressource. |
Data |
DataProtection |
enable |
Indicateur indiquant si les opérations de sous-volume sont activées sur le volume |
Encryption |
Source de clé utilisée pour chiffrer les données en volume. Applicable si le compte NetApp a encryption.keySource = 'Microsoft.KeyVault'. Les valeurs possibles (ne respectant pas la casse) sont les suivantes : « Microsoft.NetApp, Microsoft.KeyVault » |
Endpoint |
Indique si le volume local est la source ou la destination de la réplication de volume |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Export |
exportPolicy |
export |
Règle de stratégie d’exportation en volume |
file |
Indicateur indiquant si les journaux d’accès aux fichiers sont activés pour le volume, en fonction des paramètres de diagnostic actifs présents sur le volume. |
mount |
Propriétés de la cible de montage |
Network |
Fonctionnalités réseau |
placement |
Paramètres spécifiques à l’application pour le placement des volumes dans le groupe de volumes |
replication |
Propriétés de réplication |
Replication |
Planifier |
Security |
Le style de sécurité du volume, unix par défaut, est ntfs pour le protocole double ou CIFS |
Service |
serviceLevel |
smb |
smbAccessBasedEnumeration |
smb |
smbNonBrowsable |
system |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
volume |
Ressource de volume |
volume |
Propriétés de déplacement de volume |
volume |
Propriétés de l’instantané de volume |
Volume |
Proximité entre le stockage et le réseau |
avsDataStore
avsDataStore
Nom | Type | Description |
---|---|---|
Disabled |
string |
avsDataStore est désactivé |
Enabled |
string |
avsDataStore est activé |
ChownMode
Ce paramètre spécifie qui est autorisé à modifier la propriété d’un fichier. restricted : seul l’utilisateur racine peut modifier la propriété du fichier. sans restriction : les utilisateurs non racines peuvent modifier la propriété des fichiers qu’ils possèdent.
Nom | Type | Description |
---|---|---|
Restricted |
string |
|
Unrestricted |
string |
coolAccessRetrievalPolicy
coolAccessRetrievalPolicy détermine le comportement de récupération des données du niveau froid vers le stockage standard en fonction du modèle de lecture pour les volumes activés pour l’accès froid. Les valeurs possibles pour ce champ sont les suivantes : Par défaut : les données seront extraites du niveau froid au stockage standard lors de lectures aléatoires. Cette stratégie est la stratégie par défaut. OnRead : toutes les données lues par le client sont extraites du niveau froid au stockage standard sur les lectures séquentielles et aléatoires. Jamais : aucune donnée pilotée par le client n’est extraite du niveau froid vers le stockage standard.
Nom | Type | Description |
---|---|---|
Default |
string |
|
Never |
string |
|
OnRead |
string |
createdByType
Type d’identité qui a créé la ressource.
Nom | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataProtection
DataProtection
Nom | Type | Description |
---|---|---|
replication |
Réplication |
|
snapshot |
Instantané |
|
volumeRelocation |
VolumeRelocation |
enableSubvolumes
Indicateur indiquant si les opérations de sous-volume sont activées sur le volume
Nom | Type | Description |
---|---|---|
Disabled |
string |
les sous-requêtes ne sont pas activées |
Enabled |
string |
les sous-volumes sont activées |
EncryptionKeySource
Source de clé utilisée pour chiffrer les données en volume. Applicable si le compte NetApp a encryption.keySource = 'Microsoft.KeyVault'. Les valeurs possibles (ne respectant pas la casse) sont les suivantes : « Microsoft.NetApp, Microsoft.KeyVault »
Nom | Type | Description |
---|---|---|
Microsoft.KeyVault |
string |
Chiffrement à clé gérée par le client |
Microsoft.NetApp |
string |
Chiffrement de clé managée par Microsoft |
EndpointType
Indique si le volume local est la source ou la destination de la réplication de volume
Nom | Type | Description |
---|---|---|
dst |
string |
|
src |
string |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
Nom | Type | Description |
---|---|---|
info |
object |
Informations supplémentaires |
type |
string |
Type d’informations supplémentaires. |
ErrorDetail
Détail de l’erreur.
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet error. |
ExportPolicy
exportPolicy
Nom | Type | Description |
---|---|---|
rules |
Exporter une règle de stratégie |
exportPolicyRule
Règle de stratégie d’exportation en volume
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
allowedClients |
string |
Spécification d’entrée du client en tant que chaîne séparée par des virgules avec des CIDR IPv4, des adresses hôtes IPv4 et des noms d’hôtes |
|
chownMode | Restricted |
Ce paramètre spécifie qui est autorisé à modifier la propriété d’un fichier. restricted : seul l’utilisateur racine peut modifier la propriété du fichier. sans restriction : les utilisateurs non racines peuvent modifier la propriété des fichiers qu’ils possèdent. |
|
cifs |
boolean |
Autorise le protocole CIFS |
|
hasRootAccess |
boolean |
True |
Dispose d’un accès racine au volume |
kerberos5ReadOnly |
boolean |
False |
Accès En lecture seule Kerberos5. À utiliser avec swagger version 2020-05-01 ou ultérieure |
kerberos5ReadWrite |
boolean |
False |
Accès en lecture et en écriture Kerberos5. À utiliser avec swagger version 2020-05-01 ou ultérieure |
kerberos5iReadOnly |
boolean |
False |
Accès Kerberos5i en lecture seule. À utiliser avec swagger version 2020-05-01 ou ultérieure |
kerberos5iReadWrite |
boolean |
False |
Accès en lecture et en écriture Kerberos5i. À utiliser avec swagger version 2020-05-01 ou ultérieure |
kerberos5pReadOnly |
boolean |
False |
Accès kerberos5p en lecture seule. À utiliser avec swagger version 2020-05-01 ou ultérieure |
kerberos5pReadWrite |
boolean |
False |
Accès en lecture et écriture Kerberos5p. À utiliser avec swagger version 2020-05-01 ou ultérieure |
nfsv3 |
boolean |
Autorise le protocole NFSv3. Activer uniquement pour les volumes de type NFSv3 |
|
nfsv41 |
boolean |
Autorise le protocole NFSv4.1. Activer uniquement pour les volumes de type NFSv4.1 |
|
ruleIndex |
integer |
Index de commande |
|
unixReadOnly |
boolean |
Accès en lecture seule |
|
unixReadWrite |
boolean |
Accès en lecture et en écriture |
fileAccessLogs
Indicateur indiquant si les journaux d’accès aux fichiers sont activés pour le volume, en fonction des paramètres de diagnostic actifs présents sur le volume.
Nom | Type | Description |
---|---|---|
Disabled |
string |
fileAccessLogs ne sont pas activés |
Enabled |
string |
fileAccessLogs sont activés |
mountTargetProperties
Propriétés de la cible de montage
Nom | Type | Description |
---|---|---|
fileSystemId |
string |
fileSystemId |
ipAddress |
string |
ipAddress |
mountTargetId |
string |
mountTargetId |
smbServerFqdn |
string |
smbServerFQDN |
NetworkFeatures
Fonctionnalités réseau
Nom | Type | Description |
---|---|---|
Basic |
string |
Fonctionnalités réseau de base. |
Basic_Standard |
string |
Mise à jour des fonctionnalités réseau de base vers standard. |
Standard |
string |
Fonctionnalités réseau standard. |
Standard_Basic |
string |
Mise à jour des fonctionnalités réseau standard vers les fonctionnalités réseau de base. |
placementKeyValuePairs
Paramètres spécifiques à l’application pour le placement des volumes dans le groupe de volumes
Nom | Type | Description |
---|---|---|
key |
string |
Clé d’un paramètre spécifique à l’application pour le placement des volumes dans le groupe de volumes |
value |
string |
Valeur d’un paramètre spécifique à l’application pour le placement des volumes dans le groupe de volumes |
replicationObject
Propriétés de réplication
Nom | Type | Description |
---|---|---|
endpointType |
Indique si le volume local est la source ou la destination de la réplication de volume |
|
remoteVolumeRegion |
string |
Région distante pour l’autre extrémité de la réplication en volume. |
remoteVolumeResourceId |
string |
ID de ressource du volume distant. |
replicationId |
string |
Id |
replicationSchedule |
Planifier |
ReplicationSchedule
Planifier
Nom | Type | Description |
---|---|---|
_10minutely |
string |
|
daily |
string |
|
hourly |
string |
SecurityStyle
Le style de sécurité du volume, unix par défaut, est ntfs pour le protocole double ou CIFS
Nom | Type | Description |
---|---|---|
ntfs |
string |
|
unix |
string |
ServiceLevel
serviceLevel
Nom | Type | Description |
---|---|---|
Premium |
string |
Niveau de service Premium |
Standard |
string |
Niveau de service standard |
StandardZRS |
string |
Niveau de service de stockage redondant interzone |
Ultra |
string |
Niveau de service Ultra |
smbAccessBasedEnumeration
smbAccessBasedEnumeration
Nom | Type | Description |
---|---|---|
Disabled |
string |
Le paramètre de partage smbAccessBasedEnumeration est désactivé |
Enabled |
string |
Le paramètre de partage smbAccessBasedEnumeration est activé |
smbNonBrowsable
smbNonBrowsable
Nom | Type | Description |
---|---|---|
Disabled |
string |
Le paramètre de partage smbNonBrowsable est désactivé |
Enabled |
string |
Le paramètre de partage smbNonBrowsable est activé |
systemData
Métadonnées relatives à la création et à la dernière modification de la ressource.
Nom | Type | Description |
---|---|---|
createdAt |
string |
Horodatage de la création de ressources (UTC). |
createdBy |
string |
Identité qui a créé la ressource. |
createdByType |
Type d’identité qui a créé la ressource. |
|
lastModifiedAt |
string |
Horodatage de la dernière modification de la ressource (UTC) |
lastModifiedBy |
string |
Identité qui a modifié la ressource pour la dernière fois. |
lastModifiedByType |
Type d’identité qui a modifié la ressource pour la dernière fois. |
volume
Ressource de volume
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
etag |
string |
Chaîne en lecture seule unique qui change chaque fois que la ressource est mise à jour. |
|
id |
string |
ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} » |
|
location |
string |
Emplacement géographique où réside la ressource |
|
name |
string |
nom de la ressource. |
|
properties.actualThroughputMibps |
number |
Débit réel en Mio/s pour les volumes qosType automatiques calculés en fonction de la taille et de serviceLevel |
|
properties.avsDataStore | Disabled |
avsDataStore |
|
properties.backupId |
string |
ID de la sauvegarde |
|
properties.baremetalTenantId |
string |
ID de locataire baremetal |
|
properties.capacityPoolResourceId |
string |
ID de ressource de pool utilisé en cas de création d’un volume via un groupe de volumes |
|
properties.cloneProgress |
integer |
Lorsqu’un volume est restauré à partir du instantané d’un autre volume, affiche le pourcentage d’achèvement de ce processus de clonage. Lorsque cette valeur est vide/null, aucun processus de clonage n’est en cours sur ce volume. Cette valeur est mise à jour toutes les 5 minutes pendant le clonage. |
|
properties.coolAccess |
boolean |
False |
Spécifie si l’accès froid (hiérarchisation) est activé pour le volume. |
properties.coolAccessRetrievalPolicy |
coolAccessRetrievalPolicy détermine le comportement de récupération des données du niveau froid vers le stockage standard en fonction du modèle de lecture pour les volumes activés pour l’accès froid. Les valeurs possibles pour ce champ sont les suivantes : Par défaut : les données seront extraites du niveau froid au stockage standard lors de lectures aléatoires. Cette stratégie est la stratégie par défaut. OnRead : toutes les données lues par le client sont extraites du niveau froid au stockage standard sur les lectures séquentielles et aléatoires. Jamais : aucune donnée pilotée par le client n’est extraite du niveau froid vers le stockage standard. |
||
properties.coolnessPeriod |
integer |
Spécifie le nombre de jours après lesquels les données auxquelles les clients n’accèdent pas seront hiérarchisé. |
|
properties.creationToken |
string |
Jeton de création ou chemin d’accès au fichier |
|
properties.dataProtection |
DataProtection |
||
properties.dataStoreResourceId |
string[] |
dataStoreResourceId |
|
properties.defaultGroupQuotaInKiBs |
integer |
0 |
Quota de groupe par défaut pour le volume en KiBs. Si isDefaultQuotaEnabled est défini, la valeur minimale de 4 Kio s’applique. |
properties.defaultUserQuotaInKiBs |
integer |
0 |
Quota d’utilisateurs par défaut pour le volume en KiBs. Si isDefaultQuotaEnabled est défini, la valeur minimale de 4 Kio s’applique. |
properties.deleteBaseSnapshot |
boolean |
Si cette option est activée (true), le instantané à partir duquel le volume a été créé est automatiquement supprimé une fois l’opération de création de volume terminée. La valeur par défaut est false |
|
properties.enableSubvolumes | Disabled |
Indicateur indiquant si les opérations de sous-volume sont activées sur le volume |
|
properties.encrypted |
boolean |
Spécifie si le volume est chiffré ou non. Disponible uniquement sur les volumes créés ou mis à jour après le 01/01/2022. |
|
properties.encryptionKeySource | Microsoft.NetApp |
Source de clé utilisée pour chiffrer les données en volume. Applicable si le compte NetApp a encryption.keySource = 'Microsoft.KeyVault'. Les valeurs possibles (ne respectant pas la casse) sont les suivantes : « Microsoft.NetApp, Microsoft.KeyVault » |
|
properties.exportPolicy |
exportPolicy |
||
properties.fileAccessLogs | Disabled |
Indicateur indiquant si les journaux d’accès aux fichiers sont activés pour le volume, en fonction des paramètres de diagnostic actifs présents sur le volume. |
|
properties.fileSystemId |
string |
FileSystem ID |
|
properties.isDefaultQuotaEnabled |
boolean |
False |
Spécifie si le quota par défaut est activé pour le volume. |
properties.isLargeVolume |
boolean |
False |
Volume volumineux |
properties.isRestoring |
boolean |
Restoring |
|
properties.kerberosEnabled |
boolean |
False |
Décrire si un volume est KerberosEnabled. À utiliser avec swagger version 2020-05-01 ou ultérieure |
properties.keyVaultPrivateEndpointResourceId |
string |
ID de ressource du point de terminaison privé pour KeyVault. Il doit résider dans le même réseau virtuel que le volume. Applicable uniquement si encryptionKeySource = 'Microsoft.KeyVault'. |
|
properties.ldapEnabled |
boolean |
False |
Spécifie si LDAP est activé ou non pour un volume NFS donné. |
properties.maximumNumberOfFiles |
integer |
Nombre maximal de fichiers autorisés. Nécessite une demande de service pour pouvoir être modifiée. Ne peut être modifié que si le quota de volume est supérieur à 4 Tio. |
|
properties.mountTargets |
mountTargets |
||
properties.networkFeatures | Basic |
Fonctionnalités réseau |
|
properties.networkSiblingSetId |
string |
ID d’ensemble de frères du réseau |
|
properties.originatingResourceId |
string |
ID de ressource d’origine |
|
properties.placementRules |
Règles de placement de volume |
||
properties.protocolTypes |
string[] |
protocolTypes |
|
properties.provisionedAvailabilityZone |
string |
Zone de disponibilité provisionnée |
|
properties.provisioningState |
string |
Gestion du cycle de vie Azure |
|
properties.proximityPlacementGroup |
string |
Groupe de placement de proximité associé au volume |
|
properties.securityStyle | unix |
Le style de sécurité du volume, unix par défaut, est ntfs pour le protocole double ou CIFS |
|
properties.serviceLevel | Premium |
serviceLevel |
|
properties.smbAccessBasedEnumeration |
smbAccessBasedEnumeration |
||
properties.smbContinuouslyAvailable |
boolean |
False |
Active la propriété de partage disponible en continu pour le volume smb. Applicable uniquement pour le volume SMB |
properties.smbEncryption |
boolean |
False |
Active le chiffrement pour les données smb3 en cours d’exécution. Applicable uniquement pour le volume SMB/DualProtocol. À utiliser avec swagger version 2020-08-01 ou ultérieure |
properties.smbNonBrowsable |
smbNonBrowsable |
||
properties.snapshotDirectoryVisible |
boolean |
True |
S’il est activé (true), le volume contient un répertoire instantané en lecture seule qui fournit l’accès à chacun des instantanés du volume (valeur par défaut true). |
properties.snapshotId |
string |
ID d’instantané |
|
properties.storageToNetworkProximity |
Proximité entre le stockage et le réseau |
||
properties.subnetId |
string |
URI de ressource Azure pour un sous-réseau délégué. Doit avoir la délégation Microsoft.NetApp/volumes |
|
properties.t2Network |
string |
Informations réseau T2 |
|
properties.throughputMibps |
number |
Débit maximal en Mio/s qui peut être atteint par ce volume et qui sera accepté comme entrée uniquement pour le volume qosType manuel |
|
properties.unixPermissions |
string |
Autorisations UNIX pour le volume NFS accepté au format octal 4 chiffres. Le premier chiffre sélectionne les attributs set user ID(4), set group ID (2) et sticky (1). Le deuxième chiffre sélectionne l’autorisation pour le propriétaire du fichier : lecture (4), écriture (2) et exécution (1). Troisièmement, sélectionne les autorisations pour les autres utilisateurs du même groupe. quatrième pour les autres utilisateurs qui ne sont pas dans le groupe. 0755 : donne des autorisations de lecture/écriture/exécution au propriétaire et en lecture/exécution au groupe et à d’autres utilisateurs. |
|
properties.usageThreshold |
integer |
0 |
usageThreshold |
properties.volumeGroupName |
string |
Nom du groupe de volumes |
|
properties.volumeSpecName |
string |
Le nom de la spécification de volume est la désignation ou l’identificateur spécifique à l’application pour le volume particulier dans un groupe de volumes, par exemple, les données, le journal |
|
properties.volumeType |
string |
De quel type de volume s’agit-il ? Pour les volumes de destination dans la réplication inter-régions, définissez type sur DataProtection |
|
systemData |
Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy. |
||
tags |
object |
Balises de ressource. |
|
type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |
|
zones |
string[] |
Zone de disponibilité |
volumeRelocationProperties
Propriétés de déplacement de volume
Nom | Type | Description |
---|---|---|
readyToBeFinalized |
boolean |
La réinstallation est terminée et est prête à être nettoyée |
relocationRequested |
boolean |
La réinstallation a-t-elle été demandée pour ce volume |
volumeSnapshotProperties
Propriétés de l’instantané de volume
Nom | Type | Description |
---|---|---|
snapshotPolicyId |
string |
ResourceId de stratégie d’instantané |
VolumeStorageToNetworkProximity
Proximité entre le stockage et le réseau
Nom | Type | Description |
---|---|---|
AcrossT2 |
string |
Connectivité du stockage AcrossT2 standard au réseau. |
Default |
string |
Connectivité de stockage de base au réseau. |
T1 |
string |
Connectivité entre le stockage T1 standard et le réseau. |
T2 |
string |
Connectivité entre le stockage T2 standard et le réseau. |