Condividi tramite

Microsoft.SignalRService signalR 2023-08-01-preview

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa signalR può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.SignalRService/signalR, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.SignalRService/signalR@2023-08-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'
      ipRules: [
        {
          action: 'string'
          value: 'string'
        }
      ]
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    regionEndpointEnabled: 'string'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
    }
    resourceStopped: 'string'
    serverless: {
      connectionTimeoutInSeconds: int
    }
    tls: {
      clientCertEnabled: bool
    }
    upstream: {
      templates: [
        {
          auth: {
            managedIdentity: {
              resource: 'string'
            }
            type: 'string'
          }
          categoryPattern: 'string'
          eventPattern: 'string'
          hubPattern: 'string'
          urlTemplate: 'string'
        }
      ]
    }
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

IPRule

Nome Descrizione Valore
azione Azione ACL di rete di Azure. 'Consenti'
'Deny'
valore Ip o CIDR o ServiceTag corda

LiveTraceCategory

Nome Descrizione Valore
Abilitato Indica se o la categoria di traccia dinamica è abilitata.
Valori disponibili: true, false.
Senza distinzione tra maiuscole e minuscole.		 corda
nome Ottiene o imposta il nome della categoria di traccia dinamica.
Valori disponibili: ConnectivityLogs, MessagingLogs.
Senza distinzione tra maiuscole e minuscole.		 corda

LiveTraceConfiguration

Nome Descrizione Valore
Categorie Ottiene o imposta l'elenco delle configurazioni di categoria. LiveTraceCategory[]
Abilitato Indica se abilitare o meno la traccia in tempo reale.
Quando è impostato su true, il client di traccia dinamica può connettersi al servizio.
In caso contrario, il client di traccia dinamica non può connettersi al servizio, in modo che non sia possibile ricevere alcun log, indipendentemente da ciò che si configura in "categorie".
Valori disponibili: true, false.
Senza distinzione tra maiuscole e minuscole.		 corda

ManagedIdentity

Nome Descrizione Valore
digitare Rappresenta il tipo di identità: systemAssigned, userAssigned, None 'Nessuno'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Ottenere o impostare le identità assegnate dall'utente ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Nome Descrizione Valore
risorsa Risorsa che indica l'URI ID app della risorsa di destinazione.
Viene visualizzato anche nell'attestazione aud (audience) del token rilasciato.		 corda

ManagedIdentityUserAssignedIdentities

Nome Descrizione Valore

Microsoft.SignalRService/signalR

Nome Descrizione Valore
identità Una classe rappresenta le identità gestite usate per la richiesta e la risposta ManagedIdentity
gentile Tipo di servizio 'RawWebSockets'
'SignalR'
ubicazione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 3
Lunghezza massima = 3
Pattern = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obbligatorio)
proprietà Classe che descrive le proprietà della risorsa SignalRProperties
Sku Informazioni di fatturazione della risorsa. resourceSku
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

NetworkACL

Nome Descrizione Valore
permettere Tipi di richiesta consentiti. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI. Matrice di stringhe contenente uno dei seguenti elementi:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
negare Tipi di richiesta negati. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI. Matrice di stringhe contenente uno dei seguenti elementi:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'

PrivateEndpointACL

Nome Descrizione Valore
permettere Tipi di richiesta consentiti. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI. Matrice di stringhe contenente uno dei seguenti elementi:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
negare Tipi di richiesta negati. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI. Matrice di stringhe contenente uno dei seguenti elementi:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nome Nome della connessione all'endpoint privato stringa (obbligatorio)

ResourceLogCategory

Nome Descrizione Valore
Abilitato Indica se o la categoria del log delle risorse è abilitata.
Valori disponibili: true, false.
Senza distinzione tra maiuscole e minuscole.		 corda
nome Ottiene o imposta il nome della categoria del log delle risorse.
Valori disponibili: ConnectivityLogs, MessagingLogs.
Senza distinzione tra maiuscole e minuscole.		 corda

ResourceLogConfiguration

Nome Descrizione Valore
Categorie Ottiene o imposta l'elenco delle configurazioni di categoria. ResourceLogCategory[]

ResourceSku

Nome Descrizione Valore
capacità Numero intero facoltativo. Numero di unità della risorsa. 1 per impostazione predefinita.

Se presente, sono consentiti i valori seguenti:
Gratuito: 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
nome Nome dello SKU. Obbligatorio.

Valori consentiti: Standard_S1, Free_F1, Premium_P1		 stringa (obbligatorio)
livello Livello facoltativo di questo SKU specifico. 'Standard' o 'Free'.

Basic è deprecato, usare Standard.		 'Basic'
'Free'
'Premium'
'Standard'

ServerlessSettings

