Partager via

Microsoft.SignalRService webPubSub 2024-04-01-preview

  • Article

Définition de ressource Bicep

Le type de ressource webPubSub 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.SignalRService/webPubSub, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.SignalRService/webPubSub@2024-04-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    applicationFirewall: {
      clientConnectionCountRules: [
        {
          type: 'string'
          // For remaining properties, see ClientConnectionCountRule objects
        }
      ]
    }
    disableAadAuth: bool
    disableLocalAuth: bool
    liveTraceConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
      enabled: 'string'
    }
    networkACLs: {
      defaultAction: 'string'
      ipRules: [
        {
          action: 'string'
          value: 'string'
        }
      ]
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    regionEndpointEnabled: 'string'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
    }
    resourceStopped: 'string'
    socketIO: {
      serviceMode: 'string'
    }
    tls: {
      clientCertEnabled: bool
    }
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Objets ClientConnectionCountRule

Définissez le type propriété pour spécifier le type d’objet.

Pour ThrottleByJwtCustomClaimRule, utilisez :

{
  claimName: 'string'
  maxCount: int
  type: 'ThrottleByJwtCustomClaimRule'
}

Pour ThrottleByJwtSignatureRule, utilisez :

{
  maxCount: int
  type: 'ThrottleByJwtSignatureRule'
}

Pour throttleByUserIdRule, utilisez :

{
  maxCount: int
  type: 'ThrottleByUserIdRule'
}

Valeurs de propriété

ApplicationFirewallSettings

Nom Descriptif Valeur
clientConnectionCountRules Règles de contrôle du nombre de connexions clientes ClientConnectionCountRule[]

ClientConnectionCountRule

Nom Descriptif Valeur
type Défini sur « ThrottleByJwtCustomClaimRule » pour le type ThrottleByJwtCustomClaimRule. Défini sur « ThrottleByJwtSignatureRule » pour le type ThrottleByJwtSignatureRule. Défini sur « ThrottleByUserIdRule » pour le type ThrottleByUserIdRule. 'ThrottleByJwtCustomClaimRule'
'ThrottleByJwtSignatureRule'
'ThrottleByUserIdRule' (obligatoire)

IPRule

Nom Descriptif Valeur
action Action de liste de contrôle d’accès réseau Azure. 'Autoriser'
'Refuser'
valeur Adresse IP ou CIDR ou ServiceTag corde

LiveTraceCategory

Nom Descriptif Valeur
Activé Indique si la catégorie de trace dynamique est activée ou si elle est activée.
Valeurs disponibles : true, false.
Respect de la casse.		 corde
nom Obtient ou définit le nom de la catégorie de trace dynamique.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Respect de la casse.		 corde

LiveTraceConfiguration

Nom Descriptif Valeur
Catégories Obtient ou définit la liste des configurations de catégorie. liveTraceCategory[]
Activé Indique si vous activez ou non la trace dynamique.
Lorsqu’il est défini sur true, le client de trace dynamique peut se connecter au service.
Sinon, le client de suivi en direct ne peut pas se connecter au service, afin que vous ne puissiez pas recevoir de journal, quelle que soit la configuration dans « catégories ».
Valeurs disponibles : true, false.
Respect de la casse.		 corde

ManagedIdentity

Nom Descriptif Valeur
type Représente le type d’identité : systemAssigned, userAssigned, None 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Obtenir ou définir les identités affectées par l’utilisateur ManagedIdentityUserAssignedIdentities

ManagedIdentityUserAssignedIdentities

Nom Descriptif Valeur

Microsoft.SignalRService/webPubSub

Nom Descriptif Valeur
identité Une classe représente les identités managées utilisées pour la demande et la réponse managedIdentity
gentil Type de service 'SocketIO'
'WebPubSub'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 63
Modèle = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obligatoire)
Propriétés Classe qui décrit les propriétés de la ressource webPubSubProperties
Sku Informations de facturation de la ressource. ResourceSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

