Créer une file d’attente
Important
Cette API est obsolète et mise hors service à compter du 1/11/2021 et ne doit plus être utilisée.
Crée une file d'attente. Une fois créé, le manifeste de ressource de file d'attente est immuable. Cette opération est idempotente. La répétition de l'appel de création, après la création d'une file d'attente portant le même nom, renvoie un message d'erreur « Conflit 409 ».
Requête
| Méthode | URI de demande | Version HTTP |
|---|---|---|
| PUT | https://management.core.windows.net/{subscription ID}/services/ServiceBus/Namespaces/{Espace de noms}/Files d’attente/{Chemin de file d’attente} | HTTP/1.1 |
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 |
|---|---|
| Content-Type | application/xml;type=entry;charset=utf-8 |
| x-ms-version | 2012-03-01 |
La demande nécessite également un certificat client. Ce certificat doit correspondre à celui que vous avez téléchargé pour cet abonnement.
Corps de la demande
Le tableau suivant décrit les éléments clés du corps de la requête :
| Nom de la propriété | Type | Obligatoire | Description |
|---|---|---|---|
| MaxQueueSizeInMegaBytes | Entier non signé | Obligatoire | Ce paramètre spécifie la taille maximale de la file d'attente en mégaoctets. Toute tentative de mise en file d’attente d’un message qui entraîne le dépassement de cette valeur par la file d’attente échoue. Seul le contenu de l'utilisateur est comptabilisé dans cette valeur. Peut être défini au moment de la création et de l'exécution de la file d'attente : - Plage : 1 à 5*1024. - Valeur par défaut : 1*1024. |
| QueueSizeinBytes | Entier non signé | Lecture seule. Non requis lors de la création. | Ce paramètre représente les octets réels que les messages de la file d'attente occupent actuellement par rapport au quota de la file d'attente. Plage : 0 –MaxTopicSizeinMegaBytes |
| QueueDepth | Entier non signé | Lecture seule. Non requis lors de la création. | Ce paramètre affiche le nombre de messages figurant actuellement dans la file d'attente. |
| DefaultMessageTimeToLive | Date/heure XML | Facultatif. La valeur par défaut est de 14 jours. | Selon que la mise en attente de lettres mortes est activée ou non, si un message a été stocké dans la file d’attente pendant plus de temps que la durée spécifiée, il est automatiquement déplacé vers la file d’attente de lettres mortes ou supprimé. Cette valeur est remplacée par une durée de vie spécifiée sur le message si la durée de vie du message est inférieure à la durée de vie définie sur la file d'attente. Cette valeur est immuable après la création de la file dattente : - Plage : 1 seconde – 14 jours. - Valeur par défaut : 14 jours. |
| LockDuration | Date/heure XML | Facultatif. La valeur par défaut est de 30 secondes. | Ce paramètre détermine la durée en secondes durant laquelle un message doit être verrouillé à des fins de traitement par un récepteur. Après cette période, le message est déverrouillé et disponible à la consommation pour le récepteur suivant. Valeur pouvant être définie uniquement au moment de la création de la file d'attente : - Plage : de 0 à 5 min. 0 signifie que le message n’est pas verrouillé. - Valeur par défaut : 30 secondes. |
| RequiresSession | Boolean | Facultatif | Valeur pouvant être définie uniquement au moment de la création de la file d'attente. Si la truevaleur est définie sur , la file d’attente prend en charge la session et seul est SessionReceiver pris en charge. Les files d’attente prenant en charge les sessions ne sont pas prises en charge via REST.- Valeur par défaut : False. |
| RequiresDuplicateDetection | Boolean | Facultatif | Valeur pouvant être définie uniquement au moment de la création de la file d'attente. - Valeur par défaut pour la file d’attente durable : false. |
| EnableDeadLetteringOnMessageExpiration | Boolean | Facultatif | Valeur pouvant être définie uniquement au moment de la création de la file d'attente. - Valeur par défaut : false. Ce champ détermine comment Service Bus gère un message dont la durée de vie a expiré. Si la valeur est true et qu’un message expire, Service Bus déplace le message de la file d’attente vers la sous-file d’attente de lettres mortes de la file d’attente. Si elle est false, le message est définitivement supprimé de la file d’attente. |
| DuplicateDetectionHistoryTimeWindow | Time Span | facultatif. | Propriété qui spécifie l’intervalle de temps pendant lequel Service Bus détecte la duplication des messages. - Plage : 1 seconde à 7 jours. - Valeur par défaut : 10 minutes. |
| État | Chaîne | Lecture seule. Non requis lors de la création. | Peut avoir l’une des valeurs suivantes :
|
response
La réponse inclut un code d'état HTTP et un ensemble d'en-têtes de réponse.
Codes de réponse
Notes
Si vous créez une file d'attente portant un nom contenant des caractères particuliers ou codés (par exemple, "test?Name=value&", qui est codée en "test%3FName%3Dvalue%26"), une exception « Demande non valide (400) » est générée.
| Code | Description |
|---|---|
| 201 | File d'attente créée. |
| 400 | Corps de la demande non valide. |
| 401 | Échec de l'autorisation. |
| 403 | Quota dépassé, file d'attente non créée. |
| 409 | La file d'attente spécifiée existe déjà (ou le chemin spécifié est déjà occupé). |
| 500 | Erreur interne. |
Pour plus d’informations sur les codes status, consultez Codes d’état et d’erreur.
En-têtes de réponse
Aucun.
Corps de la réponse
La description de la file d'attente est renvoyée. S'il manquait des propriétés de description dans la demande PUT, certaines propriétés peuvent contenir des valeurs par défaut.