Nome Descrizione Valore
connectionTimeoutInSeconds Ottiene o imposta il timeout connessione client. Facoltativo da impostare.
Valore in secondi.
Il valore predefinito è 30 secondi.
Il cliente deve impostare il timeout su un periodo più breve se i messaggi devono essere inviati in intervalli più brevi,
e desidera che il client si disconnette più rapidamente dopo l'invio dell'ultimo messaggio.
È possibile impostare il timeout su un periodo più lungo se si prevede che i messaggi vengano inviati in intervalli più lunghi,
e vogliono mantenere attiva la stessa connessione client durante questa sessione.
Il servizio considera il client disconnesso se non ha ricevuto un messaggio (incluso keep-alive) in questo intervallo.		 Int

Vincoli:
Valore minimo = 1
Valore massimo = 120

ServerlessUpstreamSettings

Nome Descrizione Valore
Modelli Ottiene o imposta l'elenco dei modelli di URL upstream. L'ordine è importante e il primo modello corrispondente ha effetti. UpstreamTemplate []

SignalRCorsSettings

Nome Descrizione Valore
allowedOrigins Ottiene o imposta l'elenco di origini che devono essere autorizzate a effettuare chiamate tra le origini, ad esempio http://example.com:12345. Usare "*" per consentire tutto. Se omesso, consentire tutto per impostazione predefinita. string[]

SignalRFeature

Nome Descrizione Valore
bandiera FeatureFlags è la funzionalità supportata del servizio Azure SignalR.
- ServiceMode: flag per il server back-end per il servizio SignalR. Valori consentiti: "Default": have your own backend server; "Serverless": l'applicazione non ha un server back-end; "Classic": per compatibilità con le versioni precedenti. Supporta sia la modalità predefinita che quella serverless, ma non consigliata; "PredefinedOnly": per un uso futuro.
- EnableConnectivityLogs: "true"/"false", per abilitare/disabilitare rispettivamente la categoria del log di connettività.
- EnableMessagingLogs: "true"/"false", per abilitare/disabilitare rispettivamente la categoria del log di connettività.
- EnableLiveTrace: Live Trace consente di sapere cosa sta accadendo all'interno del servizio Azure SignalR, che fornirà tracce in tempo reale, sarà utile quando si sviluppa un'applicazione Web basata su Azure SignalR o si risolveranno in autonomia alcuni problemi. Si noti che le tracce in tempo reale vengono conteggiate come messaggi in uscita che verranno addebitati. Valori consentiti: "true"/"false", per abilitare/disabilitare la funzionalità di traccia in tempo reale.		 'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'ServiceMode' (obbligatorio)
proprietà Proprietà facoltative correlate a questa funzionalità. SignalRFeatureProperties
valore Valore del flag di funzionalità. Per i valori consentiti, vedere il documento del servizio Azure SignalR /azure/azure-signalr/. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)

SignalRFeatureProperties

Nome Descrizione Valore

SignalRNetworkACLs

Nome Descrizione Valore
defaultAction Azione ACL di rete di Azure. 'Consenti'
'Deny'
ipRules Regole IP per filtrare il traffico pubblico IPRule[]
privateEndpoints ACL per le richieste da endpoint privati PrivateEndpointACL []
publicNetwork ACL di rete NetworkACL

SignalRProperties

Nome Descrizione Valore
cors Impostazioni CORS (Cross-Origin Resource Sharing). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Abilitare o disabilitare l'autenticazione aad
Se impostato su true, la connessione con AuthType=aad non funzionerà.		 Bool
disableLocalAuth DisableLocalAuth
Abilitare o disabilitare l'autenticazione locale con AccessKey
Se impostato su true, la connessione con AccessKey=xxx non funzionerà.		 Bool
tratti somatici Elenco delle featureFlags.

FeatureFlags non inclusi nei parametri per l'operazione di aggiornamento non verranno modificati.
E la risposta includerà solo featureFlags impostati in modo esplicito.
Quando un featureFlag non è impostato in modo esplicito, verrà usato il relativo valore predefinito globale
Tenere tuttavia presente che il valore predefinito non significa "false". Varia in termini di featureFlags diversi.		 SignalRFeature[]
liveTraceConfiguration Configurazione della traccia in tempo reale di una risorsa Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACL di rete per la risorsa SignalRNetworkACLs
publicNetworkAccess Abilitare o disabilitare l'accesso alla rete pubblica. L'impostazione predefinita è "Enabled".
Quando è Abilitato, gli elenchi di controllo di accesso di rete vengono ancora applicati.
Quando è Disabilitato, l'accesso alla rete pubblica viene sempre disabilitato indipendentemente dall'impostazione negli elenchi di controllo di accesso di rete.		 corda
regionEndpointEnabled Abilitare o disabilitare l'endpoint a livello di area. L'impostazione predefinita è "Enabled".
Quando è Disabilitato, le nuove connessioni non verranno instradate a questo endpoint, ma le connessioni esistenti non saranno interessate.
Questa proprietà è specifica della replica. Disabilitare l'endpoint a livello di area senza replica non è consentito.		 corda
resourceLogConfiguration Configurazione del log delle risorse di una risorsa Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Arrestare o avviare la risorsa. Il valore predefinito è "False".
Quando è vero, il piano dati della risorsa viene arrestato.
Quando è false, viene avviato il piano dati della risorsa.		 corda
serverless Impostazioni serverless. ServerlessSettings
tls Impostazioni TLS per la risorsa SignalRTlsSettings
controcorrente Impostazioni per Upstream quando il servizio è in modalità senza server. serverlessUpstreamSettings