NetworkACL

Nom Descriptif Valeur
permettre Types de requêtes autorisés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nier Types de demandes refusés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'

PrivateEndpointACL

Nom Descriptif Valeur
permettre Types de requêtes autorisés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nier Types de demandes refusés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nom Nom de la connexion de point de terminaison privé chaîne (obligatoire)

ResourceLogCategory

Nom Descriptif Valeur
Activé Indique si la catégorie du journal des ressources est activée.
Valeurs disponibles : true, false.
Respect de la casse.		 corde
nom Obtient ou définit le nom de la catégorie de journal des ressources.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Respect de la casse.		 corde

ResourceLogConfiguration

Nom Descriptif Valeur
Catégories Obtient ou définit la liste des configurations de catégorie. ResourceLogCategory[]

ResourceSku

Nom Descriptif Valeur
capacité Facultatif, entier. Nombre d’unités de la ressource.
1 pour Free_F1/Standard_S1/Premium_P1, 100 pour Premium_P2 par défaut.

Si elles sont présentes, les valeurs suivantes sont autorisées :
Free_F1 : 1 ;
Standard_S1 : 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100 ;
Premium_P1 : 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100 ;
Premium_P2 : 100 200 300 400 500 600 700 800 900 1000 ;		 Int
nom Nom de la référence SKU. Obligatoire.

Valeurs autorisées : Standard_S1, Free_F1, Premium_P1, Premium_P2		 chaîne (obligatoire)
niveau Niveau facultatif de cette référence SKU particulière. 'Standard' ou 'Gratuit'.

Basic est déconseillé, utilisez Standard à la place.		 'De base'
'Free'
'Premium'
'Standard'

ThrottleByJwtCustomClaimRule

Nom Descriptif Valeur
claimName Nom de la revendication dans le jeton JWT. La connexion cliente avec la même valeur de revendication est agrégée. Si la revendication est introuvable dans le jeton, la connexion est autorisée. chaîne (obligatoire)
maxCount Nombre maximal de connexions autorisé pour la même valeur de revendication Jwt. Les clients ayant la même revendication Jwt sont rejetés si le nombre de connexions dépasse cette valeur. La valeur par défaut est 20. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 2147483647
type 'ThrottleByJwtCustomClaimRule' (obligatoire)

ThrottleByJwtSignatureRule

Nom Descriptif Valeur
maxCount Nombre maximal de connexions autorisés pour la même signature JWT. Les clients avec la même signature JWT sont rejetés si le nombre de connexions dépasse cette valeur. La valeur par défaut est 20. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 2147483647
type 'ThrottleByJwtSignatureRule' (obligatoire)

ThrottleByUserIdRule

Nom Descriptif Valeur
maxCount Nombre maximal de connexions autorisé pour le même ID d’utilisateur. Les clients ayant le même ID d’utilisateur sont rejetés si le nombre de connexions dépasse cette valeur. La valeur par défaut est 20. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 2147483647
type 'ThrottleByUserIdRule' (obligatoire)

TrackedResourceTags

Nom Descriptif Valeur

UserAssignedIdentityProperty

Nom Descriptif Valeur

WebPubSubNetworkACLs

Nom Descriptif Valeur
defaultAction Action de liste de contrôle d’accès réseau Azure. 'Autoriser'
'Refuser'
ipRules Règles IP pour le filtrage du trafic public IPRule []
privateEndpoints Listes de contrôle d’accès pour les demandes de points de terminaison privés privateEndpointACL[]
publicNetwork Liste de contrôle d’accès réseau networkACL

WebPubSubProperties

