Exporter (0) Imprimer
Développer tout

Set Queue Service Properties (API REST)

Mis à jour: novembre 2014

L'opération Set Queue Service Properties définit les propriétés du point de terminaison de service de File d'attente d'un compte de stockage, notamment les propriétés des règles Storage Analytics et CORS (Partage des ressources cross-origin). Pour plus d'informations sur les règles CORS, consultez Prise en charge du service Partage des ressources cross-origine (CORS) pour les services de stockage Windows Azure.

La requête Set Queue Service Properties peut être spécifiée comme suit. HTTPS est recommandé. Remplacez <account-name> par le nom de votre compte de stockage :

 

Méthode URI de demande Version HTTP

PUT

https://<account-name>.queue.core.windows.net/?restype=service&comp=properties

HTTP/1.1

Notez que l'URI doit toujours inclure la barre oblique (/) pour séparer le nom d'hôte du chemin d'accès et les parties de requête de l'URI. Dans le cadre de cette opération, la partie de chemin d'accès de l'URI est vide.

 

Parameter Description

restype=service&comp=properties

Obligatoire. La combinaison des deux chaînes de requête est requise pour définir les propriétés de service de stockage.

timeout

Ce paramètre est facultatif. Le paramètre timeout est exprimé en secondes. Pour plus d'informations, consultez Définition de délais d'expiration pour les opérations du service de File d'attente.

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

 

En-tête de demande Description

Authorization

Obligatoire. Spécifie le schéma d'authentification, le nom de compte de stockage et la signature. Pour plus d'informations, consultez Authentification pour les services de stockage Azure.

Date - ou - x-ms-date

Obligatoire. Spécifie le temps universel coordonné (UTC) pour la demande. Pour plus d'informations, consultez Authentification pour les services de stockage Azure.

x-ms-version

Obligatoire pour toutes les demandes authentifiées. Spécifie la version de l'opération à utiliser pour cette demande. Pour plus d'informations, consultez Contrôle de version des services BLOB, de File d'attente et de Table dans Windows Azure.

x-ms-client-request-id

Ce paramètre est facultatif. Fournit une valeur opaque générée par le client avec une limite de caractère de 1 Ko qui est enregistrée dans les journaux d'analyse quand la journalisation de l'analyse de stockage est activée. L'utilisation de cet en-tête est recommandée pour la corrélation des activités côté client avec les requêtes reçues par le serveur. Pour plus d'informations, consultez À propos de la journalisation Storage Analytics et Journalisation du stockage Windows Azure : utilisation des journaux pour suivre les demandes de stockage.

Le format du corps de la requête 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>

Le format du corps de la requête pour la version 2013-08-15 et ultérieure 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-seperated-list-of-response-headers</ExposedHeaders>
            <AllowedHeaders> comma-seperated-list-of-request-headers </AllowedHeaders>
        </CorsRule>
    </Cors>
</StorageServiceProperties>

À partir de la version 2013-08-15, vous pouvez appeler Set Queue Service Properties avec un ou plusieurs éléments racine spécifiés dans le corps de la requête. Les éléments racine incluent :

  • Journalisation

  • HourMetrics

  • MinuteMetrics

  • Cors

Il n'est plus nécessaire de spécifier chaque élément racine sur la requête. Si vous omettez un élément racine, les paramètres existants pour le service de cette fonctionnalité sont conservés. Toutefois, si vous spécifiez un élément racine donné, vous devez spécifier chaque élément enfant de cet élément.

Le tableau suivant décrit les éléments du corps de la demande :

 

Nom de l'élément Description

Journalisation

Paramètre facultatif à compter de la version 2013-08-15. Obligatoire pour les versions antérieures. Regroupe les paramètres Logging d'analyse Windows Azure.

Métriques

Obligatoire pour la version 2012-02-12 et les versions antérieures. Ne s'applique pas à la version 2013-08-15 ou version ultérieure. Regroupe les paramètres Metrics d'analyse Windows Azure. Les paramètres Métriques fournissent un résumé des statistiques de demande regroupées par l'API en agrégats horaires des files d'attente.