SignalRTlsSettings

Nome Descrizione Valore
clientCertEnabled Richiedere il certificato client durante l'handshake TLS, se abilitato. Non supportato per il livello gratuito. Qualsiasi input verrà ignorato per il livello gratuito. Bool

TrackedResourceTags

Nome Descrizione Valore

UpstreamAuthSettings

Nome Descrizione Valore
managedIdentity Impostazioni di identità gestite per upstream. ManagedIdentitySettings
digitare Enumerazione del tipo di autenticazione upstream. 'ManagedIdentity'
'Nessuno'

UpstreamTemplate

Nome Descrizione Valore
Auth Impostazioni di autenticazione upstream. Se non è impostata, non viene usata alcuna autenticazione per i messaggi upstream. upstreamAuthSettings
categoryPattern Ottiene o imposta il criterio di corrispondenza per i nomi delle categorie. Se non è impostata, corrisponde a qualsiasi categoria.
Sono supportati 3 tipi di modelli:
1. "*", corrisponde a qualsiasi nome di categoria.
2. Combinare più categorie con ",", ad esempio "connessioni, messaggi", corrisponde alla categoria "connessioni" e "messaggi".
3. Il nome della singola categoria, ad esempio "connections", corrisponde alla categoria "connections".		 corda
eventPattern Ottiene o imposta il criterio di corrispondenza per i nomi degli eventi. Se non è impostato, corrisponde a qualsiasi evento.
Sono supportati 3 tipi di modelli:
1. "*", corrisponde a qualsiasi nome di evento.
2. Combinare più eventi con ",", ad esempio "connect,disconnect", corrisponde all'evento "connect" e "disconnect".
3. Il nome dell'evento singolo, ad esempio , "connect", corrisponde a "connect".		 corda
hubPattern Ottiene o imposta il modello di corrispondenza per i nomi dell'hub. Se non è impostato, corrisponde a qualsiasi hub.
Sono supportati 3 tipi di modelli:
1. "*", corrisponde a qualsiasi nome dell'hub.
2. Combinare più hub con ",", ad esempio "hub1,hub2", corrisponde a "hub1" e "hub2".
3. Il nome dell'hub singolo, ad esempio "hub1", corrisponde a "hub1".		 corda
urlTemplate Ottiene o imposta il modello di URL Upstream. È possibile usare 3 parametri predefiniti {hub}, {category} {event} all'interno del modello, il valore dell'URL upstream viene calcolato in modo dinamico quando arriva la richiesta client.
Ad esempio, se urlTemplate è http://example.com/{hub}/api/{event}, con una richiesta client dall'hub chat si connette, eseguirà prima post a questo URL: http://example.com/chat/api/connect.		 stringa (obbligatorio)

UserAssignedIdentityProperty

Nome Descrizione Valore

Esempi di avvio rapido

Gli esempi di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Bicep File Descrizione
Distribuire un servizio Azure SignalR Questo modello crea un servizio Azure SignalR usando un modello.

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa signalR può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.SignalRService/signalR, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2023-08-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",
      "ipRules": [
        {
          "action": "string",
          "value": "string"
        }
      ],
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "regionEndpointEnabled": "string",
    "resourceLogConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ]
    },
    "resourceStopped": "string",
    "serverless": {
      "connectionTimeoutInSeconds": "int"
    },
    "tls": {
      "clientCertEnabled": "bool"
    },
    "upstream": {
      "templates": [
        {
          "auth": {
            "managedIdentity": {
              "resource": "string"
            },
            "type": "string"
          },
          "categoryPattern": "string",
          "eventPattern": "string",
          "hubPattern": "string",
          "urlTemplate": "string"
        }
      ]
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

IPRule

Nome Descrizione Valore
azione Azione ACL di rete di Azure. 'Consenti'
'Deny'
valore Ip o CIDR o ServiceTag corda

LiveTraceCategory

Nome Descrizione Valore
Abilitato Indica se o la categoria di traccia dinamica è abilitata.
Valori disponibili: true, false.
Senza distinzione tra maiuscole e minuscole.		 corda
nome Ottiene o imposta il nome della categoria di traccia dinamica.
Valori disponibili: ConnectivityLogs, MessagingLogs.
Senza distinzione tra maiuscole e minuscole.		 corda

LiveTraceConfiguration

Nome Descrizione Valore
Categorie Ottiene o imposta l'elenco delle configurazioni di categoria. LiveTraceCategory[]
Abilitato Indica se abilitare o meno la traccia in tempo reale.
Quando è impostato su true, il client di traccia dinamica può connettersi al servizio.
In caso contrario, il client di traccia dinamica non può connettersi al servizio, in modo che non sia possibile ricevere alcun log, indipendentemente da ciò che si configura in "categorie".
Valori disponibili: true, false.
Senza distinzione tra maiuscole e minuscole.		 corda

ManagedIdentity

Nome Descrizione Valore
digitare Rappresenta il tipo di identità: systemAssigned, userAssigned, None 'Nessuno'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Ottenere o impostare le identità assegnate dall'utente ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Nome Descrizione Valore
risorsa Risorsa che indica l'URI ID app della risorsa di destinazione.
Viene visualizzato anche nell'attestazione aud (audience) del token rilasciato.		 corda

ManagedIdentityUserAssignedIdentities

Nome Descrizione Valore

Microsoft.SignalRService/signalR

Nome Descrizione Valore
apiVersion Versione dell'API '2023-08-01-preview'
identità Una classe rappresenta le identità gestite usate per la richiesta e la risposta ManagedIdentity
gentile Tipo di servizio 'RawWebSockets'
'SignalR'
ubicazione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 3
Lunghezza massima = 3
Pattern = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obbligatorio)
proprietà Classe che descrive le proprietà della risorsa SignalRProperties
Sku Informazioni di fatturazione della risorsa. resourceSku
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.SignalRService/signalR'