Nom Descriptif Valeur
applicationFirewall Paramètres de pare-feu d’application pour la ressource ApplicationFirewallSettings
disableAadAuth DisableLocalAuth
Activer ou désactiver l’authentification aad
Quand la valeur est true, la connexion avec AuthType=aad ne fonctionnera pas.		 Bool
disableLocalAuth DisableLocalAuth
Activer ou désactiver l’authentification locale avec AccessKey
Quand la valeur est true, la connexion avec AccessKey=xxx ne fonctionne pas.		 Bool
liveTraceConfiguration Configuration de trace dynamique d’une ressource Microsoft.SignalRService. liveTraceConfiguration
networkACLs Listes de contrôle d’accès réseau pour la ressource WebPubSubNetworkACLs
publicNetworkAccess Activez ou désactivez l’accès au réseau public. Valeur par défaut « Activé ».
Quand elle est activée, les listes de contrôle d’accès réseau s’appliquent toujours.
Lorsqu’il est désactivé, l’accès au réseau public est toujours désactivé, quel que soit le paramètre défini dans les listes de contrôle d’accès réseau.		 corde
regionEndpointEnabled Activez ou désactivez le point de terminaison régional. Valeur par défaut « Activé ».
Lorsqu’elle est désactivée, les nouvelles connexions ne sont pas routées vers ce point de terminaison, mais les connexions existantes ne sont pas affectées.
Cette propriété est spécifique au réplica. Désactiver le point de terminaison régional sans réplica n’est pas autorisé.		 corde
resourceLogConfiguration Configuration du journal des ressources d’une ressource Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Arrêtez ou démarrez la ressource. La valeur par défaut est « False ».
Lorsqu’il est vrai, le plan de données de la ressource est arrêté.
Lorsqu’elle est false, le plan de données de la ressource est démarré.		 corde
socketIO Paramètres SocketIO pour la ressource WebPubSubSocketIOSettings
tls Paramètres TLS de la ressource WebPubSubTlsSettings

WebPubSubSocketIOSettings

Nom Descriptif Valeur
serviceMode Mode de service de Web PubSub pour Socket.IO. Valeurs autorisées :
« Par défaut » : disposez de votre propre serveur principal Socket.IO
« Serverless » : votre application n’a pas de serveur principal		 corde

WebPubSubTlsSettings

Nom Descriptif Valeur
clientCertEnabled Demandez un certificat client lors de l’établissement d’une liaison TLS s’il est activé. Non pris en charge pour le niveau gratuit. Toute entrée est ignorée pour le niveau gratuit. Bool

Exemples d’utilisation

Modules vérifiés Azure

Les modules vérifiés Azure suivants peuvent être utilisés pour déployer ce type de ressource.

Module Descriptif
service Web PubSub SignalR Module de ressources AVM pour le service SignalR Web PubSub

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Fichier Bicep Descriptif
créer Azure Web PubSub à l’aide de Bicep Azure Web PubSub Service vous aide à créer des applications web de messagerie en temps réel à l’aide de WebSockets et du modèle publish-subscribe. Cela utilise le langage Bicep pour créer et configurer une ressource Web PubSub. Vous pouvez utiliser ce modèle pour déployer facilement Web PubSub pour un didacticiel ou un test, ou comme bloc de construction pour des déploiements plus complexes avec Web PubSub.

Définition de ressource de modèle ARM

