Définition de métadonnées de file d'attenteSet Queue Metadata

L'opération Set Queue Metadata définit des métadonnées définies par l'utilisateur dans la file d'attente spécifiée.The Set Queue Metadata operation sets user-defined metadata on the specified queue. Les métadonnées sont associées à la file d'attente en tant que paires nom-valeur.Metadata is associated with the queue as name-value pairs.

RequêteRequest

La demande Set Queue Metadata peut être construite comme indiqué ci-dessous.The Set Queue Metadata request may be constructed as follows. HTTPS est recommandé.HTTPS is recommended.

MéthodeMethod URI de demandeRequest URI Version HTTPHTTP Version
PUT https://myaccount.queue.core.windows.net/myqueue?comp=metadata HTTP/1.1HTTP/1.1

URI du service de stockage émuléEmulated Storage Service URI

Lorsque vous élaborez une demande pour le service de stockage émulé, spécifiez le nom d'hôte de l'émulateur et le port de service de File d'attente sous la forme 127.0.0.1:10001, suivi du nom de compte de stockage émulé :When making a request against the emulated storage service, specify the emulator hostname and Queue service port as 127.0.0.1:10001, followed by the emulated storage account name:

MéthodeMethod URI de demandeRequest URI Version HTTPHTTP Version
PUT http://127.0.0.1:10001/devstoreaccount1/myqueue?comp=metadata HTTP/1.1HTTP/1.1

Paramètres URIURI Parameters

Les paramètres supplémentaires suivants peuvent être spécifiés dans l'URI de la demande.The following additional parameters may be specified on the request URI.

ParamètreParameter DescriptionDescription
timeout facultatif.Optional. Le paramètre timeout est exprimé en secondes.The timeout parameter is expressed in seconds. Pour plus d’informations, consultez définition de délais d’attente pour les opérations de service de file d’attente.For more information, see Setting Timeouts for Queue Service Operations.

En-têtes de requêteRequest Headers

Le tableau suivant décrit les en-têtes de demande obligatoires ou facultatifs.The following table describes required and optional request headers.

En-tête de la demandeRequest Header DescriptionDescription
Authorization Obligatoire.Required. Spécifie le schéma d’autorisation, le nom de compte et la signature.Specifies the authorization scheme, account name, and signature. Pour plus d’informations, consultez autoriser les demandes dans le stockage Azure.For more information, see Authorize requests to Azure Storage.
Date ou x-ms-dateDate or x-ms-date Obligatoire.Required. Spécifie la date/heure en temps universel coordonné (UTC) pour la requête.Specifies the Coordinated Universal Time (UTC) for the request. Pour plus d’informations, consultez autoriser les demandes dans le stockage Azure.For more information, see Authorize requests to Azure Storage.
x-ms-version facultatif.Optional. Spécifie la version de l'opération à utiliser pour cette demande.Specifies the version of the operation to use for this request. Pour plus d’informations, consultez contrôle de version pour les services de stockage Azure.For more information, see Versioning for the Azure Storage Services.
x-ms-meta-name:string-value facultatif.Optional. Une paire nom-valeur à associer à la file d'attente en tant que métadonnées.A name-value pair to associate with the queue as metadata.

Chaque appel de cette opération remplace toutes les métadonnées existantes attachées à la file d'attente.Each call to this operation replaces all existing metadata attached to the queue. Pour supprimer toutes les métadonnées de la file d'attente, appelez cette opération sans en-têtes de métadonnées.To remove all metadata from the queue, call this operation with no metadata headers.

Notez que depuis la version 2009-09-19, les noms de métadonnées doivent respecter les règles d’affectation de noms pour les identificateurs C#.Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers.
x-ms-client-request-id facultatif.Optional. Fournit une valeur opaque générée par le client avec une limite de 1 Kio de caractères qui est enregistrée dans les journaux d’analyse lorsque la journalisation de l’analyse de stockage est activée.Provides a client-generated, opaque value with a 1 KiB character limit that is recorded in the analytics logs when storage analytics logging is enabled. L’utilisation de cet en-tête est fortement recommandée pour la mise en corrélation des activités côté client avec les requêtes reçues par le serveur.Using this header is highly recommended for correlating client-side activities with requests received by the server. Pour plus d’informations, consultez à propos de la journalisation des Storage Analytics et de la journalisation Azure : utilisation des journaux pour suivre les demandes de stockage.For more information, see About Storage Analytics Logging and Azure Logging: Using Logs to Track Storage Requests.

