Partager via

Microsoft.SignalRService signalR

  • 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 des ressources

Pour créer une ressource Microsoft.SignalRService/signalR, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.SignalRService/signalR@2023-08-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    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
    }
    tls: {
      clientCertEnabled: bool
    }
    upstream: {
      templates: [
        {
          auth: {
            managedIdentity: {
              resource: 'string'
            }
            type: 'string'
          }
          categoryPattern: 'string'
          eventPattern: 'string'
          hubPattern: 'string'
          urlTemplate: 'string'
        }
      ]
    }
  }
}

Valeurs de propriétés

signalR

Nom Description Valeur
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 3-63

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit commencer par une lettre. Doit se terminer par une lettre ou un chiffre.

Le nom de la ressource doit être unique dans Azure.
location Emplacement géographique où réside la ressource chaîne (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku Informations de facturation de la ressource. ResourceSku
kind Type de service 'RawWebSockets'
'SignalR'
identité Une classe représente les identités managées utilisées pour la demande et la réponse ManagedIdentity
properties Classe qui décrit les propriétés de la ressource SignalRProperties

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

ManagedIdentityUserAssignedIdentities

Nom Description Valeur
{propriété personnalisée} UserAssignedIdentityProperty

UserAssignedIdentityProperty

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

SignalRProperties

Nom Description Valeur
cors Paramètres CORS (Cross-Origin Resource Sharing). SignalRCorsSettings
disableAadAuth DésactiverLocalAuth
Activer ou désactiver l’authentification aad
Lorsque la valeur est true, la connexion à AuthType=aad ne fonctionne pas.		 bool
disableLocalAuth DésactiverLocalAuth
Activer ou désactiver l’authentification locale avec AccessKey
Lorsque la valeur est true, la connexion à AccessKey=xxx ne fonctionne pas.		 bool
features Liste des featureFlags.

Les 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 n’inclura que les 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. La valeur par défaut est « Enabled ».
Lorsqu’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 ce que vous définissez dans les listes de contrôle d’accès réseau.		 string
regionEndpointEnabled Activez ou désactivez le point de terminaison régional. La valeur par défaut est « Enabled ».
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 réplica spécifique. Désactivez le point de terminaison régional sans réplica n’est pas autorisé.		 string
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 ».
Quand il est vrai, le plan de données de la ressource est arrêté.
Lorsqu’il est false, le plan de données de la ressource est démarré.		 string
Serverless Paramètres serverless. ServerlessSettings
Tls Paramètres TLS pour la ressource SignalRTlsSettings
upstream Paramètres de l’amont lorsque le service est en mode sans serveur. ServerlessUpstreamSettings

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 les autoriser toutes. En cas d’omission, autorisez tout par défaut. string[]

SignalRFeature

Nom Description Valeur
flag 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 » : avoir votre propre serveur principal ; « Serverless » : votre application n’a pas de serveur principal ; « Classic » : pour la compatibilité descendante. Prend en charge à la fois les modes Par défaut et Serverless, mais non recommandé ; « PrédéfiniOnly » : pour une utilisation ultérieure.
- EnableConnectivityLogs : « true »/« false », pour activer/désactiver la catégorie de journal de connectivité respectivement.
- EnableMessagingLogs : « true »/« false », pour activer/désactiver la catégorie de journal de connectivité respectivement.
- EnableLiveTrace : La trace dynamique vous permet de savoir ce qui se passe à l’intérieur du service Azure SignalR. Elle vous donnera des traces en temps réel. Elle vous sera utile lorsque vous développez votre propre application web basée sur Azure SignalR ou vous dépanner automatiquement certains problèmes. Notez que les traces actives sont comptabilisées comme des 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)
properties Propriétés facultatives liées à cette fonctionnalité. SignalRFeatureProperties
value Valeur de l’indicateur de fonctionnalité. Consultez le document de https://docs.microsoft.com/azure/azure-signalr/ service Azure SignalR pour connaître les valeurs autorisées. chaîne (obligatoire)

Contraintes :
Longueur minimale = 1
Longueur maximale = 128

SignalRFeatureProperties

Nom Description Valeur
{propriété personnalisée} string

LiveTraceConfiguration

Nom Description Valeur
categories Obtient ou définit la liste des configurations de catégorie. LiveTraceCategory[]
enabled Indique si ou non activer 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 dynamique ne peut pas se connecter au service, de sorte que vous ne pouvez pas recevoir de journal, quelle que soit la configuration que vous configurez dans les « catégories ».
Valeurs disponibles : true, false.
Ne respecte pas la casse.
 string

