Partager via

SignalR Microsoft.SignalRService

  • Article

Définition de ressource Bicep

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

resource symbolicname 'Microsoft.SignalRService/signalR@2024-10-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
        }
      ]
      clientTrafficControlRules: [
        {
          type: 'string'
          // For remaining properties, see ClientTrafficControlRule objects
        }
      ]
    }
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    disableAadAuth: bool
    disableLocalAuth: bool
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    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'
    serverless: {
      connectionTimeoutInSeconds: int
      keepAliveIntervalInSeconds: int
    }
    tls: {
      clientCertEnabled: bool
    }
    upstream: {
      templates: [
        {
          auth: {
            managedIdentity: {
              resource: 'string'
            }
            type: 'string'
          }
          categoryPattern: 'string'
          eventPattern: 'string'
          hubPattern: 'string'
          urlTemplate: 'string'
        }
      ]
    }
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Objets ClientTrafficControlRule

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

Pour TrafficThrottleByJwtCustomClaimRule, utilisez :

{
  aggregationWindowInSeconds: int
  claimName: 'string'
  maxInboundMessageBytes: int
  type: 'TrafficThrottleByJwtCustomClaimRule'
}

Pour TrafficThrottleByJwtSignatureRule, utilisez :

{
  aggregationWindowInSeconds: int
  maxInboundMessageBytes: int
  type: 'TrafficThrottleByJwtSignatureRule'
}

Pour TrafficThrottleByUserIdRule, utilisez :

{
  aggregationWindowInSeconds: int
  maxInboundMessageBytes: int
  type: 'TrafficThrottleByUserIdRule'
}

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 Description Valeur
clientConnectionCountRules Règles de contrôle du nombre de connexions clientes ClientConnectionCountRule[]
clientTrafficControlRules Règles de contrôle du trafic client ClientTrafficControlRule[]

ClientConnectionCountRule

Nom Description 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)

ClientTrafficControlRule

Nom Description Valeur
type Défini sur « TrafficThrottleByJwtCustomClaimRule » pour le type TrafficThrottleByJwtCustomClaimRule. Défini sur « TrafficThrottleByJwtSignatureRule » pour le type TrafficThrottleByJwtSignatureRule. Défini sur « TrafficThrottleByUserIdRule » pour le type TrafficThrottleByUserIdRule. 'TrafficThrottleByJwtCustomClaimRule'
'TrafficThrottleByJwtSignatureRule'
'TrafficThrottleByUserIdRule' (obligatoire)

IPRule

Nom Description 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 Description 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 Description 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 Description 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

ManagedIdentitySettings

Nom Description Valeur
ressource Ressource indiquant l’URI d’ID d’application de la ressource cible.
Il apparaît également dans la revendication aud (audience) du jeton émis.		 corde

ManagedIdentityUserAssignedIdentities

Nom Description Valeur

Microsoft.SignalRService/signalR

Nom Description 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 'RawWebSockets'
'SignalR'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 3
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 SignalRProperties
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 Description 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 Description 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 Description 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 Description Valeur
Catégories Obtient ou définit la liste des configurations de catégorie. ResourceLogCategory[]

ResourceSku

Nom Description 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'

ServerlessSettings

Nom Description Valeur
connectionTimeoutInSeconds Obtient ou définit le délai d’expiration de la connexion du client. Facultatif à définir.
Valeur en secondes.
La valeur par défaut est de 30 secondes.
Le client doit définir le délai d’expiration sur une période plus courte si les messages sont censés être envoyés dans des intervalles plus courts,
et souhaitez que le client se déconnecte plus rapidement après l’envoi du dernier message.
Vous pouvez définir le délai d’expiration sur une période plus longue si les messages sont censés être envoyés dans des intervalles plus longs,
et ils souhaitent conserver la même connexion cliente pendant cette session.
Le service considère que le client est déconnecté s’il n’a pas reçu de message (y compris keep-alive) dans cet intervalle.		 Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 120
keepAliveIntervalInSeconds Obtient ou définit l’intervalle Keep-Alive. Facultatif à définir.
La valeur est en secondes.
La valeur par défaut est de 15 secondes.
Les clients doivent définir cette valeur sur une période plus courte s’ils veulent que le service envoie des messages de maintien en vie plus fréquemment,
vérifier en temps opportun l’état de la connexion.
À l’inverse, les clients peuvent définir cette valeur sur une période plus longue s’ils veulent que le service envoie moins fréquemment des messages de maintien en vie,
réduction du trafic réseau, mais notez qu’il peut prendre plus de temps pour détecter une déconnexion.
Cet intervalle garantit que la connexion est conservée en envoyant des messages périodiques de maintien en vie au client.		 Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 120

ServerlessUpstreamSettings

Nom Description Valeur
Modèles Obtient ou définit la liste des modèles d’URL en amont. L’ordre importe, et le premier modèle correspondant prend des effets. UpstreamTemplate []

SignalRCorsSettings

