Partager via


Microsoft.SignalRService signalR 2018-10-01

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@2018-10-01' = {
  location: 'string'
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    hostNamePrefix: 'string'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

Microsoft.SignalRService/signalR

Nom Description Valeur
emplacement Région Azure GEO : par exemple, USA Ouest USA Est Centre-Nord des États-Unis États-Unis - partie centrale méridionale Europe Ouest Europe Nord Asie de l’Est Asie du Sud-Est etc.
La zone géographique d’une ressource ne change jamais après sa création.
chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Paramètres utilisés pour provisionner ou configurer la ressource SignalRCreateOrUpdatePropertiesOrSignalRProperties
Sku Informations de facturation de la ressource. (par exemple, de base ou standard) ResourceSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

ResourceSku

Nom Description Valeur
capacité Facultatif, entier. Nombre d’unités de la ressource SignalR. 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
Famille Chaîne facultative. Pour une utilisation ultérieure. corde
nom Nom de la référence SKU. Obligatoire.

Valeurs autorisées : Standard_S1, Free_F1
chaîne (obligatoire)
taille Chaîne facultative. Pour une utilisation ultérieure. corde
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'

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

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Nom Description Valeur
cors Paramètres CORS (Cross-Origin Resource Sharing). SignalRCorsSettings
fonctionnalités Liste des fonctionnalités SignalRFlags. Par exemple, ServiceMode.

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, le service SignalR utilise sa valeur globale par défaut.
Mais gardez à l’esprit que la valeur par défaut ne signifie pas « false ». Il varie en termes de FeatureFlags différents.
SignalRFeature[]
hostNamePrefix Préfixe pour le nom d’hôte du service SignalR. Conservé pour une utilisation ultérieure.
Le nom d’hôte sera au format : <hostNamePrefix>.service.signalr.net.
corde

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é.
'EnableConnectivityLogs'
'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

SignalRUpdateParametersTags

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": "2018-10-01",
  "name": "string",
  "location": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "hostNamePrefix": "string"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

Microsoft.SignalRService/signalR

Nom Description Valeur
apiVersion Version de l’API '2018-10-01'
emplacement Région Azure GEO : par exemple, USA Ouest USA Est Centre-Nord des États-Unis États-Unis - partie centrale méridionale Europe Ouest Europe Nord Asie de l’Est Asie du Sud-Est etc.
La zone géographique d’une ressource ne change jamais après sa création.
chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Paramètres utilisés pour provisionner ou configurer la ressource SignalRCreateOrUpdatePropertiesOrSignalRProperties
Sku Informations de facturation de la ressource. (par exemple, de base ou 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/signalR'

ResourceSku

Nom Description Valeur
capacité Facultatif, entier. Nombre d’unités de la ressource SignalR. 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
Famille Chaîne facultative. Pour une utilisation ultérieure. corde
nom Nom de la référence SKU. Obligatoire.

Valeurs autorisées : Standard_S1, Free_F1
chaîne (obligatoire)
taille Chaîne facultative. Pour une utilisation ultérieure. corde
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'

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

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Nom Description Valeur
cors Paramètres CORS (Cross-Origin Resource Sharing). SignalRCorsSettings
fonctionnalités Liste des fonctionnalités SignalRFlags. Par exemple, ServiceMode.

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, le service SignalR utilise sa valeur globale par défaut.
Mais gardez à l’esprit que la valeur par défaut ne signifie pas « false ». Il varie en termes de FeatureFlags différents.
SignalRFeature[]
hostNamePrefix Préfixe pour le nom d’hôte du service SignalR. Conservé pour une utilisation ultérieure.
Le nom d’hôte sera au format : <hostNamePrefix>.service.signalr.net.
corde

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é.
'EnableConnectivityLogs'
'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

SignalRUpdateParametersTags

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@2018-10-01"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      hostNamePrefix = "string"
    }
  })
}

Valeurs de propriété

Microsoft.SignalRService/signalR

Nom Description Valeur
emplacement Région Azure GEO : par exemple, USA Ouest USA Est Centre-Nord des États-Unis États-Unis - partie centrale méridionale Europe Ouest Europe Nord Asie de l’Est Asie du Sud-Est etc.
La zone géographique d’une ressource ne change jamais après sa création.
chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Paramètres utilisés pour provisionner ou configurer la ressource SignalRCreateOrUpdatePropertiesOrSignalRProperties
Sku Informations de facturation de la ressource. (par exemple, de base ou standard) ResourceSku
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.SignalRService/signalR@2018-10-01 »

ResourceSku

Nom Description Valeur
capacité Facultatif, entier. Nombre d’unités de la ressource SignalR. 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
Famille Chaîne facultative. Pour une utilisation ultérieure. corde
nom Nom de la référence SKU. Obligatoire.

Valeurs autorisées : Standard_S1, Free_F1
chaîne (obligatoire)
taille Chaîne facultative. Pour une utilisation ultérieure. corde
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'

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

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Nom Description Valeur
cors Paramètres CORS (Cross-Origin Resource Sharing). SignalRCorsSettings
fonctionnalités Liste des fonctionnalités SignalRFlags. Par exemple, ServiceMode.

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, le service SignalR utilise sa valeur globale par défaut.
Mais gardez à l’esprit que la valeur par défaut ne signifie pas « false ». Il varie en termes de FeatureFlags différents.
SignalRFeature[]
hostNamePrefix Préfixe pour le nom d’hôte du service SignalR. Conservé pour une utilisation ultérieure.
Le nom d’hôte sera au format : <hostNamePrefix>.service.signalr.net.
corde

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é.
'EnableConnectivityLogs'
'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

SignalRUpdateParametersTags

Nom Description Valeur