NetworkACL

Nome Descrizione Valore
permettere Tipi di richiesta consentiti. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI. Matrice di stringhe contenente uno dei seguenti elementi:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
negare Tipi di richiesta negati. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI. Matrice di stringhe contenente uno dei seguenti elementi:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'

PrivateEndpointACL

Nome Descrizione Valore
permettere Tipi di richiesta consentiti. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI. Matrice di stringhe contenente uno dei seguenti elementi:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
negare Tipi di richiesta negati. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI. Matrice di stringhe contenente uno dei seguenti elementi:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nome Nome della connessione all'endpoint privato stringa (obbligatorio)

ResourceLogCategory

Nome Descrizione Valore
Abilitato Indica se o la categoria del log delle risorse è abilitata.
Valori disponibili: true, false.
Senza distinzione tra maiuscole e minuscole.		 corda
nome Ottiene o imposta il nome della categoria del log delle risorse.
Valori disponibili: ConnectivityLogs, MessagingLogs.
Senza distinzione tra maiuscole e minuscole.		 corda

ResourceLogConfiguration

Nome Descrizione Valore
Categorie Ottiene o imposta l'elenco delle configurazioni di categoria. ResourceLogCategory[]

ResourceSku

Nome Descrizione Valore
capacità Numero intero facoltativo. Numero di unità della risorsa. 1 per impostazione predefinita.

Se presente, sono consentiti i valori seguenti:
Gratuito: 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
nome Nome dello SKU. Obbligatorio.

Valori consentiti: Standard_S1, Free_F1, Premium_P1		 stringa (obbligatorio)
livello Livello facoltativo di questo SKU specifico. 'Standard' o 'Free'.

Basic è deprecato, usare Standard.		 'Basic'
'Free'
'Premium'
'Standard'

ServerlessSettings

Nome Descrizione Valore
connectionTimeoutInSeconds Ottiene o imposta il timeout connessione client. Facoltativo da impostare.
Valore in secondi.
Il valore predefinito è 30 secondi.
Il cliente deve impostare il timeout su un periodo più breve se i messaggi devono essere inviati in intervalli più brevi,
e desidera che il client si disconnette più rapidamente dopo l'invio dell'ultimo messaggio.
È possibile impostare il timeout su un periodo più lungo se si prevede che i messaggi vengano inviati in intervalli più lunghi,
e vogliono mantenere attiva la stessa connessione client durante questa sessione.
Il servizio considera il client disconnesso se non ha ricevuto un messaggio (incluso keep-alive) in questo intervallo.		 Int

Vincoli:
Valore minimo = 1
Valore massimo = 120

ServerlessUpstreamSettings

Nome Descrizione Valore
Modelli Ottiene o imposta l'elenco dei modelli di URL upstream. L'ordine è importante e il primo modello corrispondente ha effetti. UpstreamTemplate []

SignalRCorsSettings

Nome Descrizione Valore
allowedOrigins Ottiene o imposta l'elenco di origini che devono essere autorizzate a effettuare chiamate tra le origini, ad esempio http://example.com:12345. Usare "*" per consentire tutto. Se omesso, consentire tutto per impostazione predefinita. string[]

SignalRFeature