LiveTraceCategory

Nom Description Valeur
enabled Indique si ou la catégorie de trace dynamique est activée.
Valeurs disponibles : true, false.
Ne respecte pas la casse.		 string
name Obtient ou définit le nom de la catégorie de trace dynamique.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Ne respecte pas la casse.
 string

SignalRNetworkACLs

Nom Description Valeur
defaultAction Action de liste de contrôle d’accès réseau Azure. 'Autoriser'
'Deny'
ipRules Règles IP pour le filtrage du trafic public IPRule[]

Contraintes :
Longueur maximale = 30
privateEndpoints Listes de contrôle d’accès pour les requêtes provenant de points de terminaison privés PrivateEndpointACL[]
publicNetwork Liste de contrôle d'accès réseau NetworkACL

IPRule

Nom Description Valeur
action Action de liste de contrôle d’accès réseau Azure. 'Autoriser'
'Deny'
value Adresse IP ou CIDR ou ServiceTag string

PrivateEndpointACL

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

NetworkACL

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

ResourceLogConfiguration

Nom Description Valeur
categories Obtient ou définit la liste des configurations de catégorie. ResourceLogCategory[]

ResourceLogCategory

Nom Description Valeur
enabled Indique si ou la catégorie de journal de ressources est activée.
Valeurs disponibles : true, false.
Ne respecte pas la casse.		 string
name Obtient ou définit le nom de la catégorie de journal des ressources.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Ne respecte pas la casse.
 string

ServerlessSettings

Nom Description Valeur
connectionTimeoutInSeconds Obtient ou définit le délai d’expiration de la connexion cliente. Facultatif à définir.
Valeur en secondes.
La valeur par défaut est 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 client active 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) pendant cet intervalle.
 int

Contraintes :
Valeur minimale = 1
Valeur maximale = 120

SignalRTlsSettings

Nom Description Valeur
clientCertEnabled Demandez un certificat client pendant l’établissement d’une négociation TLS si cette option est activée. Non pris en charge pour le niveau gratuit. Toute entrée est ignorée pour le niveau gratuit. bool

ServerlessUpstreamSettings

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

AmontTemplate

Nom Description Valeur
auth Paramètres d’authentification en amont. Si elle n’est pas définie, aucune authentification n’est utilisée pour amont messages. AmontAuthSettings
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 », il correspond à la catégorie « connexions » et « messages ».
3. Nom de catégorie unique, par exemple , « connexions », il correspond à la catégorie « connexions ».		 string
eventPattern Obtient ou définit le modèle correspondant pour les noms d’événements. S’il n’est pas défini, il correspond à n’importe quel é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 d’événement unique, par exemple, « connect », il correspond à « connect ».		 string
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. Le nom du hub unique, par exemple, « hub1 », il correspond à « hub1 ».		 string
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 cliente arrive.
Par exemple, si urlTemplate est http://example.com/{hub}/api/{event}, avec une demande cliente à partir d’un hub chat se connecte, il est d’abord POST vers cette URL : http://example.com/chat/api/connect.
 chaîne (obligatoire)

AmontAuthSettings

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

ManagedIdentitySettings

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

ResourceSku

Nom Description Valeur
capacité Facultatif, entier. Nombre d’unités de la ressource. 1 par défaut.

Le cas échéant, les valeurs suivantes sont autorisées :
Gratuit : 1 ;
Standard : 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100 ;
Premium : 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100 ;		 int
name Nom de la référence SKU. Obligatoire.

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

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

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 Azure SignalR Service à l’aide d’un modèle.

Définition de ressources 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 des ressources

Pour créer une ressource Microsoft.SignalRService/signalR, ajoutez le json suivant à votre modèle.

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2023-08-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "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"
    },
    "tls": {
      "clientCertEnabled": "bool"
    },
    "upstream": {
      "templates": [
        {
          "auth": {
            "managedIdentity": {
              "resource": "string"
            },
            "type": "string"
          },
          "categoryPattern": "string",
          "eventPattern": "string",
          "hubPattern": "string",
          "urlTemplate": "string"
        }
      ]
    }
  }
}

Valeurs de propriétés

signalR

Nom Description Valeur
type Type de ressource « Microsoft.SignalRService/signalR »
apiVersion Version de l’API de ressource « 2023-08-01-preview »
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 3-63

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit commencer par une lettre. Doit se terminer par une lettre ou un chiffre.

