Obtention de propriétés de partage
La Get Share Properties requête retourne des propriétés pour le partage ou le partage spécifié instantané.
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 - Get, qui est fourni par le fournisseur de ressources de stockage (Microsoft.Storage), à la place.
Pour en savoir plus sur l’interaction programmatique avec FileShare les ressources à l’aide du fournisseur de ressources de stockage, consultez Opérations sur les partages de fichiers.
Disponibilité du protocole
| Protocole de partage de fichiers activé | Disponible |
|---|---|
| SMB |  |
| NFS | |
Requête
La demande Get Share Properties peut être construite comme indiqué ci-dessous. Nous vous recommandons d’utiliser HTTPS.
| Méthode | URI de demande | 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 du chemin indiqués dans l'URI de la demande par les vôtres, comme suit :
| Composant Path | Description |
|---|---|
myaccount |
nom de votre compte de stockage. |
myshare |
Nom du partage de fichiers. |
Pour plus d’informations sur les restrictions de nommage de chemin d’accès, consultez Partages de noms et références, répertoires, fichiers et métadonnées.
Paramètres URI
Les paramètres supplémentaires suivants peuvent être spécifiés dans l’URI de requête :
| Paramètre | Description |
|---|---|
sharesnapshot |
facultatif. Version 2017-04-17 et ultérieures. Le sharesnapshot paramètre est une valeur de date/heure opaque qui, lorsqu’elle est présente, spécifie le partage instantané à interroger pour récupérer les propriétés. |
timeout |
facultatif. Le paramètre timeout est exprimé en secondes. Pour plus d’informations, consultez Définir des délais d’attente pour les opérations de 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 requêtes auprès du Stockage Azure. |
Date ou x-ms-date |
Obligatoire. Spécifie la date/heure en temps universel coordonné (UTC) pour la requête. Pour plus d’informations, consultez Autoriser les requêtes auprès du Stockage Azure. |
x-ms-version |
Obligatoire pour toutes les demandes autorisées. Spécifie la version de l'opération à utiliser pour cette demande. Pour plus d'informations, consultez la page Contrôle de version pour les services de Stockage Microsoft Azure. |
x-ms-client-request-id |
facultatif. Fournit une valeur opaque générée par le client avec une limite de caractères de 1 kibioctet (Kio) 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 que le serveur reçoit. Pour plus d’informations, consultez Surveiller Azure Files. |
x-ms-lease-id:<ID> |
facultatif. Version 2020-02-10 et ultérieures. 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 status code 412 (échec de la condition préalable). |
Corps de la demande
Aucun.
response
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 envoie le code d'état 200 (OK).
Pour plus d’informations sur les codes status, consultez Codes d’état et d’erreur.
En-têtes de réponse
La réponse de l'opération inclut les en-têtes suivants. La réponse peut aussi inclure des en-têtes HTTP standard supplémentaires. Tous les en-têtes standard sont conformes à la spécification du 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 est conforme à la RFC 1123. Pour plus d’informations, consultez Représentation de valeurs Date-Time dans les en-têtes. Toute opération qui modifie le partage ou ses propriétés entraîne la mise à jour de l'heure de la dernière modification. Les opérations sur les fichiers n’affectent pas l’heure de la dernière modification du partage. |
x-ms-meta-name:value |
Ensemble de paires nom-valeur contenant 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 la demande. Pour plus d’informations, consultez Résoudre les problèmes liés aux opérations d’API. |
x-ms-version |
Le Azure Files version utilisée pour exécuter la demande. |
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érieures. 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), tel que 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 (Mio/s), telle que provisionnée 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 Mio/s, telle que provisionnée pour le partage Premium. |
x-ms-share-provisioned-bandwidth-mibps |
Version 2021-02-12 et ultérieures. 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 Mio/s, telle que provisionnée 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 est conforme à la RFC 1123. |
x-ms-access-tier |
Version 2019-12-12 et ultérieures. 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érieures. 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érieures. Si le partage est en cours de transition de niveau, cet en-tête indique le niveau à partir duquel il effectue la transition. |
x-ms-lease-duration:<fixed,infinite> |
Version 2020-02-10 et ultérieures. Spécifie si le bail sur un partage est d’une durée infinie ou fixe. |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
Version 2020-02-10 et ultérieures. 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érieures. Lorsqu’un partage est loué, cet en-tête spécifie le status de bail du partage. |
x-ms-enabled-protocols: <SMB;NFS> |
Retourne les protocoles activés pour le partage actuel pour la version 2019-07-07 et ultérieure. - 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 d’écrasement racine de partage actuel pour la version 2019-07-07 et ultérieure. NFS uniquement. - NoRootSquash: l’écrasement racine est désactivé.- RootSquash: les demandes de l’UID/GID 0 sont mappées à l’UID/GID anonyme.- AllSquash: tous les UID et GID sont mappés à l’utilisateur anonyme. |
x-ms-client-request-id |
Peut être utilisé pour résoudre les problèmes liés aux demandes et aux 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 demande, il ne sera pas présent dans la réponse. |
Response body
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.
Notes
Aucun.