Partager via

Microsoft.SignalRService signalR 2021-10-01

  • 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@2021-10-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    disableAadAuth: bool
    disableLocalAuth: bool
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    networkACLs: {
      defaultAction: 'string'
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
    }
    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'
  }
}

Valeurs de propriété

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 Le type de service, il peut s’agir de SignalR ou RawWebSockets 'RawWebSockets'
'SignalR'
emplacement Emplacement GÉOGRAPHIQUE de la ressource. par exemple, USA Ouest USA Est Centre-Nord des États-Unis USA Centre Sud. corde
nom Nom de la ressource chaîne (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 par défaut.

Si elles sont présentes, les valeurs suivantes sont autorisées :
Gratuit : 1
Standard : 1 2 5 10 20 50 100		 Int
nom Nom de la référence SKU. Obligatoire.

Valeurs autorisées : Standard_S1, Free_F1		 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'

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'
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
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[]
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
resourceLogConfiguration Configuration du journal des ressources d’une ressource Microsoft.SignalRService. ResourceLogConfiguration
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 Demander un certificat client pendant l’établissement d’une liaison TLS s’il est activé Bool

TrackedResourceTags

Nom Description Valeur

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. Combiner 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. Combiner plusieurs événements avec « », par exemple « se connecter, déconnecter », il correspond à l’événement « connect » et à « disconnect »
3. Le nom de l’événement unique, par exemple, « connect », il 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. Combiner plusieurs hubs avec « », par exemple « hub1, hub2 », il correspond à « hub1 » et « hub2 »
3. Le nom du hub unique, par exemple « hub1 », 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": "2021-10-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "disableAadAuth": "bool",
    "disableLocalAuth": "bool",
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "networkACLs": {
      "defaultAction": "string",
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "resourceLogConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ]
    },
    "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"
  }
}

Valeurs de propriété

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 '2021-10-01'
identité Une classe représente les identités managées utilisées pour la demande et la réponse managedIdentity
gentil Le type de service, il peut s’agir de SignalR ou RawWebSockets 'RawWebSockets'
'SignalR'
emplacement Emplacement GÉOGRAPHIQUE de la ressource. par exemple, USA Ouest USA Est Centre-Nord des États-Unis USA Centre Sud. corde
nom Nom de la ressource chaîne (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 par défaut.

Si elles sont présentes, les valeurs suivantes sont autorisées :
Gratuit : 1
Standard : 1 2 5 10 20 50 100		 Int
nom Nom de la référence SKU. Obligatoire.

Valeurs autorisées : Standard_S1, Free_F1		 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'

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'
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
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[]
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
resourceLogConfiguration Configuration du journal des ressources d’une ressource Microsoft.SignalRService. ResourceLogConfiguration
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 Demander un certificat client pendant l’établissement d’une liaison TLS s’il est activé Bool

TrackedResourceTags

Nom Description Valeur

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. Combiner 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. Combiner plusieurs événements avec « », par exemple « se connecter, déconnecter », il correspond à l’événement « connect » et à « disconnect »
3. Le nom de l’événement unique, par exemple, « connect », il 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. Combiner plusieurs hubs avec « », par exemple « hub1, hub2 », il correspond à « hub1 » et « hub2 »
3. Le nom du hub unique, par exemple « hub1 », 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@2021-10-01"
  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 = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      disableAadAuth = bool
      disableLocalAuth = bool
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      networkACLs = {
        defaultAction = "string"
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      resourceLogConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
      }
      tls = {
        clientCertEnabled = bool
      }
      upstream = {
        templates = [
          {
            auth = {
              managedIdentity = {
                resource = "string"
              }
              type = "string"
            }
            categoryPattern = "string"
            eventPattern = "string"
            hubPattern = "string"
            urlTemplate = "string"
          }
        ]
      }
    }
  })
}

Valeurs de propriété

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 Le type de service, il peut s’agir de SignalR ou RawWebSockets 'RawWebSockets'
'SignalR'
emplacement Emplacement GÉOGRAPHIQUE de la ressource. par exemple, USA Ouest USA Est Centre-Nord des États-Unis USA Centre Sud. corde
nom Nom de la ressource chaîne (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@2021-10-01 »

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 par défaut.

Si elles sont présentes, les valeurs suivantes sont autorisées :
Gratuit : 1
Standard : 1 2 5 10 20 50 100		 Int
nom Nom de la référence SKU. Obligatoire.

Valeurs autorisées : Standard_S1, Free_F1		 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'

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'
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
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[]
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
resourceLogConfiguration Configuration du journal des ressources d’une ressource Microsoft.SignalRService. ResourceLogConfiguration
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 Demander un certificat client pendant l’établissement d’une liaison TLS s’il est activé Bool

TrackedResourceTags

Nom Description Valeur

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. Combiner 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. Combiner plusieurs événements avec « », par exemple « se connecter, déconnecter », il correspond à l’événement « connect » et à « disconnect »
3. Le nom de l’événement unique, par exemple, « connect », il 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. Combiner plusieurs hubs avec « », par exemple « hub1, hub2 », il correspond à « hub1 » et « hub2 »
3. Le nom du hub unique, par exemple « hub1 », 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