Nom Description Valeur
allowedOrigins Obtient ou définit la liste des origines qui doivent être autorisées à effectuer des appels inter-origines (par exemple : http://example.com:12345). Utilisez « * » pour autoriser tout. En cas d’omission, autorisez tout par défaut. string[]

SignalRFeature

Nom Description Valeur
drapeau FeatureFlags est les fonctionnalités prises en charge du service Azure SignalR.
- ServiceMode : indicateur pour le serveur principal pour le service SignalR. Valeurs autorisées : « Par défaut » : disposez de votre propre serveur principal ; « Serverless » : votre application n’a pas de serveur principal ; « Classique » : pour la compatibilité descendante. Prendre en charge le mode par défaut et serverless, mais pas recommandé ; « PrédéfiniOnly » : pour une utilisation ultérieure.
- EnableConnectivityLogs : « true »/« false », pour activer/désactiver respectivement la catégorie du journal de connectivité.
- EnableMessagingLogs : « true"/"false », pour activer/désactiver respectivement la catégorie du journal de connectivité.
- EnableLiveTrace : Live Trace vous permet de savoir ce qui se passe dans le service Azure SignalR, il vous donnera des traces actives en temps réel, il sera utile lorsque vous développez votre propre application web basée sur Azure SignalR ou résolution automatique de certains problèmes. Notez que les traces actives sont comptabilisées en tant que messages sortants qui seront facturés. Valeurs autorisées : « true »/« false », pour activer/désactiver la fonctionnalité de trace dynamique.		 'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'ServiceMode' (obligatoire)
Propriétés Propriétés facultatives associées à cette fonctionnalité. SignalRFeatureProperties
valeur Valeur de l’indicateur de fonctionnalité. Consultez le document de service Azure SignalR /azure/azure-signalr/ pour connaître les valeurs autorisées. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)

SignalRFeatureProperties

Nom Description Valeur

SignalRNetworkACLs

Nom Description 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

SignalRProperties

Nom Description Valeur
applicationFirewall Paramètres de pare-feu d’application pour la ressource ApplicationFirewallSettings
cors Paramètres CORS (Cross-Origin Resource Sharing). SignalRCorsSettings
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
fonctionnalités Liste des featureFlags.

FeatureFlags qui ne sont pas inclus dans les paramètres de l’opération de mise à jour ne seront pas modifiés.
Et la réponse inclut uniquement featureFlags qui sont explicitement définis.
Lorsqu’un featureFlag n’est pas défini explicitement, sa valeur par défaut globale est utilisée
Mais gardez à l’esprit que la valeur par défaut ne signifie pas « false ». Il varie en termes de FeatureFlags différents.		 SignalRFeature[]
liveTraceConfiguration Configuration de trace dynamique d’une ressource Microsoft.SignalRService. liveTraceConfiguration
networkACLs Listes de contrôle d’accès réseau pour la ressource SignalRNetworkACLs
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
serverless Paramètres serverless. ServerlessSettings
tls Paramètres TLS de la ressource SignalRTlsSettings
en amont Paramètres de l’amont lorsque le service est en mode sans serveur. ServerlessUpstreamSettings

SignalRTlsSettings

Nom Description 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

ThrottleByJwtCustomClaimRule

Nom Description 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 Description 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 Description 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 Description Valeur

TrafficThrottleByJwtCustomClaimRule

Nom Description Valeur
aggregationWindowInSeconds Fenêtre d’agrégation pour les octets de message. Les octets de message sont agrégés dans cette fenêtre et réinitialisés après la fenêtre. La valeur par défaut est de 60 secondes. Int

Contraintes:
Valeur minimale = 10
Valeur maximale = 3600
claimName Nom de la revendication dans le jeton JWT. Les octets de message avec la même valeur de revendication sont agrégés. Si la revendication est introuvable dans le jeton, la règle est ignorée. chaîne (obligatoire)
maxInboundMessageBytes Nombre maximal d’octets de message entrants cumulés autorisés pour la même signature JWT dans une fenêtre de temps. Les clients avec la même revendication JWT sont déconnectés si les octets de message dépassent cette valeur. La valeur par défaut est de 1 Go. Int

Contraintes:
Valeur minimale = 0
type 'TrafficThrottleByJwtCustomClaimRule' (obligatoire)

TrafficThrottleByJwtSignatureRule

Nom Description Valeur
aggregationWindowInSeconds Fenêtre d’agrégation pour les octets de message. Les octets de message sont agrégés dans cette fenêtre et réinitialisés après la fenêtre. La valeur par défaut est de 60 secondes. Int

Contraintes:
Valeur minimale = 10
Valeur maximale = 3600
maxInboundMessageBytes Nombre maximal d’octets de message entrants cumulés autorisés pour la même signature JWT dans une fenêtre de temps. Les clients avec la même signature JWT sont déconnectés si les octets de message dépassent cette valeur. La valeur par défaut est de 1 Go. Int

Contraintes:
Valeur minimale = 0
type 'TrafficThrottleByJwtSignatureRule' (obligatoire)

TrafficThrottleByUserIdRule

