Microsoft.SignalRService signalR 2021-10-01
- neueste
- 2024-10-01-Vorschau-
- 2024-08-01-Preview-
- 2024-04-01-Preview-
- 2024-03-01
- 2024-01-01-Preview-
- 2023-08-01-Preview-
- 2023-06-01-Preview-
- 2023-03-01-Preview-
- 2023-02-01
- 2022-08-01-Preview-
- 2022-02-01
- 2021-10-01
- 2021-09-01-Preview-
- 2021-06-01-Preview-
- 2021-04-01-preview
- 2020-07-01-Preview-
- 2020-05-01
- 2018-10-01
- 2018-03-01-Preview-
Bicep-Ressourcendefinition
Der SignalR-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.SignalRService/signalR-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.
resource symbolicname 'Microsoft.SignalRService/signalR@2021-10-01' = {
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'
}
]
networkACLs: {
defaultAction: 'string'
privateEndpoints: [
{
allow: [
'string'
]
deny: [
'string'
]
name: 'string'
}
]
publicNetwork: {
allow: [
'string'
]
deny: [
'string'
]
}
}
publicNetworkAccess: 'string'
resourceLogConfiguration: {
categories: [
{
enabled: 'string'
name: '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'
}
tags: {
{customized property}: 'string'
}
}
Eigenschaftswerte
ManagedIdentity
| Name | Beschreibung | Wert |
|---|---|---|
| Art | Stellt den Identitätstyp dar: systemAssigned, userAssigned, None | 'None' 'SystemAssigned' "UserAssigned" |
| userAssignedIdentities | Abrufen oder Festlegen der vom Benutzer zugewiesenen Identitäten | ManagedIdentityUserAssignedIdentities- |
ManagedIdentitySettings
| Name | Beschreibung | Wert |
|---|---|---|
| Ressource | Die Ressource, die den App-ID-URI der Zielressource angibt. Es wird auch im aud (Audience)-Anspruch des ausgestellten Tokens angezeigt. |
Schnur |
ManagedIdentityUserAssignedIdentities
| Name | Beschreibung | Wert |
|---|
Microsoft.SignalRService/signalR
| Name | Beschreibung | Wert | |||
|---|---|---|---|---|---|
| Identität | Eine Klasse stellt verwaltete Identitäten dar, die für Anforderung und Antwort verwendet werden. | ManagedIdentity- | |||
| Art | Die Art des Diensts, es kann SignalR oder RawWebSockets sein | "RawWebSockets" "SignalR" |
|||
| Ort | Der GEO-Standort der Ressource. z.B. West-USA | Ost-USA | Nord-Mittel-USA | South Central US. | Schnur |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) | |||
| Eigenschaften | Eine Klasse, die die Eigenschaften der Ressource beschreibt | SignalRProperties- | |||
| Sku | Die Abrechnungsinformationen der Ressource. | ResourceSku- | |||
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
NetworkACL
| Name | Beschreibung | Wert |
|---|---|---|
| erlauben | Zulässige Anforderungstypen. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'ClientConnection' 'RESTAPI' 'ServerConnection' "Ablaufverfolgung" |
| leugnen | Anforderungstypen verweigert. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'ClientConnection' 'RESTAPI' 'ServerConnection' "Ablaufverfolgung" |
PrivateEndpointACL
| Name | Beschreibung | Wert |
|---|---|---|
| erlauben | Zulässige Anforderungstypen. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'ClientConnection' 'RESTAPI' 'ServerConnection' "Ablaufverfolgung" |
| leugnen | Anforderungstypen verweigert. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'ClientConnection' 'RESTAPI' 'ServerConnection' "Ablaufverfolgung" |
| Name | Name der privaten Endpunktverbindung | Zeichenfolge (erforderlich) |
ResourceLogCategory
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Gibt an, ob die Ressourcenprotokollkategorie aktiviert ist. Verfügbare Werte: true, false. Schreibungsunabhängig. |
Schnur |
| Name | Dient zum Abrufen oder Festlegen des Namens der Ressourcenprotokollkategorie. Verfügbare Werte: ConnectivityLogs, MessagingLogs. Schreibungsunabhängig. |
Schnur |
ResourceLogConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| Kategorien | Dient zum Abrufen oder Festlegen der Liste der Kategoriekonfigurationen. | ResourceLogCategory[] |
ResourceSku
| Name | Beschreibung | Wert |
|---|---|---|
| Fassungsvermögen | Optional, ganze Zahl. Die Anzahl der Einheiten der Ressource. 1 standardmäßig. Wenn vorhanden, sind die folgenden Werte zulässig: Kostenlos: 1 Standard: 1,2,5,10,20,50,100 |
Int |
| Name | Der Name der SKU. Erforderlich. Zulässige Werte: Standard_S1, Free_F1 |
Zeichenfolge (erforderlich) |
| Rang | Optionale Ebene dieser bestimmten SKU. "Standard" oder "Kostenlos". Basic veraltet ist, verwenden Sie stattdessen Standard. |
"Einfach" "Kostenlos" "Premium" "Standard" |
ServerlessUpstreamSettings
| Name | Beschreibung | Wert |
|---|---|---|
| Schablonen | Ruft die Liste der Upstream-URL-Vorlagen ab oder legt sie fest. Reihenfolge ist wichtig, und die erste übereinstimmende Vorlage wirkt sich aus. | UpstreamTemplate[] |
SignalRCorsSettings
| Name | Beschreibung | Wert |
|---|---|---|
| allowedOrigins | Dient zum Abrufen oder Festlegen der Liste der Ursprünge, die grenzüberschreitende Aufrufe ausführen dürfen (z. B. http://example.com:12345). Verwenden Sie "*", um alle zuzulassen. Wenn sie weggelassen wird, lassen Sie alle standardmäßig zu. | string[] |
SignalRFeature
| Name | Beschreibung | Wert |
|---|---|---|
| Flagge | FeatureFlags ist die unterstützten Features des Azure SignalR-Diensts. - ServiceMode: Flag für Back-End-Server für SignalR-Dienst. Zulässige Werte: "Standard": Besitzen Sie Ihren eigenen Back-End-Server; "Serverless": Ihre Anwendung verfügt nicht über einen Back-End-Server; "Klassisch": aus Gründen der Abwärtskompatibilität. Unterstützt sowohl den Standardmodus als auch den serverlosen Modus, wird jedoch nicht empfohlen; "PredefinedOnly": für zukünftige Verwendung. - EnableConnectivityLogs: "true"/"false", um die Verbindungsprotokollkategorie bzw. die Verbindungsprotokollkategorie zu aktivieren/deaktivieren. - EnableMessagingLogs: "true"/"false", um die Verbindungsprotokollkategorie bzw. die Verbindungsprotokollkategorie zu aktivieren/zu deaktivieren. - EnableLiveTrace: Live Trace ermöglicht Es Ihnen zu wissen, was innerhalb des Azure SignalR-Diensts passiert, es gibt Ihnen Live-Ablaufverfolgungen in Echtzeit, es ist hilfreich, wenn Sie Ihre eigene Azure SignalR-basierte Webanwendung entwickeln oder einige Probleme selbst beheben. Bitte beachten Sie, dass Live-Ablaufverfolgungen als ausgehende Nachrichten gezählt werden, die in Rechnung gestellt werden. Zulässige Werte: "true"/"false", um das Live-Ablaufverfolgungsfeature zu aktivieren/zu deaktivieren. |
"EnableConnectivityLogs" 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' (erforderlich) |
| Eigenschaften | Optionale Eigenschaften im Zusammenhang mit diesem Feature. | SignalRFeatureProperties |
| Wert | Wert des Featurekennzeichnungs. Unter Azure SignalR-Dienstdokument /azure/azure-signalr/ finden Sie zulässige Werte. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
SignalRFeatureProperties
| Name | Beschreibung | Wert |
|---|
SignalRNetworkACLs
| Name | Beschreibung | Wert |
|---|---|---|
| defaultAction | Azure Networking ACL-Aktion. | "Zulassen" "Ablehnen" |
| privateEndpoints | ACLs für Anforderungen von privaten Endpunkten | PrivateEndpointACL-[] |
| publicNetwork | Netzwerk-ACL | NetworkACL- |
SignalRProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Cors | CorS-Einstellungen (Cross-Origin Resource Sharing). | SignalRCorsSettings |
| disableAadAuth | DisableLocalAuth Aktivieren oder Deaktivieren einer Aad-Authentifizierung Wenn "true" festgelegt ist, funktioniert die Verbindung mit AuthType=aad nicht. |
Bool |
| disableLocalAuth | DisableLocalAuth Aktivieren oder Deaktivieren der lokalen Authentifizierung mit AccessKey Bei Festlegung auf "true" funktioniert die Verbindung mit AccessKey=xxx nicht. |
Bool |
| Funktionen | Liste der featureFlags. FeatureFlags, die nicht in den Parametern für den Updatevorgang enthalten sind, werden nicht geändert. Und die Antwort enthält nur FeatureFlags, die explizit festgelegt sind. Wenn ein featureFlag nicht explizit festgelegt wird, wird der globale Standardwert verwendet. Bedenken Sie jedoch, dass der Standardwert nicht "false" bedeutet. Es variiert in Bezug auf verschiedene FeatureFlags. |
SignalRFeature[] |
| networkACLs | Netzwerk-ACLs für die Ressource | SignalRNetworkACLs |
| publicNetworkAccess | Aktivieren oder Deaktivieren des öffentlichen Netzwerkzugriffs. Der Standardwert ist "Aktiviert". Wenn sie aktiviert ist, gelten weiterhin Netzwerk-ACLs. Wenn sie deaktiviert ist, ist der Zugriff auf öffentliche Netzwerke immer deaktiviert, unabhängig davon, was Sie in Netzwerk-ACLs festgelegt haben. |
Schnur |
| resourceLogConfiguration | Ressourcenprotokollkonfiguration einer Microsoft.SignalRService-Ressource. | ResourceLogConfiguration- |
| tls | TLS-Einstellungen für die Ressource | SignalRTlsSettings |
| stromaufwärts | Die Einstellungen für den Upstream, wenn sich der Dienst im serverlosen Modus befindet. | ServerlessUpstreamSettings- |
SignalRTlsSettings
| Name | Beschreibung | Wert |
|---|---|---|
| clientCertEnabled | Anfordern eines Clientzertifikats während des TLS-Handshakes, falls aktiviert | Bool |
TrackedResourceTags
| Name | Beschreibung | Wert |
|---|
UpstreamAuthSettings
| Name | Beschreibung | Wert |
|---|---|---|
| managedIdentity | Verwaltete Identitätseinstellungen für upstream. | ManagedIdentitySettings- |
| Art | Vorgelagerte Authentifizierungstyp-Enumeration. | "ManagedIdentity" 'None' |
UpstreamTemplate
| Name | Beschreibung | Wert |
|---|---|---|
| Auth | Vorgelagerte Authentifizierungseinstellungen. Wenn sie nicht festgelegt ist, wird keine Authentifizierung für upstream-Nachrichten verwendet. | UpstreamAuthSettings |
| categoryPattern | Dient zum Abrufen oder Festlegen des Abgleichsmusters für Kategorienamen. Wenn sie nicht festgelegt ist, entspricht sie einer Kategorie. Es werden drei Arten von Mustern unterstützt: 1. "*", es entspricht einem beliebigen Kategorienamen. 2. Kombinieren Sie mehrere Kategorien mit ",", z. B. "Verbindungen,Nachrichten", sie entspricht der Kategorie "Verbindungen" und "Nachrichten". 3. Der Name der einzelnen Kategorie, z. B. "Connections", entspricht er der Kategorie "Connections". |
Schnur |
| eventPattern | Dient zum Abrufen oder Festlegen des Abgleichsmusters für Ereignisnamen. Wenn sie nicht festgelegt ist, stimmt sie mit einem Ereignis überein. Es werden drei Arten von Mustern unterstützt: 1. "*", es entspricht jedem Ereignisnamen. 2. Kombinieren Sie mehrere Ereignisse mit ",", z. B. "Verbinden,Trennen", mit dem Ereignis "connect" und "disconnect" 3. Der Name des einzelnen Ereignisses, z. B. "connect", stimmt mit "connect" überein. |
Schnur |
| hubPattern | Ruft ab oder legt das übereinstimmende Muster für Hubnamen fest. Wenn sie nicht festgelegt ist, stimmt sie mit einem Hub überein. Es werden drei Arten von Mustern unterstützt: 1. "*", es entspricht jedem Hubnamen. 2. Kombinieren Sie mehrere Hubs mit ",", z. B. "hub1,hub2", sie entspricht "hub1" und "hub2" 3. Der name des einzelnen Hubs, z. B. "hub1", entspricht er "hub1" |
Schnur |
| urlTemplate | Ruft die Upstream-URL-Vorlage ab oder legt sie fest. Sie können drei vordefinierte Parameter {hub}, {category} {event} innerhalb der Vorlage verwenden, der Wert der Upstream-URL wird dynamisch berechnet, wenn die Clientanforderung eingeht. Wenn die urlTemplate z. B. http://example.com/{hub}/api/{event}ist und eine Clientanforderung vom Hub chat eine Verbindung herstellt, wird zunächst POST an diese URL gestellt: http://example.com/chat/api/connect. |
Zeichenfolge (erforderlich) |
UserAssignedIdentityProperty
| Name | Beschreibung | Wert |
|---|
Schnellstartbeispiele
Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.
| Bicep-Datei | Beschreibung |
|---|---|
| Bereitstellen eines Azure SignalR-Diensts | Diese Vorlage erstellt einen Azure SignalR-Dienst mithilfe einer Vorlage. |
ARM-Vorlagenressourcendefinition
Der SignalR-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.SignalRService/signalR-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2021-10-01",
"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"
}
],
"networkACLs": {
"defaultAction": "string",
"privateEndpoints": [
{
"allow": [ "string" ],
"deny": [ "string" ],
"name": "string"
}
],
"publicNetwork": {
"allow": [ "string" ],
"deny": [ "string" ]
}
},
"publicNetworkAccess": "string",
"resourceLogConfiguration": {
"categories": [
{
"enabled": "string",
"name": "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"
},
"tags": {
"{customized property}": "string"
}
}
Eigenschaftswerte
ManagedIdentity
| Name | Beschreibung | Wert |
|---|---|---|
| Art | Stellt den Identitätstyp dar: systemAssigned, userAssigned, None | 'None' 'SystemAssigned' "UserAssigned" |
| userAssignedIdentities | Abrufen oder Festlegen der vom Benutzer zugewiesenen Identitäten | ManagedIdentityUserAssignedIdentities- |
ManagedIdentitySettings
| Name | Beschreibung | Wert |
|---|---|---|
| Ressource | Die Ressource, die den App-ID-URI der Zielressource angibt. Es wird auch im aud (Audience)-Anspruch des ausgestellten Tokens angezeigt. |
Schnur |
ManagedIdentityUserAssignedIdentities
| Name | Beschreibung | Wert |
|---|
Microsoft.SignalRService/signalR
| Name | Beschreibung | Wert | |||
|---|---|---|---|---|---|
| apiVersion | Die API-Version | '2021-10-01' | |||
| Identität | Eine Klasse stellt verwaltete Identitäten dar, die für Anforderung und Antwort verwendet werden. | ManagedIdentity- | |||
| Art | Die Art des Diensts, es kann SignalR oder RawWebSockets sein | "RawWebSockets" "SignalR" |
|||
| Ort | Der GEO-Standort der Ressource. z.B. West-USA | Ost-USA | Nord-Mittel-USA | South Central US. | Schnur |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) | |||
| Eigenschaften | Eine Klasse, die die Eigenschaften der Ressource beschreibt | SignalRProperties- | |||
| Sku | Die Abrechnungsinformationen der Ressource. | ResourceSku- | |||
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen | |||
| Art | Der Ressourcentyp | "Microsoft.SignalRService/signalR" |
NetworkACL
| Name | Beschreibung | Wert |
|---|---|---|
| erlauben | Zulässige Anforderungstypen. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'ClientConnection' 'RESTAPI' 'ServerConnection' "Ablaufverfolgung" |
| leugnen | Anforderungstypen verweigert. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'ClientConnection' 'RESTAPI' 'ServerConnection' "Ablaufverfolgung" |
PrivateEndpointACL
| Name | Beschreibung | Wert |
|---|---|---|
| erlauben | Zulässige Anforderungstypen. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'ClientConnection' 'RESTAPI' 'ServerConnection' "Ablaufverfolgung" |
| leugnen | Anforderungstypen verweigert. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'ClientConnection' 'RESTAPI' 'ServerConnection' "Ablaufverfolgung" |
| Name | Name der privaten Endpunktverbindung | Zeichenfolge (erforderlich) |
ResourceLogCategory
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Gibt an, ob die Ressourcenprotokollkategorie aktiviert ist. Verfügbare Werte: true, false. Schreibungsunabhängig. |
Schnur |
| Name | Dient zum Abrufen oder Festlegen des Namens der Ressourcenprotokollkategorie. Verfügbare Werte: ConnectivityLogs, MessagingLogs. Schreibungsunabhängig. |
Schnur |
ResourceLogConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| Kategorien | Dient zum Abrufen oder Festlegen der Liste der Kategoriekonfigurationen. | ResourceLogCategory[] |
ResourceSku
| Name | Beschreibung | Wert |
|---|---|---|
| Fassungsvermögen | Optional, ganze Zahl. Die Anzahl der Einheiten der Ressource. 1 standardmäßig. Wenn vorhanden, sind die folgenden Werte zulässig: Kostenlos: 1 Standard: 1,2,5,10,20,50,100 |
Int |
| Name | Der Name der SKU. Erforderlich. Zulässige Werte: Standard_S1, Free_F1 |
Zeichenfolge (erforderlich) |
| Rang | Optionale Ebene dieser bestimmten SKU. "Standard" oder "Kostenlos". Basic veraltet ist, verwenden Sie stattdessen Standard. |
"Einfach" "Kostenlos" "Premium" "Standard" |
ServerlessUpstreamSettings
| Name | Beschreibung | Wert |
|---|---|---|
| Schablonen | Ruft die Liste der Upstream-URL-Vorlagen ab oder legt sie fest. Reihenfolge ist wichtig, und die erste übereinstimmende Vorlage wirkt sich aus. | UpstreamTemplate[] |
SignalRCorsSettings
| Name | Beschreibung | Wert |
|---|---|---|
| allowedOrigins | Dient zum Abrufen oder Festlegen der Liste der Ursprünge, die grenzüberschreitende Aufrufe ausführen dürfen (z. B. http://example.com:12345). Verwenden Sie "*", um alle zuzulassen. Wenn sie weggelassen wird, lassen Sie alle standardmäßig zu. | string[] |
SignalRFeature
| Name | Beschreibung | Wert |
|---|---|---|
| Flagge | FeatureFlags ist die unterstützten Features des Azure SignalR-Diensts. - ServiceMode: Flag für Back-End-Server für SignalR-Dienst. Zulässige Werte: "Standard": Besitzen Sie Ihren eigenen Back-End-Server; "Serverless": Ihre Anwendung verfügt nicht über einen Back-End-Server; "Klassisch": aus Gründen der Abwärtskompatibilität. Unterstützt sowohl den Standardmodus als auch den serverlosen Modus, wird jedoch nicht empfohlen; "PredefinedOnly": für zukünftige Verwendung. - EnableConnectivityLogs: "true"/"false", um die Verbindungsprotokollkategorie bzw. die Verbindungsprotokollkategorie zu aktivieren/deaktivieren. - EnableMessagingLogs: "true"/"false", um die Verbindungsprotokollkategorie bzw. die Verbindungsprotokollkategorie zu aktivieren/zu deaktivieren. - EnableLiveTrace: Live Trace ermöglicht Es Ihnen zu wissen, was innerhalb des Azure SignalR-Diensts passiert, es gibt Ihnen Live-Ablaufverfolgungen in Echtzeit, es ist hilfreich, wenn Sie Ihre eigene Azure SignalR-basierte Webanwendung entwickeln oder einige Probleme selbst beheben. Bitte beachten Sie, dass Live-Ablaufverfolgungen als ausgehende Nachrichten gezählt werden, die in Rechnung gestellt werden. Zulässige Werte: "true"/"false", um das Live-Ablaufverfolgungsfeature zu aktivieren/zu deaktivieren. |
"EnableConnectivityLogs" 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' (erforderlich) |
| Eigenschaften | Optionale Eigenschaften im Zusammenhang mit diesem Feature. | SignalRFeatureProperties |
| Wert | Wert des Featurekennzeichnungs. Unter Azure SignalR-Dienstdokument /azure/azure-signalr/ finden Sie zulässige Werte. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
SignalRFeatureProperties
| Name | Beschreibung | Wert |
|---|
SignalRNetworkACLs
| Name | Beschreibung | Wert |
|---|---|---|
| defaultAction | Azure Networking ACL-Aktion. | "Zulassen" "Ablehnen" |
| privateEndpoints | ACLs für Anforderungen von privaten Endpunkten | PrivateEndpointACL-[] |
| publicNetwork | Netzwerk-ACL | NetworkACL- |
SignalRProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Cors | CorS-Einstellungen (Cross-Origin Resource Sharing). | SignalRCorsSettings |
| disableAadAuth | DisableLocalAuth Aktivieren oder Deaktivieren einer Aad-Authentifizierung Wenn "true" festgelegt ist, funktioniert die Verbindung mit AuthType=aad nicht. |
Bool |
| disableLocalAuth | DisableLocalAuth Aktivieren oder Deaktivieren der lokalen Authentifizierung mit AccessKey Bei Festlegung auf "true" funktioniert die Verbindung mit AccessKey=xxx nicht. |
Bool |
| Funktionen | Liste der featureFlags. FeatureFlags, die nicht in den Parametern für den Updatevorgang enthalten sind, werden nicht geändert. Und die Antwort enthält nur FeatureFlags, die explizit festgelegt sind. Wenn ein featureFlag nicht explizit festgelegt wird, wird der globale Standardwert verwendet. Bedenken Sie jedoch, dass der Standardwert nicht "false" bedeutet. Es variiert in Bezug auf verschiedene FeatureFlags. |
SignalRFeature[] |
| networkACLs | Netzwerk-ACLs für die Ressource | SignalRNetworkACLs |
| publicNetworkAccess | Aktivieren oder Deaktivieren des öffentlichen Netzwerkzugriffs. Der Standardwert ist "Aktiviert". Wenn sie aktiviert ist, gelten weiterhin Netzwerk-ACLs. Wenn sie deaktiviert ist, ist der Zugriff auf öffentliche Netzwerke immer deaktiviert, unabhängig davon, was Sie in Netzwerk-ACLs festgelegt haben. |
Schnur |
| resourceLogConfiguration | Ressourcenprotokollkonfiguration einer Microsoft.SignalRService-Ressource. | ResourceLogConfiguration- |
| tls | TLS-Einstellungen für die Ressource | SignalRTlsSettings |
| stromaufwärts | Die Einstellungen für den Upstream, wenn sich der Dienst im serverlosen Modus befindet. | ServerlessUpstreamSettings- |
SignalRTlsSettings
| Name | Beschreibung | Wert |
|---|---|---|
| clientCertEnabled | Anfordern eines Clientzertifikats während des TLS-Handshakes, falls aktiviert | Bool |
TrackedResourceTags
| Name | Beschreibung | Wert |
|---|
UpstreamAuthSettings
| Name | Beschreibung | Wert |
|---|---|---|
| managedIdentity | Verwaltete Identitätseinstellungen für upstream. | ManagedIdentitySettings- |
| Art | Vorgelagerte Authentifizierungstyp-Enumeration. | "ManagedIdentity" 'None' |
UpstreamTemplate
| Name | Beschreibung | Wert |
|---|---|---|
| Auth | Vorgelagerte Authentifizierungseinstellungen. Wenn sie nicht festgelegt ist, wird keine Authentifizierung für upstream-Nachrichten verwendet. | UpstreamAuthSettings |
| categoryPattern | Dient zum Abrufen oder Festlegen des Abgleichsmusters für Kategorienamen. Wenn sie nicht festgelegt ist, entspricht sie einer Kategorie. Es werden drei Arten von Mustern unterstützt: 1. "*", es entspricht einem beliebigen Kategorienamen. 2. Kombinieren Sie mehrere Kategorien mit ",", z. B. "Verbindungen,Nachrichten", sie entspricht der Kategorie "Verbindungen" und "Nachrichten". 3. Der Name der einzelnen Kategorie, z. B. "Connections", entspricht er der Kategorie "Connections". |
Schnur |
| eventPattern | Dient zum Abrufen oder Festlegen des Abgleichsmusters für Ereignisnamen. Wenn sie nicht festgelegt ist, stimmt sie mit einem Ereignis überein. Es werden drei Arten von Mustern unterstützt: 1. "*", es entspricht jedem Ereignisnamen. 2. Kombinieren Sie mehrere Ereignisse mit ",", z. B. "Verbinden,Trennen", mit dem Ereignis "connect" und "disconnect" 3. Der Name des einzelnen Ereignisses, z. B. "connect", stimmt mit "connect" überein. |
Schnur |
| hubPattern | Ruft ab oder legt das übereinstimmende Muster für Hubnamen fest. Wenn sie nicht festgelegt ist, stimmt sie mit einem Hub überein. Es werden drei Arten von Mustern unterstützt: 1. "*", es entspricht jedem Hubnamen. 2. Kombinieren Sie mehrere Hubs mit ",", z. B. "hub1,hub2", sie entspricht "hub1" und "hub2" 3. Der name des einzelnen Hubs, z. B. "hub1", entspricht er "hub1" |
Schnur |
| urlTemplate | Ruft die Upstream-URL-Vorlage ab oder legt sie fest. Sie können drei vordefinierte Parameter {hub}, {category} {event} innerhalb der Vorlage verwenden, der Wert der Upstream-URL wird dynamisch berechnet, wenn die Clientanforderung eingeht. Wenn die urlTemplate z. B. http://example.com/{hub}/api/{event}ist und eine Clientanforderung vom Hub chat eine Verbindung herstellt, wird zunächst POST an diese URL gestellt: http://example.com/chat/api/connect. |
Zeichenfolge (erforderlich) |
UserAssignedIdentityProperty
| Name | Beschreibung | Wert |
|---|
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
| Schablone | Beschreibung |
|---|---|
Bereitstellen eines Azure SignalR-Diensts
|
Diese Vorlage erstellt einen Azure SignalR-Dienst mithilfe einer Vorlage. |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der SignalR-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.SignalRService/signalR-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SignalRService/signalR@2021-10-01"
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"
}
]
networkACLs = {
defaultAction = "string"
privateEndpoints = [
{
allow = [
"string"
]
deny = [
"string"
]
name = "string"
}
]
publicNetwork = {
allow = [
"string"
]
deny = [
"string"
]
}
}
publicNetworkAccess = "string"
resourceLogConfiguration = {
categories = [
{
enabled = "string"
name = "string"
}
]
}
tls = {
clientCertEnabled = bool
}
upstream = {
templates = [
{
auth = {
managedIdentity = {
resource = "string"
}
type = "string"
}
categoryPattern = "string"
eventPattern = "string"
hubPattern = "string"
urlTemplate = "string"
}
]
}
}
})
}
Eigenschaftswerte
ManagedIdentity
| Name | Beschreibung | Wert |
|---|---|---|
| Art | Stellt den Identitätstyp dar: systemAssigned, userAssigned, None | 'None' 'SystemAssigned' "UserAssigned" |
| userAssignedIdentities | Abrufen oder Festlegen der vom Benutzer zugewiesenen Identitäten | ManagedIdentityUserAssignedIdentities- |
ManagedIdentitySettings
| Name | Beschreibung | Wert |
|---|---|---|
| Ressource | Die Ressource, die den App-ID-URI der Zielressource angibt. Es wird auch im aud (Audience)-Anspruch des ausgestellten Tokens angezeigt. |
Schnur |
ManagedIdentityUserAssignedIdentities
| Name | Beschreibung | Wert |
|---|
Microsoft.SignalRService/signalR
| Name | Beschreibung | Wert | |||
|---|---|---|---|---|---|
| Identität | Eine Klasse stellt verwaltete Identitäten dar, die für Anforderung und Antwort verwendet werden. | ManagedIdentity- | |||
| Art | Die Art des Diensts, es kann SignalR oder RawWebSockets sein | "RawWebSockets" "SignalR" |
|||
| Ort | Der GEO-Standort der Ressource. z.B. West-USA | Ost-USA | Nord-Mittel-USA | South Central US. | Schnur |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) | |||
| Eigenschaften | Eine Klasse, die die Eigenschaften der Ressource beschreibt | SignalRProperties- | |||
| Sku | Die Abrechnungsinformationen der Ressource. | ResourceSku- | |||
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. | |||
| Art | Der Ressourcentyp | "Microsoft.SignalRService/signalR@2021-10-01" |
NetworkACL
| Name | Beschreibung | Wert |
|---|---|---|
| erlauben | Zulässige Anforderungstypen. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'ClientConnection' 'RESTAPI' 'ServerConnection' "Ablaufverfolgung" |
| leugnen | Anforderungstypen verweigert. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'ClientConnection' 'RESTAPI' 'ServerConnection' "Ablaufverfolgung" |
PrivateEndpointACL
| Name | Beschreibung | Wert |
|---|---|---|
| erlauben | Zulässige Anforderungstypen. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'ClientConnection' 'RESTAPI' 'ServerConnection' "Ablaufverfolgung" |
| leugnen | Anforderungstypen verweigert. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'ClientConnection' 'RESTAPI' 'ServerConnection' "Ablaufverfolgung" |
| Name | Name der privaten Endpunktverbindung | Zeichenfolge (erforderlich) |
ResourceLogCategory
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Gibt an, ob die Ressourcenprotokollkategorie aktiviert ist. Verfügbare Werte: true, false. Schreibungsunabhängig. |
Schnur |
| Name | Dient zum Abrufen oder Festlegen des Namens der Ressourcenprotokollkategorie. Verfügbare Werte: ConnectivityLogs, MessagingLogs. Schreibungsunabhängig. |
Schnur |
ResourceLogConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| Kategorien | Dient zum Abrufen oder Festlegen der Liste der Kategoriekonfigurationen. | ResourceLogCategory[] |
ResourceSku
| Name | Beschreibung | Wert |
|---|---|---|
| Fassungsvermögen | Optional, ganze Zahl. Die Anzahl der Einheiten der Ressource. 1 standardmäßig. Wenn vorhanden, sind die folgenden Werte zulässig: Kostenlos: 1 Standard: 1,2,5,10,20,50,100 |
Int |
| Name | Der Name der SKU. Erforderlich. Zulässige Werte: Standard_S1, Free_F1 |
Zeichenfolge (erforderlich) |
| Rang | Optionale Ebene dieser bestimmten SKU. "Standard" oder "Kostenlos". Basic veraltet ist, verwenden Sie stattdessen Standard. |
"Einfach" "Kostenlos" "Premium" "Standard" |
ServerlessUpstreamSettings
| Name | Beschreibung | Wert |
|---|---|---|
| Schablonen | Ruft die Liste der Upstream-URL-Vorlagen ab oder legt sie fest. Reihenfolge ist wichtig, und die erste übereinstimmende Vorlage wirkt sich aus. | UpstreamTemplate[] |
SignalRCorsSettings
| Name | Beschreibung | Wert |
|---|---|---|
| allowedOrigins | Dient zum Abrufen oder Festlegen der Liste der Ursprünge, die grenzüberschreitende Aufrufe ausführen dürfen (z. B. http://example.com:12345). Verwenden Sie "*", um alle zuzulassen. Wenn sie weggelassen wird, lassen Sie alle standardmäßig zu. | string[] |
SignalRFeature
| Name | Beschreibung | Wert |
|---|---|---|
| Flagge | FeatureFlags ist die unterstützten Features des Azure SignalR-Diensts. - ServiceMode: Flag für Back-End-Server für SignalR-Dienst. Zulässige Werte: "Standard": Besitzen Sie Ihren eigenen Back-End-Server; "Serverless": Ihre Anwendung verfügt nicht über einen Back-End-Server; "Klassisch": aus Gründen der Abwärtskompatibilität. Unterstützt sowohl den Standardmodus als auch den serverlosen Modus, wird jedoch nicht empfohlen; "PredefinedOnly": für zukünftige Verwendung. - EnableConnectivityLogs: "true"/"false", um die Verbindungsprotokollkategorie bzw. die Verbindungsprotokollkategorie zu aktivieren/deaktivieren. - EnableMessagingLogs: "true"/"false", um die Verbindungsprotokollkategorie bzw. die Verbindungsprotokollkategorie zu aktivieren/zu deaktivieren. - EnableLiveTrace: Live Trace ermöglicht Es Ihnen zu wissen, was innerhalb des Azure SignalR-Diensts passiert, es gibt Ihnen Live-Ablaufverfolgungen in Echtzeit, es ist hilfreich, wenn Sie Ihre eigene Azure SignalR-basierte Webanwendung entwickeln oder einige Probleme selbst beheben. Bitte beachten Sie, dass Live-Ablaufverfolgungen als ausgehende Nachrichten gezählt werden, die in Rechnung gestellt werden. Zulässige Werte: "true"/"false", um das Live-Ablaufverfolgungsfeature zu aktivieren/zu deaktivieren. |
"EnableConnectivityLogs" 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' (erforderlich) |
| Eigenschaften | Optionale Eigenschaften im Zusammenhang mit diesem Feature. | SignalRFeatureProperties |
| Wert | Wert des Featurekennzeichnungs. Unter Azure SignalR-Dienstdokument /azure/azure-signalr/ finden Sie zulässige Werte. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
SignalRFeatureProperties
| Name | Beschreibung | Wert |
|---|
SignalRNetworkACLs
| Name | Beschreibung | Wert |
|---|---|---|
| defaultAction | Azure Networking ACL-Aktion. | "Zulassen" "Ablehnen" |
| privateEndpoints | ACLs für Anforderungen von privaten Endpunkten | PrivateEndpointACL-[] |
| publicNetwork | Netzwerk-ACL | NetworkACL- |
SignalRProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Cors | CorS-Einstellungen (Cross-Origin Resource Sharing). | SignalRCorsSettings |
| disableAadAuth | DisableLocalAuth Aktivieren oder Deaktivieren einer Aad-Authentifizierung Wenn "true" festgelegt ist, funktioniert die Verbindung mit AuthType=aad nicht. |
Bool |
| disableLocalAuth | DisableLocalAuth Aktivieren oder Deaktivieren der lokalen Authentifizierung mit AccessKey Bei Festlegung auf "true" funktioniert die Verbindung mit AccessKey=xxx nicht. |
Bool |
| Funktionen | Liste der featureFlags. FeatureFlags, die nicht in den Parametern für den Updatevorgang enthalten sind, werden nicht geändert. Und die Antwort enthält nur FeatureFlags, die explizit festgelegt sind. Wenn ein featureFlag nicht explizit festgelegt wird, wird der globale Standardwert verwendet. Bedenken Sie jedoch, dass der Standardwert nicht "false" bedeutet. Es variiert in Bezug auf verschiedene FeatureFlags. |
SignalRFeature[] |
| networkACLs | Netzwerk-ACLs für die Ressource | SignalRNetworkACLs |
| publicNetworkAccess | Aktivieren oder Deaktivieren des öffentlichen Netzwerkzugriffs. Der Standardwert ist "Aktiviert". Wenn sie aktiviert ist, gelten weiterhin Netzwerk-ACLs. Wenn sie deaktiviert ist, ist der Zugriff auf öffentliche Netzwerke immer deaktiviert, unabhängig davon, was Sie in Netzwerk-ACLs festgelegt haben. |
Schnur |
| resourceLogConfiguration | Ressourcenprotokollkonfiguration einer Microsoft.SignalRService-Ressource. | ResourceLogConfiguration- |
| tls | TLS-Einstellungen für die Ressource | SignalRTlsSettings |
| stromaufwärts | Die Einstellungen für den Upstream, wenn sich der Dienst im serverlosen Modus befindet. | ServerlessUpstreamSettings- |
SignalRTlsSettings
| Name | Beschreibung | Wert |
|---|---|---|
| clientCertEnabled | Anfordern eines Clientzertifikats während des TLS-Handshakes, falls aktiviert | Bool |
TrackedResourceTags
| Name | Beschreibung | Wert |
|---|
UpstreamAuthSettings
| Name | Beschreibung | Wert |
|---|---|---|
| managedIdentity | Verwaltete Identitätseinstellungen für upstream. | ManagedIdentitySettings- |
| Art | Vorgelagerte Authentifizierungstyp-Enumeration. | "ManagedIdentity" 'None' |
UpstreamTemplate
| Name | Beschreibung | Wert |
|---|---|---|
| Auth | Vorgelagerte Authentifizierungseinstellungen. Wenn sie nicht festgelegt ist, wird keine Authentifizierung für upstream-Nachrichten verwendet. | UpstreamAuthSettings |
| categoryPattern | Dient zum Abrufen oder Festlegen des Abgleichsmusters für Kategorienamen. Wenn sie nicht festgelegt ist, entspricht sie einer Kategorie. Es werden drei Arten von Mustern unterstützt: 1. "*", es entspricht einem beliebigen Kategorienamen. 2. Kombinieren Sie mehrere Kategorien mit ",", z. B. "Verbindungen,Nachrichten", sie entspricht der Kategorie "Verbindungen" und "Nachrichten". 3. Der Name der einzelnen Kategorie, z. B. "Connections", entspricht er der Kategorie "Connections". |
Schnur |
| eventPattern | Dient zum Abrufen oder Festlegen des Abgleichsmusters für Ereignisnamen. Wenn sie nicht festgelegt ist, stimmt sie mit einem Ereignis überein. Es werden drei Arten von Mustern unterstützt: 1. "*", es entspricht jedem Ereignisnamen. 2. Kombinieren Sie mehrere Ereignisse mit ",", z. B. "Verbinden,Trennen", mit dem Ereignis "connect" und "disconnect" 3. Der Name des einzelnen Ereignisses, z. B. "connect", stimmt mit "connect" überein. |
Schnur |
| hubPattern | Ruft ab oder legt das übereinstimmende Muster für Hubnamen fest. Wenn sie nicht festgelegt ist, stimmt sie mit einem Hub überein. Es werden drei Arten von Mustern unterstützt: 1. "*", es entspricht jedem Hubnamen. 2. Kombinieren Sie mehrere Hubs mit ",", z. B. "hub1,hub2", sie entspricht "hub1" und "hub2" 3. Der name des einzelnen Hubs, z. B. "hub1", entspricht er "hub1" |
Schnur |
| urlTemplate | Ruft die Upstream-URL-Vorlage ab oder legt sie fest. Sie können drei vordefinierte Parameter {hub}, {category} {event} innerhalb der Vorlage verwenden, der Wert der Upstream-URL wird dynamisch berechnet, wenn die Clientanforderung eingeht. Wenn die urlTemplate z. B. http://example.com/{hub}/api/{event}ist und eine Clientanforderung vom Hub chat eine Verbindung herstellt, wird zunächst POST an diese URL gestellt: http://example.com/chat/api/connect. |
Zeichenfolge (erforderlich) |
UserAssignedIdentityProperty
| Name | Beschreibung | Wert |
|---|