Le type de ressource webPubSub 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.SignalRService/webPubSub, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.SignalRService/webPubSub",
  "apiVersion": "2024-04-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "applicationFirewall": {
      "clientConnectionCountRules": [ {
        "type": "string"
        // For remaining properties, see ClientConnectionCountRule objects
      } ]
    },
    "disableAadAuth": "bool",
    "disableLocalAuth": "bool",
    "liveTraceConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ],
      "enabled": "string"
    },
    "networkACLs": {
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "string",
          "value": "string"
        }
      ],
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "regionEndpointEnabled": "string",
    "resourceLogConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ]
    },
    "resourceStopped": "string",
    "socketIO": {
      "serviceMode": "string"
    },
    "tls": {
      "clientCertEnabled": "bool"
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Objets ClientConnectionCountRule

Définissez le type propriété pour spécifier le type d’objet.

Pour ThrottleByJwtCustomClaimRule, utilisez :

{
  "claimName": "string",
  "maxCount": "int",
  "type": "ThrottleByJwtCustomClaimRule"
}

Pour ThrottleByJwtSignatureRule, utilisez :

{
  "maxCount": "int",
  "type": "ThrottleByJwtSignatureRule"
}

Pour throttleByUserIdRule, utilisez :

{
  "maxCount": "int",
  "type": "ThrottleByUserIdRule"
}

Valeurs de propriété

ApplicationFirewallSettings

Nom Descriptif Valeur
clientConnectionCountRules Règles de contrôle du nombre de connexions clientes ClientConnectionCountRule[]

ClientConnectionCountRule

Nom Descriptif Valeur
type Défini sur « ThrottleByJwtCustomClaimRule » pour le type ThrottleByJwtCustomClaimRule. Défini sur « ThrottleByJwtSignatureRule » pour le type ThrottleByJwtSignatureRule. Défini sur « ThrottleByUserIdRule » pour le type ThrottleByUserIdRule. 'ThrottleByJwtCustomClaimRule'
'ThrottleByJwtSignatureRule'
'ThrottleByUserIdRule' (obligatoire)

IPRule

Nom Descriptif Valeur
action Action de liste de contrôle d’accès réseau Azure. 'Autoriser'
'Refuser'
valeur Adresse IP ou CIDR ou ServiceTag corde

LiveTraceCategory

Nom Descriptif Valeur
Activé Indique si la catégorie de trace dynamique est activée ou si elle est activée.
Valeurs disponibles : true, false.
Respect de la casse.		 corde
nom Obtient ou définit le nom de la catégorie de trace dynamique.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Respect de la casse.		 corde

LiveTraceConfiguration

Nom Descriptif Valeur
Catégories Obtient ou définit la liste des configurations de catégorie. liveTraceCategory[]
Activé Indique si vous activez ou non la trace dynamique.
Lorsqu’il est défini sur true, le client de trace dynamique peut se connecter au service.
Sinon, le client de suivi en direct ne peut pas se connecter au service, afin que vous ne puissiez pas recevoir de journal, quelle que soit la configuration dans « catégories ».
Valeurs disponibles : true, false.
Respect de la casse.		 corde

ManagedIdentity

Nom Descriptif Valeur
type Représente le type d’identité : systemAssigned, userAssigned, None 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Obtenir ou définir les identités affectées par l’utilisateur ManagedIdentityUserAssignedIdentities

ManagedIdentityUserAssignedIdentities

Nom Descriptif Valeur

Microsoft.SignalRService/webPubSub

Nom Descriptif Valeur
apiVersion Version de l’API '2024-04-01-preview'
identité Une classe représente les identités managées utilisées pour la demande et la réponse managedIdentity
gentil Type de service 'SocketIO'
'WebPubSub'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 63
Modèle = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obligatoire)
Propriétés Classe qui décrit les propriétés de la ressource webPubSubProperties
Sku Informations de facturation de la ressource. ResourceSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.SignalRService/webPubSub'

NetworkACL

Nom Descriptif Valeur
permettre Types de requêtes autorisés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nier Types de demandes refusés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'

PrivateEndpointACL

Nom Descriptif Valeur
permettre Types de requêtes autorisés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nier Types de demandes refusés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nom Nom de la connexion de point de terminaison privé chaîne (obligatoire)

ResourceLogCategory

Nom Descriptif Valeur
Activé Indique si la catégorie du journal des ressources est activée.
Valeurs disponibles : true, false.
Respect de la casse.		 corde
nom Obtient ou définit le nom de la catégorie de journal des ressources.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Respect de la casse.		 corde

ResourceLogConfiguration

Nom Descriptif Valeur
Catégories Obtient ou définit la liste des configurations de catégorie. ResourceLogCategory[]

ResourceSku

Nom Descriptif Valeur
capacité Facultatif, entier. Nombre d’unités de la ressource.
1 pour Free_F1/Standard_S1/Premium_P1, 100 pour Premium_P2 par défaut.