Nome Descrizione Valore
bandiera FeatureFlags è la funzionalità supportata del servizio Azure SignalR.
- ServiceMode: flag per il server back-end per il servizio SignalR. Valori consentiti: "Default": have your own backend server; "Serverless": l'applicazione non ha un server back-end; "Classic": per compatibilità con le versioni precedenti. Supporta sia la modalità predefinita che quella serverless, ma non consigliata; "PredefinedOnly": per un uso futuro.
- EnableConnectivityLogs: "true"/"false", per abilitare/disabilitare rispettivamente la categoria del log di connettività.
- EnableMessagingLogs: "true"/"false", per abilitare/disabilitare rispettivamente la categoria del log di connettività.
- EnableLiveTrace: Live Trace consente di sapere cosa sta accadendo all'interno del servizio Azure SignalR, che fornirà tracce in tempo reale, sarà utile quando si sviluppa un'applicazione Web basata su Azure SignalR o si risolveranno in autonomia alcuni problemi. Si noti che le tracce in tempo reale vengono conteggiate come messaggi in uscita che verranno addebitati. Valori consentiti: "true"/"false", per abilitare/disabilitare la funzionalità di traccia in tempo reale.		 'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'ServiceMode' (obbligatorio)
proprietà Proprietà facoltative correlate a questa funzionalità. SignalRFeatureProperties
valore Valore del flag di funzionalità. Per i valori consentiti, vedere il documento del servizio Azure SignalR /azure/azure-signalr/. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)

SignalRFeatureProperties

Nome Descrizione Valore

SignalRNetworkACLs

Nome Descrizione Valore
defaultAction Azione ACL di rete di Azure. 'Consenti'
'Deny'
ipRules Regole IP per filtrare il traffico pubblico IPRule[]
privateEndpoints ACL per le richieste da endpoint privati PrivateEndpointACL []
publicNetwork ACL di rete NetworkACL

SignalRProperties

Nome Descrizione Valore
cors Impostazioni CORS (Cross-Origin Resource Sharing). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Abilitare o disabilitare l'autenticazione aad
Se impostato su true, la connessione con AuthType=aad non funzionerà.		 Bool
disableLocalAuth DisableLocalAuth
Abilitare o disabilitare l'autenticazione locale con AccessKey
Se impostato su true, la connessione con AccessKey=xxx non funzionerà.		 Bool
tratti somatici Elenco delle featureFlags.

FeatureFlags non inclusi nei parametri per l'operazione di aggiornamento non verranno modificati.
E la risposta includerà solo featureFlags impostati in modo esplicito.
Quando un featureFlag non è impostato in modo esplicito, verrà usato il relativo valore predefinito globale
Tenere tuttavia presente che il valore predefinito non significa "false". Varia in termini di featureFlags diversi.		 SignalRFeature[]
liveTraceConfiguration Configurazione della traccia in tempo reale di una risorsa Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACL di rete per la risorsa SignalRNetworkACLs
publicNetworkAccess Abilitare o disabilitare l'accesso alla rete pubblica. L'impostazione predefinita è "Enabled".
Quando è Abilitato, gli elenchi di controllo di accesso di rete vengono ancora applicati.
Quando è Disabilitato, l'accesso alla rete pubblica viene sempre disabilitato indipendentemente dall'impostazione negli elenchi di controllo di accesso di rete.		 corda
regionEndpointEnabled Abilitare o disabilitare l'endpoint a livello di area. L'impostazione predefinita è "Enabled".
Quando è Disabilitato, le nuove connessioni non verranno instradate a questo endpoint, ma le connessioni esistenti non saranno interessate.
Questa proprietà è specifica della replica. Disabilitare l'endpoint a livello di area senza replica non è consentito.		 corda
resourceLogConfiguration Configurazione del log delle risorse di una risorsa Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Arrestare o avviare la risorsa. Il valore predefinito è "False".
Quando è vero, il piano dati della risorsa viene arrestato.
Quando è false, viene avviato il piano dati della risorsa.		 corda
serverless Impostazioni serverless. ServerlessSettings
tls Impostazioni TLS per la risorsa SignalRTlsSettings
controcorrente Impostazioni per Upstream quando il servizio è in modalità senza server. serverlessUpstreamSettings

SignalRTlsSettings

Nome Descrizione Valore
clientCertEnabled Richiedere il certificato client durante l'handshake TLS, se abilitato. Non supportato per il livello gratuito. Qualsiasi input verrà ignorato per il livello gratuito. Bool

TrackedResourceTags

Nome Descrizione Valore

UpstreamAuthSettings

Nome Descrizione Valore
managedIdentity Impostazioni di identità gestite per upstream. ManagedIdentitySettings
digitare Enumerazione del tipo di autenticazione upstream. 'ManagedIdentity'
'Nessuno'

UpstreamTemplate