Nom Description Valeur
aggregationWindowInSeconds Fenêtre d’agrégation pour les octets de message. Les octets de message sont agrégés dans cette fenêtre et réinitialisés après la fenêtre. La valeur par défaut est de 60 secondes. Int

Contraintes:
Valeur minimale = 10
Valeur maximale = 3600
maxInboundMessageBytes Nombre maximal d’octets de message entrants cumulés autorisés pour le même ID utilisateur dans une fenêtre de temps. Les clients ayant le même ID d’utilisateur sont déconnectés si les octets de message dépassent cette valeur. La valeur par défaut est de 1 Go. Int

Contraintes:
Valeur minimale = 0
type 'TrafficThrottleByUserIdRule' (obligatoire)

UpstreamAuthSettings

Nom Description Valeur
managedIdentity Paramètres d’identité managée pour l’amont. ManagedIdentitySettings
type Énumération de type d’authentification en amont. 'ManagedIdentity'
'None'

UpstreamTemplate

Nom Description Valeur
Auth Paramètres d’authentification en amont. Si ce n’est pas défini, aucune authentification n’est utilisée pour les messages en amont. UpstreamAuthSettings
categoryPattern Obtient ou définit le modèle correspondant pour les noms de catégorie. S’il n’est pas défini, il correspond à n’importe quelle catégorie.
Il existe 3 types de modèles pris en charge :
1. « * », il correspond à n’importe quel nom de catégorie.
2. Combinez plusieurs catégories avec « », par exemple « connexions, messages », elle correspond à la catégorie « connexions » et « messages ».
3. Nom de catégorie unique, par exemple « connexions », il correspond à la catégorie « connexions ».		 corde
eventPattern Obtient ou définit le modèle correspondant pour les noms d’événements. S’il n’est pas défini, il correspond à un événement.
Il existe 3 types de modèles pris en charge :
1. « * », il correspond à n’importe quel nom d’événement.
2. Combinez plusieurs événements avec « », par exemple « connect,disconnect », il correspond à l’événement « connect » et à « disconnect ».
3. Le nom de l’événement unique, par exemple , « connect », correspond à « connect ».		 corde
hubPattern Obtient ou définit le modèle correspondant pour les noms de hub. S’il n’est pas défini, il correspond à n’importe quel hub.
Il existe 3 types de modèles pris en charge :
1. « * », il correspond à n’importe quel nom de hub.
2. Combinez plusieurs hubs avec « », par exemple « hub1, hub2 », il correspond à « hub1 » et « hub2 ».
3. Nom du hub unique, par exemple « hub1 », il correspond à « hub1 ».		 corde
urlTemplate Obtient ou définit le modèle d’URL en amont. Vous pouvez utiliser 3 paramètres prédéfinis {hub}, {category} {event} à l’intérieur du modèle, la valeur de l’URL en amont est calculée dynamiquement lorsque la demande du client est entrée.
Par exemple, si l’URLTemplate est http://example.com/{hub}/api/{event}, avec une demande cliente du hub chat se connecte, elle effectue d’abord une publication à cette URL : http://example.com/chat/api/connect.		 chaîne (obligatoire)

UserAssignedIdentityProperty

Nom Description Valeur

Exemples de démarrage rapide

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

Fichier Bicep Description
Déployer un service Azure SignalR Ce modèle crée un service Azure SignalR à l’aide d’un modèle.

Définition de ressource de modèle ARM

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

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2024-10-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
      } ],
      "clientTrafficControlRules": [ {
        "type": "string"
        // For remaining properties, see ClientTrafficControlRule objects
      } ]
    },
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "disableAadAuth": "bool",
    "disableLocalAuth": "bool",
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "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",
    "serverless": {
      "connectionTimeoutInSeconds": "int",
      "keepAliveIntervalInSeconds": "int"
    },
    "tls": {
      "clientCertEnabled": "bool"
    },
    "upstream": {
      "templates": [
        {
          "auth": {
            "managedIdentity": {
              "resource": "string"
            },
            "type": "string"
          },
          "categoryPattern": "string",
          "eventPattern": "string",
          "hubPattern": "string",
          "urlTemplate": "string"
        }
      ]
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Objets ClientTrafficControlRule

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

Pour TrafficThrottleByJwtCustomClaimRule, utilisez :

{
  "aggregationWindowInSeconds": "int",
  "claimName": "string",
  "maxInboundMessageBytes": "int",
  "type": "TrafficThrottleByJwtCustomClaimRule"
}

Pour TrafficThrottleByJwtSignatureRule, utilisez :

{
  "aggregationWindowInSeconds": "int",
  "maxInboundMessageBytes": "int",
  "type": "TrafficThrottleByJwtSignatureRule"
}

Pour TrafficThrottleByUserIdRule, utilisez :

{
  "aggregationWindowInSeconds": "int",
  "maxInboundMessageBytes": "int",
  "type": "TrafficThrottleByUserIdRule"
}

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 Description Valeur
clientConnectionCountRules Règles de contrôle du nombre de connexions clientes ClientConnectionCountRule[]
clientTrafficControlRules Règles de contrôle du trafic client ClientTrafficControlRule[]

ClientConnectionCountRule

Nom Description 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)