Si elles sont présentes, les valeurs suivantes sont autorisées :
Free_F1 : 1 ;
Standard_S1 : 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100 ;
Premium_P1 : 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100 ;
Premium_P2 : 100 200 300 400 500 600 700 800 900 1000 ;		 Int
nom Nom de la référence SKU. Obligatoire.

Valeurs autorisées : Standard_S1, Free_F1, Premium_P1, Premium_P2		 chaîne (obligatoire)
niveau Niveau facultatif de cette référence SKU particulière. 'Standard' ou 'Gratuit'.

Basic est déconseillé, utilisez Standard à la place.		 'De base'
'Free'
'Premium'
'Standard'

ThrottleByJwtCustomClaimRule

Nom Descriptif Valeur
claimName Nom de la revendication dans le jeton JWT. La connexion cliente avec la même valeur de revendication est agrégée. Si la revendication est introuvable dans le jeton, la connexion est autorisée. chaîne (obligatoire)
maxCount Nombre maximal de connexions autorisé pour la même valeur de revendication Jwt. Les clients ayant la même revendication Jwt sont rejetés si le nombre de connexions dépasse cette valeur. La valeur par défaut est 20. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 2147483647
type 'ThrottleByJwtCustomClaimRule' (obligatoire)

ThrottleByJwtSignatureRule

Nom Descriptif Valeur
maxCount Nombre maximal de connexions autorisés pour la même signature JWT. Les clients avec la même signature JWT sont rejetés si le nombre de connexions dépasse cette valeur. La valeur par défaut est 20. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 2147483647
type 'ThrottleByJwtSignatureRule' (obligatoire)

ThrottleByUserIdRule

Nom Descriptif Valeur
maxCount Nombre maximal de connexions autorisé pour le même ID d’utilisateur. Les clients ayant le même ID d’utilisateur sont rejetés si le nombre de connexions dépasse cette valeur. La valeur par défaut est 20. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 2147483647
type 'ThrottleByUserIdRule' (obligatoire)

TrackedResourceTags

Nom Descriptif Valeur

UserAssignedIdentityProperty

Nom Descriptif Valeur

WebPubSubNetworkACLs

Nom Descriptif Valeur
defaultAction Action de liste de contrôle d’accès réseau Azure. 'Autoriser'
'Refuser'
ipRules Règles IP pour le filtrage du trafic public IPRule []
privateEndpoints Listes de contrôle d’accès pour les demandes de points de terminaison privés privateEndpointACL[]
publicNetwork Liste de contrôle d’accès réseau networkACL

WebPubSubProperties

Nom Descriptif Valeur
applicationFirewall Paramètres de pare-feu d’application pour la ressource ApplicationFirewallSettings
disableAadAuth DisableLocalAuth
Activer ou désactiver l’authentification aad
Quand la valeur est true, la connexion avec AuthType=aad ne fonctionnera pas.		 Bool
disableLocalAuth DisableLocalAuth
Activer ou désactiver l’authentification locale avec AccessKey
Quand la valeur est true, la connexion avec AccessKey=xxx ne fonctionne pas.		 Bool
liveTraceConfiguration Configuration de trace dynamique d’une ressource Microsoft.SignalRService. liveTraceConfiguration
networkACLs Listes de contrôle d’accès réseau pour la ressource WebPubSubNetworkACLs
publicNetworkAccess Activez ou désactivez l’accès au réseau public. Valeur par défaut « Activé ».
Quand elle est activée, les listes de contrôle d’accès réseau s’appliquent toujours.
Lorsqu’il est désactivé, l’accès au réseau public est toujours désactivé, quel que soit le paramètre défini dans les listes de contrôle d’accès réseau.		 corde
regionEndpointEnabled Activez ou désactivez le point de terminaison régional. Valeur par défaut « Activé ».
Lorsqu’elle est désactivée, les nouvelles connexions ne sont pas routées vers ce point de terminaison, mais les connexions existantes ne sont pas affectées.
Cette propriété est spécifique au réplica. Désactiver le point de terminaison régional sans réplica n’est pas autorisé.		 corde
resourceLogConfiguration Configuration du journal des ressources d’une ressource Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Arrêtez ou démarrez la ressource. La valeur par défaut est « False ».
Lorsqu’il est vrai, le plan de données de la ressource est arrêté.
Lorsqu’elle est false, le plan de données de la ressource est démarré.		 corde
socketIO Paramètres SocketIO pour la ressource WebPubSubSocketIOSettings
tls Paramètres TLS de la ressource WebPubSubTlsSettings

