Partager via

Obtenir les propriétés de partage

  • Article

La requête Get Share Properties retourne les propriétés du partage ou de l’instantané de partage spécifiés.

Bien que cette API soit entièrement prise en charge, il s’agit d’une API de gestion héritée. Pour cette raison, nous vous recommandons d’utiliser partages de fichiers - Obtenir, qui est fourni par le fournisseur de ressources de stockage (Microsoft.Storage), à la place.

Pour en savoir plus sur l’interaction programmatique avec des ressources FileShare à l’aide du fournisseur de ressources de stockage, consultez Opérations sur FileShares.

Disponibilité du protocole

Protocole de partage de fichiers activé Disponible
SMB Oui
NFS Oui

Demander

La requête Get Share Properties peut être construite comme suit. Nous vous recommandons d’utiliser HTTPS.

Méthode URI de requête Version HTTP
GET/HEAD https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1
GET/HEAD https://myaccount.file.core.windows.net/myshare?restype=share&sharesnapshot=<DateTime> HTTP/1.1

Remplacez les composants de chemin d’accès indiqués dans l’URI de requête par vos propres composants, comme suit :

Composant Path Description
myaccount Nom de votre compte de stockage.
myshare Nom de votre partage de fichiers.

Pour plus d’informations sur les restrictions de nommage de chemin d’accès, consultez partages de noms et de références, répertoires, fichiers et métadonnées.

Paramètres d’URI

Les paramètres supplémentaires suivants peuvent être spécifiés dans l’URI de requête :

Paramètre Description
sharesnapshot Optionnel. Version 2017-04-17 et ultérieure. Le paramètre sharesnapshot est une valeur de date/heure opaque qui, lorsqu’il est présent, spécifie l’instantané de partage à interroger pour récupérer les propriétés.
timeout Optionnel. Le paramètre de délai d’expiration est exprimé en secondes. Pour plus d’informations, consultez Définir des délais d’attente pour les opérations Azure Files.

En-têtes de requête

Les en-têtes obligatoires et facultatifs sont décrits dans le tableau suivant :

En-tête de requête Description
Authorization Obligatoire. Spécifie le schéma d’autorisation, le nom du compte et la signature. Pour plus d’informations, consultez Autoriser les demandes vers le stockage Azure.
Date ou x-ms-date Obligatoire. Spécifie le temps universel coordonné (UTC) de la requête. Pour plus d’informations, consultez Autoriser les demandes vers le stockage Azure.
x-ms-version Obligatoire pour toutes les demandes autorisées. Spécifie la version de l’opération à utiliser pour cette requête. Pour plus d’informations, consultez Contrôle de version pour les services stockage Azure.
x-ms-client-request-id Optionnel. Fournit une valeur opaque générée par le client avec une limite de caractères de 1 kibioctet (KiB) enregistrée dans les journaux lors de la configuration de la journalisation. Nous vous recommandons vivement d’utiliser cet en-tête pour mettre en corrélation les activités côté client avec les demandes reçues par le serveur. Pour plus d’informations, consultez Monitor Azure Files.
x-ms-lease-id:<ID> Optionnel. Version 2020-02-10 et ultérieure. Si l’en-tête est spécifié, l’opération est effectuée uniquement si le bail du partage de fichiers est actuellement actif et que l’ID de bail spécifié dans la demande correspond à l’ID de bail du partage de fichiers. En l’absence de correspondance, l’opération échoue avec le code d’état 412 (Échec de la condition préalable).

Corps de la demande

Aucun.

Réponse

La réponse inclut un code d’état HTTP et un ensemble d’en-têtes de réponse.

Code d’état

Une opération réussie retourne le code d’état 200 (OK).

Pour plus d’informations sur les codes d’état, consultez Les codes d’état et d’erreur.

En-têtes de réponse

La réponse de cette opération inclut les en-têtes suivants. La réponse peut également inclure des en-têtes HTTP standard supplémentaires. Tous les en-têtes standard sont conformes à la spécification de protocole HTTP/1.1.

