Obtention des propriétés du service de File d'attente

Article
06/27/2023

L’opération Get Queue Service Properties obtient les propriétés d’un compte de stockage File d’attente Azure, y compris les propriétés pour les règles de Storage Analytics et cors (cross-origin resource sharing).

Pour plus d’informations sur les règles cors (cross-origin resource sharing) et la logique d’évaluation, consultez Prise en charge de CORS pour les services de stockage Azure.

Requête

La demande Get Queue Service Properties 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 demande	Version HTTP
GET	`https://<account-name>.queue.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Remarque

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

Paramètres URI

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

Paramètre	Description
`restype=service&comp=properties`	Obligatoire. La combinaison des deux chaînes de requête est requise pour obtenir les propriétés de 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 stockage file d’attente Azure.

En-têtes de requête

Le tableau suivant décrit les en-têtes de demande obligatoires ou facultatifs.

En-tête de requête	Description
`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 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`	Optionnel. 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 le stockage File d’attente Azure.

Corps de la demande

Aucun.

response

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 d’état

Une opération réussie envoie le code d'état 200 (OK).

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
`x-ms-request-id`	Identifie de manière unique une demande effectuée auprès du 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 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

Le format du corps de la réponse pour la version 2012-02-12 et les versions antérieures est le suivant :

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>version-number</Version>  
        <Delete>true|false</Delete>  
        <Read>true|false</Read>  
        <Write>true|false</Write>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Logging>  
    <Metrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Metrics>  
</StorageServiceProperties>

À compter de la version 2013-08-15, le format du corps de la réponse est le suivant :

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>version-number</Version>  
        <Delete>true|false</Delete>  
        <Read>true|false</Read>  
        <Write>true|false</Write>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Logging>  
    <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>  
</StorageServiceProperties>

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

Nom de l’élément	Description
Logging	Regroupe les paramètres de journalisation Storage Analytics.
Métriques	Regroupe les paramètres de métriques Storage Analytics. Les paramètres Metrics fournissent un résumé des statistiques de demande regroupées par l'API en agrégats horaires des files d'attente.
HourMetrics	Regroupe les paramètres Storage Analytics HourMetrics. Les paramètres HourMetrics fournissent un résumé des statistiques de demande regroupées par l'API en agrégats horaires des files d'attente.
MinuteMetrics	Regroupe les paramètres Storage Analytics MinuteMetrics. Les paramètres MinuteMetrics* fournissent des statistiques de demande pour chaque minutes des files d'attente.
Version	Version de Storage Analytics en cours d’utilisation.
Supprimer	S’applique uniquement à la configuration de journalisation. Indique si toutes les demandes de suppression sont journalisées.
Lire	S’applique uniquement à la configuration de journalisation. Indique si toutes les demandes de lecture sont journalisées.
Écrire	S’applique uniquement à la configuration de journalisation. Indique si toutes les demandes d'écriture sont journalisées.
Activé	Indique si les métriques sont activées pour le Stockage File d’attente Azure. Si la réplication géographique redondante avec accès en lecture est activée, les métriques primaires et secondaires sont collectées. Si la réplication géographique redondante avec accès en lecture n'est pas activée, seules les métriques primaires sont collectées.
IncludeAPIs	S'applique uniquement à la configuration des métriques. Indique si les métriques génèrent des statistiques de synthèse 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 stockage.
RetentionPolicy/Days	Indique le nombre de jours pendant lesquels les métriques ou les données de journalisation sont conservées. Toutes les données plus anciennes que cette valeur seront supprimées.
Scro	Regroupe toutes les règles CORS.
CorsRule	Regroupe les paramètres d'une règle CORS.
AllowedOrigins	Liste séparée par des virgules des domaines d’origine autorisés via CORS, ou un astérisque (*) 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 d’en-têtes séparés par des virgules qui sont autorisés à faire partie de la requête cross-origin.
AllowedMethods	Liste séparée par des virgules de méthodes HTTP qui sont autorisées à être exécutées par l'origine. Pour stockage Azure, les méthodes autorisées sont DELETE, GET, HEAD, MERGE, POST, OPTIONS ou PUT.

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 demande l'obtention des propriétés du service de File d'attente pour le compte de stockage fictif nommé myaccount :

GET https://myaccount.queue.core.windows.net/?restype=service&comp=properties HTTP/1.1

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

x-ms-version: 2013-08-15  
x-ms-date: Wed, 23 Oct 2013 04:49:03 GMT  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.queue.core.windows.net

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

HTTP/1.1 200 OK  
Content-Length: 1020  
Content-Type: application/xml  
Date: Wed, 23 Oct 2013 04:49:04 GMT  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2013-08-15

Le corps de la réponse est similaire à :

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>1.0</Version>  
        <Delete>true</Delete>  
        <Read>false</Read>  
        <Write>true</Write>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </Logging>  
    <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>  
</StorageServiceProperties>

Voir aussi

Analyse du stockage
Prise en charge de CORS pour les services de stockage Azure
Spécification HTTP CORS

Partager via