Le nom de la ressource doit être unique dans Azure.
location Emplacement géographique où réside la ressource chaîne (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku Informations de facturation de la ressource. ResourceSku
kind Type de service 'RawWebSockets'
'SignalR'
identité Une classe représente les identités managées utilisées pour la demande et la réponse ManagedIdentity
properties Classe qui décrit les propriétés de la ressource SignalRProperties

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

ManagedIdentityUserAssignedIdentities

Nom Description Valeur
{propriété personnalisée} UserAssignedIdentityProperty

UserAssignedIdentityProperty

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

SignalRProperties

Nom Description Valeur
cors Paramètres CORS (Cross-Origin Resource Sharing). SignalRCorsSettings
disableAadAuth DésactiverLocalAuth
Activer ou désactiver l’authentification aad
Lorsque la valeur est true, la connexion à AuthType=aad ne fonctionne pas.		 bool
disableLocalAuth DésactiverLocalAuth
Activer ou désactiver l’authentification locale avec AccessKey
Lorsque la valeur est true, la connexion à AccessKey=xxx ne fonctionne pas.		 bool
features Liste des featureFlags.

Les 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 n’inclura que les 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. La valeur par défaut est « Enabled ».
Lorsqu’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 ce que vous définissez dans les listes de contrôle d’accès réseau.		 string
regionEndpointEnabled Activez ou désactivez le point de terminaison régional. La valeur par défaut est « Enabled ».
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 réplica spécifique. Désactivez le point de terminaison régional sans réplica n’est pas autorisé.		 string
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 ».
Quand il est vrai, le plan de données de la ressource est arrêté.
Lorsqu’il est false, le plan de données de la ressource est démarré.		 string
Serverless Paramètres serverless. ServerlessSettings
Tls Paramètres TLS pour la ressource SignalRTlsSettings
upstream Paramètres de l’amont lorsque le service est en mode sans serveur. ServerlessUpstreamSettings

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 les autoriser toutes. En cas d’omission, autorisez tout par défaut. string[]

SignalRFeature

Nom Description Valeur
flag 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 » : avoir votre propre serveur principal ; « Serverless » : votre application n’a pas de serveur principal ; « Classic » : pour la compatibilité descendante. Prend en charge à la fois les modes Par défaut et Serverless, mais non recommandé ; « PrédéfiniOnly » : pour une utilisation ultérieure.
- EnableConnectivityLogs : « true »/« false », pour activer/désactiver la catégorie de journal de connectivité respectivement.
- EnableMessagingLogs : « true »/« false », pour activer/désactiver la catégorie de journal de connectivité respectivement.
- EnableLiveTrace : La trace dynamique vous permet de savoir ce qui se passe à l’intérieur du service Azure SignalR. Elle vous donnera des traces en temps réel. Elle vous sera utile lorsque vous développez votre propre application web basée sur Azure SignalR ou vous dépanner automatiquement certains problèmes. Notez que les traces actives sont comptabilisées comme des 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)
properties Propriétés facultatives liées à cette fonctionnalité. SignalRFeatureProperties
value Valeur de l’indicateur de fonctionnalité. Consultez le document de https://docs.microsoft.com/azure/azure-signalr/ service Azure SignalR pour connaître les valeurs autorisées. chaîne (obligatoire)

Contraintes :
Longueur minimale = 1
Longueur maximale = 128

SignalRFeatureProperties

Nom Description Valeur
{propriété personnalisée} string

LiveTraceConfiguration

Nom Description Valeur
categories Obtient ou définit la liste des configurations de catégorie. LiveTraceCategory[]
enabled Indique si la trace dynamique est activé ou non.
Lorsqu’il est défini sur true, le client de trace dynamique peut se connecter au service.
Sinon, le client de trace dynamique ne peut pas se connecter au service, de sorte que vous ne pouvez pas recevoir de journal, quel que soit ce que vous configurez dans les « catégories ».
Valeurs disponibles : true, false.
Ne respecte pas la casse.
 string

LiveTraceCategory

Nom Description Valeur
enabled Indique si ou la catégorie de trace dynamique est activée.
Valeurs disponibles : true, false.
Ne respecte pas la casse.		 string
name Obtient ou définit le nom de la catégorie de trace dynamique.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Ne respecte pas la casse.
 string

SignalRNetworkACLs