Nome Descrizione Valore
Auth Impostazioni di autenticazione upstream. Se non è impostata, non viene usata alcuna autenticazione per i messaggi upstream. upstreamAuthSettings
categoryPattern Ottiene o imposta il criterio di corrispondenza per i nomi delle categorie. Se non è impostata, corrisponde a qualsiasi categoria.
Sono supportati 3 tipi di modelli:
1. "*", corrisponde a qualsiasi nome di categoria.
2. Combinare più categorie con ",", ad esempio "connessioni, messaggi", corrisponde alla categoria "connessioni" e "messaggi".
3. Il nome della singola categoria, ad esempio "connections", corrisponde alla categoria "connections".		 corda
eventPattern Ottiene o imposta il criterio di corrispondenza per i nomi degli eventi. Se non è impostato, corrisponde a qualsiasi evento.
Sono supportati 3 tipi di modelli:
1. "*", corrisponde a qualsiasi nome di evento.
2. Combinare più eventi con ",", ad esempio "connect,disconnect", corrisponde all'evento "connect" e "disconnect".
3. Il nome dell'evento singolo, ad esempio , "connect", corrisponde a "connect".		 corda
hubPattern Ottiene o imposta il modello di corrispondenza per i nomi dell'hub. Se non è impostato, corrisponde a qualsiasi hub.
Sono supportati 3 tipi di modelli:
1. "*", corrisponde a qualsiasi nome dell'hub.
2. Combinare più hub con ",", ad esempio "hub1,hub2", corrisponde a "hub1" e "hub2".
3. Il nome dell'hub singolo, ad esempio "hub1", corrisponde a "hub1".		 corda
urlTemplate Ottiene o imposta il modello di URL Upstream. È possibile usare 3 parametri predefiniti {hub}, {category} {event} all'interno del modello, il valore dell'URL upstream viene calcolato in modo dinamico quando arriva la richiesta client.
Ad esempio, se urlTemplate è http://example.com/{hub}/api/{event}, con una richiesta client dall'hub chat si connette, eseguirà prima post a questo URL: http://example.com/chat/api/connect.		 stringa (obbligatorio)

UserAssignedIdentityProperty

Nome Descrizione Valore

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Sagoma Descrizione
Distribuire un servizio Azure SignalR

Distribuire in Azure 		Questo modello crea un servizio Azure SignalR usando un modello.

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa signalR può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.SignalRService/signalR, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR@2023-08-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"
        ipRules = [
          {
            action = "string"
            value = "string"
          }
        ]
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      regionEndpointEnabled = "string"
      resourceLogConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
      }
      resourceStopped = "string"
      serverless = {
        connectionTimeoutInSeconds = int
      }
      tls = {
        clientCertEnabled = bool
      }
      upstream = {
        templates = [
          {
            auth = {
              managedIdentity = {
                resource = "string"
              }
              type = "string"
            }
            categoryPattern = "string"
            eventPattern = "string"
            hubPattern = "string"
            urlTemplate = "string"
          }
        ]
      }
    }
  })
}

Valori delle proprietà

IPRule

Nome Descrizione Valore
azione Azione ACL di rete di Azure. 'Consenti'
'Deny'
valore Ip o CIDR o ServiceTag corda

LiveTraceCategory

Nome Descrizione Valore
Abilitato Indica se o la categoria di traccia dinamica è abilitata.
Valori disponibili: true, false.
Senza distinzione tra maiuscole e minuscole.		 corda
nome Ottiene o imposta il nome della categoria di traccia dinamica.
Valori disponibili: ConnectivityLogs, MessagingLogs.
Senza distinzione tra maiuscole e minuscole.		 corda

LiveTraceConfiguration

Nome Descrizione Valore
Categorie Ottiene o imposta l'elenco delle configurazioni di categoria. LiveTraceCategory[]
Abilitato Indica se abilitare o meno la traccia in tempo reale.
Quando è impostato su true, il client di traccia dinamica può connettersi al servizio.
In caso contrario, il client di traccia dinamica non può connettersi al servizio, in modo che non sia possibile ricevere alcun log, indipendentemente da ciò che si configura in "categorie".
Valori disponibili: true, false.
Senza distinzione tra maiuscole e minuscole.		 corda

ManagedIdentity

Nome Descrizione Valore
digitare Rappresenta il tipo di identità: systemAssigned, userAssigned, None 'Nessuno'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Ottenere o impostare le identità assegnate dall'utente ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Nome Descrizione Valore
risorsa Risorsa che indica l'URI ID app della risorsa di destinazione.
Viene visualizzato anche nell'attestazione aud (audience) del token rilasciato.		 corda

ManagedIdentityUserAssignedIdentities

Nome Descrizione Valore

Microsoft.SignalRService/signalR

Nome Descrizione Valore
identità Una classe rappresenta le identità gestite usate per la richiesta e la risposta ManagedIdentity
gentile Tipo di servizio 'RawWebSockets'
'SignalR'
ubicazione Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 3
Lunghezza massima = 3
Pattern = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obbligatorio)
proprietà Classe che descrive le proprietà della risorsa SignalRProperties
Sku Informazioni di fatturazione della risorsa. resourceSku
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.SignalRService/signalR@2023-08-01-preview"

NetworkACL

Nome Descrizione Valore
permettere Tipi di richiesta consentiti. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI. Matrice di stringhe contenente uno dei seguenti elementi:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
negare Tipi di richiesta negati. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI. Matrice di stringhe contenente uno dei seguenti elementi:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'