WebPubSubSocketIOSettings

Nom Descriptif Valeur
serviceMode Mode de service de Web PubSub pour Socket.IO. Valeurs autorisées :
« Par défaut » : disposez de votre propre serveur principal Socket.IO
« Serverless » : votre application n’a pas de serveur principal		 corde

WebPubSubTlsSettings

Nom Descriptif Valeur
clientCertEnabled Demandez un certificat client lors de l’établissement d’une liaison TLS s’il est activé. Non pris en charge pour le niveau gratuit. Toute entrée est ignorée pour le niveau gratuit. Bool

Exemples d’utilisation

Modèles de démarrage rapide Azure

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

Modèle Descriptif
créer Azure Web PubSub à l’aide de Bicep

Déployer sur Azure 		Azure Web PubSub Service vous aide à créer des applications web de messagerie en temps réel à l’aide de WebSockets et du modèle publish-subscribe. Cela utilise le langage Bicep pour créer et configurer une ressource Web PubSub. Vous pouvez utiliser ce modèle pour déployer facilement Web PubSub pour un didacticiel ou un test, ou comme bloc de construction pour des déploiements plus complexes avec Web PubSub.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource webPubSub 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.SignalRService/webPubSub, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/webPubSub@2024-04-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      applicationFirewall = {
        clientConnectionCountRules = [
          {
            type = "string"
            // For remaining properties, see ClientConnectionCountRule objects
          }
        ]
      }
      disableAadAuth = bool
      disableLocalAuth = bool
      liveTraceConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
        enabled = "string"
      }
      networkACLs = {
        defaultAction = "string"
        ipRules = [
          {
            action = "string"
            value = "string"
          }
        ]
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      regionEndpointEnabled = "string"
      resourceLogConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
      }
      resourceStopped = "string"
      socketIO = {
        serviceMode = "string"
      }
      tls = {
        clientCertEnabled = bool
      }
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  }
}

Objets ClientConnectionCountRule

Définissez le type propriété pour spécifier le type d’objet.

Pour ThrottleByJwtCustomClaimRule, utilisez :

{
  claimName = "string"
  maxCount = int
  type = "ThrottleByJwtCustomClaimRule"
}

Pour ThrottleByJwtSignatureRule, utilisez :

{
  maxCount = int
  type = "ThrottleByJwtSignatureRule"
}

Pour throttleByUserIdRule, utilisez :

{
  maxCount = int
  type = "ThrottleByUserIdRule"
}

Valeurs de propriété

ApplicationFirewallSettings

Nom Descriptif Valeur
clientConnectionCountRules Règles de contrôle du nombre de connexions clientes ClientConnectionCountRule[]

ClientConnectionCountRule

Nom Descriptif Valeur
type Défini sur « ThrottleByJwtCustomClaimRule » pour le type ThrottleByJwtCustomClaimRule. Défini sur « ThrottleByJwtSignatureRule » pour le type ThrottleByJwtSignatureRule. Défini sur « ThrottleByUserIdRule » pour le type ThrottleByUserIdRule. 'ThrottleByJwtCustomClaimRule'
'ThrottleByJwtSignatureRule'
'ThrottleByUserIdRule' (obligatoire)

IPRule

