Partager via


Espaces de noms Microsoft.ServiceBus 2024-01-01

Définition de ressource Bicep

Le type de ressource d’espaces de noms peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ServiceBus/namespaces, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ServiceBus/namespaces@2024-01-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    alternateName: 'string'
    disableLocalAuth: bool
    encryption: {
      keySource: 'Microsoft.KeyVault'
      keyVaultProperties: [
        {
          identity: {
            userAssignedIdentity: 'string'
          }
          keyName: 'string'
          keyVaultUri: 'string'
          keyVersion: 'string'
        }
      ]
      requireInfrastructureEncryption: bool
    }
    minimumTlsVersion: 'string'
    premiumMessagingPartitions: int
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {
            id: 'string'
          }
          privateLinkServiceConnectionState: {
            description: 'string'
            status: 'string'
          }
          provisioningState: 'string'
        }
      }
    ]
    publicNetworkAccess: 'string'
    zoneRedundant: bool
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

ConnectionState

Nom Description Valeur
description Description de l’état de connexion. corde
statut État de la connexion. 'Approuvé'
'Déconnecté'
'En attente'
'Rejeté'

Chiffrement

Nom Description Valeur
keySource Énumère la valeur possible de keySource pour le chiffrement 'Microsoft.KeyVault'
keyVaultProperties Propriétés de KeyVault KeyVaultProperties[]
requireInfrastructureEncryption Activer le chiffrement d’infrastructure (double chiffrement) Bool

Identité

Nom Description Valeur
type Type d’identité de service managé. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Propriétés des identités affectées par l’utilisateur IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Nom Description Valeur

KeyVaultProperties

Nom Description Valeur
identité UserAssignedIdentityProperties
keyName Nom de la clé à partir de KeyVault corde
keyVaultUri Uri de KeyVault corde
keyVersion Version de KeyVault corde

Microsoft.ServiceBus/namespaces

Nom Description Valeur
identité Propriétés de la description de l’identité BYOK Identity
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de l’espace de noms. SBNamespaceProperties
Sku Propriétés de la référence SKU SBSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

PrivateEndpoint

Nom Description Valeur
id Identificateur ARM pour point de terminaison privé. corde

PrivateEndpointConnection

Nom Description Valeur
Propriétés Propriétés de PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nom Description Valeur
privateEndpoint Ressource de point de terminaison privé pour cette connexion. PrivateEndpoint
privateLinkServiceConnectionState Détails sur l’état de la connexion. ConnectionState
provisioningState État d’approvisionnement de la connexion de point de terminaison privé. 'Annulé'
'Création'
'Suppression'
'Échec'
'Réussi'
'Mise à jour'

SBNamespaceProperties

Nom Description Valeur
alternateName Autre nom pour l’espace de noms corde
disableLocalAuth Cette propriété désactive l’authentification SAP pour l’espace de noms Service Bus. Bool
chiffrement Propriétés de la description du chiffrement BYOK chiffrement
minimumTlsVersion Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ». '1.0'
'1.1'
'1.2'
premiumMessagingPartitions Nombre de partitions d’un espace de noms Service Bus. Cette propriété s’applique uniquement aux espaces de noms de référence SKU Premium. La valeur par défaut est 1 et les valeurs possibles sont 1, 2 et 4 Int
privateEndpointConnections Liste des connexions de point de terminaison privé. PrivateEndpointConnection[]
publicNetworkAccess Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée. 'Désactivé'
'Activé'
'SecuredByPerimeter'
zoneRedundant L’activation de cette propriété crée un espace de noms Service Bus Premium dans les régions prises en charge par les zones de disponibilité. Bool

SBSku

Nom Description Valeur
capacité Unités de messagerie pour votre espace de noms Service Bus Premium. Les capacités valides sont {1, 2, 4, 8, 16} multiples de votre paramètre properties.premiumMessagingPartitions. Par exemple, si properties.premiumMessagingPartitions est de 1, les valeurs de capacité possibles sont 1, 2, 4, 8 et 16. Si properties.premiumMessagingPartitions est 4, les valeurs de capacité possibles sont 4, 8, 16, 32 et 64 Int
nom Nom de cette référence SKU. 'De base'
'Premium'
'Standard' (obligatoire)
niveau Niveau de facturation de cette référence SKU particulière. 'De base'
'Premium'
'Standard'

TrackedResourceTags

Nom Description Valeur

UserAssignedIdentity

Nom Description Valeur

UserAssignedIdentityProperties