ClientTrafficControlRule

Nom Description Valeur
type Défini sur « TrafficThrottleByJwtCustomClaimRule » pour le type TrafficThrottleByJwtCustomClaimRule. Défini sur « TrafficThrottleByJwtSignatureRule » pour le type TrafficThrottleByJwtSignatureRule. Défini sur « TrafficThrottleByUserIdRule » pour le type TrafficThrottleByUserIdRule. 'TrafficThrottleByJwtCustomClaimRule'
'TrafficThrottleByJwtSignatureRule'
'TrafficThrottleByUserIdRule' (obligatoire)

IPRule

Nom Description 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 Description 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 Description 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 Description 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

ManagedIdentitySettings

Nom Description Valeur
ressource Ressource indiquant l’URI d’ID d’application de la ressource cible.
Il apparaît également dans la revendication aud (audience) du jeton émis.		 corde

ManagedIdentityUserAssignedIdentities

Nom Description Valeur

Microsoft.SignalRService/signalR

Nom Description Valeur
apiVersion Version de l’API '2024-10-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 'RawWebSockets'
'SignalR'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 3
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 SignalRProperties
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/signalR'

NetworkACL

Nom Description 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 Description 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 Description 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 Description Valeur
Catégories Obtient ou définit la liste des configurations de catégorie. ResourceLogCategory[]

ResourceSku

Nom Description 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'

ServerlessSettings

Nom Description Valeur
connectionTimeoutInSeconds Obtient ou définit le délai d’expiration de la connexion du client. Facultatif à définir.
Valeur en secondes.
La valeur par défaut est de 30 secondes.
Le client doit définir le délai d’expiration sur une période plus courte si les messages sont censés être envoyés dans des intervalles plus courts,
et souhaitez que le client se déconnecte plus rapidement après l’envoi du dernier message.
Vous pouvez définir le délai d’expiration sur une période plus longue si les messages sont censés être envoyés dans des intervalles plus longs,
et ils souhaitent conserver la même connexion cliente pendant cette session.
Le service considère que le client est déconnecté s’il n’a pas reçu de message (y compris keep-alive) dans cet intervalle.		 Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 120
keepAliveIntervalInSeconds Obtient ou définit l’intervalle Keep-Alive. Facultatif à définir.
La valeur est en secondes.
La valeur par défaut est de 15 secondes.
Les clients doivent définir cette valeur sur une période plus courte s’ils veulent que le service envoie des messages de maintien en vie plus fréquemment,
vérifier en temps opportun l’état de la connexion.
À l’inverse, les clients peuvent définir cette valeur sur une période plus longue s’ils veulent que le service envoie moins fréquemment des messages de maintien en vie,
réduction du trafic réseau, mais notez qu’il peut prendre plus de temps pour détecter une déconnexion.
Cet intervalle garantit que la connexion est conservée en envoyant des messages périodiques de maintien en vie au client.		 Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 120

ServerlessUpstreamSettings

Nom Description Valeur
Modèles Obtient ou définit la liste des modèles d’URL en amont. L’ordre importe, et le premier modèle correspondant prend des effets. UpstreamTemplate []

SignalRCorsSettings

Nom Description Valeur
allowedOrigins Obtient ou définit la liste des origines qui doivent être autorisées à effectuer des appels inter-origines (par exemple : http://example.com:12345). Utilisez « * » pour autoriser tout. En cas d’omission, autorisez tout par défaut. string[]

SignalRFeature

Nom Description Valeur
drapeau FeatureFlags est les fonctionnalités prises en charge du service Azure SignalR.
- ServiceMode : indicateur pour le serveur principal pour le service SignalR. Valeurs autorisées : « Par défaut » : disposez de votre propre serveur principal ; « Serverless » : votre application n’a pas de serveur principal ; « Classique » : pour la compatibilité descendante. Prendre en charge le mode par défaut et serverless, mais pas recommandé ; « PrédéfiniOnly » : pour une utilisation ultérieure.
- EnableConnectivityLogs : « true »/« false », pour activer/désactiver respectivement la catégorie du journal de connectivité.
- EnableMessagingLogs : « true"/"false », pour activer/désactiver respectivement la catégorie du journal de connectivité.
- EnableLiveTrace : Live Trace vous permet de savoir ce qui se passe dans le service Azure SignalR, il vous donnera des traces actives en temps réel, il sera utile lorsque vous développez votre propre application web basée sur Azure SignalR ou résolution automatique de certains problèmes. Notez que les traces actives sont comptabilisées en tant que messages sortants qui seront facturés. Valeurs autorisées : « true »/« false », pour activer/désactiver la fonctionnalité de trace dynamique.		 'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'ServiceMode' (obligatoire)
Propriétés Propriétés facultatives associées à cette fonctionnalité. SignalRFeatureProperties
valeur Valeur de l’indicateur de fonctionnalité. Consultez le document de service Azure SignalR /azure/azure-signalr/ pour connaître les valeurs autorisées. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)