Corps de la demandeRequest Body

Aucun.None.

Exemple de demandeSample Request

Request Syntax:  
PUT https://myaccount.queue.core.windows.net/myqueue?comp=metadata HTTP/1.1  
  
Request Headers:  
x-ms-version: 2011-08-18  
x-ms-date: Fri, 16 Sep 2011 01:47:14 GMT  
x-ms-meta-meta-sample1: sample1  
x-ms-meta-meta-sample2: sample2  
Authorization: SharedKey myaccount:u6PSIebDltGW5xHpO77epRpiUhcsTkWMvcM4GTmfqqA=  

responseResponse

La réponse inclut un code d'état HTTP et un ensemble d'en-têtes de réponse.The response includes an HTTP status code and a set of response headers.

Code d’étatStatus Code

Une opération réussie renvoie le code d'état 204 (Aucun contenu).A successful operation returns status code 204 (No Content).

Pour plus d’informations sur les codes d’État, consultez codes d’État et d’erreur.For information about status codes, see Status and Error Codes.

En-têtes de réponseResponse Headers

La réponse de l'opération inclut les en-têtes suivants.The response for this operation includes the following headers. La réponse peut aussi inclure des en-têtes HTTP standard supplémentaires.The response may also include additional standard HTTP headers. Tous les en-têtes standard sont conformes à la spécification du protocole HTTP/1.1.All standard headers conform to the HTTP/1.1 protocol specification.

En-tête de réponseResponse header DescriptionDescription
x-ms-request-id Cet en-tête identifie de façon unique la demande qui a été effectuée et peut être utilisé pour résoudre les problèmes de la demande.This header uniquely identifies the request that was made and can be used for troubleshooting the request. Pour plus d’informations, consultez Troubleshooting API Operations.For more information, see Troubleshooting API Operations.
x-ms-version Indique la version du service de File d'attente utilisé pour exécuter la demande.Indicates the version of the Queue service used to execute the request. Cet en-tête est renvoyé pour les demandes effectuées avec la version 2009-09-19 ou une version ultérieure.This header is returned for requests made against version 2009-09-19 and later.
Date Une valeur de date/heure UTC générée par le service qui indique le moment auquel la réponse a été initiée.A UTC date/time value generated by the service that indicates the time at which the response was initiated.
x-ms-client-request-id Cet en-tête peut être utilisé pour dépanner les demandes et les réponses correspondantes.This header can be used to troubleshoot requests and corresponding responses. La valeur de cet en-tête est égale à la valeur de l' x-ms-client-request-id en-tête si elle est présente dans la demande et que la valeur est supérieure à 1024 caractères ASCII visibles.The value of this header is equal to the value of the x-ms-client-request-id header if it is present in the request and the value is at most 1024 visible ASCII characters. Si l' x-ms-client-request-id en-tête n’est pas présent dans la demande, cet en-tête ne sera pas présent dans la réponse.If the x-ms-client-request-id header is not present in the request, this header will not be present in the response.

Corps de la réponseResponse Body

Aucun.None.

AutorisationAuthorization

Seul le propriétaire du compte peut appeler cette opération.Only the account owner may call this operation.

RemarquesRemarks

Pour supprimer des métadonnées de file d'attente, appelez Set Queue Metadata sans spécifier d'en-tête de métadonnées.To delete queue metadata, call Set Queue Metadata without specifying any metadata headers.

Voir aussiSee Also

Codes d’erreur du service de file d’attente Queue Service Error Codes
Autoriser les demandes au stockage Azure Authorize requests to Azure Storage
Codes d’État et d’erreurStatus and Error Codes