Partager via

Obtenir les propriétés du service de fichiers

L’opération Get File Service Properties obtient les propriétés de la FileService ressource à l’aide de l’API FileREST. Bien que cette API soit entièrement prise en charge, il s’agit d’une API de gestion héritée. Nous vous recommandons plutôt d’utiliser les services de fichiers - Obtenir les propriétés du service, fournies par le fournisseur de ressources de stockage (Microsoft.Storage). Pour en savoir plus sur l’interaction programmatique avec la ressource à l’aide FileService du fournisseur de ressources de stockage, consultez Opérations sur la ressource FileService.

Disponibilité du protocole

Protocole de partage de fichiers activé Disponible
PME Oui
Système de fichiers en réseau (NFS) Oui

Requête

La Get File Service Properties demande peut être spécifiée comme suit. Nous vous recommandons d’utiliser HTTPS. Remplacez <account-name> par le nom de votre compte de stockage :

Méthode URI de la requête Version HTTP
AVOIR https://<account-name>.file.core.windows.net/?restype=service&comp=properties HTTP/1.1

Remarque

L’URI doit toujours inclure un caractère de barre oblique (/) pour séparer le nom d’hôte du chemin d’accès et des parties de requête de l’URI. Dans cette opération, la partie chemin d’accès de l’URI est vide.

Paramètres d’URI

Paramètre d’URI Descriptif
restype=service&comp=properties Obligatoire. La combinaison des deux chaînes de requête est requise pour définir les propriétés du service de stockage.
timeout Optionnel. 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 service de fichiers.

En-têtes de requête

Le tableau suivant décrit les en-têtes de requête obligatoires et facultatifs.

En-tête de requête Descriptif
Authorization Obligatoire. Spécifie le schéma d’autorisation, le nom du compte de stockage 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. Cette opération est disponible uniquement dans la version 2015-02-21 et ultérieure. Pour récupérer les propriétés des métriques pour le service de fichiers, vous devez spécifier la version 2015-04-05 ou ultérieure.

Pour plus d'informations, consultez la page Contrôle de version pour les services de Stockage Microsoft 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 Azure Storage Analytics 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 la section Superviser Azure Files.

Corps de la requête

Aucun.

Réponse

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

Code de statut

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

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 Descriptif
x-ms-request-id Identifie de manière unique une requête effectuée sur le service.
x-ms-version Spécifie la version de l’opération utilisée pour la réponse. Pour plus d'informations, consultez la page Contrôle de version pour les services de Stockage Microsoft Azure.
x-ms-client-request-id Peut être utilisé pour résoudre les demandes et leurs 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 n’est pas présent dans la réponse.

Corps de réponse

Le format du corps de la réponse pour la version 2020-02-10 est le suivant :

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <HourMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>comma-separated-list-of-allowed-origins</AllowedOrigins>  
            <AllowedMethods>comma-separated-list-of-HTTP-verb</AllowedMethods>  
            <MaxAgeInSeconds>max-caching-age-in-seconds</MaxAgeInSeconds>  
            <ExposedHeaders>comma-separated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders>comma-separated-list-of-request-headers</AllowedHeaders>  
        </CorsRule>  
    </Cors>
    <ShareDeleteRetentionPolicy>
        <Enabled>true|false</Enabled>
        <Days>integer-value</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true|false</Enabled>
            </Multichannel>
            <Versions>semicolon-separated-list-of-smb-versions</Versions>
            <AuthenticationMethods>semicolon-separated-list-of-auth-methods</AuthenticationMethod>
            <KerberosTicketEncryption>semicolon-separated-list-of-kerberos-encryption-algorithms</KerberosTicketEncryption>
            <ChannelEncryption>semicolon-separated-list-of-smb-channel-encryption-algorithms</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>

Les éléments du corps de la réponse sont décrits dans le tableau suivant :