HourMetrics

Facultatif pour la version 2013-08-15 ou version ultérieure ; ne s'applique pas aux versions antérieures. Regroupe les paramètres HourMetrics d'analyse Windows Azure. 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

Facultatif pour la version 2013-08-15 ou version ultérieure ; ne s'applique pas aux versions antérieures. Regroupe les paramètres MinuteMetrics d'analyse Windows Azure. Les paramètres MinuteMetrics fournissent des statistiques de demande pour chaque minutes des files d'attente. Pour les versions antérieures à la version à 2013-08-15, MinuteMetrics n'est pas inclus dans le corps de la réponse.

Version

Obligatoire si les paramètres Logging, Metrics, HourMetrics ou MinuteMetrics sont spécifiés. La version de Storage Analytics à configurer.

Supprimer

Obligatoire si les paramètres Logging, Metrics, HourMetrics ou MinuteMetrics sont spécifiés. S'applique uniquement à la configuration de journalisation. Indique si toutes les demandes de suppression doivent être journalisées.

Lire

Obligatoire si les paramètres Logging, Metrics, HourMetrics ou MinuteMetrics sont spécifiés. S'applique uniquement à la configuration de journalisation. Indique si toutes les demandes de lecture doivent être journalisées.

Write

Obligatoire si les paramètres Logging, Metrics, HourMetrics ou MinuteMetrics sont spécifiés. S'applique uniquement à la configuration de journalisation. Indique si toutes les demandes d'écriture doivent être journalisées.

Activé

Obligatoire. Indique si les métriques sont activées pour le service de File d'attente.

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

Obligatoire uniquement si les métriques sont activées. S'applique uniquement à la configuration des métriques. Indique si les métriques doivent générer des statistiques de synthèse pour les opérations d'API appelées.

RetentionPolicy/Enabled

Obligatoire. Indique si une stratégie de rétention est activée pour le service de stockage.

RetentionPolicy/Days

Obligatoire uniquement si une stratégie de rétention est activée. Indique le nombre de jours pendant lesquels les métriques ou les données de journalisation doivent être conservées. Toutes les données plus anciennes que cette valeur seront supprimées. La valeur minimale que vous pouvez spécifier est 1 ; la plus grande valeur est 365 (un an).

Cors

Ce paramètre est facultatif. L'élément Cors est pris en charge pour la version 2013-08-15 ou version ultérieure. Regroupe toutes les règles CORS.

Si cet élément n'est pas spécifié, le regroupement ne remplace pas les paramètres CORS existants.

CorsRule

Ce paramètre est facultatif. Spécifie une règle CORS pour le service de File d'attente. Incluez jusqu'à cinq éléments CorsRule dans la requête. Si aucun élément CorsRule n'est inclus dans le corps de la requête, toutes les règles CORS sont supprimées, et les règles CORS sont désactivées pour le service de File d'attente.

AllowedOrigins

Obligatoire si l'élément CorsRule est présent. Liste séparée par des virgules de domaines d'origine qui sont autorisés via les règles CORS, ou « * » si tous les domaines sont autorisés. Limitée à 64 domaines d'origine. Chaque origine autorisée peut comporter jusqu'à 256 caractères.

ExposedHeaders

Obligatoire si l'élément CorsRule est présent. Liste séparée par des virgules d'en-têtes de réponse à exposer aux clients CORS. Limitée à 64 en-têtes définis et deux en-têtes avec préfixe. Chaque en-tête peut comporter jusqu'à 256 caractères.

MaxAgeInSeconds

Obligatoire si l'élément CorsRule est présent. Nombre de secondes pendant lequel le client/navigateur doit mettre en cache une réponse préliminaire.

AllowedHeaders