PrivateEndpointACL

Nome Descrizione Valore
permettere Tipi di richiesta consentiti. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI. Matrice di stringhe contenente uno dei seguenti elementi:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
negare Tipi di richiesta negati. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI. Matrice di stringhe contenente uno dei seguenti elementi:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nome Nome della connessione all'endpoint privato stringa (obbligatorio)

ResourceLogCategory

Nome Descrizione Valore
Abilitato Indica se o la categoria del log delle risorse è abilitata.
Valori disponibili: true, false.
Senza distinzione tra maiuscole e minuscole.		 corda
nome Ottiene o imposta il nome della categoria del log delle risorse.
Valori disponibili: ConnectivityLogs, MessagingLogs.
Senza distinzione tra maiuscole e minuscole.		 corda

ResourceLogConfiguration

Nome Descrizione Valore
Categorie Ottiene o imposta l'elenco delle configurazioni di categoria. ResourceLogCategory[]

ResourceSku

Nome Descrizione Valore
capacità Numero intero facoltativo. Numero di unità della risorsa. 1 per impostazione predefinita.

Se presente, sono consentiti i valori seguenti:
Gratuito: 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
nome Nome dello SKU. Obbligatorio.

Valori consentiti: Standard_S1, Free_F1, Premium_P1		 stringa (obbligatorio)
livello Livello facoltativo di questo SKU specifico. 'Standard' o 'Free'.

Basic è deprecato, usare Standard.		 'Basic'
'Free'
'Premium'
'Standard'

ServerlessSettings

Nome Descrizione Valore
connectionTimeoutInSeconds Ottiene o imposta il timeout connessione client. Facoltativo da impostare.
Valore in secondi.
Il valore predefinito è 30 secondi.
Il cliente deve impostare il timeout su un periodo più breve se i messaggi devono essere inviati in intervalli più brevi,
e desidera che il client si disconnette più rapidamente dopo l'invio dell'ultimo messaggio.
È possibile impostare il timeout su un periodo più lungo se si prevede che i messaggi vengano inviati in intervalli più lunghi,
e vogliono mantenere attiva la stessa connessione client durante questa sessione.
Il servizio considera il client disconnesso se non ha ricevuto un messaggio (incluso keep-alive) in questo intervallo.		 Int

Vincoli:
Valore minimo = 1
Valore massimo = 120

ServerlessUpstreamSettings

Nome Descrizione Valore
Modelli Ottiene o imposta l'elenco dei modelli di URL upstream. L'ordine è importante e il primo modello corrispondente ha effetti. UpstreamTemplate []

SignalRCorsSettings

Nome Descrizione Valore
allowedOrigins Ottiene o imposta l'elenco di origini che devono essere autorizzate a effettuare chiamate tra le origini, ad esempio http://example.com:12345. Usare "*" per consentire tutto. Se omesso, consentire tutto per impostazione predefinita. string[]

SignalRFeature

Nome Descrizione Valore
bandiera FeatureFlags è la funzionalità supportata del servizio Azure SignalR.
- ServiceMode: flag per il server back-end per il servizio SignalR. Valori consentiti: "Default": have your own backend server; "Serverless": l'applicazione non ha un server back-end; "Classic": per compatibilità con le versioni precedenti. Supporta sia la modalità predefinita che quella serverless, ma non consigliata; "PredefinedOnly": per un uso futuro.
- EnableConnectivityLogs: "true"/"false", per abilitare/disabilitare rispettivamente la categoria del log di connettività.
- EnableMessagingLogs: "true"/"false", per abilitare/disabilitare rispettivamente la categoria del log di connettività.
- EnableLiveTrace: Live Trace consente di sapere cosa sta accadendo all'interno del servizio Azure SignalR, che fornirà tracce in tempo reale, sarà utile quando si sviluppa un'applicazione Web basata su Azure SignalR o si risolveranno in autonomia alcuni problemi. Si noti che le tracce in tempo reale vengono conteggiate come messaggi in uscita che verranno addebitati. Valori consentiti: "true"/"false", per abilitare/disabilitare la funzionalità di traccia in tempo reale.		 'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'ServiceMode' (obbligatorio)
proprietà Proprietà facoltative correlate a questa funzionalità. SignalRFeatureProperties
valore Valore del flag di funzionalità. Per i valori consentiti, vedere il documento del servizio Azure SignalR /azure/azure-signalr/. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)

SignalRFeatureProperties

Nome Descrizione Valore

SignalRNetworkACLs

Nome Descrizione Valore
defaultAction Azione ACL di rete di Azure. 'Consenti'
'Deny'
ipRules Regole IP per filtrare il traffico pubblico IPRule[]
privateEndpoints ACL per le richieste da endpoint privati PrivateEndpointACL []
publicNetwork ACL di rete NetworkACL

SignalRProperties