Nom Descriptif
HourMetrics Regroupe les paramètres Storage Analytics HourMetrics . Les HourMetrics paramètres fournissent un résumé des statistiques de requête, regroupés par API dans des agrégats horaires.
MinuteMetrics Regroupe les paramètres Storage Analytics MinuteMetrics . Les MinuteMetrics paramètres fournissent des statistiques de requête pour chaque minute.
Version Version de Storage Analytics en cours d’utilisation.
Enabled Indique si les métriques sont activées pour le service de fichiers.
IncludeAPIs Indique si les métriques génèrent des statistiques récapitulatives pour les opérations d’API appelées.
RetentionPolicy/Enabled Indique si une stratégie de rétention est activée pour le service de fichiers.
RetentionPolicy/Days Indique le nombre de jours pendant lesquels les données de métriques sont conservées. Toutes les données antérieures à cette valeur sont supprimées au mieux.
Cors Regroupe toutes les règles CORS (Cross-Origin Resource Sharing).
CorsRule Regroupe les paramètres d’une règle CORS.
AllowedOrigins Liste séparée par des virgules de domaines d’origine autorisés via CORS ou « * » si tous les domaines sont autorisés.
ExposedHeaders Liste séparée par des virgules d’en-têtes de réponse à exposer aux clients CORS.
MaxAgeInSeconds Nombre de secondes pendant lesquelles le client ou le navigateur doit mettre en cache une réponse préliminaire.
AllowedHeaders Liste séparée par des virgules d’en-têtes qui sont autorisés à faire partie de la demande d’origine croisée.
AllowedMethods Liste séparée par des virgules des méthodes HTTP autorisées à être exécutées par l’origine. Pour Azure Files, les méthodes autorisées sont DELETE, GET, HEAD, MERGE, POST, OPTIONS et PUT.
ShareDeleteRetentionPolicy Propriétés de suppression réversible pour les partages de fichiers Azure dans ce compte de stockage.
Days Indique le nombre de jours pendant lesquels le partage de fichiers Azure doit être conservé (supprimé de manière réversible). La valeur spécifiée minimale peut être 1 et la valeur maximale est 365.
Enabled Indique si la suppression réversible du compte de stockage est activée pour Azure Files.
ProtocolSettings Regroupe les paramètres des protocoles de système de fichiers.
SMB Regroupe les paramètres du bloc de messages serveur (SMB).
Multichannel Contient les paramètres de SMB Multichannel. Ce paramètre a une propriété : activée/désactivée.
Versions Disponible à partir de la version 2020-04-08. Liste séparée par des points-virgules des versions SMB autorisées. Valeurs possibles : SMB2.1, SMB3.0et SMB3.1.1. Si Version ce n’est pas spécifié, la valeur par défaut est que toutes les versions sont activées. Toutefois, SMB 2.1 est disponible uniquement si la propriété du compte de require secure transit stockage est désactivée, car SMB 2.1 ne prend pas en charge le chiffrement.
AuthenticationMethods Disponible à partir de la version 2020-04-08. Liste séparée par des points-virgules des méthodes d’authentification autorisées. Valeurs possibles : NTLMv2, Kerberos. Si AuthenticationMethods ce n’est pas spécifié, la valeur par défaut est que toutes les méthodes d’authentification sont autorisées.
KerberosTicketEncryption Disponible à partir de la version 2020-04-08. Liste séparée par des points-virgules des algorithmes de chiffrement de ticket Kerberos autorisés. Valeurs possibles : RC4-HMAC et AES-256. Si KerberosTicketEncryption ce n’est pas spécifié, la valeur par défaut est que tous les algorithmes de chiffrement de ticket Kerberos sont pris en charge.
ChannelEncryption Disponible à partir de la version 2020-04-08. Liste séparée par des points-virgules des algorithmes de chiffrement de canal SMB autorisés. Valeurs possibles : AES-128-CCM, AES-128-GCMet AES-256-GCM. Si ChannelEncryption ce n’est pas spécifié, la valeur par défaut est que toutes les valeurs de chiffrement de canal sont prises en charge. Si la propriété du compte de require secure transit stockage est désactivée, l’accès SMB non chiffré est également autorisé.

Autorisation

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

Exemple de requête et de réponse

L’exemple d’URI suivant effectue une requête pour obtenir les propriétés du service de fichiers pour un compte de stockage nommé myaccount :

Méthode URL Protocole
AVOIR https://myaccount.file.core.windows.net/?restype=service&comp=properties HTTP/1.1

La demande est envoyée avec les en-têtes suivants :

x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.file.core.windows.net

Une fois la demande envoyée, la réponse suivante est retournée :

HTTP/1.1 200 OK  
Content-Length: 1020  
Content-Type: application/xml  
Date: <date>  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2015-04-05

La réponse inclut le corps XML suivant :

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <HourMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>true</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>http://www.fabrikam.com,http://www.contoso.com</AllowedOrigins>  
            <AllowedMethods>GET,PUT</AllowedMethods>  
            <MaxAgeInSeconds>500</MaxAgeInSeconds>  
            <ExposedHeaders>x-ms-meta-data*,x-ms-meta-customheader</ExposedHeaders>  
            <AllowedHeaders>x-ms-meta-target*,x-ms-meta-customheader</AllowedHeaders>  
        </CorsRule>  
    </Cors>
    <ShareDeleteRetentionPolicy>
        <Enabled>true</Enabled>
        <Days>7</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true</Enabled>
            </Multichannel>
            <Versions>SMB3.1.1</Versions>
            <AuthenticationMethods>Kerberos</AuthenticationMethods>
            <KerberosTicketEncryption>AES-256</KerberosTicketEncryption>
            <ChannelEncryption>AES-256-GCM</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>

Remarques

Pour plus d’informations sur les règles CORS et la logique d’évaluation, consultez la prise en charge de CORS pour les services stockage Azure.

Pour plus d’informations, consultez Storage Analytics.