Nom Descriptif Valeur
action Action de liste de contrôle d’accès réseau Azure. 'Autoriser'
'Refuser'
valeur Adresse IP ou CIDR ou ServiceTag corde

LiveTraceCategory

Nom Descriptif Valeur
Activé Indique si la catégorie de trace dynamique est activée ou si elle est activée.
Valeurs disponibles : true, false.
Respect de la casse.		 corde
nom Obtient ou définit le nom de la catégorie de trace dynamique.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Respect de la casse.		 corde

LiveTraceConfiguration

Nom Descriptif Valeur
Catégories Obtient ou définit la liste des configurations de catégorie. liveTraceCategory[]
Activé Indique si vous activez ou non la trace dynamique.
Lorsqu’il est défini sur true, le client de trace dynamique peut se connecter au service.
Sinon, le client de suivi en direct ne peut pas se connecter au service, afin que vous ne puissiez pas recevoir de journal, quelle que soit la configuration dans « catégories ».
Valeurs disponibles : true, false.
Respect de la casse.		 corde

ManagedIdentity

Nom Descriptif Valeur
type Représente le type d’identité : systemAssigned, userAssigned, None 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Obtenir ou définir les identités affectées par l’utilisateur ManagedIdentityUserAssignedIdentities

ManagedIdentityUserAssignedIdentities

Nom Descriptif Valeur

Microsoft.SignalRService/webPubSub

Nom Descriptif Valeur
identité Une classe représente les identités managées utilisées pour la demande et la réponse managedIdentity
gentil Type de service 'SocketIO'
'WebPubSub'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 63
Modèle = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obligatoire)
Propriétés Classe qui décrit les propriétés de la ressource webPubSubProperties
Sku Informations de facturation de la ressource. ResourceSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.SignalRService/webPubSub@2024-04-01-preview »

NetworkACL

Nom Descriptif Valeur
permettre Types de requêtes autorisés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nier Types de demandes refusés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'

PrivateEndpointACL

Nom Descriptif Valeur
permettre Types de requêtes autorisés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nier Types de demandes refusés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nom Nom de la connexion de point de terminaison privé chaîne (obligatoire)

ResourceLogCategory

Nom Descriptif Valeur
Activé Indique si la catégorie du journal des ressources est activée.
Valeurs disponibles : true, false.
Respect de la casse.		 corde
nom Obtient ou définit le nom de la catégorie de journal des ressources.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Respect de la casse.		 corde

ResourceLogConfiguration

Nom Descriptif Valeur
Catégories Obtient ou définit la liste des configurations de catégorie. ResourceLogCategory[]

ResourceSku

Nom Descriptif Valeur
capacité Facultatif, entier. Nombre d’unités de la ressource.
1 pour Free_F1/Standard_S1/Premium_P1, 100 pour Premium_P2 par défaut.

Si elles sont présentes, les valeurs suivantes sont autorisées :
Free_F1 : 1 ;
Standard_S1 : 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100 ;
Premium_P1 : 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100 ;
Premium_P2 : 100 200 300 400 500 600 700 800 900 1000 ;		 Int
nom Nom de la référence SKU. Obligatoire.

Valeurs autorisées : Standard_S1, Free_F1, Premium_P1, Premium_P2		 chaîne (obligatoire)
niveau Niveau facultatif de cette référence SKU particulière. 'Standard' ou 'Gratuit'.

Basic est déconseillé, utilisez Standard à la place.		 'De base'
'Free'
'Premium'
'Standard'

ThrottleByJwtCustomClaimRule

Nom Descriptif Valeur
claimName Nom de la revendication dans le jeton JWT. La connexion cliente avec la même valeur de revendication est agrégée. Si la revendication est introuvable dans le jeton, la connexion est autorisée. chaîne (obligatoire)
maxCount Nombre maximal de connexions autorisé pour la même valeur de revendication Jwt. Les clients ayant la même revendication Jwt sont rejetés si le nombre de connexions dépasse cette valeur. La valeur par défaut est 20. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 2147483647
type 'ThrottleByJwtCustomClaimRule' (obligatoire)

