Microsoft.SignalRService signalR 2023-06-01-preview
- dernière
- 2024-10-01-preview
- 2024-08-01-preview
- 2024-04-01-preview
- 2024-03-01
- 2024-01-01-preview
- 2023-08-01-preview
- 2023-06-01-preview
- 2023-03-01-preview
- 2023-02-01
- 2022-08-01-preview
- 2022-02-01
- 2021-10-01
- 2021-09-01-preview
- 2021-06-01-preview
- 2021-04-01-preview
- 2020-07-01-preview
- 2020-05-01
- 2018-10-01
- 2018-03-01-preview
Définition de ressource Bicep
Le type de ressource signalR peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de 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 le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.SignalRService/signalR@2023-06-01-preview' = {
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'
}
]
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'
resourceLogConfiguration: {
categories: [
{
enabled: 'string'
name: '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'
}
tags: {
{customized property}: 'string'
}
}
Valeurs de propriété
LiveTraceCategory
Nom | Description | Valeur |
---|---|---|
Activé | Indique si la catégorie de trace dynamique est activée ou si elle est activée. Valeurs disponibles : true, false. Respect de la casse. |
corde |
nom | Obtient ou définit le nom de la catégorie de trace dynamique. Valeurs disponibles : ConnectivityLogs, MessagingLogs. Respect de la casse. |
corde |
LiveTraceConfiguration
Nom | Description | Valeur |
---|---|---|
Catégories | Obtient ou définit la liste des configurations de catégorie. | liveTraceCategory[] |
Activé | Indique si vous activez ou non la trace dynamique. Lorsqu’il est défini sur true, le client de trace dynamique peut se connecter au service. Sinon, le client de suivi en direct ne peut pas se connecter au service, afin que vous ne puissiez pas recevoir de journal, quelle que soit la configuration dans « catégories ». Valeurs disponibles : true, false. Respect de la casse. |
corde |
ManagedIdentity
Nom | Description | Valeur |
---|---|---|
type | Représente le type d’identité : systemAssigned, userAssigned, None | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | Obtenir ou définir les identités affectées par l’utilisateur | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
Nom | Description | Valeur |
---|---|---|
ressource | Ressource indiquant l’URI d’ID d’application de la ressource cible. Il apparaît également dans la revendication aud (audience) du jeton émis. |
corde |
ManagedIdentityUserAssignedIdentities
Nom | Description | Valeur |
---|
Microsoft.SignalRService/signalR
Nom | Description | Valeur |
---|---|---|
identité | Une classe représente les identités managées utilisées pour la demande et la réponse | managedIdentity |
gentil | Type de service | 'RawWebSockets' 'SignalR' |
emplacement | Emplacement géographique où réside la ressource | chaîne (obligatoire) |
nom | Nom de la ressource | corde Contraintes: Longueur minimale = 3 Longueur maximale = 3 Modèle = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obligatoire) |
Propriétés | Classe qui décrit les propriétés de la ressource | SignalRProperties |
Sku | Informations de facturation de la ressource. | ResourceSku |
étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles |
NetworkACL
Nom | Description | Valeur |
---|---|---|
permettre | Types de requêtes autorisés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
nier | Types de demandes refusés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
PrivateEndpointACL
Nom | Description | Valeur |
---|---|---|
permettre | Types de requêtes autorisés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
nier | Types de demandes refusés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
nom | Nom de la connexion de point de terminaison privé | chaîne (obligatoire) |
ResourceLogCategory
Nom | Description | Valeur |
---|---|---|
Activé | Indique si la catégorie du journal des ressources est activée. Valeurs disponibles : true, false. Respect de la casse. |
corde |
nom | Obtient ou définit le nom de la catégorie de journal des ressources. Valeurs disponibles : ConnectivityLogs, MessagingLogs. Respect de la casse. |
corde |
ResourceLogConfiguration
Nom | Description | Valeur |
---|---|---|
Catégories | Obtient ou définit la liste des configurations de catégorie. | ResourceLogCategory[] |
ResourceSku
Nom | Description | Valeur |
---|---|---|
capacité | Facultatif, entier. Nombre d’unités de la ressource. 1 par défaut. Si elles sont présentes, 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 |
nom | 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 'Gratuit'. Basic est déconseillé, utilisez Standard à la place. |
'De base' 'Free' 'Premium' 'Standard' |
ServerlessSettings
Nom | Description | Valeur |
---|---|---|
connectionTimeoutInSeconds | Obtient ou définit le délai d’expiration de la connexion du client. Facultatif à définir. Valeur en secondes. La valeur par défaut est de 30 secondes. Le client doit définir le délai d’expiration sur une période plus courte si les messages sont censés être envoyés dans des intervalles plus courts, et souhaitez que le client se déconnecte plus rapidement après l’envoi du dernier message. Vous pouvez définir le délai d’expiration sur une période plus longue si les messages sont censés être envoyés dans des intervalles plus longs, et ils souhaitent conserver la même connexion cliente pendant cette session. Le service considère que le client est déconnecté s’il n’a pas reçu de message (y compris keep-alive) dans cet intervalle. |
Int Contraintes: Valeur minimale = 1 Valeur maximale = 120 |
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[] |
liveTraceConfiguration | Configuration de trace dynamique d’une ressource Microsoft.SignalRService. | liveTraceConfiguration |
networkACLs | Listes de contrôle d’accès réseau pour la ressource | SignalRNetworkACLs |
publicNetworkAccess | Activez ou désactivez l’accès au réseau public. Valeur par défaut « Activé ». Quand elle est activée, les listes de contrôle d’accès réseau s’appliquent toujours. Lorsqu’il est désactivé, l’accès au réseau public est toujours désactivé, quel que soit le paramètre défini dans les listes de contrôle d’accès réseau. |
corde |
resourceLogConfiguration | Configuration du journal des ressources d’une ressource Microsoft.SignalRService. | ResourceLogConfiguration |
serverless | Paramètres serverless. | ServerlessSettings |
tls | Paramètres TLS de la ressource | SignalRTlsSettings |
en amont | Paramètres de l’amont lorsque le service est en mode sans serveur. | ServerlessUpstreamSettings |
SignalRTlsSettings
Nom | Description | Valeur |
---|---|---|
clientCertEnabled | Demandez un certificat client lors de l’établissement d’une liaison TLS s’il est activé. Non pris en charge pour le niveau gratuit. Toute entrée est ignorée pour le niveau gratuit. | Bool |
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
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 :
- groupes de ressources - Consultez commandes de déploiement de 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 le code JSON suivant à votre modèle.
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2023-06-01-preview",
"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"
}
],
"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",
"resourceLogConfiguration": {
"categories": [
{
"enabled": "string",
"name": "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"
},
"tags": {
"{customized property}": "string"
}
}
Valeurs de propriété
LiveTraceCategory
Nom | Description | Valeur |
---|---|---|
Activé | Indique si la catégorie de trace dynamique est activée ou si elle est activée. Valeurs disponibles : true, false. Respect de la casse. |
corde |
nom | Obtient ou définit le nom de la catégorie de trace dynamique. Valeurs disponibles : ConnectivityLogs, MessagingLogs. Respect de la casse. |
corde |
LiveTraceConfiguration
Nom | Description | Valeur |
---|---|---|
Catégories | Obtient ou définit la liste des configurations de catégorie. | liveTraceCategory[] |
Activé | Indique si vous activez ou non la trace dynamique. Lorsqu’il est défini sur true, le client de trace dynamique peut se connecter au service. Sinon, le client de suivi en direct ne peut pas se connecter au service, afin que vous ne puissiez pas recevoir de journal, quelle que soit la configuration dans « catégories ». Valeurs disponibles : true, false. Respect de la casse. |
corde |
ManagedIdentity
Nom | Description | Valeur |
---|---|---|
type | Représente le type d’identité : systemAssigned, userAssigned, None | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | Obtenir ou définir les identités affectées par l’utilisateur | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
Nom | Description | Valeur |
---|---|---|
ressource | Ressource indiquant l’URI d’ID d’application de la ressource cible. Il apparaît également dans la revendication aud (audience) du jeton émis. |
corde |
ManagedIdentityUserAssignedIdentities
Nom | Description | Valeur |
---|
Microsoft.SignalRService/signalR
Nom | Description | Valeur |
---|---|---|
apiVersion | Version de l’API | '2023-06-01-preview' |
identité | Une classe représente les identités managées utilisées pour la demande et la réponse | managedIdentity |
gentil | Type de service | 'RawWebSockets' 'SignalR' |
emplacement | Emplacement géographique où réside la ressource | chaîne (obligatoire) |
nom | Nom de la ressource | corde Contraintes: Longueur minimale = 3 Longueur maximale = 3 Modèle = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obligatoire) |
Propriétés | Classe qui décrit les propriétés de la ressource | SignalRProperties |
Sku | Informations de facturation de la ressource. | ResourceSku |
étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles |
type | Type de ressource | 'Microsoft.SignalRService/signalR' |
NetworkACL
Nom | Description | Valeur |
---|---|---|
permettre | Types de requêtes autorisés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
nier | Types de demandes refusés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
PrivateEndpointACL
Nom | Description | Valeur |
---|---|---|
permettre | Types de requêtes autorisés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
nier | Types de demandes refusés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
nom | Nom de la connexion de point de terminaison privé | chaîne (obligatoire) |
ResourceLogCategory
Nom | Description | Valeur |
---|---|---|
Activé | Indique si la catégorie du journal des ressources est activée. Valeurs disponibles : true, false. Respect de la casse. |
corde |
nom | Obtient ou définit le nom de la catégorie de journal des ressources. Valeurs disponibles : ConnectivityLogs, MessagingLogs. Respect de la casse. |
corde |
ResourceLogConfiguration
Nom | Description | Valeur |
---|---|---|
Catégories | Obtient ou définit la liste des configurations de catégorie. | ResourceLogCategory[] |
ResourceSku
Nom | Description | Valeur |
---|---|---|
capacité | Facultatif, entier. Nombre d’unités de la ressource. 1 par défaut. Si elles sont présentes, 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 |
nom | 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 'Gratuit'. Basic est déconseillé, utilisez Standard à la place. |
'De base' 'Free' 'Premium' 'Standard' |
ServerlessSettings
Nom | Description | Valeur |
---|---|---|
connectionTimeoutInSeconds | Obtient ou définit le délai d’expiration de la connexion du client. Facultatif à définir. Valeur en secondes. La valeur par défaut est de 30 secondes. Le client doit définir le délai d’expiration sur une période plus courte si les messages sont censés être envoyés dans des intervalles plus courts, et souhaitez que le client se déconnecte plus rapidement après l’envoi du dernier message. Vous pouvez définir le délai d’expiration sur une période plus longue si les messages sont censés être envoyés dans des intervalles plus longs, et ils souhaitent conserver la même connexion cliente pendant cette session. Le service considère que le client est déconnecté s’il n’a pas reçu de message (y compris keep-alive) dans cet intervalle. |
Int Contraintes: Valeur minimale = 1 Valeur maximale = 120 |
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[] |
liveTraceConfiguration | Configuration de trace dynamique d’une ressource Microsoft.SignalRService. | liveTraceConfiguration |
networkACLs | Listes de contrôle d’accès réseau pour la ressource | SignalRNetworkACLs |
publicNetworkAccess | Activez ou désactivez l’accès au réseau public. Valeur par défaut « Activé ». Quand elle est activée, les listes de contrôle d’accès réseau s’appliquent toujours. Lorsqu’il est désactivé, l’accès au réseau public est toujours désactivé, quel que soit le paramètre défini dans les listes de contrôle d’accès réseau. |
corde |
resourceLogConfiguration | Configuration du journal des ressources d’une ressource Microsoft.SignalRService. | ResourceLogConfiguration |
serverless | Paramètres serverless. | ServerlessSettings |
tls | Paramètres TLS de la ressource | SignalRTlsSettings |
en amont | Paramètres de l’amont lorsque le service est en mode sans serveur. | ServerlessUpstreamSettings |
SignalRTlsSettings
Nom | Description | Valeur |
---|---|---|
clientCertEnabled | Demandez un certificat client lors de l’établissement d’une liaison TLS s’il est activé. Non pris en charge pour le niveau gratuit. Toute entrée est ignorée pour le niveau gratuit. | Bool |
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
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 |
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@2023-06-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
kind = "string"
location = "string"
sku = {
capacity = int
name = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
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"
privateEndpoints = [
{
allow = [
"string"
]
deny = [
"string"
]
name = "string"
}
]
publicNetwork = {
allow = [
"string"
]
deny = [
"string"
]
}
}
publicNetworkAccess = "string"
resourceLogConfiguration = {
categories = [
{
enabled = "string"
name = "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é
LiveTraceCategory
Nom | Description | Valeur |
---|---|---|
Activé | Indique si la catégorie de trace dynamique est activée ou si elle est activée. Valeurs disponibles : true, false. Respect de la casse. |
corde |
nom | Obtient ou définit le nom de la catégorie de trace dynamique. Valeurs disponibles : ConnectivityLogs, MessagingLogs. Respect de la casse. |
corde |
LiveTraceConfiguration
Nom | Description | Valeur |
---|---|---|
Catégories | Obtient ou définit la liste des configurations de catégorie. | liveTraceCategory[] |
Activé | Indique si vous activez ou non la trace dynamique. Lorsqu’il est défini sur true, le client de trace dynamique peut se connecter au service. Sinon, le client de suivi en direct ne peut pas se connecter au service, afin que vous ne puissiez pas recevoir de journal, quelle que soit la configuration dans « catégories ». Valeurs disponibles : true, false. Respect de la casse. |
corde |
ManagedIdentity
Nom | Description | Valeur |
---|---|---|
type | Représente le type d’identité : systemAssigned, userAssigned, None | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | Obtenir ou définir les identités affectées par l’utilisateur | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
Nom | Description | Valeur |
---|---|---|
ressource | Ressource indiquant l’URI d’ID d’application de la ressource cible. Il apparaît également dans la revendication aud (audience) du jeton émis. |
corde |
ManagedIdentityUserAssignedIdentities
Nom | Description | Valeur |
---|
Microsoft.SignalRService/signalR
Nom | Description | Valeur |
---|---|---|
identité | Une classe représente les identités managées utilisées pour la demande et la réponse | managedIdentity |
gentil | Type de service | 'RawWebSockets' 'SignalR' |
emplacement | Emplacement géographique où réside la ressource | chaîne (obligatoire) |
nom | Nom de la ressource | corde Contraintes: Longueur minimale = 3 Longueur maximale = 3 Modèle = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obligatoire) |
Propriétés | Classe qui décrit les propriétés de la ressource | SignalRProperties |
Sku | Informations de facturation de la ressource. | ResourceSku |
étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. |
type | Type de ressource | « Microsoft.SignalRService/signalR@2023-06-01-preview » |
NetworkACL
Nom | Description | Valeur |
---|---|---|
permettre | Types de requêtes autorisés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
nier | Types de demandes refusés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
PrivateEndpointACL
Nom | Description | Valeur |
---|---|---|
permettre | Types de requêtes autorisés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
nier | Types de demandes refusés. La valeur peut être une ou plusieurs de : ClientConnection, ServerConnection, RESTAPI. | Tableau de chaînes contenant l’un des éléments suivants : 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
nom | Nom de la connexion de point de terminaison privé | chaîne (obligatoire) |
ResourceLogCategory
Nom | Description | Valeur |
---|---|---|
Activé | Indique si la catégorie du journal des ressources est activée. Valeurs disponibles : true, false. Respect de la casse. |
corde |
nom | Obtient ou définit le nom de la catégorie de journal des ressources. Valeurs disponibles : ConnectivityLogs, MessagingLogs. Respect de la casse. |
corde |
ResourceLogConfiguration
Nom | Description | Valeur |
---|---|---|
Catégories | Obtient ou définit la liste des configurations de catégorie. | ResourceLogCategory[] |
ResourceSku
Nom | Description | Valeur |
---|---|---|
capacité | Facultatif, entier. Nombre d’unités de la ressource. 1 par défaut. Si elles sont présentes, 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 |
nom | 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 'Gratuit'. Basic est déconseillé, utilisez Standard à la place. |
'De base' 'Free' 'Premium' 'Standard' |
ServerlessSettings
Nom | Description | Valeur |
---|---|---|
connectionTimeoutInSeconds | Obtient ou définit le délai d’expiration de la connexion du client. Facultatif à définir. Valeur en secondes. La valeur par défaut est de 30 secondes. Le client doit définir le délai d’expiration sur une période plus courte si les messages sont censés être envoyés dans des intervalles plus courts, et souhaitez que le client se déconnecte plus rapidement après l’envoi du dernier message. Vous pouvez définir le délai d’expiration sur une période plus longue si les messages sont censés être envoyés dans des intervalles plus longs, et ils souhaitent conserver la même connexion cliente pendant cette session. Le service considère que le client est déconnecté s’il n’a pas reçu de message (y compris keep-alive) dans cet intervalle. |
Int Contraintes: Valeur minimale = 1 Valeur maximale = 120 |
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[] |
liveTraceConfiguration | Configuration de trace dynamique d’une ressource Microsoft.SignalRService. | liveTraceConfiguration |
networkACLs | Listes de contrôle d’accès réseau pour la ressource | SignalRNetworkACLs |
publicNetworkAccess | Activez ou désactivez l’accès au réseau public. Valeur par défaut « Activé ». Quand elle est activée, les listes de contrôle d’accès réseau s’appliquent toujours. Lorsqu’il est désactivé, l’accès au réseau public est toujours désactivé, quel que soit le paramètre défini dans les listes de contrôle d’accès réseau. |
corde |
resourceLogConfiguration | Configuration du journal des ressources d’une ressource Microsoft.SignalRService. | ResourceLogConfiguration |
serverless | Paramètres serverless. | ServerlessSettings |
tls | Paramètres TLS de la ressource | SignalRTlsSettings |
en amont | Paramètres de l’amont lorsque le service est en mode sans serveur. | ServerlessUpstreamSettings |
SignalRTlsSettings
Nom | Description | Valeur |
---|---|---|
clientCertEnabled | Demandez un certificat client lors de l’établissement d’une liaison TLS s’il est activé. Non pris en charge pour le niveau gratuit. Toute entrée est ignorée pour le niveau gratuit. | Bool |
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
UserAssignedIdentityProperty
Nom | Description | Valeur |
---|