Nom Description Valeur
userAssignedIdentity ID ARM de l’identité utilisateur sélectionnée pour le chiffrement corde

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep Description
Créer un espace de noms Service Bus et une file d’attente Ce modèle vous permet de déployer un espace de noms Service Bus Standard et une file d’attente.
créer une règle de réseau virtuel d’espace de noms Service Bus Ce modèle vous permet de déployer un espace de noms Service Bus Premium avec une règle de réseau virtuel
créer une rubrique personnalisée Azure Event Grid et un abonnement file d’attente Crée une rubrique personnalisée Azure Event Grid et un abonnement de file d’attente Service Bus. Modèle créé à l’origine par Markus Meyer.
crée une application de microservices Dapr à l’aide de Container Apps Créez une application de microservices Dapr à l’aide de Container Apps.
Crée une application Dapr pub-sub servicebus à l’aide de Container Apps Créez une application Dapr pub-sub servicebus à l’aide de Container Apps.

Définition de ressource de modèle ARM

Le type de ressource d’espaces de noms peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ServiceBus/namespaces, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.ServiceBus/namespaces",
  "apiVersion": "2024-01-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "alternateName": "string",
    "disableLocalAuth": "bool",
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": [
        {
          "identity": {
            "userAssignedIdentity": "string"
          },
          "keyName": "string",
          "keyVaultUri": "string",
          "keyVersion": "string"
        }
      ],
      "requireInfrastructureEncryption": "bool"
    },
    "minimumTlsVersion": "string",
    "premiumMessagingPartitions": "int",
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "publicNetworkAccess": "string",
    "zoneRedundant": "bool"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

ConnectionState

Nom Description Valeur
description Description de l’état de connexion. corde
statut État de la connexion. 'Approuvé'
'Déconnecté'
'En attente'
'Rejeté'

Chiffrement

Nom Description Valeur
keySource Énumère la valeur possible de keySource pour le chiffrement 'Microsoft.KeyVault'
keyVaultProperties Propriétés de KeyVault KeyVaultProperties[]
requireInfrastructureEncryption Activer le chiffrement d’infrastructure (double chiffrement) Bool

Identité

Nom Description Valeur
type Type d’identité de service managé. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Propriétés des identités affectées par l’utilisateur IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Nom Description Valeur

KeyVaultProperties

Nom Description Valeur
identité UserAssignedIdentityProperties
keyName Nom de la clé à partir de KeyVault corde
keyVaultUri Uri de KeyVault corde
keyVersion Version de KeyVault corde

Microsoft.ServiceBus/namespaces

Nom Description Valeur
apiVersion Version de l’API '2024-01-01'
identité Propriétés de la description de l’identité BYOK Identity
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de l’espace de noms. SBNamespaceProperties
Sku Propriétés de la référence SKU SBSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.ServiceBus/namespaces'

PrivateEndpoint

Nom Description Valeur
id Identificateur ARM pour point de terminaison privé. corde

PrivateEndpointConnection

Nom Description Valeur
Propriétés Propriétés de PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nom Description Valeur
privateEndpoint Ressource de point de terminaison privé pour cette connexion. PrivateEndpoint
privateLinkServiceConnectionState Détails sur l’état de la connexion. ConnectionState
provisioningState État d’approvisionnement de la connexion de point de terminaison privé. 'Annulé'
'Création'
'Suppression'
'Échec'
'Réussi'
'Mise à jour'

SBNamespaceProperties

Nom Description Valeur
alternateName Autre nom pour l’espace de noms corde
disableLocalAuth Cette propriété désactive l’authentification SAP pour l’espace de noms Service Bus. Bool
chiffrement Propriétés de la description du chiffrement BYOK chiffrement
minimumTlsVersion Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ». '1.0'
'1.1'
'1.2'
premiumMessagingPartitions Nombre de partitions d’un espace de noms Service Bus. Cette propriété s’applique uniquement aux espaces de noms de référence SKU Premium. La valeur par défaut est 1 et les valeurs possibles sont 1, 2 et 4 Int
privateEndpointConnections Liste des connexions de point de terminaison privé. PrivateEndpointConnection[]
publicNetworkAccess Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée. 'Désactivé'
'Activé'
'SecuredByPerimeter'
zoneRedundant L’activation de cette propriété crée un espace de noms Service Bus Premium dans les régions prises en charge par les zones de disponibilité. Bool

SBSku

