Microsoft.SignalRService signalR 2021-09-01-preview
Definizione di risorsa Bicep
Il tipo di risorsa signalR può essere distribuito con operazioni destinate a:
- Gruppi di risorse - Vedere i comandi di distribuzione dei 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 bicep seguente al modello.
resource symbolicname 'Microsoft.SignalRService/signalR@2021-09-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'
}
]
networkACLs: {
defaultAction: 'string'
privateEndpoints: [
{
allow: [
'string'
]
deny: [
'string'
]
name: 'string'
}
]
publicNetwork: {
allow: [
'string'
]
deny: [
'string'
]
}
}
publicNetworkAccess: 'string'
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 (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 della risorsa. Ad esempio Stati Uniti occidentali, Stati Uniti orientali, Stati Uniti centro-settentrionali, Stati Uniti centro-meridionali. | string |
tags | Tag del servizio che è un elenco di coppie chiave-valore che descrivono la risorsa. | Dizionario di nomi e valori di tag. Vedere Tag nei modelli |
sku | Informazioni di fatturazione della risorsa. (ad esempio Gratuito, Standard) | ResourceSku |
kind | Tipo di servizio, ad esempio "SignalR" per "Microsoft.SignalRService/SignalR" | 'RawWebSockets' 'SignalR' |
identity | Risposta dell'identità gestita | ManagedIdentity |
properties | Impostazioni usate per effettuare il provisioning o configurare la risorsa | SignalRProperties |
ManagedIdentity
Nome | Descrizione | Valore |
---|---|---|
tipo | Rappresentare 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 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[] |
networkACLs | ACL rete | 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 |
Tls | Impostazioni TLS. | SignalRTlsSettings |
upstream | Impostazioni 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 |
SignalRNetworkACLs
Nome | Descrizione | Valore |
---|---|---|
Defaultaction | Azione predefinita quando nessun'altra regola corrisponde | 'Consenti' 'Deny' |
privateEndpoints | ACL per le richieste da endpoint privati | PrivateEndpointACL[] |
publicNetwork | ACL per le richieste dalla rete pubblica | 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' 'Trace' |
deny | 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' |
name | Nome della connessione dell'endpoint privato | stringa (obbligatorio) |
NetworkACL
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' 'Trace' |
deny | 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' |
SignalRTlsSettings
Nome | Descrizione | Valore |
---|---|---|
clientCertEnabled | Richiedere il certificato client durante l'handshake TLS, se abilitato | 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 | Ottiene o imposta le impostazioni di autenticazione per un 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. "*", 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" |
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. "*", in modo che corrisponda 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 | Ottiene o imposta le impostazioni dell'identità gestita. È obbligatorio se il tipo di autenticazione è impostato su ManagedIdentity. | ManagedIdentitySettings |
tipo | Ottiene o imposta il tipo di autenticazione. Nessuna o ManagedIdentity è ora supportata. | '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.5.10.20.50.100 |
INT |
name | Il nome della SKU. Obbligatorio. Valori consentiti: Standard_S1, Free_F1 |
stringa (obbligatoria) |
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": "2021-09-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"
}
],
"networkACLs": {
"defaultAction": "string",
"privateEndpoints": [
{
"allow": [ "string" ],
"deny": [ "string" ],
"name": "string"
}
],
"publicNetwork": {
"allow": [ "string" ],
"deny": [ "string" ]
}
},
"publicNetworkAccess": "string",
"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 | '2021-09-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 della risorsa. Ad esempio Stati Uniti occidentali , Stati Uniti orientali , Stati Uniti centro-settentrionali , Stati Uniti centro-meridionali. | string |
tags | Tag del servizio che è un elenco di coppie di valori chiave che descrivono la risorsa. | Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli |
sku | Informazioni di fatturazione della risorsa. (ad esempio Gratuito, Standard) | ResourceSku |
kind | Tipo di servizio, ad esempio "SignalR" per "Microsoft.SignalRService/SignalR" | 'RawWebSockets' 'SignalR' |
identity | Risposta dell'identità gestita | ManagedIdentity |
properties | Impostazioni usate per effettuare il provisioning o configurare la risorsa | SignalRProperties |
ManagedIdentity
Nome | Descrizione | Valore |
---|---|---|
tipo | Rappresentare 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[] |
networkACLs | ACL rete | SignalRNetworkACLs |
publicNetworkAccess | Abilitare o disabilitare l'accesso alla rete pubblica. Impostazione predefinita su "Abilitato". Quando è abilitato, gli elenchi di controllo di controllo di rete sono ancora applicabili. Quando è disabilitato, l'accesso alla rete pubblica è sempre disabilitato indipendentemente dall'aCL di rete impostato. |
string |
Tls | Impostazioni TLS. | SignalRTlsSettings |
upstream | Impostazioni upstream quando il servizio è in modalità meno server. | ServerlessUpstreamSettings |
SignalRCorsSettings
Nome | Descrizione | Valore |
---|---|---|
allowedOrigins | Ottiene o imposta l'elenco di origini che devono essere consentite per effettuare chiamate tra origini ( ad esempio: http://example.com:12345 ). Usare "*" per consentirli tutti. Se omesso, consenti tutto per impostazione predefinita. |
string[] |
SignalRFeature
Nome | Descrizione | Valore |
---|---|---|
flag | FeatureFlags è la funzionalità supportata 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 dispone di un server back-end; "Classico": per la compatibilità con le versioni precedenti. Supporta sia la modalità predefinita che serverless, ma non è consigliata; "PredefinitaOnly": per l'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 fornisce tracce live in tempo reale, sarà utile quando si sviluppa un'applicazione Web basata su Azure SignalR o si risolveranno alcuni problemi. Si noti che le tracce live 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 (obbligatoria) Vincoli: Lunghezza minima = 1 Lunghezza massima = 128 |
SignalRFeatureProperties
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | string |
SignalRNetworkACLs
Nome | Descrizione | Valore |
---|---|---|
Defaultaction | Azione predefinita quando nessun'altra regola corrisponde | 'Allow' 'Deny' |
privateEndpoints | ACL per le richieste da endpoint privati | PrivateEndpointACL[] |
publicNetwork | Elenco di controllo di accesso per le richieste dalla rete pubblica | 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' |
SignalRTlsSettings
Nome | Descrizione | Valore |
---|---|---|
clientCertEnabled | Richiedere il certificato client durante l'handshake TLS se abilitato | 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 | Ottiene o imposta le impostazioni di autenticazione per un 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. "*", 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 categoria singola, 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 evento 2. Combinare più eventi con ",", ad esempio "connetti, disconnettersi", corrisponde all'evento "connect" e "disconnect" 3. Nome singolo evento, ad esempio "connect", corrisponde a "connect" |
string |
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" |
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 dinamicamente quando viene eseguita la richiesta client. Ad esempio, se l'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 (obbligatoria) |
UpstreamAuthSettings
Nome | Descrizione | Valore |
---|---|---|
managedIdentity | Ottiene o imposta le impostazioni di identità gestite. È necessario se il tipo di autenticazione è impostato su ManagedIdentity. | ManagedIdentitySettings |
tipo | Ottiene o imposta il tipo di autenticazione. None o ManagedIdentity è ora supportato. | 'ManagedIdentity' 'Nessuno' |
ManagedIdentitySettings
Nome | Descrizione | Valore |
---|---|---|
Risorsa | Risorsa che indica l'URI ID app della risorsa di destinazione. Viene anche visualizzata nell'attestazione aud (pubblico) del token emesso. |
string |
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.5.10.20.50.100 |
INT |
name | Il nome della SKU. Obbligatorio. Valori consentiti: Standard_S1, Free_F1 |
stringa (obbligatoria) |
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:
- 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@2021-09-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"
}
]
networkACLs = {
defaultAction = "string"
privateEndpoints = [
{
allow = [
"string"
]
deny = [
"string"
]
name = "string"
}
]
publicNetwork = {
allow = [
"string"
]
deny = [
"string"
]
}
}
publicNetworkAccess = "string"
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@2021-09-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 della risorsa. Ad esempio Stati Uniti occidentali , Stati Uniti orientali , Stati Uniti centro-settentrionali , Stati Uniti centro-meridionali. | string |
parent_id | Per distribuire in un gruppo di risorse, usare l'ID del gruppo di risorse. | stringa (obbligatoria) |
tags | Tag del servizio che è un elenco di coppie di valori chiave che descrivono la risorsa. | Dizionario dei nomi e dei valori dei tag. |
sku | Informazioni di fatturazione della risorsa. (ad esempio Gratuito, Standard) | ResourceSku |
kind | Tipo di servizio, ad esempio "SignalR" per "Microsoft.SignalRService/SignalR" | "RawWebSockets" "SignalR" |
identity | Risposta dell'identità gestita | ManagedIdentity |
properties | Impostazioni usate per effettuare il provisioning o configurare la risorsa | SignalRProperties |
ManagedIdentity
Nome | Descrizione | Valore |
---|---|---|
tipo | Rappresentare 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[] |
networkACLs | ACL rete | 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 |
Tls | Impostazioni TLS. | SignalRTlsSettings |
upstream | Impostazioni 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 |
SignalRNetworkACLs
Nome | Descrizione | Valore |
---|---|---|
Defaultaction | Azione predefinita quando nessun'altra regola corrisponde | "Consenti" "Nega" |
privateEndpoints | ACL per le richieste da endpoint privati | PrivateEndpointACL[] |
publicNetwork | ACL per le richieste dalla rete pubblica | 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ù di: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno dei seguenti elementi: "ClientConnection" "RESTAPI" "ServerConnection" "Traccia" |
name | Nome della connessione dell'endpoint privato | stringa (obbligatorio) |
NetworkACL
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ù di: ClientConnection, ServerConnection, RESTAPI. | Matrice di stringhe contenente uno dei seguenti elementi: "ClientConnection" "RESTAPI" "ServerConnection" "Traccia" |
SignalRTlsSettings
Nome | Descrizione | Valore |
---|---|---|
clientCertEnabled | Richiedere il certificato client durante l'handshake TLS, se abilitato | 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 | Ottiene o imposta le impostazioni di autenticazione per un 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. "*", 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" |
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. "*", in modo che corrisponda 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 | Ottiene o imposta le impostazioni dell'identità gestita. È obbligatorio se il tipo di autenticazione è impostato su ManagedIdentity. | ManagedIdentitySettings |
tipo | Ottiene o imposta il tipo di autenticazione. Nessuna o ManagedIdentity è ora supportata. | "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,5,10,20,50,100 |
INT |
name | Il nome della SKU. Obbligatorio. Valori consentiti: Standard_S1, Free_F1 |
stringa (obbligatorio) |
Livello | Livello facoltativo di questo SKU specifico. 'Standard' o 'Free'. Basic è deprecato, usare Standard invece . |
"Basic" "Gratuito" "Premium" "Standard" |