SignalRFeatureProperties

Nom Description Valeur

SignalRNetworkACLs

Nom Description 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

SignalRProperties

Nom Description Valeur
applicationFirewall Paramètres de pare-feu d’application pour la ressource ApplicationFirewallSettings
cors Paramètres CORS (Cross-Origin Resource Sharing). SignalRCorsSettings
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
fonctionnalités Liste des featureFlags.

FeatureFlags qui ne sont pas inclus dans les paramètres de l’opération de mise à jour ne seront pas modifiés.
Et la réponse inclut uniquement featureFlags qui sont explicitement définis.
Lorsqu’un featureFlag n’est pas défini explicitement, sa valeur par défaut globale est utilisée
Mais gardez à l’esprit que la valeur par défaut ne signifie pas « false ». Il varie en termes de FeatureFlags différents.		 SignalRFeature[]
liveTraceConfiguration Configuration de trace dynamique d’une ressource Microsoft.SignalRService. liveTraceConfiguration
networkACLs Listes de contrôle d’accès réseau pour la ressource SignalRNetworkACLs
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
serverless Paramètres serverless. ServerlessSettings
tls Paramètres TLS de la ressource SignalRTlsSettings
en amont Paramètres de l’amont lorsque le service est en mode sans serveur. ServerlessUpstreamSettings

SignalRTlsSettings

Nom Description 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

ThrottleByJwtCustomClaimRule

Nom Description 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 Description 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 Description 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 Description Valeur

TrafficThrottleByJwtCustomClaimRule

Nom Description Valeur
aggregationWindowInSeconds Fenêtre d’agrégation pour les octets de message. Les octets de message sont agrégés dans cette fenêtre et réinitialisés après la fenêtre. La valeur par défaut est de 60 secondes. Int

Contraintes:
Valeur minimale = 10
Valeur maximale = 3600
claimName Nom de la revendication dans le jeton JWT. Les octets de message avec la même valeur de revendication sont agrégés. Si la revendication est introuvable dans le jeton, la règle est ignorée. chaîne (obligatoire)
maxInboundMessageBytes Nombre maximal d’octets de message entrants cumulés autorisés pour la même signature JWT dans une fenêtre de temps. Les clients avec la même revendication JWT sont déconnectés si les octets de message dépassent cette valeur. La valeur par défaut est de 1 Go. Int

Contraintes:
Valeur minimale = 0
type 'TrafficThrottleByJwtCustomClaimRule' (obligatoire)

TrafficThrottleByJwtSignatureRule

Nom Description Valeur
aggregationWindowInSeconds Fenêtre d’agrégation pour les octets de message. Les octets de message sont agrégés dans cette fenêtre et réinitialisés après la fenêtre. La valeur par défaut est de 60 secondes. Int

Contraintes:
Valeur minimale = 10
Valeur maximale = 3600
maxInboundMessageBytes Nombre maximal d’octets de message entrants cumulés autorisés pour la même signature JWT dans une fenêtre de temps. Les clients avec la même signature JWT sont déconnectés si les octets de message dépassent cette valeur. La valeur par défaut est de 1 Go. Int

Contraintes:
Valeur minimale = 0
type 'TrafficThrottleByJwtSignatureRule' (obligatoire)

TrafficThrottleByUserIdRule

Nom Description Valeur
aggregationWindowInSeconds Fenêtre d’agrégation pour les octets de message. Les octets de message sont agrégés dans cette fenêtre et réinitialisés après la fenêtre. La valeur par défaut est de 60 secondes. Int

Contraintes:
Valeur minimale = 10
Valeur maximale = 3600
maxInboundMessageBytes Nombre maximal d’octets de message entrants cumulés autorisés pour le même ID utilisateur dans une fenêtre de temps. Les clients ayant le même ID d’utilisateur sont déconnectés si les octets de message dépassent cette valeur. La valeur par défaut est de 1 Go. Int

Contraintes:
Valeur minimale = 0
type 'TrafficThrottleByUserIdRule' (obligatoire)

UpstreamAuthSettings

Nom Description Valeur
managedIdentity Paramètres d’identité managée pour l’amont. ManagedIdentitySettings
type Énumération de type d’authentification en amont. 'ManagedIdentity'
'None'

UpstreamTemplate