Nome Descrizione Valore
cors Impostazioni CORS (Cross-Origin Resource Sharing). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Abilitare o disabilitare l'autenticazione aad
Se impostato su true, la connessione con AuthType=aad non funzionerà.		 Bool
disableLocalAuth DisableLocalAuth
Abilitare o disabilitare l'autenticazione locale con AccessKey
Se impostato su true, la connessione con AccessKey=xxx non funzionerà.		 Bool
tratti somatici Elenco delle featureFlags.

FeatureFlags non inclusi nei parametri per l'operazione di aggiornamento non verranno modificati.
E la risposta includerà solo featureFlags impostati in modo esplicito.
Quando un featureFlag non è impostato in modo esplicito, verrà usato il relativo valore predefinito globale
Tenere tuttavia presente che il valore predefinito non significa "false". Varia in termini di featureFlags diversi.		 SignalRFeature[]
liveTraceConfiguration Configurazione della traccia in tempo reale di una risorsa Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACL di rete per la risorsa SignalRNetworkACLs
publicNetworkAccess Abilitare o disabilitare l'accesso alla rete pubblica. L'impostazione predefinita è "Enabled".
Quando è Abilitato, gli elenchi di controllo di accesso di rete vengono ancora applicati.
Quando è Disabilitato, l'accesso alla rete pubblica viene sempre disabilitato indipendentemente dall'impostazione negli elenchi di controllo di accesso di rete.		 corda
regionEndpointEnabled Abilitare o disabilitare l'endpoint a livello di area. L'impostazione predefinita è "Enabled".
Quando è Disabilitato, le nuove connessioni non verranno instradate a questo endpoint, ma le connessioni esistenti non saranno interessate.
Questa proprietà è specifica della replica. Disabilitare l'endpoint a livello di area senza replica non è consentito.		 corda
resourceLogConfiguration Configurazione del log delle risorse di una risorsa Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Arrestare o avviare la risorsa. Il valore predefinito è "False".
Quando è vero, il piano dati della risorsa viene arrestato.
Quando è false, viene avviato il piano dati della risorsa.		 corda
serverless Impostazioni serverless. ServerlessSettings
tls Impostazioni TLS per la risorsa SignalRTlsSettings
controcorrente Impostazioni per Upstream quando il servizio è in modalità senza server. serverlessUpstreamSettings

SignalRTlsSettings

Nome Descrizione Valore
clientCertEnabled Richiedere il certificato client durante l'handshake TLS, se abilitato. Non supportato per il livello gratuito. Qualsiasi input verrà ignorato per il livello gratuito. Bool

TrackedResourceTags

Nome Descrizione Valore

UpstreamAuthSettings

Nome Descrizione Valore
managedIdentity Impostazioni di identità gestite per upstream. ManagedIdentitySettings
digitare Enumerazione del tipo di autenticazione upstream. 'ManagedIdentity'
'Nessuno'

UpstreamTemplate

Nome Descrizione Valore
Auth Impostazioni di autenticazione upstream. Se non è impostata, non viene usata alcuna autenticazione per i messaggi upstream. upstreamAuthSettings
categoryPattern Ottiene o imposta il criterio di corrispondenza per i nomi delle categorie. Se non è impostata, corrisponde a qualsiasi categoria.
Sono supportati 3 tipi di modelli:
1. "*", corrisponde a qualsiasi nome di categoria.
2. Combinare più categorie con ",", ad esempio "connessioni, messaggi", corrisponde alla categoria "connessioni" e "messaggi".
3. Il nome della singola categoria, ad esempio "connections", corrisponde alla categoria "connections".		 corda
eventPattern Ottiene o imposta il criterio di corrispondenza per i nomi degli eventi. Se non è impostato, corrisponde a qualsiasi evento.
Sono supportati 3 tipi di modelli:
1. "*", corrisponde a qualsiasi nome di evento.
2. Combinare più eventi con ",", ad esempio "connect,disconnect", corrisponde all'evento "connect" e "disconnect".
3. Il nome dell'evento singolo, ad esempio , "connect", corrisponde a "connect".		 corda
hubPattern Ottiene o imposta il modello di corrispondenza per i nomi dell'hub. Se non è impostato, corrisponde a qualsiasi hub.
Sono supportati 3 tipi di modelli:
1. "*", corrisponde a qualsiasi nome dell'hub.
2. Combinare più hub con ",", ad esempio "hub1,hub2", corrisponde a "hub1" e "hub2".
3. Il nome dell'hub singolo, ad esempio "hub1", corrisponde a "hub1".		 corda
urlTemplate Ottiene o imposta il modello di URL Upstream. È possibile usare 3 parametri predefiniti {hub}, {category} {event} all'interno del modello, il valore dell'URL upstream viene calcolato in modo dinamico quando arriva la richiesta client.
Ad esempio, se urlTemplate è http://example.com/{hub}/api/{event}, con una richiesta client dall'hub chat si connette, eseguirà prima post a questo URL: http://example.com/chat/api/connect.		 stringa (obbligatorio)

UserAssignedIdentityProperty

Nome Descrizione Valore