ThrottleByJwtSignatureRule

Nom Descriptif Valeur
maxCount Nombre maximal de connexions autorisés pour la même signature JWT. Les clients avec la même signature JWT sont rejetés si le nombre de connexions dépasse cette valeur. La valeur par défaut est 20. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 2147483647
type 'ThrottleByJwtSignatureRule' (obligatoire)

ThrottleByUserIdRule

Nom Descriptif Valeur
maxCount Nombre maximal de connexions autorisé pour le même ID d’utilisateur. Les clients ayant le même ID d’utilisateur sont rejetés si le nombre de connexions dépasse cette valeur. La valeur par défaut est 20. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 2147483647
type 'ThrottleByUserIdRule' (obligatoire)

TrackedResourceTags

Nom Descriptif Valeur

UserAssignedIdentityProperty

Nom Descriptif Valeur

WebPubSubNetworkACLs

Nom Descriptif Valeur
defaultAction Action de liste de contrôle d’accès réseau Azure. 'Autoriser'
'Refuser'
ipRules Règles IP pour le filtrage du trafic public IPRule []
privateEndpoints Listes de contrôle d’accès pour les demandes de points de terminaison privés privateEndpointACL[]
publicNetwork Liste de contrôle d’accès réseau networkACL

WebPubSubProperties

Nom Descriptif Valeur
applicationFirewall Paramètres de pare-feu d’application pour la ressource ApplicationFirewallSettings
disableAadAuth DisableLocalAuth
Activer ou désactiver l’authentification aad
Quand la valeur est true, la connexion avec AuthType=aad ne fonctionnera pas.		 Bool
disableLocalAuth DisableLocalAuth
Activer ou désactiver l’authentification locale avec AccessKey
Quand la valeur est true, la connexion avec AccessKey=xxx ne fonctionne pas.		 Bool
liveTraceConfiguration Configuration de trace dynamique d’une ressource Microsoft.SignalRService. liveTraceConfiguration
networkACLs Listes de contrôle d’accès réseau pour la ressource WebPubSubNetworkACLs
publicNetworkAccess Activez ou désactivez l’accès au réseau public. Valeur par défaut « Activé ».
Quand elle est activée, les listes de contrôle d’accès réseau s’appliquent toujours.
Lorsqu’il est désactivé, l’accès au réseau public est toujours désactivé, quel que soit le paramètre défini dans les listes de contrôle d’accès réseau.		 corde
regionEndpointEnabled Activez ou désactivez le point de terminaison régional. Valeur par défaut « Activé ».
Lorsqu’elle est désactivée, les nouvelles connexions ne sont pas routées vers ce point de terminaison, mais les connexions existantes ne sont pas affectées.
Cette propriété est spécifique au réplica. Désactiver le point de terminaison régional sans réplica n’est pas autorisé.		 corde
resourceLogConfiguration Configuration du journal des ressources d’une ressource Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Arrêtez ou démarrez la ressource. La valeur par défaut est « False ».
Lorsqu’il est vrai, le plan de données de la ressource est arrêté.
Lorsqu’elle est false, le plan de données de la ressource est démarré.		 corde
socketIO Paramètres SocketIO pour la ressource WebPubSubSocketIOSettings
tls Paramètres TLS de la ressource WebPubSubTlsSettings

WebPubSubSocketIOSettings

Nom Descriptif Valeur
serviceMode Mode de service de Web PubSub pour Socket.IO. Valeurs autorisées :
« Par défaut » : disposez de votre propre serveur principal Socket.IO
« Serverless » : votre application n’a pas de serveur principal		 corde

WebPubSubTlsSettings

Nom Descriptif Valeur
clientCertEnabled Demandez un certificat client lors de l’établissement d’une liaison TLS s’il est activé. Non pris en charge pour le niveau gratuit. Toute entrée est ignorée pour le niveau gratuit. Bool