Partager via

Microsoft.SignalRService webPubSub 2021-09-01-preview

Définition de ressource Bicep

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

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

Format de ressource

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

resource symbolicname 'Microsoft.SignalRService/webPubSub@2021-09-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    disableAadAuth: bool
    disableLocalAuth: bool
    eventHandler: {
      items: {
        {customized property}: [
          {
            auth: {
              managedIdentity: {
                resource: 'string'
              }
              type: 'string'
            }
            systemEventPattern: 'string'
            urlTemplate: 'string'
            userEventPattern: 'string'
          }
        ]
      }
    }
    liveTraceConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
      enabled: 'string'
    }
    networkACLs: {
      defaultAction: 'string'
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    tls: {
      clientCertEnabled: bool
    }
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

Microsoft.SignalRService/webPubSub

Nom Descriptif Valeur
identité Réponse de l’identité managée managedIdentity
emplacement Emplacement GÉOGRAPHIQUE de la ressource. par exemple, USA Ouest | USA Est | USA Centre Nord | USA Centre Sud. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Paramètres utilisés pour provisionner ou configurer la ressource webPubSubProperties
Sku Informations de facturation de la ressource. (par exemple, Gratuit, Standard) ResourceSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

EventHandlerSettings

Nom Descriptif Valeur
Articles Obtient ou définit les éléments EventHandler. La clé est le nom du hub et la valeur correspond à EventHandlerTemplate correspondant. EventHandlerSettingsItems

EventHandlerSettingsItems

Nom Descriptif Valeur

EventHandlerTemplate

Nom Descriptif Valeur
Auth Obtient ou définit les paramètres d’authentification d’un gestionnaire d’événements. Si ce n’est pas défini, aucune authentification n’est utilisée. UpstreamAuthSettings
systemEventPattern Obtient ot définit le modèle d’événement système.
Il existe 2 types de modèles pris en charge :
1. Le nom de l’événement unique, par exemple, « connect », il correspond à « connect »
2. Combiner plusieurs événements avec « », par exemple « se connecter, déconnecté », il correspond à l’événement « connect » et à « déconnecté »		 corde
urlModèle Obtient ou définit le modèle d’URL EventHandler. Vous pouvez utiliser un paramètre prédéfini {hub} et {event} à l’intérieur du modèle, la valeur de l’URL EventHandler est calculée dynamiquement lorsque la demande cliente est entrée.
Par exemple, UrlTemplate peut être http://example.com/api/{hub}/{event}. Le composant hôte ne peut pas contenir de paramètres.		 chaîne (obligatoire)
userEventPattern Obtient ou définit le modèle correspondant pour les noms d’événements.
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 « event1,event2 », il correspond à l’événement « event1 » et à « event2 »
3. Nom de l’événement unique, par exemple « event1 », il correspond à « event1 »		 corde

LiveTraceCatégorie

Nom Descriptif Valeur
Activé Indique si la catégorie de journal 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.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Respect de la casse.		 corde

LiveTraceConfiguration

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

Identitémanagée

Nom Descriptif Valeur
type Représenter le type d’identité : systemAssigned, userAssigned, None « Aucun »
'SystemAssigned'
'UserAssigned'
Identités attribuées par l'utilisateur Obtenir ou définir les identités affectées par l’utilisateur ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

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

NetworkACL

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

PrivateEndpointACL

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

ResourceSku

Nom Descriptif 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'
« Gratuit »
« Haut de gamme »
« Standard »

TrackedResourceTags

Nom Descriptif Valeur

AmontAuthParamètres

Nom Descriptif Valeur
managedIdentity Obtient ou définit les paramètres d’identité managée. Elle est requise si le type d’authentification est défini sur ManagedIdentity. ManagedIdentitySettings
type Obtient ou définit le type d’authentification. Aucun ou ManagedIdentity n’est désormais pris en charge. 'ManagedIdentity'
« Aucun »

UserAssignedIdentityProperty

Nom Descriptif Valeur

WebPubSubNetworkACLs

Nom Descriptif Valeur
defaultAction Action par défaut quand aucune autre règle ne correspond '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 pour les requêtes provenant du réseau public networkACL

WebPubSubProperties

Nom Descriptif Valeur
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
eventHandler Paramètres du gestionnaire d’événements dans le service webpubsub. EventHandlerSettings
liveTraceConfiguration Configuration de trace dynamique d’une ressource Microsoft.SignalRService. liveTraceConfiguration
réseauACLs Listes de contrôle d’accès réseau WebPubSubNetworkACLs
publicNetworkAccess Activez ou désactivez l’accès au réseau public. Valeur par défaut « Activé ».
Quand elle est activée, les listes de contrôle d’accès réseau s’appliquent toujours.
Lorsqu’il est désactivé, l’accès au réseau public est toujours désactivé, quel que soit le paramètre défini dans les listes de contrôle d’accès réseau.		 corde
TLS Paramètres TLS. WebPubSubTlsSettings

WebPubSubTlsSettings

Nom Descriptif Valeur
clientCertEnabled Demander un certificat client pendant l’établissement d’une liaison TLS s’il est activé Bool

Exemples d’utilisation

Exemples Bicep

Exemple de base de déploiement du service Azure Web PubSub.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource webPubSub 'Microsoft.SignalRService/webPubSub@2023-02-01' = {
  name: resourceName
  location: location
  properties: {
    disableAadAuth: false
    disableLocalAuth: false
    publicNetworkAccess: 'Enabled'
    tls: {
      clientCertEnabled: false
    }
  }
  sku: {
    capacity: 1
    name: 'Standard_S1'
  }
}

Modules vérifiés Azure

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

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

Exemples de démarrage rapide Azure

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

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

Définition de ressource de modèle ARM

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

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

Format de ressource

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

{
  "type": "Microsoft.SignalRService/webPubSub",
  "apiVersion": "2021-09-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "disableAadAuth": "bool",
    "disableLocalAuth": "bool",
    "eventHandler": {
      "items": {
        "{customized property}": [
          {
            "auth": {
              "managedIdentity": {
                "resource": "string"
              },
              "type": "string"
            },
            "systemEventPattern": "string",
            "urlTemplate": "string",
            "userEventPattern": "string"
          }
        ]
      }
    },
    "liveTraceConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ],
      "enabled": "string"
    },
    "networkACLs": {
      "defaultAction": "string",
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "tls": {
      "clientCertEnabled": "bool"
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

Microsoft.SignalRService/webPubSub

Nom Descriptif Valeur
apiVersion Version de l’API '2021-09-01-preview'
identité Réponse de l’identité managée managedIdentity
emplacement Emplacement GÉOGRAPHIQUE de la ressource. par exemple, USA Ouest | USA Est | USA Centre Nord | USA Centre Sud. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Paramètres utilisés pour provisionner ou configurer la ressource webPubSubProperties
Sku Informations de facturation de la ressource. (par exemple, Gratuit, Standard) ResourceSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.SignalRService/webPubSub'

EventHandlerSettings

Nom Descriptif Valeur
Articles Obtient ou définit les éléments EventHandler. La clé est le nom du hub et la valeur correspond à EventHandlerTemplate correspondant. EventHandlerSettingsItems

EventHandlerSettingsItems

Nom Descriptif Valeur

EventHandlerTemplate

Nom Descriptif Valeur
Auth Obtient ou définit les paramètres d’authentification d’un gestionnaire d’événements. Si ce n’est pas défini, aucune authentification n’est utilisée. UpstreamAuthSettings
systemEventPattern Obtient ot définit le modèle d’événement système.
Il existe 2 types de modèles pris en charge :
1. Le nom de l’événement unique, par exemple, « connect », il correspond à « connect »
2. Combiner plusieurs événements avec « », par exemple « se connecter, déconnecté », il correspond à l’événement « connect » et à « déconnecté »		 corde
urlModèle Obtient ou définit le modèle d’URL EventHandler. Vous pouvez utiliser un paramètre prédéfini {hub} et {event} à l’intérieur du modèle, la valeur de l’URL EventHandler est calculée dynamiquement lorsque la demande cliente est entrée.
Par exemple, UrlTemplate peut être http://example.com/api/{hub}/{event}. Le composant hôte ne peut pas contenir de paramètres.		 chaîne (obligatoire)
userEventPattern Obtient ou définit le modèle correspondant pour les noms d’événements.
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 « event1,event2 », il correspond à l’événement « event1 » et à « event2 »
3. Nom de l’événement unique, par exemple « event1 », il correspond à « event1 »		 corde

LiveTraceCatégorie

Nom Descriptif Valeur
Activé Indique si la catégorie de journal 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.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Respect de la casse.		 corde

LiveTraceConfiguration

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

Identitémanagée

Nom Descriptif Valeur
type Représenter le type d’identité : systemAssigned, userAssigned, None « Aucun »
'SystemAssigned'
'UserAssigned'
Identités attribuées par l'utilisateur Obtenir ou définir les identités affectées par l’utilisateur ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

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

NetworkACL

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

PrivateEndpointACL

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

ResourceSku

Nom Descriptif 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'
« Gratuit »
« Haut de gamme »
« Standard »

TrackedResourceTags

Nom Descriptif Valeur

AmontAuthParamètres

Nom Descriptif Valeur
managedIdentity Obtient ou définit les paramètres d’identité managée. Elle est requise si le type d’authentification est défini sur ManagedIdentity. ManagedIdentitySettings
type Obtient ou définit le type d’authentification. Aucun ou ManagedIdentity n’est désormais pris en charge. 'ManagedIdentity'
« Aucun »

UserAssignedIdentityProperty

Nom Descriptif Valeur

WebPubSubNetworkACLs

Nom Descriptif Valeur
defaultAction Action par défaut quand aucune autre règle ne correspond '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 pour les requêtes provenant du réseau public networkACL

WebPubSubProperties

Nom Descriptif Valeur
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
eventHandler Paramètres du gestionnaire d’événements dans le service webpubsub. EventHandlerSettings
liveTraceConfiguration Configuration de trace dynamique d’une ressource Microsoft.SignalRService. liveTraceConfiguration
réseauACLs Listes de contrôle d’accès réseau WebPubSubNetworkACLs
publicNetworkAccess Activez ou désactivez l’accès au réseau public. Valeur par défaut « Activé ».
Quand elle est activée, les listes de contrôle d’accès réseau s’appliquent toujours.
Lorsqu’il est désactivé, l’accès au réseau public est toujours désactivé, quel que soit le paramètre défini dans les listes de contrôle d’accès réseau.		 corde
TLS Paramètres TLS. WebPubSubTlsSettings

WebPubSubTlsSettings

Nom Descriptif Valeur
clientCertEnabled Demander un certificat client pendant l’établissement d’une liaison TLS s’il est activé Bool

Exemples d’utilisation

Modèles de démarrage rapide Azure

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

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

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

Définition de ressource Terraform (fournisseur AzAPI)

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

  • Groupes de ressources

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

Format de ressource

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/webPubSub@2021-09-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      disableAadAuth = bool
      disableLocalAuth = bool
      eventHandler = {
        items = {
          {customized property} = [
            {
              auth = {
                managedIdentity = {
                  resource = "string"
                }
                type = "string"
              }
              systemEventPattern = "string"
              urlTemplate = "string"
              userEventPattern = "string"
            }
          ]
        }
      }
      liveTraceConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
        enabled = "string"
      }
      networkACLs = {
        defaultAction = "string"
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      tls = {
        clientCertEnabled = bool
      }
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  }
}

Valeurs de propriété

Microsoft.SignalRService/webPubSub

Nom Descriptif Valeur
identité Réponse de l’identité managée managedIdentity
emplacement Emplacement GÉOGRAPHIQUE de la ressource. par exemple, USA Ouest | USA Est | USA Centre Nord | USA Centre Sud. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Paramètres utilisés pour provisionner ou configurer la ressource webPubSubProperties
Sku Informations de facturation de la ressource. (par exemple, Gratuit, Standard) ResourceSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.SignalRService/webPubSub@2021-09-01-preview »

EventHandlerSettings

Nom Descriptif Valeur
Articles Obtient ou définit les éléments EventHandler. La clé est le nom du hub et la valeur correspond à EventHandlerTemplate correspondant. EventHandlerSettingsItems

EventHandlerSettingsItems

Nom Descriptif Valeur

EventHandlerTemplate

Nom Descriptif Valeur
Auth Obtient ou définit les paramètres d’authentification d’un gestionnaire d’événements. Si ce n’est pas défini, aucune authentification n’est utilisée. UpstreamAuthSettings
systemEventPattern Obtient ot définit le modèle d’événement système.
Il existe 2 types de modèles pris en charge :
1. Le nom de l’événement unique, par exemple, « connect », il correspond à « connect »
2. Combiner plusieurs événements avec « », par exemple « se connecter, déconnecté », il correspond à l’événement « connect » et à « déconnecté »		 corde
urlModèle Obtient ou définit le modèle d’URL EventHandler. Vous pouvez utiliser un paramètre prédéfini {hub} et {event} à l’intérieur du modèle, la valeur de l’URL EventHandler est calculée dynamiquement lorsque la demande cliente est entrée.
Par exemple, UrlTemplate peut être http://example.com/api/{hub}/{event}. Le composant hôte ne peut pas contenir de paramètres.		 chaîne (obligatoire)
userEventPattern Obtient ou définit le modèle correspondant pour les noms d’événements.
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 « event1,event2 », il correspond à l’événement « event1 » et à « event2 »
3. Nom de l’événement unique, par exemple « event1 », il correspond à « event1 »		 corde

LiveTraceCatégorie

Nom Descriptif Valeur
Activé Indique si la catégorie de journal 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.
Valeurs disponibles : ConnectivityLogs, MessagingLogs.
Respect de la casse.		 corde

LiveTraceConfiguration

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

Identitémanagée

Nom Descriptif Valeur
type Représenter le type d’identité : systemAssigned, userAssigned, None « Aucun »
'SystemAssigned'
'UserAssigned'
Identités attribuées par l'utilisateur Obtenir ou définir les identités affectées par l’utilisateur ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

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

NetworkACL

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

PrivateEndpointACL

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

ResourceSku

Nom Descriptif 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'
« Gratuit »
« Haut de gamme »
« Standard »

TrackedResourceTags

Nom Descriptif Valeur

AmontAuthParamètres

Nom Descriptif Valeur
managedIdentity Obtient ou définit les paramètres d’identité managée. Elle est requise si le type d’authentification est défini sur ManagedIdentity. ManagedIdentitySettings
type Obtient ou définit le type d’authentification. Aucun ou ManagedIdentity n’est désormais pris en charge. 'ManagedIdentity'
« Aucun »

UserAssignedIdentityProperty

Nom Descriptif Valeur

WebPubSubNetworkACLs

Nom Descriptif Valeur
defaultAction Action par défaut quand aucune autre règle ne correspond '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 pour les requêtes provenant du réseau public networkACL

WebPubSubProperties

Nom Descriptif Valeur
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
eventHandler Paramètres du gestionnaire d’événements dans le service webpubsub. EventHandlerSettings
liveTraceConfiguration Configuration de trace dynamique d’une ressource Microsoft.SignalRService. liveTraceConfiguration
réseauACLs Listes de contrôle d’accès réseau WebPubSubNetworkACLs
publicNetworkAccess Activez ou désactivez l’accès au réseau public. Valeur par défaut « Activé ».
Quand elle est activée, les listes de contrôle d’accès réseau s’appliquent toujours.
Lorsqu’il est désactivé, l’accès au réseau public est toujours désactivé, quel que soit le paramètre défini dans les listes de contrôle d’accès réseau.		 corde
TLS Paramètres TLS. WebPubSubTlsSettings

WebPubSubTlsSettings

Nom Descriptif Valeur
clientCertEnabled Demander un certificat client pendant l’établissement d’une liaison TLS s’il est activé Bool

Exemples d’utilisation

Échantillons Terraform

Exemple de base de déploiement du service Azure Web PubSub.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "webPubSub" {
  type      = "Microsoft.SignalRService/webPubSub@2023-02-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      disableAadAuth      = false
      disableLocalAuth    = false
      publicNetworkAccess = "Enabled"
      tls = {
        clientCertEnabled = false
      }
    }
    sku = {
      capacity = 1
      name     = "Standard_S1"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on