Nom Description Valeur
defaultAction Action de la liste de contrôle d’accès réseau Azure. 'Autoriser'
'Deny'
ipRules Règles IP pour le filtrage du trafic public IPRule[]

Contraintes :
Longueur maximale = 30
privateEndpoints Listes de contrôle d’accès pour les demandes provenant de points de terminaison privés PrivateEndpointACL[]
publicNetwork Liste de contrôle d'accès réseau NetworkACL

IPRule

Nom Description Valeur
action Action de la liste de contrôle d’accès réseau Azure. 'Autoriser'
'Deny'
value Adresse IP, CIDR ou ServiceTag string

PrivateEndpointACL

Nom Description Valeur
allow Types de requêtes autorisés. La valeur peut être un ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
deny Types de requêtes refusés. La valeur peut être un ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
name Nom de la connexion de point de terminaison privé string (obligatoire)

NetworkACL

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

ResourceLogConfiguration

Nom Description Valeur
categories Obtient ou définit la liste des configurations de catégorie. ResourceLogCategory[]

ResourceLogCategory

Nom Description Valeur
enabled Indique si ou la catégorie de journal de ressources est activée.
Valeurs disponibles : true, false.
Ne respecte pas la casse.		 string
name Obtient ou définit le nom de la catégorie de journal de ressources.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Ne respecte pas la casse.
 string

ServerlessSettings

Nom Description Valeur
connectionTimeoutInSeconds Obtient ou définit le délai d’expiration de connexion du client. Facultatif à définir.
Valeur en secondes.
La valeur par défaut est 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 souhaitent 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 active 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

SignalRTlsSettings

Nom Description Valeur
clientCertEnabled Demander un certificat client pendant la négociation TLS si cette option est activée. Non pris en charge pour le niveau gratuit. Toute entrée sera ignorée pour le niveau gratuit. bool

ServerlessUpstreamSettings

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

UpstreamTemplate

Nom Description Valeur
auth Paramètres d’authentification en amont. Si elle n’est pas définie, aucune authentification n’est utilisée pour amont messages. 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.
Trois types de modèles sont pris en charge :
1. « * », il correspond à n’importe quel nom de catégorie.
2. Combinez plusieurs catégories avec « , », par exemple « connexions, messages », il correspond à la catégorie « connexions » et « messages ».
3. Le nom de catégorie unique, par exemple, « connections », il correspond à la catégorie « connections ».		 string
eventPattern Obtient ou définit le modèle correspondant pour les noms d’événements. S’il n’est pas défini, il correspond à n’importe quel événement.
Trois types de modèles sont 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 d’événement unique, par exemple, « connect », il correspond à « connect ».		 string
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.
Trois types de modèles sont 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. Le nom du hub unique, par exemple, « hub1 », il correspond à « hub1 ».		 string
urlTemplate Obtient ou définit le modèle d’URL en amont. Vous pouvez utiliser 3 paramètres prédéfinis {hub}, {category} {event} dans le modèle. La valeur de l’URL en amont est calculée dynamiquement lorsque la demande du client arrive.
Par exemple, si urlTemplate est http://example.com/{hub}/api/{event}, avec une requête cliente provenant du hub chat se connecte, il commence par POST vers cette URL : http://example.com/chat/api/connect.
 string (obligatoire)

UpstreamAuthSettings

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

ManagedIdentitySettings

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

ResourceSku

Nom Description Valeur
capacité Facultatif, entier. Nombre d’unités de la ressource. 1 par défaut.

Le cas échéant, les valeurs suivantes sont autorisées :
Gratuit : 1 ;
Standard : 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100 ;
Premium : 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100 ;		 int
name Nom de la référence SKU. Obligatoire.

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

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

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 Azure SignalR Service à 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 des ressources

Pour créer une ressource Microsoft.SignalRService/signalR, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR@2023-08-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      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
      }
      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"
    }
    kind = "string"
  })
}

Valeurs de propriétés

signalR

Nom Description Valeur
type Type de ressource « Microsoft.SignalRService/signalR@2023-08-01-preview »
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 3-63

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit commencer par une lettre. Doit se terminer par une lettre ou un chiffre.

Le nom de la ressource doit être unique dans Azure.
location Emplacement géographique où réside la ressource chaîne (obligatoire)
parent_id Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources. chaîne (obligatoire)
tags Balises de ressource. Dictionnaire de noms et de valeurs d’étiquettes.
sku Informations de facturation de la ressource. ResourceSku
kind Type de service « RawWebSockets »
« SignalR »
identité Une classe représente les identités managées utilisées pour la demande et la réponse ManagedIdentity
properties Classe qui décrit les propriétés de la ressource SignalRProperties