En-tête de réponse Description
Last-Modified Retourne la date et l’heure de la dernière modification du partage. Le format de date suit RFC 1123. Pour plus d’informations, consultez Représentation des valeurs de Date-Time dans les en-têtes. Toute opération qui modifie le partage ou ses propriétés met à jour l’heure de dernière modification. Les opérations sur les fichiers n’affectent pas l’heure de dernière modification du partage.
x-ms-meta-name:value Ensemble de paires nom-valeur qui contiennent les métadonnées définies par l’utilisateur du partage.
ETag Contient une valeur que vous pouvez utiliser pour effectuer des opérations de manière conditionnelle. La valeur est placée entre guillemets.
x-ms-request-id Identifie de manière unique la demande qui a été effectuée et peut être utilisée pour résoudre les problèmes de la demande. Pour plus d’informations, consultez Résoudre les problèmes d’opérations d’API.
x-ms-version Version d’Azure Files utilisée pour exécuter la requête.
Date Valeur de date/heure UTC générée par le service, qui indique l’heure à laquelle la réponse a été lancée.
x-ms-share-quota Version 2015-02-21 et ultérieure. Retourne le quota de partage actuel en gibibytes (Gio).
x-ms-share-provisioned-iops Version 2019-07-07 et ultérieure. Retourné uniquement pour les partages de fichiers Premium (partages de fichiers dans le type de compte de stockage FileStorage). Retourne le nombre d’opérations d’entrée/sortie par seconde (IOPS), comme provisionné pour le partage Premium.
x-ms-share-provisioned-ingress-mbps Version 2019-07-07 et ultérieure. Retourné uniquement pour les partages de fichiers Premium (partages de fichiers dans le type de compte de stockage FileStorage). Retourne l’entrée en mebibytes par seconde (MiB/s), comme provisionné pour le partage Premium.
x-ms-share-provisioned-egress-mbps Version 2019-07-07 et ultérieure. Retourné uniquement pour les partages de fichiers Premium (partages de fichiers dans le type de compte de stockage FileStorage). Retourne la sortie en MiB/s, comme provisionné pour le partage Premium.
x-ms-share-provisioned-bandwidth-mibps Version 2021-02-12 et ultérieure. Retourné uniquement pour les partages de fichiers Premium (partages de fichiers dans le type de compte de stockage FileStorage). Retourne la bande passante combinée (entrée + sortie) en MiB/s, comme provisionné pour le partage Premium.
x-ms-share-next-allowed-quota-downgrade-time Version 2019-07-07 et ultérieure. Retourné uniquement pour les partages de fichiers Premium (partages de fichiers dans le type de compte de stockage FileStorage). Valeur de date/heure qui spécifie quand le quota pour le partage de fichiers Premium est autorisé à être réduit. Le format de date suit RFC 1123.
x-ms-access-tier Version 2019-12-12 et ultérieure. Retourne le niveau d’accès actuel du partage. Dans les comptes de stockage à usage général version 2 (GPv2), TransationOptimized est le niveau par défaut du partage. Dans les types de compte de stockage FileStorage, Premium est le niveau par défaut du partage.
x-ms-access-tier-change-time Version 2019-12-12 et ultérieure. Retourne la date et l’heure de la dernière modification du niveau d’accès sur le partage.
x-ms-access-tier-transition-state Version 2019-12-12 et ultérieure. Si le partage fait l’objet d’une transition de niveau, cet en-tête indique le niveau à partir duquel il passe.
x-ms-lease-duration:<fixed,infinite> Version 2020-02-10 et ultérieure. Spécifie si le bail sur un partage est infini ou fixe.
x-ms-lease-state: <available;leased;expired;breaking;broken> Version 2020-02-10 et ultérieure. Lorsqu’un partage est loué, cet en-tête spécifie l’état du bail du partage.
x-ms-lease-status: <locked;unlocked> Version 2020-02-10 et ultérieure. Lorsqu’un partage est loué, cet en-tête spécifie l’état du bail du partage.
x-ms-enabled-protocols: <SMB;NFS> Retourne les protocoles actuels avec partage pour la version 2019-07-07 et ultérieures.

- SMB: le partage est accessible par SMBv3.0, SMBv2.1 et REST.
- NFS: le partage est accessible par NFSv4.1.
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> Retourne le comportement de courge racine de partage actuel pour la version 2019-07-07 et ultérieure. NFS uniquement.

- NoRootSquash: la courge racine est désactivée.
- RootSquash: les requêtes provenant d’UID/GID 0 sont mappées à l’UID/GID anonyme.
- AllSquash: tous les UID et LES GIO sont mappés à l’utilisateur anonyme.

Cet en-tête est retourné uniquement pour les partages, et non pour les instantanés.
x-ms-enable-snapshot-virtual-directory-access: <true;false> Version 2024-08-04 et ultérieure. Spécifie si le répertoire virtuel d’instantané doit être accessible à la racine du point de montage du partage lorsque NFS est activé.

Cet en-tête est retourné uniquement pour les partages, et non pour les instantanés.
x-ms-client-request-id Peut être utilisé pour résoudre les demandes et les réponses correspondantes. La valeur de cet en-tête est égale à la valeur de l’en-tête x-ms-client-request-id s’il est présent dans la requête et que la valeur ne contient pas plus de 1 024 caractères ASCII visibles. Si l’en-tête x-ms-client-request-id n’est pas présent dans la requête, il ne sera pas présent dans la réponse.
x-ms-share-paid-bursting-enabled: <true;false> Version 2024-11-04 et ultérieure. Retourné uniquement pour les partages de fichiers Premium (partages de fichiers dans le type de compte de stockage FileStorage). Spécifie si le bursting payant est activé.

Cet en-tête est retourné uniquement pour les partages, et non pour les instantanés.
x-ms-share-paid-bursting-max-iops Version 2024-11-04 et ultérieure. Retourné uniquement pour les partages de fichiers Premium. Retourne le nombre maximal d’E/S par seconde avec rafales payantes autorisées pour le partage. Retourné uniquement si x-ms-share-paid-bursting-enabled a la valeur true.

Cet en-tête est retourné uniquement pour les partages, et non pour les instantanés.
x-ms-share-paid-bursting-max-bandwidth-mibps Version 2024-11-04 et ultérieure. Retourné uniquement pour les partages de fichiers Premium. Retourne le nombre maximal de mio/s payés autorisés pour le partage. Retourné uniquement si x-ms-share-paid-bursting-enabled a la valeur true.

Cet en-tête est retourné uniquement pour les partages, et non pour les instantanés.

Corps de la réponse

Aucun.

Exemple de réponse

Response Status:  
HTTP/1.1 200 OK  
  
Response Headers:  
Transfer-Encoding: chunked  
x-ms-meta-name: some_metadata  
Date: <date>  
ETag: "0x8CB171DBEAD6A6B"  
Last-Modified: <date>  
x-ms-share-quota: 1024
x-ms-access-tier: Premium
x-ms-version: 2020-02-10  
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0

Autorisation

Seul le propriétaire du compte peut appeler cette opération.

Remarques

Aucun.

Voir aussi

opérations sur les partages de fichiers Azure