Nom Description Valeur
Auth Paramètres d’authentification en amont. Si ce n’est pas défini, aucune authentification n’est utilisée pour les messages en amont. UpstreamAuthSettings
categoryPattern Obtient ou définit le modèle correspondant pour les noms de catégorie. S’il n’est pas défini, il correspond à n’importe quelle catégorie.
Il existe 3 types de modèles pris en charge :
1. « * », il correspond à n’importe quel nom de catégorie.
2. Combinez plusieurs catégories avec « », par exemple « connexions, messages », elle correspond à la catégorie « connexions » et « messages ».
3. Nom de catégorie unique, par exemple « connexions », il correspond à la catégorie « connexions ».		 corde
eventPattern Obtient ou définit le modèle correspondant pour les noms d’événements. S’il n’est pas défini, il correspond à un événement.
Il existe 3 types de modèles pris en charge :
1. « * », il correspond à n’importe quel nom d’événement.
2. Combinez plusieurs événements avec « », par exemple « connect,disconnect », il correspond à l’événement « connect » et à « disconnect ».
3. Le nom de l’événement unique, par exemple , « connect », correspond à « connect ».		 corde
hubPattern Obtient ou définit le modèle correspondant pour les noms de hub. S’il n’est pas défini, il correspond à n’importe quel hub.
Il existe 3 types de modèles pris en charge :
1. « * », il correspond à n’importe quel nom de hub.
2. Combinez plusieurs hubs avec « », par exemple « hub1, hub2 », il correspond à « hub1 » et « hub2 ».
3. Nom du hub unique, par exemple « hub1 », il correspond à « hub1 ».		 corde
urlTemplate Obtient ou définit le modèle d’URL en amont. Vous pouvez utiliser 3 paramètres prédéfinis {hub}, {category} {event} à l’intérieur du modèle, la valeur de l’URL en amont est calculée dynamiquement lorsque la demande du client est entrée.
Par exemple, si l’URLTemplate est http://example.com/{hub}/api/{event}, avec une demande cliente du hub chat se connecte, elle effectue d’abord une publication à cette URL : http://example.com/chat/api/connect.		 chaîne (obligatoire)

UserAssignedIdentityProperty

Nom Description Valeur

Modèles de démarrage rapide

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

Modèle Description
Déployer un service Azure SignalR

Déployer sur Azure 		Ce modèle crée un service Azure SignalR à l’aide d’un modèle.

Définition de ressource Terraform (fournisseur AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR@2024-10-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      applicationFirewall = {
        clientConnectionCountRules = [
          {
            type = "string"
            // For remaining properties, see ClientConnectionCountRule objects
          }
        ]
        clientTrafficControlRules = [
          {
            type = "string"
            // For remaining properties, see ClientTrafficControlRule objects
          }
        ]
      }
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      disableAadAuth = bool
      disableLocalAuth = bool
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      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"
      serverless = {
        connectionTimeoutInSeconds = int
        keepAliveIntervalInSeconds = int
      }
      tls = {
        clientCertEnabled = bool
      }
      upstream = {
        templates = [
          {
            auth = {
              managedIdentity = {
                resource = "string"
              }
              type = "string"
            }
            categoryPattern = "string"
            eventPattern = "string"
            hubPattern = "string"
            urlTemplate = "string"
          }
        ]
      }
    }
  })
}

Objets ClientTrafficControlRule

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

Pour TrafficThrottleByJwtCustomClaimRule, utilisez :

{
  aggregationWindowInSeconds = int
  claimName = "string"
  maxInboundMessageBytes = int
  type = "TrafficThrottleByJwtCustomClaimRule"
}

Pour TrafficThrottleByJwtSignatureRule, utilisez :

{
  aggregationWindowInSeconds = int
  maxInboundMessageBytes = int
  type = "TrafficThrottleByJwtSignatureRule"
}

Pour TrafficThrottleByUserIdRule, utilisez :

{
  aggregationWindowInSeconds = int
  maxInboundMessageBytes = int
  type = "TrafficThrottleByUserIdRule"
}

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 Description Valeur
clientConnectionCountRules Règles de contrôle du nombre de connexions clientes ClientConnectionCountRule[]
clientTrafficControlRules Règles de contrôle du trafic client ClientTrafficControlRule[]

ClientConnectionCountRule

Nom Description 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)

ClientTrafficControlRule

Nom Description Valeur
type Défini sur « TrafficThrottleByJwtCustomClaimRule » pour le type TrafficThrottleByJwtCustomClaimRule. Défini sur « TrafficThrottleByJwtSignatureRule » pour le type TrafficThrottleByJwtSignatureRule. Défini sur « TrafficThrottleByUserIdRule » pour le type TrafficThrottleByUserIdRule. 'TrafficThrottleByJwtCustomClaimRule'
'TrafficThrottleByJwtSignatureRule'
'TrafficThrottleByUserIdRule' (obligatoire)

IPRule

Nom Description 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 Description 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 Description 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 Description 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

ManagedIdentitySettings

Nom Description Valeur
ressource Ressource indiquant l’URI d’ID d’application de la ressource cible.
Il apparaît également dans la revendication aud (audience) du jeton émis.		 corde

ManagedIdentityUserAssignedIdentities

Nom Description Valeur

Microsoft.SignalRService/signalR

Nom Description 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 'RawWebSockets'
'SignalR'
emplacement Emplacement géographique où réside la ressource chaîne (obligatoire)
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 3
Longueur maximale = 3
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 SignalRProperties
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/signalR@2024-10-01-preview »

NetworkACL

Nom Description 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 Description 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 Description 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 Description Valeur
Catégories Obtient ou définit la liste des configurations de catégorie. ResourceLogCategory[]

ResourceSku