Nom Description Valeur
capacité Unités de messagerie pour votre espace de noms Service Bus Premium. Les capacités valides sont {1, 2, 4, 8, 16} multiples de votre paramètre properties.premiumMessagingPartitions. Par exemple, si properties.premiumMessagingPartitions est de 1, les valeurs de capacité possibles sont 1, 2, 4, 8 et 16. Si properties.premiumMessagingPartitions est 4, les valeurs de capacité possibles sont 4, 8, 16, 32 et 64 Int
nom Nom de cette référence SKU. 'De base'
'Premium'
'Standard' (obligatoire)
niveau Niveau de facturation de cette référence SKU particulière. 'De base'
'Premium'
'Standard'

TrackedResourceTags

Nom Description Valeur

UserAssignedIdentity

Nom Description Valeur

UserAssignedIdentityProperties

Nom Description Valeur
userAssignedIdentity ID ARM de l’identité utilisateur sélectionnée pour le chiffrement corde

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
se connecter à un espace de noms Service Bus via un point de terminaison privé

Déployer sur Azure
Cet exemple montre comment utiliser la configuration d’un réseau virtuel et d’une zone DNS privée pour accéder à un espace de noms Service Bus via un point de terminaison privé.
corrélation des messages sur Logic Apps à l’aide de Service Bus

Déployer sur Azure
qui montre comment mettre en corrélation des messages sur Logic Apps à l’aide d’Azure Service Bus
Créer un de géorécupération Service Bus

Déployer sur Azure
Ce modèle vous permet de configurer l’alias de géo-reprise d’activité Service Bus sur les espaces de noms de référence SKU Premium.
Créer un espace de noms Service Bus

Déployer sur Azure
Ce modèle vous permet de déployer un espace de noms Service Bus avec une référence SKU De base/Standard.
Créer un espace de noms Service Bus et une file d’attente

Déployer sur Azure
Ce modèle vous permet de déployer un espace de noms Service Bus Standard et une file d’attente.
Créer un espace de noms Service Bus et une règle d’autorisation de file d’attente

Déployer sur Azure
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 rubrique Service Bus

Déployer sur Azure
Ce modèle crée un espace de noms et une rubrique Service Bus.
Créer une règle de filtre IP d’espace de noms Service Bus

Déployer sur Azure
Ce modèle vous permet de déployer un espace de noms Service Bus Premium avec une règle de filtre IP
créer une règle de réseau virtuel d’espace de noms Service Bus

Déployer sur Azure
Ce modèle vous permet de déployer un espace de noms Service Bus Premium avec une règle de réseau virtuel
créer un espace de noms, une rubrique et un abonnement Service Bus

Déployer sur Azure
Ce modèle vous permet de déployer un espace de noms Service Bus Standard, une rubrique et un abonnement.
Créer un espace de noms, une rubrique, un abonnement et une règle Service Bus

Déployer sur Azure
Ce modèle vous permet de déployer un espace de noms Service Bus Standard, une rubrique, un abonnement et une règle.
créer un espace de noms Service Bus Premium et un AuthorizationRule

Déployer sur Azure
Ce modèle crée un espace de noms Service Bus Premium et un espace de noms AuthorizationRule
créer une rubrique Service Bus avec un abonnement et un de filtre SQL

Déployer sur Azure
Ce modèle crée un espace de noms et une rubrique Service Bus avec un abonnement à l’aide d’une expression de filtre SQL pour recevoir uniquement les messages qui correspondent à l’expression de filtre SQL définie.
créer une rubrique personnalisée Azure Event Grid et un abonnement file d’attente

Déployer sur Azure
Crée une rubrique personnalisée Azure Event Grid et un abonnement de file d’attente Service Bus. Modèle créé à l’origine par Markus Meyer.
créer un abonnement à une rubrique personnalisée Azure Event Grid

Déployer sur Azure
Crée une rubrique personnalisée Azure Event Grid et un abonnement à une rubrique Service Bus. Modèle créé à l’origine par Markus Meyer.
crée une application de microservices Dapr à l’aide de Container Apps

Déployer sur Azure
Créez une application de microservices Dapr à l’aide de Container Apps.
Crée une application Dapr pub-sub servicebus à l’aide de Container Apps

Déployer sur Azure
Créez une application Dapr pub-sub servicebus à l’aide de Container Apps.
EPiserverCMS dans Azure

Déployer sur Azure
Ce modèle vous permet de créer des ressources requises pour le déploiement EpiServerCMS dans Azure
modèles d’intégration - Routeur de messages - Service Bus

