Espaces de noms/files d’attente Microsoft.ServiceBus
Définition de ressource Bicep
Le type de ressource espaces de noms/files d’attente peut être déployé sur :
- Groupes de ressources - Voir commandes de déploiement de groupe de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.ServiceBus/namespaces/queues, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ServiceBus/namespaces/queues@2022-01-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
autoDeleteOnIdle: 'string'
deadLetteringOnMessageExpiration: bool
defaultMessageTimeToLive: 'string'
duplicateDetectionHistoryTimeWindow: 'string'
enableBatchedOperations: bool
enableExpress: bool
enablePartitioning: bool
forwardDeadLetteredMessagesTo: 'string'
forwardTo: 'string'
lockDuration: 'string'
maxDeliveryCount: int
maxMessageSizeInKilobytes: int
maxSizeInMegabytes: int
requiresDuplicateDetection: bool
requiresSession: bool
status: 'string'
}
}
Valeurs de propriétés
namespaces/queues
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep. |
string (obligatoire) Limite de caractères : 1-260 Caractères valides : Caractères alphanumériques, points, traits d’union, traits de soulignement et barres obliques. Doit commencer et se terminer par un caractère alphanumérique. |
| parent | Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente. |
Nom symbolique pour la ressource de type : espaces de noms |
| properties | Propriétés de la file d’attente | SBQueueProperties |
SBQueueProperties
| Nom | Description | Valeur |
|---|---|---|
| autoDeleteOnIdle | Intervalle d’inactivité timeSpan ISO 8061 après lequel la file d’attente est automatiquement supprimée. La durée minimale est de 5 minutes. | string |
| deadLetteringOnMessageExpiration | Valeur qui indique si cette file d’attente prend en charge les lettres mortes lorsqu’un message expire. | bool |
| defaultMessageTimeToLive | Intervalle de temps de message par défaut ISO 8601 pour la valeur dynamique. Il s’agit de la durée d’expiration du message, à partir du moment où le message est envoyé à Service Bus. Il s’agit de la valeur par défaut utilisée lorsque TimeToLive n’est pas défini sur un message lui-même. | string |
| duplicateDetectionHistoryTimeWindow | Structure timeSpan ISO 8601 qui définit la durée de l’historique de détection des doublons. La valeur par défaut est 10 minutes. | string |
| enableBatchedOperations | Valeur qui indique si les opérations par lots côté serveur sont activées. | bool |
| enableExpress | Valeur qui indique si les entités Express sont activées. Une file d’attente express conserve temporairement un message en mémoire avant de l’écrire dans un stockage persistant. | bool |
| enablePartitioning | Valeur qui indique si la file d’attente doit être partitionnée entre plusieurs répartiteurs de messages. | bool |
| forwardDeadLetteredMessagesTo | Nom de la file d’attente/de la rubrique pour transférer le message lettre morte | string |
| forwardTo | Nom de la file d’attente/de la rubrique pour transférer les messages | string |
| lockDuration | Durée de la période ISO 8601 d’un peek-lock ; autrement dit, la durée pendant laquelle le message est verrouillé pour d’autres récepteurs. La valeur maximale de LockDuration est de 5 minutes ; la valeur par défaut est 1 minute. | string |
| maxDeliveryCount | Nombre maximal de livraisons. Un message devient une lettre morte après ce nombre de remises. la valeur par défaut est 10. | int |
| maxMessageSizeInKilobytes | Taille maximale (en Ko) de la charge utile de message qui peut être acceptée par la file d’attente. Cette propriété est utilisée uniquement dans Premium aujourd’hui et la valeur par défaut est 1024. | int |
| maxSizeInMegabytes | Taille maximale de la file d’attente en mégaoctets, qui correspond à la taille de la mémoire allouée à la file d’attente. La valeur par défaut est 1024. | int |
| requiresDuplicateDetection | Valeur indiquant si cette file d’attente nécessite une détection des doublons. | bool |
| requiresSession | Valeur qui indique si la file d’attente prend en charge le concept de sessions. | bool |
| status | Énumère les valeurs possibles pour l’état d’une entité de messagerie. | 'Active' 'Création' 'Suppression' 'Désactivé' 'ReceiveDisabled' 'Renommage' 'Restauration' 'SendDisabled' 'Inconnu' |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
Créer Azure Event Grid abonnement à une rubrique personnalisée et à une file d’attente |
Crée un Azure Event Grid rubrique personnalisée et un abonnement à la file d’attente Service Bus. Modèle créé à l’origine par Markus Meyer. |
| Créer un espace de noms Service Bus et une règle d’autorisation de file d’attente |
Ce modèle vous permet de déployer un espace de noms Service Bus Standard et des règles d’autorisation pour l’espace de noms et une file d’attente. |
| Créer un espace de noms et une file d’attente Service Bus |
Ce modèle vous permet de déployer un espace de noms Service Bus Standard et une file d’attente. |
Définition de ressources de modèle ARM
Le type de ressource espaces de noms/files d’attente peut être déployé sur :
- Groupes de ressources - Voir commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.ServiceBus/namespaces/queues, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.ServiceBus/namespaces/queues",
"apiVersion": "2022-01-01-preview",
"name": "string",
"properties": {
"autoDeleteOnIdle": "string",
"deadLetteringOnMessageExpiration": "bool",
"defaultMessageTimeToLive": "string",
"duplicateDetectionHistoryTimeWindow": "string",
"enableBatchedOperations": "bool",
"enableExpress": "bool",
"enablePartitioning": "bool",
"forwardDeadLetteredMessagesTo": "string",
"forwardTo": "string",
"lockDuration": "string",
"maxDeliveryCount": "int",
"maxMessageSizeInKilobytes": "int",
"maxSizeInMegabytes": "int",
"requiresDuplicateDetection": "bool",
"requiresSession": "bool",
"status": "string"
}
}
Valeurs de propriétés
namespaces/queues
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.ServiceBus/namespaces/queues » |
| apiVersion | Version de l’API de ressource | « 2022-01-01-preview » |
| name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON. |
chaîne (obligatoire) Limite de caractères : 1-260 Caractères valides : Caractères alphanumériques, points, traits d’union, traits de soulignement et barres obliques. Doit commencer et se terminer par un caractère alphanumérique. |
| properties | Propriétés de la file d’attente | SBQueueProperties |
SBQueueProperties
| Nom | Description | Valeur |
|---|---|---|
| autoDeleteOnIdle | Intervalle d’inactivité iso 8061 timeSpan après lequel la file d’attente est automatiquement supprimée. La durée minimale est de 5 minutes. | string |
| deadLetteringOnMessageExpiration | Valeur qui indique si cette file d’attente a la prise en charge des lettres mortes lorsqu’un message expire. | bool |
| defaultMessageTimeToLive | Intervalle de temps de message par défaut ISO 8601 pour la valeur dynamique. Il s’agit de la durée après laquelle le message expire, à partir du moment où le message est envoyé à Service Bus. Il s’agit de la valeur par défaut utilisée lorsque TimeToLive n’est pas défini sur un message lui-même. | string |
| duplicateDetectionHistoryTimeWindow | Structure timeSpan ISO 8601 qui définit la durée de l’historique de détection en double. La valeur par défaut est 10 minutes. | string |
| enableBatchedOperations | Valeur qui indique si les opérations par lots côté serveur sont activées. | bool |
| enableExpress | Valeur qui indique si les entités Express sont activées. Une file d’attente express conserve temporairement un message en mémoire avant de l’écrire dans un stockage persistant. | bool |
| enablePartitioning | Valeur qui indique si la file d’attente doit être partitionnée entre plusieurs répartiteurs de messages. | bool |
| forwardDeadLetteredMessagesTo | Nom de la file d’attente/de la rubrique pour transférer le message lettre morte | string |
| forwardTo | Nom de la file d’attente/de la rubrique pour transférer les messages | string |
| lockDuration | Durée de la période ISO 8601 d’un peek-lock; c’est-à-dire la durée pendant laquelle le message est verrouillé pour d’autres récepteurs. La valeur maximale de LockDuration est de 5 minutes ; la valeur par défaut est 1 minute. | string |
| maxDeliveryCount | Nombre maximal de remises. Un message devient une lettre morte après ce nombre de remises. la valeur par défaut est 10. | int |
| maxMessageSizeInKilobytes | Taille maximale (en Ko) de la charge utile du message qui peut être acceptée par la file d’attente. Cette propriété est utilisée uniquement dans Premium aujourd’hui et la valeur par défaut est 1024. | int |
| maxSizeInMegabytes | Taille maximale de la file d’attente en mégaoctets, qui correspond à la taille de la mémoire allouée à la file d’attente. La valeur par défaut est 1024. | int |
| requiresDuplicateDetection | Valeur indiquant si cette file d’attente nécessite une détection des doublons. | bool |
| requiresSession | Valeur qui indique si la file d’attente prend en charge le concept de sessions. | bool |
| status | Énumère les valeurs possibles pour l’état d’une entité de messagerie. | 'Active' 'Création' 'Suppression' 'Désactivé' 'ReceiveDisabled' 'Renommage' 'Restauration' 'SendDisabled' 'Unknown' |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
| Créer Azure Event Grid abonnement de rubrique et de file d’attente personnalisé |
Crée un Azure Event Grid rubrique personnalisée et un abonnement de file d’attente Service Bus. Modèle créé à l’origine par Markus Meyer. |
| Créer un espace de noms Service Bus et une règle d’autorisation de file d’attente |
Ce modèle vous permet de déployer un espace de noms Service Bus Standard et des règles d’autorisation pour l’espace de noms et une file d’attente. |
| Créer un espace de noms et une file d’attente Service Bus |
Ce modèle vous permet de déployer un espace de noms Service Bus Standard et une file d’attente. |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource espaces de noms/files d’attente peut être déployé sur :
- Groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.ServiceBus/namespaces/queues, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ServiceBus/namespaces/queues@2022-01-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
autoDeleteOnIdle = "string"
deadLetteringOnMessageExpiration = bool
defaultMessageTimeToLive = "string"
duplicateDetectionHistoryTimeWindow = "string"
enableBatchedOperations = bool
enableExpress = bool
enablePartitioning = bool
forwardDeadLetteredMessagesTo = "string"
forwardTo = "string"
lockDuration = "string"
maxDeliveryCount = int
maxMessageSizeInKilobytes = int
maxSizeInMegabytes = int
requiresDuplicateDetection = bool
requiresSession = bool
status = "string"
}
})
}
Valeurs de propriétés
namespaces/queues
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.ServiceBus/namespaces/queues@2022-01-01-preview » |
| name | Nom de la ressource | string (obligatoire) Limite de caractères : 1-260 Caractères valides : Caractères alphanumériques, points, traits d’union, traits de soulignement et barres obliques. Doit commencer et se terminer par un caractère alphanumérique. |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID pour la ressource de type : espaces de noms |
| properties | Propriétés de la file d’attente | SBQueueProperties |
SBQueueProperties
| Nom | Description | Valeur |
|---|---|---|
| autoDeleteOnIdle | Intervalle d’inactivité timeSpan ISO 8061 après lequel la file d’attente est automatiquement supprimée. La durée minimale est de 5 minutes. | string |
| deadLetteringOnMessageExpiration | Valeur qui indique si cette file d’attente prend en charge les lettres mortes lorsqu’un message expire. | bool |
| defaultMessageTimeToLive | Intervalle de temps de message par défaut ISO 8601 pour la valeur dynamique. Il s’agit de la durée d’expiration du message, à partir du moment où le message est envoyé à Service Bus. Il s’agit de la valeur par défaut utilisée lorsque TimeToLive n’est pas défini sur un message lui-même. | string |
| duplicateDetectionHistoryTimeWindow | Structure timeSpan ISO 8601 qui définit la durée de l’historique de détection des doublons. La valeur par défaut est 10 minutes. | string |
| enableBatchedOperations | Valeur qui indique si les opérations par lots côté serveur sont activées. | bool |
| enableExpress | Valeur qui indique si les entités Express sont activées. Une file d’attente express conserve temporairement un message en mémoire avant de l’écrire dans un stockage persistant. | bool |
| enablePartitioning | Valeur qui indique si la file d’attente doit être partitionnée entre plusieurs répartiteurs de messages. | bool |
| forwardDeadLetteredMessagesTo | Nom de la file d’attente/de la rubrique pour transférer le message lettre morte | string |
| forwardTo | Nom de la file d’attente/de la rubrique pour transférer les messages | string |
| lockDuration | Durée de la période ISO 8601 d’un peek-lock ; autrement dit, la durée pendant laquelle le message est verrouillé pour d’autres récepteurs. La valeur maximale de LockDuration est de 5 minutes ; la valeur par défaut est 1 minute. | string |
| maxDeliveryCount | Nombre maximal de livraisons. Un message devient une lettre morte après ce nombre de remises. la valeur par défaut est 10. | int |
| maxMessageSizeInKilobytes | Taille maximale (en Ko) de la charge utile de message qui peut être acceptée par la file d’attente. Cette propriété est utilisée uniquement dans Premium aujourd’hui et la valeur par défaut est 1024. | int |
| maxSizeInMegabytes | Taille maximale de la file d’attente en mégaoctets, qui correspond à la taille de la mémoire allouée à la file d’attente. La valeur par défaut est 1024. | int |
| requiresDuplicateDetection | Valeur indiquant si cette file d’attente nécessite une détection des doublons. | bool |
| requiresSession | Valeur qui indique si la file d’attente prend en charge le concept de sessions. | bool |
| status | Énumère les valeurs possibles pour l’état d’une entité de messagerie. | « Actif » « Création » « Suppression » « Désactivé » « ReceiveDisabled » « Renommage » « Restauration » « SendDisabled » « Inconnu » |