ManagedIdentity

Nom Description Valeur
type Représente le type d’identité : systemAssigned, userAssigned, None « SystemAssigned »
« UserAssigned »
identity_ids Obtenir ou définir les identités affectées par l’utilisateur Tableau d’ID d’identité utilisateur.

ManagedIdentityUserAssignedIdentities

Nom Description Valeur
{propriété personnalisée} UserAssignedIdentityProperty

UserAssignedIdentityProperty

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

SignalRProperties

Nom Description Valeur
cors Paramètres CORS (Cross-Origin Resource Sharing). SignalRCorsSettings
disableAadAuth DésactiverLocalAuth
Activer ou désactiver l’authentification aad
Lorsque la valeur est true, la connexion à AuthType=aad ne fonctionne pas.		 bool
disableLocalAuth DésactiverLocalAuth
Activer ou désactiver l’authentification locale avec AccessKey
Lorsque la valeur est true, la connexion à AccessKey=xxx ne fonctionne pas.		 bool
features Liste des featureFlags.

Les 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 n’inclura que les 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. La valeur par défaut est « Enabled ».
Lorsqu’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 ce que vous définissez dans les listes de contrôle d’accès réseau.		 string
regionEndpointEnabled Activez ou désactivez le point de terminaison régional. La valeur par défaut est « Enabled ».
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 réplica spécifique. Désactivez le point de terminaison régional sans réplica n’est pas autorisé.		 string
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 ».
Quand il est vrai, le plan de données de la ressource est arrêté.
Lorsqu’il est false, le plan de données de la ressource est démarré.		 string
Serverless Paramètres serverless. ServerlessSettings
Tls Paramètres TLS pour la ressource SignalRTlsSettings
upstream Paramètres de l’amont lorsque le service est en mode sans serveur. ServerlessUpstreamSettings

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 les autoriser toutes. En cas d’omission, autorisez tout par défaut. string[]

SignalRFeature

Nom Description Valeur
flag 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 » : avoir votre propre serveur principal ; « Serverless » : votre application n’a pas de serveur principal ; « Classic » : pour la compatibilité descendante. Prend en charge à la fois les modes Par défaut et Serverless, mais non recommandé ; « PrédéfiniOnly » : pour une utilisation ultérieure.
- EnableConnectivityLogs : « true »/« false », pour activer/désactiver la catégorie de journal de connectivité respectivement.
- EnableMessagingLogs : « true »/« false », pour activer/désactiver la catégorie de journal de connectivité respectivement.
- EnableLiveTrace : La trace dynamique vous permet de savoir ce qui se passe à l’intérieur du service Azure SignalR. Elle vous donnera des traces en temps réel. Elle vous sera utile lorsque vous développez votre propre application web basée sur Azure SignalR ou vous dépanner automatiquement certains problèmes. Notez que les traces actives sont comptabilisées comme des 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)
properties Propriétés facultatives liées à cette fonctionnalité. SignalRFeatureProperties
value Valeur de l’indicateur de fonctionnalité. Consultez le document de https://docs.microsoft.com/azure/azure-signalr/ service Azure SignalR pour connaître les valeurs autorisées. chaîne (obligatoire)

Contraintes :
Longueur minimale = 1
Longueur maximale = 128

SignalRFeatureProperties

Nom Description Valeur
{propriété personnalisée} string

LiveTraceConfiguration

Nom Description Valeur
categories Obtient ou définit la liste des configurations de catégorie. LiveTraceCategory[]
enabled Indique si ou non activer 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 dynamique ne peut pas se connecter au service, de sorte que vous ne pouvez pas recevoir de journal, quelle que soit la configuration que vous configurez dans les « catégories ».
Valeurs disponibles : true, false.
Ne respecte pas la casse.
 string

LiveTraceCategory

Nom Description Valeur
enabled Indique si ou la catégorie de trace dynamique est activée.
Valeurs disponibles : true, false.
Ne respecte pas la casse.		 string
name Obtient ou définit le nom de la catégorie de trace dynamique.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Ne respecte pas la casse.
 string

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[]

Contraintes :
Longueur maximale = 30
privateEndpoints Listes de contrôle d’accès pour les requêtes provenant de points de terminaison privés PrivateEndpointACL[]
publicNetwork Liste de contrôle d'accès réseau NetworkACL