Obligatoire si l'élément CorsRule existe. Liste séparées par des virgules d'en-têtes autorisés à faire partie de la requête cross-origin. Limitée à 64 en-têtes définis et deux en-têtes avec préfixe. Chaque en-tête peut comporter jusqu'à 256 caractères.

AllowedMethods

Obligatoire si l'élément CorsRule existe. Liste séparée par des virgules de méthodes HTTP qui sont autorisées à être exécutées par l'origine. Pour Windows Azure Storage, les méthodes autorisées sont DELETE, GET, HEAD, MERGE, POST, OPTIONS ou PUT.

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

Une opération ayant réussi retourne le code d'état 202 (Accepté).

Pour plus d'informations sur les codes d'état, consultez Codes d'état et d'erreur de la gestion des services.

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

Une valeur qui identifie de façon unique une demande faite au service.

x-ms-version

Spécifie la version de l'opération utilisée pour la réponse. Pour plus d'informations, consultez Contrôle de version des services BLOB, de File d'attente et de Table dans Windows Azure.

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

Les restrictions et limitations suivantes s'appliquent aux règles CORS dans Windows Azure Storage :

  • Au plus cinq règles peuvent être enregistrées.

  • La taille maximale de tous les paramètres de règles CORS dans la requête, à l'exception des balises XML, ne doit pas dépasser 2 Ko.

  • La longueur d'un en-tête autorisé, de l'en-tête exposé, ou de l'origine autorisée ne doit pas dépasser 256 caractères.

  • Les en-têtes autorisés et les en-têtes exposés peuvent être :

    • Des en-têtes littéraux, où le nom précis d'en-tête est spécifié, tel que x-ms-meta-processed. Au plus 64 en-têtes littéraux peuvent être spécifiés sur la requête.

    • Des en-têtes préfixés, où un préfixe de l'en-tête est spécifié, tel que x-ms-meta-data*. Le fait de spécifier un préfixe de cette façon autorise ou expose les en-têtes qui commencent par le préfixe donné. Au plus deux en-têtes préfixés peuvent être spécifiés sur la requête.

  • Les méthodes (ou les mots HTTP) spécifiés dans l'élément AllowedMethods doivent respecter les méthodes prises en charge par les API de service de stockage Windows Azure. Les méthodes prises en charge sont DELETE, GET, HEAD, MERGE, POST, OPTIONS et PUT.

La spécification de règles CORS sur la requête est facultative. Si vous appelez Set Queue Service Properties sans spécifier l'élément Cors dans le corps de la requête, toutes les règles CORS existantes sont conservées.

Pour désactiver les règles CORS, appelez Set Queue Service Properties avec un paramètre de règles CORS vide (c.-à-d.,</Cors>) et aucune règle CORS interne. Cet appel supprime toutes les règles existantes, ce qui désactive les règles CORS pour le service de File d'attente.

Tous les éléments de règle CORS sont obligatoires si l'élément CorsRule est spécifié. La requête échoue avec le code d'erreur 400 (Bad Request) si un élément est manquant.

Avec la version 2013-08-15, les éléments de paramètres XML sont facultatifs ; par conséquent, la mise à jour d'un élément spécifique peut être effectuée en envoyant un paramètre XML qui contient uniquement l'élément mis à jour et les autres paramètres ne sont pas affectés.

Pour plus d'informations sur les règles CORS et la logique d'évaluation, consultez Prise en charge du service Partage des ressources cross-origine (CORS) pour les services de stockage Windows Azure.

L'exemple d'URI suivant effectue une demande pour modifier les propriétés du service de File d'attente pour le compte de stockage fictif nommé myaccount:

PUT 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:28:19 GMT
Authorization: SharedKey
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=
Host: myaccount.queue.core.windows.net

La demande est envoyée avec le corps XML suivant :

<?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>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> 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>


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

HTTP/1.1 202 Accepted
Connection: Keep-Alive
Transfer-Encoding: chunked
Date: Wed, 23 Oct 2013 04:28:20 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

Voir aussi

Afficher:
© 2014 Microsoft