Microsoft.SignalRService signalR 2023-06-01-preview
Definizione di risorsa Bicep
Il tipo di risorsa signalR può essere distribuito con operazioni destinate:
- 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 di risorsa
Per creare una risorsa Microsoft.SignalRService/signalR, aggiungere il modello Bicep seguente.
resource symbolicname 'Microsoft.SignalRService/signalR@2023-06-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
kind: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
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'
}
]
}
}
}
Valori delle proprietà
signalR
Nome | Descrizione | valore |
---|---|---|
name | Nome della risorsa | stringa (obbligatoria) Limite di caratteri: 3-63 Caratteri validi: Caratteri alfanumerici e trattini. Deve iniziare con una lettera. Deve terminare con una lettera o un numero. Il nome della risorsa deve essere univoco in Azure. |
posizione | Posizione geografica in cui vive la risorsa | stringa (obbligatoria) |
tags | Tag di risorse. | Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli |
sku | Informazioni di fatturazione della risorsa. | ResourceSku |
kind | Tipo di servizio | 'RawWebSockets' 'SignalR' |
identity | Una classe rappresenta le identità gestite usate per la richiesta e la risposta | ManagedIdentity |
properties | Classe che descrive le proprietà della risorsa | SignalRProperties |
ManagedIdentity
Nome | Descrizione | Valore |
---|---|---|
tipo | Rappresenta il tipo di identità: systemAssigned, userAssigned, None | 'Nessuno' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | Ottenere o impostare le identità assegnate dall'utente | ManagedIdentityUserAssignedIdentities |
ManagedIdentityUserAssignedIdentities
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | UserAssignedIdentityProperty |
UserAssignedIdentityProperty
Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.
SignalRProperties
Nome | Descrizione | Valore |
---|---|---|
CORS | Impostazioni CORS (Cross-Origin Resource Sharing). | SignalRCorsSettings |
disableAadAuth | DisableLocalAuth Abilitare o disabilitare l'autenticazione aad Se impostato come true, la connessione con AuthType=aad non funzionerà. |
bool |
disableLocalAuth | DisableLocalAuth Abilitare o disabilitare l'autenticazione locale con AccessKey Se impostato come true, la connessione con AccessKey=xxx non funzionerà. |
bool |
funzionalità | Elenco delle funzionalitàFlags. FeatureFlags che non sono 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 valore predefinito globale Tuttavia, tenere presente che il valore predefinito non significa "false". Varia in termini di featureFlag diversi. |
SignalRFeature[] |
liveTraceConfiguration | Configurazione della traccia dinamica di una risorsa Microsoft.SignalRService. | LiveTraceConfiguration |
networkACLs | ACL di rete per la risorsa | SignalRNetworkACLs |
publicNetworkAccess | Abilitare o disabilitare l'accesso alla rete pubblica. Il valore predefinito è "Abilitato". Quando è Abilitato, gli elenchi di controllo di accesso di rete sono ancora validi. Quando è Disabilitato, l'accesso alla rete pubblica viene sempre disabilitato indipendentemente dall'impostazione negli elenchi di controllo di accesso di rete. |
string |
resourceLogConfiguration | Configurazione del log delle risorse di una risorsa Microsoft.SignalRService. | ResourceLogConfiguration |
senza server | Impostazioni serverless. | ServerlessSettings |
Tls | Impostazioni TLS per la risorsa | SignalRTlsSettings |
upstream | Impostazioni per Upstream quando il servizio è in modalità senza server. | ServerlessUpstreamSettings |
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 consentirli tutti. Se omesso, consentire tutto per impostazione predefinita. |
string[] |
SignalRFeature
Nome | Descrizione | Valore |
---|---|---|
flag | FeatureFlags è le funzionalità supportate del servizio Azure SignalR. - ServiceMode: flag per il server back-end per il servizio SignalR. Valori consentiti: "Default": avere il proprio server back-end; "Serverless": l'applicazione non ha un server back-end; "Classic": per la compatibilità con le versioni precedenti. Supportare 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 accade all'interno del servizio Azure SignalR, che fornirà tracce live 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 attive vengono conteggiate come messaggi in uscita che verranno addebitati. Valori consentiti: "true"/"false" per abilitare/disabilitare la funzionalità di traccia dinamica. |
'EnableConnectivityLogs' 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' (obbligatorio) |
properties | Proprietà facoltative correlate a questa funzionalità. | SignalRFeatureProperties |
Valore | Valore del flag di funzionalità. Per i valori consentiti, vedere il documento https://docs.microsoft.com/azure/azure-signalr/ del servizio Azure SignalR. |
stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 128 |
SignalRFeatureProperties
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | string |
LiveTraceConfiguration
Nome | Descrizione | Valore |
---|---|---|
Categorie | Ottiene o imposta l'elenco di configurazioni di categoria. | LiveTraceCategory[] |
Enabled | Indica se abilitare o meno la traccia dinamica. Quando è impostata 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. |
string |
LiveTraceCategory
Nome | Descrizione | Valore |
---|---|---|
Enabled | Indica se o la categoria di traccia dinamica è abilitata. Valori disponibili: true, false. Senza distinzione tra maiuscole e minuscole. |
string |
name | Ottiene o imposta il nome della categoria di traccia attiva. Valori disponibili: ConnectivityLogs, MessagingLogs. Senza distinzione tra maiuscole e minuscole. |
string |
SignalRNetworkACLs
Nome | Descrizione | Valore |
---|---|---|
Defaultaction | Azione ACL di rete di Azure. | 'Allow' 'Deny' |
privateEndpoints | ACL per le richieste da endpoint privati | PrivateEndpointACL[] |
publicNetwork | ACL rete | NetworkACL |
PrivateEndpointACL
Nome | Descrizione | Valore |
---|---|---|
allow | Tipi di richiesta consentiti. Il valore può essere uno o più: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno qualsiasi di: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
deny | Tipi di richiesta negati. Il valore può essere uno o più: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno qualsiasi di: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
name | Nome della connessione dell'endpoint privato | stringa (obbligatoria) |
NetworkACL
Nome | Descrizione | Valore |
---|---|---|
allow | Tipi di richiesta consentiti. Il valore può essere uno o più: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno qualsiasi di: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
deny | Tipi di richiesta negati. Il valore può essere uno o più: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno qualsiasi di: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
ResourceLogConfiguration
Nome | Descrizione | Valore |
---|---|---|
Categorie | Ottiene o imposta l'elenco delle configurazioni di categoria. | ResourceLogCategory[] |
ResourceLogCategory
Nome | Descrizione | Valore |
---|---|---|
Enabled | Indica se o la categoria di log delle risorse è abilitata. Valori disponibili: true, false. Distinzione tra maiuscole e minuscole. |
string |
name | Ottiene o imposta il nome della categoria del log delle risorse. Valori disponibili: ConnectivityLogs, MessagingLogs. Distinzione tra maiuscole e minuscole. |
string |
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 si vuole che il client disconnettersi più rapidamente dopo l'invio dell'ultimo messaggio. È possibile impostare il timeout su un periodo più lungo se i messaggi devono essere 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 |
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 |
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[] |
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 di categoria. Se non è impostata, corrisponde a qualsiasi categoria. Sono supportati 3 tipi di modelli: 1. "*", in modo che corrisponda 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". |
string |
eventPattern | Ottiene o imposta il modello 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". |
string |
hubPattern | Ottiene o imposta il modello di corrispondenza per i nomi dell'hub. Se non è impostata, 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". |
string |
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, verrà prima POST a questo URL: http://example.com/chat/api/connect . |
stringa (obbligatorio) |
UpstreamAuthSettings
Nome | Descrizione | Valore |
---|---|---|
managedIdentity | Impostazioni di identità gestite per upstream. | ManagedIdentitySettings |
tipo | Enumerazione del tipo di autenticazione upstream. | 'ManagedIdentity' 'Nessuno' |
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. |
string |
ResourceSku
Nome | Descrizione | Valore |
---|---|---|
capacità | Valore integer 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 |
name | Il nome della 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 invece . |
'Basic' 'Free' 'Premium' 'Standard' |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
Modello | Descrizione |
---|---|
Distribuire un servizio Azure SignalR |
Questo modello crea un Servizio Azure SignalR usando un modello. |
Definizione della risorsa modello di Resource Manager
Il tipo di risorsa signalR può essere distribuito con operazioni destinate:
- 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 di risorsa
Per creare una risorsa Microsoft.SignalRService/signalR, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2023-06-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"kind": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"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"
}
]
}
}
}
Valori delle proprietà
signalR
Nome | Descrizione | Valore |
---|---|---|
tipo | Tipo di risorsa | 'Microsoft.SignalRService/signalR' |
apiVersion | Versione dell'API risorsa | '2023-06-01-preview' |
name | Nome della risorsa | stringa (obbligatoria) Limite di caratteri: 3-63 Caratteri validi: Caratteri alfanumerici e trattini. Deve iniziare con una lettera. Deve terminare con una lettera o un numero. Il nome della risorsa deve essere univoco in Azure. |
posizione | Posizione geografica in cui vive la risorsa | stringa (obbligatoria) |
tags | Tag di risorse. | Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli |
sku | Informazioni di fatturazione della risorsa. | ResourceSku |
kind | Tipo di servizio | 'RawWebSockets' 'SignalR' |
identity | Una classe rappresenta le identità gestite usate per la richiesta e la risposta | ManagedIdentity |
properties | Classe che descrive le proprietà della risorsa | SignalRProperties |
ManagedIdentity
Nome | Descrizione | Valore |
---|---|---|
tipo | Rappresenta il tipo di identità: systemAssigned, userAssigned, None | 'Nessuno' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | Ottenere o impostare le identità assegnate dall'utente | ManagedIdentityUserAssignedIdentities |
ManagedIdentityUserAssignedIdentities
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | UserAssignedIdentityProperty |
UserAssignedIdentityProperty
Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.
SignalRProperties
Nome | Descrizione | Valore |
---|---|---|
CORS | Impostazioni CORS (Cross-Origin Resource Sharing). | SignalRCorsSettings |
disableAadAuth | DisableLocalAuth Abilitare o disabilitare l'autenticazione aad Se impostato come true, la connessione con AuthType=aad non funzionerà. |
bool |
disableLocalAuth | DisableLocalAuth Abilitare o disabilitare l'autenticazione locale con AccessKey Se impostato come true, la connessione con AccessKey=xxx non funzionerà. |
bool |
funzionalità | Elenco delle funzionalitàFlags. FeatureFlags che non sono inclusi nei parametri per l'operazione di aggiornamento non verranno modificati. E la risposta includerà solo featureFlags che sono impostate in modo esplicito. Quando una funzionalitàFlag non è impostata in modo esplicito, verrà usato il relativo valore predefinito globale Ma tenere presente che il valore predefinito non significa "false". Varia in termini di featureFlags diversi. |
SignalRFeature[] |
liveTraceConfiguration | Configurazione di 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. Il valore predefinito è "Abilitato". Quando è Abilitato, gli elenchi di controllo di accesso di rete sono ancora validi. Quando è Disabilitato, l'accesso alla rete pubblica viene sempre disabilitato indipendentemente dall'impostazione negli elenchi di controllo di accesso di rete. |
string |
resourceLogConfiguration | Configurazione del log delle risorse di una risorsa Microsoft.SignalRService. | ResourceLogConfiguration |
senza server | Impostazioni serverless. | ServerlessSettings |
Tls | Impostazioni TLS per la risorsa | SignalRTlsSettings |
upstream | Impostazioni per Upstream quando il servizio è in modalità senza server. | ServerlessUpstreamSettings |
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 consentirli tutti. Se omesso, consentire tutto per impostazione predefinita. |
string[] |
SignalRFeature
Nome | Descrizione | Valore |
---|---|---|
flag | FeatureFlags è le funzionalità supportate del servizio Azure SignalR. - ServiceMode: flag per il server back-end per il servizio SignalR. Valori consentiti: "Default": avere il proprio server back-end; "Serverless": l'applicazione non ha un server back-end; "Classic": per la compatibilità con le versioni precedenti. Supportare 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 accade all'interno del servizio Azure SignalR, che fornirà tracce live 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 attive vengono conteggiate come messaggi in uscita che verranno addebitati. Valori consentiti: "true"/"false" per abilitare/disabilitare la funzionalità di traccia dinamica. |
'EnableConnectivityLogs' 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' (obbligatorio) |
properties | Proprietà facoltative correlate a questa funzionalità. | SignalRFeatureProperties |
Valore | Valore del flag di funzionalità. Per i valori consentiti, vedere il documento https://docs.microsoft.com/azure/azure-signalr/ del servizio Azure SignalR. |
stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 128 |
SignalRFeatureProperties
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | string |
LiveTraceConfiguration
Nome | Descrizione | Valore |
---|---|---|
Categorie | Ottiene o imposta l'elenco di configurazioni di categoria. | LiveTraceCategory[] |
Enabled | Indica se abilitare o meno la traccia dinamica. Quando è impostata 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. |
string |
LiveTraceCategory
Nome | Descrizione | Valore |
---|---|---|
Enabled | Indica se o la categoria di traccia dinamica è abilitata. Valori disponibili: true, false. Senza distinzione tra maiuscole e minuscole. |
string |
name | Ottiene o imposta il nome della categoria di traccia attiva. Valori disponibili: ConnectivityLogs, MessagingLogs. Senza distinzione tra maiuscole e minuscole. |
string |
SignalRNetworkACLs
Nome | Descrizione | Valore |
---|---|---|
Defaultaction | Azione ACL di rete di Azure. | 'Consenti' 'Deny' |
privateEndpoints | ACL per le richieste da endpoint privati | PrivateEndpointACL[] |
publicNetwork | ACL rete | NetworkACL |
PrivateEndpointACL
Nome | Descrizione | Valore |
---|---|---|
allow | Tipi di richiesta consentiti. Il valore può essere uno o più: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno qualsiasi di: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
deny | Tipi di richiesta negati. Il valore può essere uno o più: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno qualsiasi di: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
name | Nome della connessione dell'endpoint privato | stringa (obbligatoria) |
NetworkACL
Nome | Descrizione | Valore |
---|---|---|
allow | Tipi di richiesta consentiti. Il valore può essere uno o più: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno qualsiasi di: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
deny | Tipi di richiesta negati. Il valore può essere uno o più: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno qualsiasi di: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
ResourceLogConfiguration
Nome | Descrizione | Valore |
---|---|---|
Categorie | Ottiene o imposta l'elenco delle configurazioni di categoria. | ResourceLogCategory[] |
ResourceLogCategory
Nome | Descrizione | Valore |
---|---|---|
Enabled | Indica se o la categoria di log delle risorse è abilitata. Valori disponibili: true, false. Distinzione tra maiuscole e minuscole. |
string |
name | Ottiene o imposta il nome della categoria del log delle risorse. Valori disponibili: ConnectivityLogs, MessagingLogs. Distinzione tra maiuscole e minuscole. |
string |
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 si vuole che il client disconnettersi più rapidamente dopo l'invio dell'ultimo messaggio. È possibile impostare il timeout su un periodo più lungo se i messaggi devono essere 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 |
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 |
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[] |
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 di categoria. Se non è impostata, corrisponde a qualsiasi categoria. Sono supportati 3 tipi di modelli: 1. "*", in modo che corrisponda 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". |
string |
eventPattern | Ottiene o imposta il modello 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". |
string |
hubPattern | Ottiene o imposta il modello di corrispondenza per i nomi dell'hub. Se non è impostata, 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". |
string |
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, verrà prima POST a questo URL: http://example.com/chat/api/connect . |
stringa (obbligatorio) |
UpstreamAuthSettings
Nome | Descrizione | Valore |
---|---|---|
managedIdentity | Impostazioni di identità gestite per upstream. | ManagedIdentitySettings |
tipo | Enumerazione del tipo di autenticazione upstream. | 'ManagedIdentity' 'Nessuno' |
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. |
string |
ResourceSku
Nome | Descrizione | Valore |
---|---|---|
capacità | Valore integer 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 |
name | Il nome della 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 invece . |
'Basic' 'Free' 'Premium' 'Standard' |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
Modello | Descrizione |
---|---|
Distribuire un servizio Azure SignalR |
Questo modello crea un Servizio Azure SignalR usando un modello. |
Definizione della 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 di risorsa
Per creare una risorsa Microsoft.SignalRService/signalR, aggiungere il codice Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SignalRService/signalR@2023-06-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
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"
}
]
}
}
sku = {
capacity = int
name = "string"
tier = "string"
}
kind = "string"
})
}
Valori delle proprietà
signalR
Nome | Descrizione | Valore |
---|---|---|
tipo | Tipo di risorsa | "Microsoft.SignalRService/signalR@2023-06-01-preview" |
name | Nome della risorsa | stringa (obbligatorio) Limite di caratteri: 3-63 Caratteri validi: Caratteri alfanumerici e trattini. Deve iniziare con una lettera. Deve terminare con una lettera o un numero. Il nome della risorsa deve essere univoco in Azure. |
posizione | Posizione geografica in cui risiede la risorsa | stringa (obbligatorio) |
parent_id | Per eseguire la distribuzione in un gruppo di risorse, usare l'ID del gruppo di risorse. | stringa (obbligatorio) |
tags | Tag delle risorse. | Dizionario di nomi e valori di tag. |
sku | Informazioni di fatturazione della risorsa. | ResourceSku |
kind | Tipo di servizio | "RawWebSockets" "SignalR" |
identity | Una classe rappresenta le identità gestite usate per la richiesta e la risposta | ManagedIdentity |
properties | Classe che descrive le proprietà della risorsa | SignalRProperties |
ManagedIdentity
Nome | Descrizione | Valore |
---|---|---|
tipo | Rappresenta il tipo di identità: systemAssigned, userAssigned, None | "SystemAssigned" "UserAssigned" |
identity_ids | Ottenere o impostare le identità assegnate dall'utente | Matrice di ID identità utente. |
ManagedIdentityUserAssignedIdentities
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | UserAssignedIdentityProperty |
UserAssignedIdentityProperty
Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.
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 |
funzionalità | Elenco delle featureFlags. FeatureFlags non inclusi nei parametri per l'operazione di aggiornamento non verrà modificato. E la risposta includerà solo featureFlags impostati in modo esplicito. Quando un featureFlag non è impostato in modo esplicito, verrà usato il valore predefinito globale Tuttavia, tenere presente che il valore predefinito non significa "false". Varia in termini di featureFlag diversi. |
SignalRFeature[] |
liveTraceConfiguration | Configurazione della traccia dinamica di una risorsa Microsoft.SignalRService. | LiveTraceConfiguration |
networkACLs | ACL di rete per la risorsa | SignalRNetworkACLs |
publicNetworkAccess | Abilitare o disabilitare l'accesso alla rete pubblica. Il valore predefinito è "Abilitato". Quando è Abilitato, gli elenchi di controllo di accesso di rete sono ancora validi. Quando è Disabilitato, l'accesso alla rete pubblica viene sempre disabilitato indipendentemente dall'impostazione negli elenchi di controllo di accesso di rete. |
string |
resourceLogConfiguration | Configurazione del log delle risorse di una risorsa Microsoft.SignalRService. | ResourceLogConfiguration |
senza server | Impostazioni serverless. | ServerlessSettings |
Tls | Impostazioni TLS per la risorsa | SignalRTlsSettings |
upstream | Impostazioni per Upstream quando il servizio è in modalità senza server. | ServerlessUpstreamSettings |
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 consentirli tutti. Se omesso, consentire tutto per impostazione predefinita. |
string[] |
SignalRFeature
Nome | Descrizione | Valore |
---|---|---|
flag | FeatureFlags è le funzionalità supportate del servizio Azure SignalR. - ServiceMode: flag per il server back-end per il servizio SignalR. Valori consentiti: "Default": avere il proprio server back-end; "Serverless": l'applicazione non ha un server back-end; "Classic": per la compatibilità con le versioni precedenti. Supportare 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 accade all'interno del servizio Azure SignalR, che fornirà tracce live 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 attive vengono conteggiate come messaggi in uscita che verranno addebitati. Valori consentiti: "true"/"false" per abilitare/disabilitare la funzionalità di traccia dinamica. |
"EnableConnectivityLogs" "EnableLiveTrace" "EnableMessagingLogs" "ServiceMode" (obbligatorio) |
properties | Proprietà facoltative correlate a questa funzionalità. | SignalRFeatureProperties |
Valore | Valore del flag di funzionalità. Per i valori consentiti, vedere il documento https://docs.microsoft.com/azure/azure-signalr/ del servizio Azure SignalR. |
stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 128 |
SignalRFeatureProperties
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | string |
LiveTraceConfiguration
Nome | Descrizione | Valore |
---|---|---|
Categorie | Ottiene o imposta l'elenco di configurazioni di categoria. | LiveTraceCategory[] |
Enabled | Indica se abilitare o meno la traccia dinamica. Quando è impostata 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. |
string |
LiveTraceCategory
Nome | Descrizione | Valore |
---|---|---|
Enabled | Indica se o la categoria di traccia dinamica è abilitata. Valori disponibili: true, false. Senza distinzione tra maiuscole e minuscole. |
string |
name | Ottiene o imposta il nome della categoria di traccia attiva. Valori disponibili: ConnectivityLogs, MessagingLogs. Senza distinzione tra maiuscole e minuscole. |
string |
SignalRNetworkACLs
Nome | Descrizione | Valore |
---|---|---|
Defaultaction | Azione ACL di rete di Azure. | "Consenti" "Nega" |
privateEndpoints | ACL per le richieste da endpoint privati | PrivateEndpointACL[] |
publicNetwork | ACL rete | NetworkACL |
PrivateEndpointACL
Nome | Descrizione | Valore |
---|---|---|
allow | 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" "Traccia" |
deny | Tipi di richiesta negati. Il valore può essere uno o più: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno qualsiasi di: "ClientConnection" "RESTAPI" "ServerConnection" "Traccia" |
name | Nome della connessione dell'endpoint privato | stringa (obbligatoria) |
NetworkACL
Nome | Descrizione | Valore |
---|---|---|
allow | Tipi di richiesta consentiti. Il valore può essere uno o più: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno qualsiasi di: "ClientConnection" "RESTAPI" "ServerConnection" "Traccia" |
deny | Tipi di richiesta negati. Il valore può essere uno o più: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno qualsiasi di: "ClientConnection" "RESTAPI" "ServerConnection" "Traccia" |
ResourceLogConfiguration
Nome | Descrizione | Valore |
---|---|---|
Categorie | Ottiene o imposta l'elenco delle configurazioni di categoria. | ResourceLogCategory[] |
ResourceLogCategory
Nome | Descrizione | Valore |
---|---|---|
Enabled | Indica se o la categoria di log delle risorse è abilitata. Valori disponibili: true, false. Distinzione tra maiuscole e minuscole. |
string |
name | Ottiene o imposta il nome della categoria del log delle risorse. Valori disponibili: ConnectivityLogs, MessagingLogs. Distinzione tra maiuscole e minuscole. |
string |
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 si vuole che il client disconnettersi più rapidamente dopo l'invio dell'ultimo messaggio. È possibile impostare il timeout su un periodo più lungo se i messaggi devono essere 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 |
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 |
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[] |
UpstreamTemplate
Nome | Descrizione | Valore |
---|---|---|
auth | Impostazioni di autenticazione upstream. Se non è impostato, non viene usata alcuna autenticazione per i messaggi upstream. | UpstreamAuthSettings |
categoryPattern | Ottiene o imposta il modello di corrispondenza per i nomi di categoria. Se non è impostato, corrisponde a qualsiasi categoria. Sono supportati 3 tipi di modelli: 1. "*", in modo che corrisponda 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". |
string |
eventPattern | Ottiene o imposta il modello 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". |
string |
hubPattern | Ottiene o imposta il modello di corrispondenza per i nomi dell'hub. Se non è impostata, 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". |
string |
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, verrà prima POST a questo URL: http://example.com/chat/api/connect . |
stringa (obbligatorio) |
UpstreamAuthSettings
Nome | Descrizione | Valore |
---|---|---|
managedIdentity | Impostazioni di identità gestite per upstream. | ManagedIdentitySettings |
tipo | Enumerazione del tipo di autenticazione upstream. | "ManagedIdentity" "None" |
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. |
string |
ResourceSku
Nome | Descrizione | Valore |
---|---|---|
capacità | Valore integer 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 |
name | Il nome della 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 invece . |
"Basic" "Gratuito" "Premium" "Standard" |