IPRule

Nom Description Valeur
action Action de liste de contrôle d’accès réseau Azure. « Autoriser »
« Refuser »
value Adresse IP ou CIDR ou ServiceTag string

PrivateEndpointACL

Nom Description Valeur
allow Types de requêtes autorisés. La valeur peut être un ou plusieurs des éléments suivants : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
« ClientConnection »
« RESTAPI »
« ServerConnection »
« Trace »
deny Types de demandes refusées. La valeur peut être un ou plusieurs des éléments suivants : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
« ClientConnection »
« RESTAPI »
« ServerConnection »
« Trace »
name Nom de la connexion de point de terminaison privé chaîne (obligatoire)

NetworkACL

Nom Description Valeur
allow Types de requêtes autorisés. La valeur peut être un ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
« ClientConnection »
« RESTAPI »
« ServerConnection »
« Trace »
deny Types de requêtes refusés. La valeur peut être un ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. Tableau de chaînes contenant l’un des éléments suivants :
« ClientConnection »
« RESTAPI »
« ServerConnection »
« Trace »

ResourceLogConfiguration

Nom Description Valeur
categories Obtient ou définit la liste des configurations de catégorie. ResourceLogCategory[]

ResourceLogCategory

Nom Description Valeur
enabled Indique si ou la catégorie de journal de ressources est activée.
Valeurs disponibles : true, false.
Ne respecte pas la casse.		 string
name Obtient ou définit le nom de la catégorie de journal de ressources.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Ne respecte pas la casse.
 string

ServerlessSettings

Nom Description Valeur
connectionTimeoutInSeconds Obtient ou définit le délai d’expiration de connexion du client. Facultatif à définir.
Valeur en secondes.
La valeur par défaut est 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 souhaitent 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 active 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

SignalRTlsSettings

Nom Description Valeur
clientCertEnabled Demander un certificat client pendant la négociation TLS si cette option est activée. Non pris en charge pour le niveau gratuit. Toute entrée sera ignorée pour le niveau gratuit. bool

ServerlessUpstreamSettings

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

UpstreamTemplate

Nom Description Valeur
auth Paramètres d’authentification en amont. Si elle n’est pas définie, aucune authentification n’est utilisée pour amont messages. 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.
Trois types de modèles sont pris en charge :
1. « * », il correspond à n’importe quel nom de catégorie.
2. Combinez plusieurs catégories avec « , », par exemple « connexions, messages », il correspond à la catégorie « connexions » et « messages ».
3. Le nom de catégorie unique, par exemple, « connections », il correspond à la catégorie « connections ».		 string
eventPattern Obtient ou définit le modèle correspondant pour les noms d’événements. S’il n’est pas défini, il correspond à n’importe quel événement.
Trois types de modèles sont 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 d’événement unique, par exemple, « connect », il correspond à « connect ».		 string
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.
Trois types de modèles sont 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. Le nom du hub unique, par exemple, « hub1 », il correspond à « hub1 ».		 string
urlTemplate Obtient ou définit le modèle d’URL en amont. Vous pouvez utiliser 3 paramètres prédéfinis {hub}, {category} {event} dans le modèle. La valeur de l’URL en amont est calculée dynamiquement lorsque la demande du client arrive.
Par exemple, si urlTemplate est http://example.com/{hub}/api/{event}, avec une requête cliente provenant du hub chat se connecte, il commence par POST vers cette URL : http://example.com/chat/api/connect.
 string (obligatoire)

UpstreamAuthSettings

Nom Description Valeur
managedIdentity Paramètres d’identité managée pour amont. ManagedIdentitySettings
type Énumération du type d’authentification en amont. « ManagedIdentity »
"None"

ManagedIdentitySettings

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

ResourceSku

Nom Description Valeur
capacité Facultatif, entier. Nombre d’unités de la ressource. 1 par défaut.

Le cas échéant, les valeurs suivantes sont autorisées :
Gratuit : 1 ;
Standard : 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100 ;
Prime : 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100 ;		 int
name Nom de la référence SKU. Obligatoire.

Valeurs autorisées : Standard_S1, Free_F1 Premium_P1		 string (obligatoire)
Niveau Niveau facultatif de cette référence SKU particulière. « Standard » ou « Gratuit ».

Basic est déconseillé, utilisez Standard à la place.
 "Basic"
« Gratuit »
« Premium »
« Standard »