Nom Description 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'

ServerlessSettings

Nom Description Valeur
connectionTimeoutInSeconds Obtient ou définit le délai d’expiration de la connexion du client. Facultatif à définir.
Valeur en secondes.
La valeur par défaut est de 30 secondes.
Le client doit définir le délai d’expiration sur une période plus courte si les messages sont censés être envoyés dans des intervalles plus courts,
et souhaitez que le client se déconnecte plus rapidement après l’envoi du dernier message.
Vous pouvez définir le délai d’expiration sur une période plus longue si les messages sont censés être envoyés dans des intervalles plus longs,
et ils souhaitent conserver la même connexion cliente pendant cette session.
Le service considère que le client est déconnecté s’il n’a pas reçu de message (y compris keep-alive) dans cet intervalle.		 Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 120
keepAliveIntervalInSeconds Obtient ou définit l’intervalle Keep-Alive. Facultatif à définir.
La valeur est en secondes.
La valeur par défaut est de 15 secondes.
Les clients doivent définir cette valeur sur une période plus courte s’ils veulent que le service envoie des messages de maintien en vie plus fréquemment,
vérifier en temps opportun l’état de la connexion.
À l’inverse, les clients peuvent définir cette valeur sur une période plus longue s’ils veulent que le service envoie moins fréquemment des messages de maintien en vie,
réduction du trafic réseau, mais notez qu’il peut prendre plus de temps pour détecter une déconnexion.
Cet intervalle garantit que la connexion est conservée en envoyant des messages périodiques de maintien en vie au client.		 Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 120

ServerlessUpstreamSettings

Nom Description Valeur
Modèles Obtient ou définit la liste des modèles d’URL en amont. L’ordre importe, et le premier modèle correspondant prend des effets. UpstreamTemplate []

SignalRCorsSettings

Nom Description Valeur
allowedOrigins Obtient ou définit la liste des origines qui doivent être autorisées à effectuer des appels inter-origines (par exemple : http://example.com:12345). Utilisez « * » pour autoriser tout. En cas d’omission, autorisez tout par défaut. string[]

SignalRFeature

Nom Description Valeur
drapeau FeatureFlags est les fonctionnalités prises en charge du service Azure SignalR.
- ServiceMode : indicateur pour le serveur principal pour le service SignalR. Valeurs autorisées : « Par défaut » : disposez de votre propre serveur principal ; « Serverless » : votre application n’a pas de serveur principal ; « Classique » : pour la compatibilité descendante. Prendre en charge le mode par défaut et serverless, mais pas recommandé ; « PrédéfiniOnly » : pour une utilisation ultérieure.
- EnableConnectivityLogs : « true »/« false », pour activer/désactiver respectivement la catégorie du journal de connectivité.
- EnableMessagingLogs : « true"/"false », pour activer/désactiver respectivement la catégorie du journal de connectivité.
- EnableLiveTrace : Live Trace vous permet de savoir ce qui se passe dans le service Azure SignalR, il vous donnera des traces actives en temps réel, il sera utile lorsque vous développez votre propre application web basée sur Azure SignalR ou résolution automatique de certains problèmes. Notez que les traces actives sont comptabilisées en tant que messages sortants qui seront facturés. Valeurs autorisées : « true »/« false », pour activer/désactiver la fonctionnalité de trace dynamique.		 'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'ServiceMode' (obligatoire)
Propriétés Propriétés facultatives associées à cette fonctionnalité. SignalRFeatureProperties
valeur Valeur de l’indicateur de fonctionnalité. Consultez le document de service Azure SignalR /azure/azure-signalr/ pour connaître les valeurs autorisées. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)

SignalRFeatureProperties

Nom Description Valeur

SignalRNetworkACLs

Nom Description 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

SignalRProperties

Nom Description Valeur
applicationFirewall Paramètres de pare-feu d’application pour la ressource ApplicationFirewallSettings
cors Paramètres CORS (Cross-Origin Resource Sharing). SignalRCorsSettings
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
fonctionnalités Liste des featureFlags.

FeatureFlags qui ne sont pas inclus dans les paramètres de l’opération de mise à jour ne seront pas modifiés.
Et la réponse inclut uniquement featureFlags qui sont explicitement définis.
Lorsqu’un featureFlag n’est pas défini explicitement, sa valeur par défaut globale est utilisée
Mais gardez à l’esprit que la valeur par défaut ne signifie pas « false ». Il varie en termes de FeatureFlags différents.		 SignalRFeature[]
liveTraceConfiguration Configuration de trace dynamique d’une ressource Microsoft.SignalRService. liveTraceConfiguration
networkACLs Listes de contrôle d’accès réseau pour la ressource SignalRNetworkACLs
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
serverless Paramètres serverless. ServerlessSettings
tls Paramètres TLS de la ressource SignalRTlsSettings
en amont Paramètres de l’amont lorsque le service est en mode sans serveur. ServerlessUpstreamSettings

SignalRTlsSettings

Nom Description 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

ThrottleByJwtCustomClaimRule

