Anteckning
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
- senaste
- Förhandsversion 2024-10-01
- 2024-08-01-preview
- 2024-04-01 – förhandsversion
- 2024-03-01
- 2024-01-01-förhandsversion
- 2023-08-01 – förhandsversion
- Förhandsversion 2023-06-01
- 2023-03-01 – förhandsversion
- 2023-02-01
- 2022-08-01 – förhandsversion
- 2022-02-01
- 2021-10-01
- Förhandsversion 2021-09-01
- Förhandsversion 2021-06-01
- 2021-04-01-preview
- Förhandsversion 2020-07-01
- 2020-05-01
- 2018-10-01
- 2018-03-01-preview
Bicep-resursdefinition
SignalR-resurstypen kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.SignalRService/signalR-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.SignalRService/signalR@2021-06-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
cors: {
allowedOrigins: [
'string'
]
}
disableAadAuth: bool
disableLocalAuth: bool
features: [
{
flag: 'string'
properties: {
{customized property}: 'string'
}
value: 'string'
}
]
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'
}
tags: {
{customized property}: 'string'
}
}
Egenskapsvärden
Hanterad identitet
Namn | Beskrivning | Värde |
---|---|---|
typ | Representera identitetstypen: systemAssigned, userAssigned, None | "Ingen" "SystemAssigned" "UserAssigned" |
användartilldelade identiteter | Hämta eller ange användartilldelade identiteter | ManagedIdentityUserAssignedIdentiteter |
Inställningar för hanterad identitet
Namn | Beskrivning | Värde |
---|---|---|
resurs | Resursen som anger app-ID-URI:n för målresursen. Det visas också i aud-anspråket (målgruppen) för den utfärdade token. |
sträng |
ManagedIdentityUserAssignedIdentiteter
Namn | Beskrivning | Värde |
---|
Microsoft.SignalRService/signalR
Namn | Beskrivning | Värde |
---|---|---|
identitet | Svar på hanterad identitet | Hanterad identitet |
sort | Typen av tjänst – t.ex. "SignalR" för "Microsoft.SignalRService/SignalR" | "RawWebSockets" "SignalR" |
plats | Resursens GEO-plats. t.ex. USA, västra | USA, östra | USA, norra centrala | USA, södra centrala. | sträng |
Namn | Resursnamnet | sträng (krävs) |
Egenskaper | Inställningar som används för att etablera eller konfigurera resursen | SignalRProperties |
Sku | Faktureringsinformation för resursen. (t.ex. kostnadsfritt, standard) | ResourceSku (på engelska) |
Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
Nätverks-ACL
Namn | Beskrivning | Värde |
---|---|---|
tillåta | Tillåtna typer av begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI. | Strängmatris som innehåller något av: "ClientConnection" "RESTAPI" "ServerConnection" "Spårning" |
neka | Typer av nekade begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI. | Strängmatris som innehåller något av: "ClientConnection" "RESTAPI" "ServerConnection" "Spårning" |
PrivateEndpointACL (på engelska)
Namn | Beskrivning | Värde |
---|---|---|
tillåta | Tillåtna typer av begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI. | Strängmatris som innehåller något av: "ClientConnection" "RESTAPI" "ServerConnection" "Spårning" |
neka | Typer av nekade begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI. | Strängmatris som innehåller något av: "ClientConnection" "RESTAPI" "ServerConnection" "Spårning" |
Namn | Namnet på den privata slutpunktsanslutningen | sträng (krävs) |
ResourceSku (på engelska)
Namn | Beskrivning | Värde |
---|---|---|
kapacitet | Valfritt heltal. Antalet enheter för resursen. 1 som standard. Om det finns tillåts följande värden: Kostnadsfritt: 1 Standard: 1,2,5,10,20,50,100 |
Int |
Namn | Namnet på SKU:n. Krävs. Tillåtna värden: Standard_S1, Free_F1 |
sträng (krävs) |
Nivå | Valfri nivå för den här specifika SKU:n. "Standard" eller "Kostnadsfri". Basic är inaktuell använder du Standard i stället. |
"Grundläggande" "Kostnadsfri" "Premium" "Standard" |
ServerlessUpstreamInställningar
Namn | Beskrivning | Värde |
---|---|---|
Mallar | Hämtar eller anger listan över överordnade URL-mallar. Ordningen är viktig och den första matchande mallen får effekter. | UppströmsMall[] |
SignalRCorsInställningar
Namn | Beskrivning | Värde |
---|---|---|
allowedOrigins | Hämtar eller anger den lista över ursprung som ska tillåtas att göra korsande anrop (till exempel: http://example.com:12345). Använd "*" för att tillåta alla. Om det utelämnas tillåter du alla som standard. | sträng[] |
SignalRFeature (på engelska)
Namn | Beskrivning | Värde |
---|---|---|
flagga | FeatureFlags är de funktioner som stöds i Azure SignalR-tjänsten. – ServiceMode: Flagga för serverdelsserver för SignalR-tjänsten. Värden tillåtna: "Standard": har en egen serverdelsserver; "Serverlös": programmet har ingen serverdelsserver. "Klassisk": för bakåtkompatibilitet. Stöd för både standardläge och serverlöst läge men rekommenderas inte. "PredefinedOnly": för framtida användning. – EnableConnectivityLogs: "true"/"false", för att aktivera/inaktivera anslutningsloggkategorin. – EnableMessagingLogs: "true"/"false", för att aktivera/inaktivera anslutningsloggkategorin. – EnableLiveTrace: Med Live Trace kan du veta vad som händer i Azure SignalR-tjänsten, det ger dig livespårningar i realtid. Det är användbart när du utvecklar ett eget Azure SignalR-baserat webbprogram eller själv felsöker några problem. Observera att livespårningar räknas som utgående meddelanden som debiteras. Värden tillåts: "true"/"false", för att aktivera/inaktivera funktionen för livespårning. |
"EnableConnectivityLogs" "EnableLiveTrace" "EnableMessagingLogs" "ServiceMode" (krävs) |
Egenskaper | Valfria egenskaper som är relaterade till den här funktionen. | SignalRFeatureProperties (på engelska) |
värde | Värdet för funktionsflaggan. Se Azure SignalR Service-dokumentet /azure/azure-signalr/ för tillåtna värden. | sträng Begränsningar: Min längd = 1 Maximal längd = 128 (krävs) |
SignalRFeatureProperties (på engelska)
Namn | Beskrivning | Värde |
---|
SignalRNetworkACL:er
Namn | Beskrivning | Värde |
---|---|---|
defaultAction (standardåtgärd) | Standardåtgärd när ingen annan regel matchar | "Tillåt" "Neka" |
privata ändpunkter | ACL:er för begäranden från privata slutpunkter | PrivateEndpointACL[] |
publicNetwork (på engelska) | ACL för begäranden från offentliga nätverk | Nätverks-ACL |
SignalRProperties
Namn | Beskrivning | Värde |
---|---|---|
korset | CORS-inställningar (Cross-Origin Resource Sharing). | SignalRCorsInställningar |
disableAadAuth | DisableLocalAuth Aktivera eller inaktivera aad-autentisering När värdet är true fungerar inte anslutningen med AuthType=aad. |
Bool |
disableLocalAuth | DisableLocalAuth Aktivera eller inaktivera lokal autentisering med AccessKey När värdet är true fungerar inte anslutningen med AccessKey=xxx. |
Bool |
Funktioner | Lista över featureFlags. FeatureFlags som inte ingår i parametrarna för uppdateringsåtgärden ändras inte. Och svaret innehåller endast featureFlags som uttryckligen anges. När en featureFlag inte uttryckligen anges används dess globala standardvärde Men kom ihåg att standardvärdet inte betyder "false". Det varierar beroende på olika FeatureFlags. |
SignalRFeature[] |
networkACL:er | Nätverks-ACL:er | SignalRNetworkACL:er |
publicNetworkAccess (publicNetworkÅtkomst) | Aktivera eller inaktivera åtkomst till offentligt nätverk. Standardvärdet är "Aktiverad". När den är aktiverad gäller fortfarande nätverks-ACL:er. När den är inaktiverad inaktiveras alltid åtkomsten till det offentliga nätverket oavsett vad du anger i nätverks-ACL:er. |
sträng |
tls tls | TLS-inställningar. | Inställningar för SignalRTls |
uppströms | Överordnade inställningar när tjänsten är i serverlöst läge. | ServerlessUpstreamInställningar |
Inställningar för SignalRTls
Namn | Beskrivning | Värde |
---|---|---|
clientCertEnabled | Begär klientcertifikat under TLS-handskakning om det är aktiverat | Bool |
Spårade resurstaggar
Namn | Beskrivning | Värde |
---|
UpstreamAuthSettings (uppströmsAuthsettings)
Namn | Beskrivning | Värde |
---|---|---|
managedIdentity | Hämtar eller anger inställningarna för hanterad identitet. Det krävs om autentiseringstypen är inställd på ManagedIdentity. | Inställningar för hanterad identitet |
typ | Hämtar eller anger typen av autentisering. Ingen eller ManagedIdentity stöds nu. | "ManagedIdentity" "Ingen" |
UpstreamTemplate
Namn | Beskrivning | Värde |
---|---|---|
Auth | Hämtar eller ställer in autentiseringsinställningarna för en överordnad. Om den inte har angetts används ingen autentisering för överordnade meddelanden. | UpstreamAuthSettings (uppströmsAuthsettings) |
kategoriMönster | Hämtar eller anger matchningsmönstret för kategorinamn. Om den inte har angetts matchar den alla kategorier. Det finns tre typer av mönster som stöds: 1. "*", den matchar valfritt kategorinamn 2. Kombinera flera kategorier med ",", till exempel "anslutningar, meddelanden", matchar kategorin "anslutningar" och "meddelanden" 3. Namnet på en kategori, till exempel "anslutningar", matchar kategorin "anslutningar" |
sträng |
händelsemönster | Hämtar eller anger matchningsmönstret för händelsenamn. Om den inte har angetts matchar den alla händelser. Det finns tre typer av mönster som stöds: 1. "*", den matchar alla händelsenamn 2. Kombinera flera händelser med "", till exempel "anslut,koppla från", matchar händelsen "anslut" och "koppla från" 3. Det enskilda händelsenamnet, till exempel "anslut", matchar "anslut" |
sträng |
hubPattern | Hämtar eller anger matchningsmönstret för hubbnamn. Om den inte har angetts matchar den alla hubbar. Det finns tre typer av mönster som stöds: 1. "*", den matchar alla hubbnamn 2. Kombinera flera hubbar med "", till exempel "hub1,hub2", matchar det "hub1" och "hub2" 3. Namnet på den enskilda hubben, till exempel "hub1", matchar "hub1" |
sträng |
urlTemplate (på engelska) | Hämtar eller ställer in mallen Överordnad URL. Du kan använda tre fördefinierade parametrar {hub}, {category} {event} i mallen. Värdet för den överordnade URL:en beräknas dynamiskt när klientbegäran kommer in. Om urlTemplate till exempel är http://example.com/{hub}/api/{event} , med en klientbegäran från hubben chat ansluter, skickas den först till den här URL:en: http://example.com/chat/api/connect . |
sträng (krävs) |
UserAssignedIdentityEgenskap
Namn | Beskrivning | Värde |
---|
Användningsexempel
Azure-verifierade moduler
Följande Azure-verifierade moduler kan användas för att distribuera den här resurstypen.
Modul | Beskrivning |
---|---|
SignalR-tjänst SignalR | AVM-resursmodul för SignalR Service SignalR |
Azure-snabbstartsexempel
Följande Azure-snabbstartsmallar innehålla Bicep-exempel för distribution av den här resurstypen.
Bicep-fil | Beskrivning |
---|---|
Distribuera en Azure SignalR-tjänst | Den här mallen skapar en Azure SignalR Service med hjälp av en mall. |
Resursdefinition för ARM-mall
SignalR-resurstypen kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.SignalRService/signalR-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2021-06-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"cors": {
"allowedOrigins": [ "string" ]
},
"disableAadAuth": "bool",
"disableLocalAuth": "bool",
"features": [
{
"flag": "string",
"properties": {
"{customized property}": "string"
},
"value": "string"
}
],
"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"
},
"tags": {
"{customized property}": "string"
}
}
Egenskapsvärden
Hanterad identitet
Namn | Beskrivning | Värde |
---|---|---|
typ | Representera identitetstypen: systemAssigned, userAssigned, None | "Ingen" "SystemAssigned" "UserAssigned" |
användartilldelade identiteter | Hämta eller ange användartilldelade identiteter | ManagedIdentityUserAssignedIdentiteter |
Inställningar för hanterad identitet
Namn | Beskrivning | Värde |
---|---|---|
resurs | Resursen som anger app-ID-URI:n för målresursen. Det visas också i aud-anspråket (målgruppen) för den utfärdade token. |
sträng |
ManagedIdentityUserAssignedIdentiteter
Namn | Beskrivning | Värde |
---|
Microsoft.SignalRService/signalR
Namn | Beskrivning | Värde |
---|---|---|
apiVersion | API-versionen | "2021-06-01-preview" |
identitet | Svar på hanterad identitet | Hanterad identitet |
sort | Typen av tjänst – t.ex. "SignalR" för "Microsoft.SignalRService/SignalR" | "RawWebSockets" "SignalR" |
plats | Resursens GEO-plats. t.ex. USA, västra | USA, östra | USA, norra centrala | USA, södra centrala. | sträng |
Namn | Resursnamnet | sträng (krävs) |
Egenskaper | Inställningar som används för att etablera eller konfigurera resursen | SignalRProperties |
Sku | Faktureringsinformation för resursen. (t.ex. kostnadsfritt, standard) | ResourceSku (på engelska) |
Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
typ | Resurstypen | "Microsoft.SignalRService/signalR" |
Nätverks-ACL
Namn | Beskrivning | Värde |
---|---|---|
tillåta | Tillåtna typer av begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI. | Strängmatris som innehåller något av: "ClientConnection" "RESTAPI" "ServerConnection" "Spårning" |
neka | Typer av nekade begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI. | Strängmatris som innehåller något av: "ClientConnection" "RESTAPI" "ServerConnection" "Spårning" |
PrivateEndpointACL (på engelska)
Namn | Beskrivning | Värde |
---|---|---|
tillåta | Tillåtna typer av begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI. | Strängmatris som innehåller något av: "ClientConnection" "RESTAPI" "ServerConnection" "Spårning" |
neka | Typer av nekade begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI. | Strängmatris som innehåller något av: "ClientConnection" "RESTAPI" "ServerConnection" "Spårning" |
Namn | Namnet på den privata slutpunktsanslutningen | sträng (krävs) |
ResourceSku (på engelska)
Namn | Beskrivning | Värde |
---|---|---|
kapacitet | Valfritt heltal. Antalet enheter för resursen. 1 som standard. Om det finns tillåts följande värden: Kostnadsfritt: 1 Standard: 1,2,5,10,20,50,100 |
Int |
Namn | Namnet på SKU:n. Krävs. Tillåtna värden: Standard_S1, Free_F1 |
sträng (krävs) |
Nivå | Valfri nivå för den här specifika SKU:n. "Standard" eller "Kostnadsfri". Basic är inaktuell använder du Standard i stället. |
"Grundläggande" "Kostnadsfri" "Premium" "Standard" |
ServerlessUpstreamInställningar
Namn | Beskrivning | Värde |
---|---|---|
Mallar | Hämtar eller anger listan över överordnade URL-mallar. Ordningen är viktig och den första matchande mallen får effekter. | UppströmsMall[] |
SignalRCorsInställningar
Namn | Beskrivning | Värde |
---|---|---|
allowedOrigins | Hämtar eller anger den lista över ursprung som ska tillåtas att göra korsande anrop (till exempel: http://example.com:12345). Använd "*" för att tillåta alla. Om det utelämnas tillåter du alla som standard. | sträng[] |
SignalRFeature (på engelska)
Namn | Beskrivning | Värde |
---|---|---|
flagga | FeatureFlags är de funktioner som stöds i Azure SignalR-tjänsten. – ServiceMode: Flagga för serverdelsserver för SignalR-tjänsten. Värden tillåtna: "Standard": har en egen serverdelsserver; "Serverlös": programmet har ingen serverdelsserver. "Klassisk": för bakåtkompatibilitet. Stöd för både standardläge och serverlöst läge men rekommenderas inte. "PredefinedOnly": för framtida användning. – EnableConnectivityLogs: "true"/"false", för att aktivera/inaktivera anslutningsloggkategorin. – EnableMessagingLogs: "true"/"false", för att aktivera/inaktivera anslutningsloggkategorin. – EnableLiveTrace: Med Live Trace kan du veta vad som händer i Azure SignalR-tjänsten, det ger dig livespårningar i realtid. Det är användbart när du utvecklar ett eget Azure SignalR-baserat webbprogram eller själv felsöker några problem. Observera att livespårningar räknas som utgående meddelanden som debiteras. Värden tillåts: "true"/"false", för att aktivera/inaktivera funktionen för livespårning. |
"EnableConnectivityLogs" "EnableLiveTrace" "EnableMessagingLogs" "ServiceMode" (krävs) |
Egenskaper | Valfria egenskaper som är relaterade till den här funktionen. | SignalRFeatureProperties (på engelska) |
värde | Värdet för funktionsflaggan. Se Azure SignalR Service-dokumentet /azure/azure-signalr/ för tillåtna värden. | sträng Begränsningar: Min längd = 1 Maximal längd = 128 (krävs) |
SignalRFeatureProperties (på engelska)
Namn | Beskrivning | Värde |
---|
SignalRNetworkACL:er
Namn | Beskrivning | Värde |
---|---|---|
defaultAction (standardåtgärd) | Standardåtgärd när ingen annan regel matchar | "Tillåt" "Neka" |
privata ändpunkter | ACL:er för begäranden från privata slutpunkter | PrivateEndpointACL[] |
publicNetwork (på engelska) | ACL för begäranden från offentliga nätverk | Nätverks-ACL |
SignalRProperties
Namn | Beskrivning | Värde |
---|---|---|
korset | CORS-inställningar (Cross-Origin Resource Sharing). | SignalRCorsInställningar |
disableAadAuth | DisableLocalAuth Aktivera eller inaktivera aad-autentisering När värdet är true fungerar inte anslutningen med AuthType=aad. |
Bool |
disableLocalAuth | DisableLocalAuth Aktivera eller inaktivera lokal autentisering med AccessKey När värdet är true fungerar inte anslutningen med AccessKey=xxx. |
Bool |
Funktioner | Lista över featureFlags. FeatureFlags som inte ingår i parametrarna för uppdateringsåtgärden ändras inte. Och svaret innehåller endast featureFlags som uttryckligen anges. När en featureFlag inte uttryckligen anges används dess globala standardvärde Men kom ihåg att standardvärdet inte betyder "false". Det varierar beroende på olika FeatureFlags. |
SignalRFeature[] |
networkACL:er | Nätverks-ACL:er | SignalRNetworkACL:er |
publicNetworkAccess (publicNetworkÅtkomst) | Aktivera eller inaktivera åtkomst till offentligt nätverk. Standardvärdet är "Aktiverad". När den är aktiverad gäller fortfarande nätverks-ACL:er. När den är inaktiverad inaktiveras alltid åtkomsten till det offentliga nätverket oavsett vad du anger i nätverks-ACL:er. |
sträng |
tls tls | TLS-inställningar. | Inställningar för SignalRTls |
uppströms | Överordnade inställningar när tjänsten är i serverlöst läge. | ServerlessUpstreamInställningar |
Inställningar för SignalRTls
Namn | Beskrivning | Värde |
---|---|---|
clientCertEnabled | Begär klientcertifikat under TLS-handskakning om det är aktiverat | Bool |
Spårade resurstaggar
Namn | Beskrivning | Värde |
---|
UpstreamAuthSettings (uppströmsAuthsettings)
Namn | Beskrivning | Värde |
---|---|---|
managedIdentity | Hämtar eller anger inställningarna för hanterad identitet. Det krävs om autentiseringstypen är inställd på ManagedIdentity. | Inställningar för hanterad identitet |
typ | Hämtar eller anger typen av autentisering. Ingen eller ManagedIdentity stöds nu. | "ManagedIdentity" "Ingen" |
UpstreamTemplate
Namn | Beskrivning | Värde |
---|---|---|
Auth | Hämtar eller ställer in autentiseringsinställningarna för en överordnad. Om den inte har angetts används ingen autentisering för överordnade meddelanden. | UpstreamAuthSettings (uppströmsAuthsettings) |
kategoriMönster | Hämtar eller anger matchningsmönstret för kategorinamn. Om den inte har angetts matchar den alla kategorier. Det finns tre typer av mönster som stöds: 1. "*", den matchar valfritt kategorinamn 2. Kombinera flera kategorier med ",", till exempel "anslutningar, meddelanden", matchar kategorin "anslutningar" och "meddelanden" 3. Namnet på en kategori, till exempel "anslutningar", matchar kategorin "anslutningar" |
sträng |
händelsemönster | Hämtar eller anger matchningsmönstret för händelsenamn. Om den inte har angetts matchar den alla händelser. Det finns tre typer av mönster som stöds: 1. "*", den matchar alla händelsenamn 2. Kombinera flera händelser med "", till exempel "anslut,koppla från", matchar händelsen "anslut" och "koppla från" 3. Det enskilda händelsenamnet, till exempel "anslut", matchar "anslut" |
sträng |
hubPattern | Hämtar eller anger matchningsmönstret för hubbnamn. Om den inte har angetts matchar den alla hubbar. Det finns tre typer av mönster som stöds: 1. "*", den matchar alla hubbnamn 2. Kombinera flera hubbar med "", till exempel "hub1,hub2", matchar det "hub1" och "hub2" 3. Namnet på den enskilda hubben, till exempel "hub1", matchar "hub1" |
sträng |
urlTemplate (på engelska) | Hämtar eller ställer in mallen Överordnad URL. Du kan använda tre fördefinierade parametrar {hub}, {category} {event} i mallen. Värdet för den överordnade URL:en beräknas dynamiskt när klientbegäran kommer in. Om urlTemplate till exempel är http://example.com/{hub}/api/{event} , med en klientbegäran från hubben chat ansluter, skickas den först till den här URL:en: http://example.com/chat/api/connect . |
sträng (krävs) |
UserAssignedIdentityEgenskap
Namn | Beskrivning | Värde |
---|
Användningsexempel
Azure-snabbstartsmallar
Följande Azure-snabbstartsmallar distribuera den här resurstypen.
Mall | Beskrivning |
---|---|
Distribuera en Azure SignalR-tjänst |
Den här mallen skapar en Azure SignalR Service med hjälp av en mall. |
Resursdefinition för Terraform (AzAPI-provider)
SignalR-resurstypen kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.SignalRService/signalR-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SignalRService/signalR@2021-06-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "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"
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"
}
}
}
Egenskapsvärden
Hanterad identitet
Namn | Beskrivning | Värde |
---|---|---|
typ | Representera identitetstypen: systemAssigned, userAssigned, None | "Ingen" "SystemAssigned" "UserAssigned" |
användartilldelade identiteter | Hämta eller ange användartilldelade identiteter | ManagedIdentityUserAssignedIdentiteter |
Inställningar för hanterad identitet
Namn | Beskrivning | Värde |
---|---|---|
resurs | Resursen som anger app-ID-URI:n för målresursen. Det visas också i aud-anspråket (målgruppen) för den utfärdade token. |
sträng |
ManagedIdentityUserAssignedIdentiteter
Namn | Beskrivning | Värde |
---|
Microsoft.SignalRService/signalR
Namn | Beskrivning | Värde |
---|---|---|
identitet | Svar på hanterad identitet | Hanterad identitet |
sort | Typen av tjänst – t.ex. "SignalR" för "Microsoft.SignalRService/SignalR" | "RawWebSockets" "SignalR" |
plats | Resursens GEO-plats. t.ex. USA, västra | USA, östra | USA, norra centrala | USA, södra centrala. | sträng |
Namn | Resursnamnet | sträng (krävs) |
Egenskaper | Inställningar som används för att etablera eller konfigurera resursen | SignalRProperties |
Sku | Faktureringsinformation för resursen. (t.ex. kostnadsfritt, standard) | ResourceSku (på engelska) |
Taggar | Resurstaggar | Ordlista med taggnamn och värden. |
typ | Resurstypen | "Microsoft.SignalRService/signalR@2021-06-01-preview" |
Nätverks-ACL
Namn | Beskrivning | Värde |
---|---|---|
tillåta | Tillåtna typer av begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI. | Strängmatris som innehåller något av: "ClientConnection" "RESTAPI" "ServerConnection" "Spårning" |
neka | Typer av nekade begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI. | Strängmatris som innehåller något av: "ClientConnection" "RESTAPI" "ServerConnection" "Spårning" |
PrivateEndpointACL (på engelska)
Namn | Beskrivning | Värde |
---|---|---|
tillåta | Tillåtna typer av begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI. | Strängmatris som innehåller något av: "ClientConnection" "RESTAPI" "ServerConnection" "Spårning" |
neka | Typer av nekade begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI. | Strängmatris som innehåller något av: "ClientConnection" "RESTAPI" "ServerConnection" "Spårning" |
Namn | Namnet på den privata slutpunktsanslutningen | sträng (krävs) |
ResourceSku (på engelska)
Namn | Beskrivning | Värde |
---|---|---|
kapacitet | Valfritt heltal. Antalet enheter för resursen. 1 som standard. Om det finns tillåts följande värden: Kostnadsfritt: 1 Standard: 1,2,5,10,20,50,100 |
Int |
Namn | Namnet på SKU:n. Krävs. Tillåtna värden: Standard_S1, Free_F1 |
sträng (krävs) |
Nivå | Valfri nivå för den här specifika SKU:n. "Standard" eller "Kostnadsfri". Basic är inaktuell använder du Standard i stället. |
"Grundläggande" "Kostnadsfri" "Premium" "Standard" |
ServerlessUpstreamInställningar
Namn | Beskrivning | Värde |
---|---|---|
Mallar | Hämtar eller anger listan över överordnade URL-mallar. Ordningen är viktig och den första matchande mallen får effekter. | UppströmsMall[] |
SignalRCorsInställningar
Namn | Beskrivning | Värde |
---|---|---|
allowedOrigins | Hämtar eller anger den lista över ursprung som ska tillåtas att göra korsande anrop (till exempel: http://example.com:12345). Använd "*" för att tillåta alla. Om det utelämnas tillåter du alla som standard. | sträng[] |
SignalRFeature (på engelska)
Namn | Beskrivning | Värde |
---|---|---|
flagga | FeatureFlags är de funktioner som stöds i Azure SignalR-tjänsten. – ServiceMode: Flagga för serverdelsserver för SignalR-tjänsten. Värden tillåtna: "Standard": har en egen serverdelsserver; "Serverlös": programmet har ingen serverdelsserver. "Klassisk": för bakåtkompatibilitet. Stöd för både standardläge och serverlöst läge men rekommenderas inte. "PredefinedOnly": för framtida användning. – EnableConnectivityLogs: "true"/"false", för att aktivera/inaktivera anslutningsloggkategorin. – EnableMessagingLogs: "true"/"false", för att aktivera/inaktivera anslutningsloggkategorin. – EnableLiveTrace: Med Live Trace kan du veta vad som händer i Azure SignalR-tjänsten, det ger dig livespårningar i realtid. Det är användbart när du utvecklar ett eget Azure SignalR-baserat webbprogram eller själv felsöker några problem. Observera att livespårningar räknas som utgående meddelanden som debiteras. Värden tillåts: "true"/"false", för att aktivera/inaktivera funktionen för livespårning. |
"EnableConnectivityLogs" "EnableLiveTrace" "EnableMessagingLogs" "ServiceMode" (krävs) |
Egenskaper | Valfria egenskaper som är relaterade till den här funktionen. | SignalRFeatureProperties (på engelska) |
värde | Värdet för funktionsflaggan. Se Azure SignalR Service-dokumentet /azure/azure-signalr/ för tillåtna värden. | sträng Begränsningar: Min längd = 1 Maximal längd = 128 (krävs) |
SignalRFeatureProperties (på engelska)
Namn | Beskrivning | Värde |
---|
SignalRNetworkACL:er
Namn | Beskrivning | Värde |
---|---|---|
defaultAction (standardåtgärd) | Standardåtgärd när ingen annan regel matchar | "Tillåt" "Neka" |
privata ändpunkter | ACL:er för begäranden från privata slutpunkter | PrivateEndpointACL[] |
publicNetwork (på engelska) | ACL för begäranden från offentliga nätverk | Nätverks-ACL |
SignalRProperties
Namn | Beskrivning | Värde |
---|---|---|
korset | CORS-inställningar (Cross-Origin Resource Sharing). | SignalRCorsInställningar |
disableAadAuth | DisableLocalAuth Aktivera eller inaktivera aad-autentisering När värdet är true fungerar inte anslutningen med AuthType=aad. |
Bool |
disableLocalAuth | DisableLocalAuth Aktivera eller inaktivera lokal autentisering med AccessKey När värdet är true fungerar inte anslutningen med AccessKey=xxx. |
Bool |
Funktioner | Lista över featureFlags. FeatureFlags som inte ingår i parametrarna för uppdateringsåtgärden ändras inte. Och svaret innehåller endast featureFlags som uttryckligen anges. När en featureFlag inte uttryckligen anges används dess globala standardvärde Men kom ihåg att standardvärdet inte betyder "false". Det varierar beroende på olika FeatureFlags. |
SignalRFeature[] |
networkACL:er | Nätverks-ACL:er | SignalRNetworkACL:er |
publicNetworkAccess (publicNetworkÅtkomst) | Aktivera eller inaktivera åtkomst till offentligt nätverk. Standardvärdet är "Aktiverad". När den är aktiverad gäller fortfarande nätverks-ACL:er. När den är inaktiverad inaktiveras alltid åtkomsten till det offentliga nätverket oavsett vad du anger i nätverks-ACL:er. |
sträng |
tls tls | TLS-inställningar. | Inställningar för SignalRTls |
uppströms | Överordnade inställningar när tjänsten är i serverlöst läge. | ServerlessUpstreamInställningar |
Inställningar för SignalRTls
Namn | Beskrivning | Värde |
---|---|---|
clientCertEnabled | Begär klientcertifikat under TLS-handskakning om det är aktiverat | Bool |
Spårade resurstaggar
Namn | Beskrivning | Värde |
---|
UpstreamAuthSettings (uppströmsAuthsettings)
Namn | Beskrivning | Värde |
---|---|---|
managedIdentity | Hämtar eller anger inställningarna för hanterad identitet. Det krävs om autentiseringstypen är inställd på ManagedIdentity. | Inställningar för hanterad identitet |
typ | Hämtar eller anger typen av autentisering. Ingen eller ManagedIdentity stöds nu. | "ManagedIdentity" "Ingen" |
UpstreamTemplate
Namn | Beskrivning | Värde |
---|---|---|
Auth | Hämtar eller ställer in autentiseringsinställningarna för en överordnad. Om den inte har angetts används ingen autentisering för överordnade meddelanden. | UpstreamAuthSettings (uppströmsAuthsettings) |
kategoriMönster | Hämtar eller anger matchningsmönstret för kategorinamn. Om den inte har angetts matchar den alla kategorier. Det finns tre typer av mönster som stöds: 1. "*", den matchar valfritt kategorinamn 2. Kombinera flera kategorier med ",", till exempel "anslutningar, meddelanden", matchar kategorin "anslutningar" och "meddelanden" 3. Namnet på en kategori, till exempel "anslutningar", matchar kategorin "anslutningar" |
sträng |
händelsemönster | Hämtar eller anger matchningsmönstret för händelsenamn. Om den inte har angetts matchar den alla händelser. Det finns tre typer av mönster som stöds: 1. "*", den matchar alla händelsenamn 2. Kombinera flera händelser med "", till exempel "anslut,koppla från", matchar händelsen "anslut" och "koppla från" 3. Det enskilda händelsenamnet, till exempel "anslut", matchar "anslut" |
sträng |
hubPattern | Hämtar eller anger matchningsmönstret för hubbnamn. Om den inte har angetts matchar den alla hubbar. Det finns tre typer av mönster som stöds: 1. "*", den matchar alla hubbnamn 2. Kombinera flera hubbar med "", till exempel "hub1,hub2", matchar det "hub1" och "hub2" 3. Namnet på den enskilda hubben, till exempel "hub1", matchar "hub1" |
sträng |
urlTemplate (på engelska) | Hämtar eller ställer in mallen Överordnad URL. Du kan använda tre fördefinierade parametrar {hub}, {category} {event} i mallen. Värdet för den överordnade URL:en beräknas dynamiskt när klientbegäran kommer in. Om urlTemplate till exempel är http://example.com/{hub}/api/{event} , med en klientbegäran från hubben chat ansluter, skickas den först till den här URL:en: http://example.com/chat/api/connect . |
sträng (krävs) |
UserAssignedIdentityEgenskap
Namn | Beskrivning | Värde |
---|