Déployer sur Azure
Solution qui montre comment configurer le modèle de routeur de messages à l’aide d’une rubrique Service Bus

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource d’espaces de noms peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ServiceBus/namespaces, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces@2024-01-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      alternateName = "string"
      disableLocalAuth = bool
      encryption = {
        keySource = "Microsoft.KeyVault"
        keyVaultProperties = [
          {
            identity = {
              userAssignedIdentity = "string"
            }
            keyName = "string"
            keyVaultUri = "string"
            keyVersion = "string"
          }
        ]
        requireInfrastructureEncryption = bool
      }
      minimumTlsVersion = "string"
      premiumMessagingPartitions = int
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
              id = "string"
            }
            privateLinkServiceConnectionState = {
              description = "string"
              status = "string"
            }
            provisioningState = "string"
          }
        }
      ]
      publicNetworkAccess = "string"
      zoneRedundant = bool
    }
  })
}

Valeurs de propriété

ConnectionState

Nom Description Valeur
description Description de l’état de connexion. corde
statut État de la connexion. 'Approuvé'
'Déconnecté'
'En attente'
'Rejeté'

Chiffrement

Nom Description Valeur
keySource Énumère la valeur possible de keySource pour le chiffrement 'Microsoft.KeyVault'
keyVaultProperties Propriétés de KeyVault KeyVaultProperties[]
requireInfrastructureEncryption Activer le chiffrement d’infrastructure (double chiffrement) Bool

Identité

Nom Description Valeur
type Type d’identité de service managé. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Propriétés des identités affectées par l’utilisateur IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Nom Description Valeur

KeyVaultProperties

Nom Description Valeur
identité UserAssignedIdentityProperties
keyName Nom de la clé à partir de KeyVault corde
keyVaultUri Uri de KeyVault corde
keyVersion Version de KeyVault corde

Microsoft.ServiceBus/namespaces

Nom Description Valeur
identité Propriétés de la description de l’identité BYOK Identity
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de l’espace de noms. SBNamespaceProperties
Sku Propriétés de la référence SKU SBSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.ServiceBus/namespaces@2024-01-01 »

PrivateEndpoint

Nom Description Valeur
id Identificateur ARM pour point de terminaison privé. corde

PrivateEndpointConnection

Nom Description Valeur
Propriétés Propriétés de PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nom Description Valeur
privateEndpoint Ressource de point de terminaison privé pour cette connexion. PrivateEndpoint
privateLinkServiceConnectionState Détails sur l’état de la connexion. ConnectionState
provisioningState État d’approvisionnement de la connexion de point de terminaison privé. 'Annulé'
'Création'
'Suppression'
'Échec'
'Réussi'
'Mise à jour'

SBNamespaceProperties

Nom Description Valeur
alternateName Autre nom pour l’espace de noms corde
disableLocalAuth Cette propriété désactive l’authentification SAP pour l’espace de noms Service Bus. Bool
chiffrement Propriétés de la description du chiffrement BYOK chiffrement
minimumTlsVersion Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ». '1.0'
'1.1'
'1.2'
premiumMessagingPartitions Nombre de partitions d’un espace de noms Service Bus. Cette propriété s’applique uniquement aux espaces de noms de référence SKU Premium. La valeur par défaut est 1 et les valeurs possibles sont 1, 2 et 4 Int
privateEndpointConnections Liste des connexions de point de terminaison privé. PrivateEndpointConnection[]
publicNetworkAccess Cela détermine si le trafic est autorisé sur le réseau public. Par défaut, elle est activée. 'Désactivé'
'Activé'
'SecuredByPerimeter'
zoneRedundant L’activation de cette propriété crée un espace de noms Service Bus Premium dans les régions prises en charge par les zones de disponibilité. Bool

SBSku

Nom Description Valeur
capacité Unités de messagerie pour votre espace de noms Service Bus Premium. Les capacités valides sont {1, 2, 4, 8, 16} multiples de votre paramètre properties.premiumMessagingPartitions. Par exemple, si properties.premiumMessagingPartitions est de 1, les valeurs de capacité possibles sont 1, 2, 4, 8 et 16. Si properties.premiumMessagingPartitions est 4, les valeurs de capacité possibles sont 4, 8, 16, 32 et 64 Int
nom Nom de cette référence SKU. 'De base'
'Premium'
'Standard' (obligatoire)
niveau Niveau de facturation de cette référence SKU particulière. 'De base'
'Premium'
'Standard'

TrackedResourceTags

Nom Description Valeur

UserAssignedIdentity

Nom Description Valeur

UserAssignedIdentityProperties

Nom Description Valeur
userAssignedIdentity ID ARM de l’identité utilisateur sélectionnée pour le chiffrement corde