Nom Description 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 Description 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 Description 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 Description Valeur

TrafficThrottleByJwtCustomClaimRule

Nom Description Valeur
aggregationWindowInSeconds Fenêtre d’agrégation pour les octets de message. Les octets de message sont agrégés dans cette fenêtre et réinitialisés après la fenêtre. La valeur par défaut est de 60 secondes. Int

Contraintes:
Valeur minimale = 10
Valeur maximale = 3600
claimName Nom de la revendication dans le jeton JWT. Les octets de message avec la même valeur de revendication sont agrégés. Si la revendication est introuvable dans le jeton, la règle est ignorée. chaîne (obligatoire)
maxInboundMessageBytes Nombre maximal d’octets de message entrants cumulés autorisés pour la même signature JWT dans une fenêtre de temps. Les clients avec la même revendication JWT sont déconnectés si les octets de message dépassent cette valeur. La valeur par défaut est de 1 Go. Int

Contraintes:
Valeur minimale = 0
type 'TrafficThrottleByJwtCustomClaimRule' (obligatoire)

TrafficThrottleByJwtSignatureRule

Nom Description Valeur
aggregationWindowInSeconds Fenêtre d’agrégation pour les octets de message. Les octets de message sont agrégés dans cette fenêtre et réinitialisés après la fenêtre. La valeur par défaut est de 60 secondes. Int

Contraintes:
Valeur minimale = 10
Valeur maximale = 3600
maxInboundMessageBytes Nombre maximal d’octets de message entrants cumulés autorisés pour la même signature JWT dans une fenêtre de temps. Les clients avec la même signature JWT sont déconnectés si les octets de message dépassent cette valeur. La valeur par défaut est de 1 Go. Int

Contraintes:
Valeur minimale = 0
type 'TrafficThrottleByJwtSignatureRule' (obligatoire)

TrafficThrottleByUserIdRule

Nom Description Valeur
aggregationWindowInSeconds Fenêtre d’agrégation pour les octets de message. Les octets de message sont agrégés dans cette fenêtre et réinitialisés après la fenêtre. La valeur par défaut est de 60 secondes. Int

Contraintes:
Valeur minimale = 10
Valeur maximale = 3600
maxInboundMessageBytes Nombre maximal d’octets de message entrants cumulés autorisés pour le même ID utilisateur dans une fenêtre de temps. Les clients ayant le même ID d’utilisateur sont déconnectés si les octets de message dépassent cette valeur. La valeur par défaut est de 1 Go. Int

Contraintes:
Valeur minimale = 0
type 'TrafficThrottleByUserIdRule' (obligatoire)

UpstreamAuthSettings

Nom Description Valeur
managedIdentity Paramètres d’identité managée pour l’amont. ManagedIdentitySettings
type Énumération de type d’authentification en amont. 'ManagedIdentity'
'None'

UpstreamTemplate

Nom Description Valeur
Auth Paramètres d’authentification en amont. Si ce n’est pas défini, aucune authentification n’est utilisée pour les messages en amont. UpstreamAuthSettings
categoryPattern Obtient ou définit le modèle correspondant pour les noms de catégorie. S’il n’est pas défini, il correspond à n’importe quelle catégorie.
Il existe 3 types de modèles pris en charge :
1. « * », il correspond à n’importe quel nom de catégorie.
2. Combinez plusieurs catégories avec « », par exemple « connexions, messages », elle correspond à la catégorie « connexions » et « messages ».
3. Nom de catégorie unique, par exemple « connexions », il correspond à la catégorie « connexions ».		 corde
eventPattern Obtient ou définit le modèle correspondant pour les noms d’événements. S’il n’est pas défini, il correspond à un événement.
Il existe 3 types de modèles pris en charge :
1. « * », il correspond à n’importe quel nom d’événement.
2. Combinez plusieurs événements avec « », par exemple « connect,disconnect », il correspond à l’événement « connect » et à « disconnect ».
3. Le nom de l’événement unique, par exemple , « connect », correspond à « connect ».		 corde
hubPattern Obtient ou définit le modèle correspondant pour les noms de hub. S’il n’est pas défini, il correspond à n’importe quel hub.
Il existe 3 types de modèles pris en charge :
1. « * », il correspond à n’importe quel nom de hub.
2. Combinez plusieurs hubs avec « », par exemple « hub1, hub2 », il correspond à « hub1 » et « hub2 ».
3. Nom du hub unique, par exemple « hub1 », il correspond à « hub1 ».		 corde
urlTemplate Obtient ou définit le modèle d’URL en amont. Vous pouvez utiliser 3 paramètres prédéfinis {hub}, {category} {event} à l’intérieur du modèle, la valeur de l’URL en amont est calculée dynamiquement lorsque la demande du client est entrée.
Par exemple, si l’URLTemplate est http://example.com/{hub}/api/{event}, avec une demande cliente du hub chat se connecte, elle effectue d’abord une publication à cette URL : http://example.com/chat/api/connect.		 chaîne (obligatoire)

UserAssignedIdentityProperty

Nom Description Valeur