Share via

Microsoft.SignalRService signalR

  • Článek

Definice prostředku Bicep

Typ prostředku signalR je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.SignalRService/signalR, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.SignalRService/signalR@2023-08-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    disableAadAuth: bool
    disableLocalAuth: bool
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    liveTraceConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
      enabled: 'string'
    }
    networkACLs: {
      defaultAction: 'string'
      ipRules: [
        {
          action: 'string'
          value: 'string'
        }
      ]
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    regionEndpointEnabled: 'string'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
    }
    resourceStopped: 'string'
    serverless: {
      connectionTimeoutInSeconds: int
    }
    tls: {
      clientCertEnabled: bool
    }
    upstream: {
      templates: [
        {
          auth: {
            managedIdentity: {
              resource: 'string'
            }
            type: 'string'
          }
          categoryPattern: 'string'
          eventPattern: 'string'
          hubPattern: 'string'
          urlTemplate: 'string'
        }
      ]
    }
  }
}

Hodnoty vlastností

signalR

Název Description Hodnota
name Název prostředku string (povinné)

Limit počtu znaků: 3–63

Platné znaky:
Alfanumerické znaky a spojovníky.

Začněte písmenem. Končí písmenem nebo číslicí.

Název prostředku musí být v rámci Azure jedinečný.
location Geografické umístění, ve kterém se nachází prostředek string (povinné)
tags Značky prostředků. Slovník názvů značek a hodnot. Viz Značky v šablonách
Sku Fakturační údaje o prostředku. ResourceSku
Druhu Druh služby RawWebSockets
'SignalR'
identity Třída představuje spravované identity používané pro požadavky a odpovědi. Spravovaná identita
properties Třída, která popisuje vlastnosti prostředku SignalRVlastnosti

Spravovaná identita

Název Description Hodnota
typ Představuje typ identity: systemAssigned, userAssigned, None 'Žádný'
'SystemAssigned'
'UserAssigned'
userAssignedIdentity Získání nebo nastavení identit přiřazených uživatelem ManagedIdentityUserAssignedIdentities

ManagedIdentityUserAssignedIdentities

Název Description Hodnota
{přizpůsobená vlastnost} UserAssignedIdentityProperty

UserAssignedIdentityProperty

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.

SignalRVlastnosti

Název Description Hodnota
cors Nastavení sdílení prostředků mezi zdroji (CORS). Nastavení SignalRCorsSettings
disableAadAuth DisableLocalAuth
Povolení nebo zakázání ověřování aad
Pokud je nastavená hodnota true, připojení s AuthType=aad nebude fungovat.		 bool
disableLocalAuth DisableLocalAuth
Povolení nebo zakázání místního ověřování pomocí AccessKey
Pokud je nastavená hodnota true, připojení pomocí AccessKey=xxx nebude fungovat.		 bool
funkce Seznam funkcíFlags.

FeatureFlags, které nejsou zahrnuty v parametrech pro operaci aktualizace, nebudou změněny.
A odpověď bude obsahovat pouze vlastnosti featureFlags, které jsou explicitně nastaveny.
Pokud není explicitně nastavená vlastnost featureFlag, použije se její globálně výchozí hodnota.
Mějte ale na paměti, že výchozí hodnota neznamená "false". Liší se z hlediska různých FeatureFlags.		 SignalRFeature[]
liveTraceConfiguration Konfigurace živého trasování prostředku Microsoft.SignalRService LiveTraceConfiguration
networkACLs Síťové seznamy ACL pro prostředek SignalRNetworkACLs
publicNetworkAccess Povolte nebo zakažte veřejný síťový přístup. Výchozí hodnota je "Povoleno".
Síťové seznamy ACL platí i v případě, že je povoleno.
Pokud je zakázaný, veřejný síťový přístup je vždy zakázán bez ohledu na to, co jste nastavili v seznamech ACL sítě.		 řetězec
regionEndpointEnabled Povolte nebo zakažte místní koncový bod. Výchozí hodnota je "Povoleno".
Pokud je tato možnost zakázaná, nová připojení se do tohoto koncového bodu nesměrují, ale na stávající připojení to nebude mít vliv.
Tato vlastnost je specifická pro repliku. Zakázání místního koncového bodu bez repliky není povolené.		 řetězec
resourceLogConfiguration Konfigurace protokolu prostředků prostředku Microsoft.SignalRService. Konfigurace protokolu prostředků
prostředekStopped Zastavte nebo spusťte prostředek. Výchozí hodnota je False.
Pokud je to pravda, rovina dat prostředku se vypne.
Když je hodnota false, spustí se rovina dat prostředku.		 řetězec
Prostředí bez serveru Bezserverová nastavení. Bezserverová nastavení
Tls Nastavení protokolu TLS pro prostředek Nastavení SignalRTlsSettings
upstream Nastavení upstreamu, když je služba v režimu bez serveru. Nastavení bezserverového proudu

Nastavení SignalRCorsSettings

Název Description Hodnota
allowedOrigins Získá nebo nastaví seznam původů, které by měly být povoleny pro volání mezi zdroji (například: http://example.com:12345). Pokud chcete povolit vše, použijte "*". Pokud tento parametr vynecháte, ve výchozím nastavení povolíte vše. string[]

SignalRFeature

Název Description Hodnota
flag FeatureFlags jsou podporované funkce služby Azure SignalR.
– ServiceMode: Příznak back-endového serveru pro službu SignalR. Povolené hodnoty: "Výchozí": máte vlastní back-endový server; "Bezserverový": vaše aplikace nemá back-endový server; "Classic": pro zpětnou kompatibilitu. Podpora výchozího i bezserverového režimu, ale nedoporučuje se; "PredefinedOnly": pro budoucí použití.
– EnableConnectivityLogs: "true"/"false", pokud chcete povolit nebo zakázat kategorii protokolu připojení.
– EnableMessagingLogs: "true"/"false", pokud chcete povolit nebo zakázat kategorii protokolu připojení.
– EnableLiveTrace: Živé trasování umožňuje zjistit, co se děje ve službě Azure SignalR, poskytne vám živé trasování v reálném čase a bude užitečné při vývoji vlastní webové aplikace založené na Azure SignalR nebo při vlastním řešení některých problémů. Upozorňujeme, že živé trasování se počítá jako odchozí zprávy, za které se budou účtovat poplatky. Povolené hodnoty: "true"/"false" pro povolení nebo zakázání funkce živého trasování.		 EnableConnectivityLogs
EnableLiveTrace
EnableMessagingLogs
ServiceMode (povinné)
properties Volitelné vlastnosti související s touto funkcí SignalRFeatureProperties
hodnota Hodnota příznaku funkce Povolené hodnoty najdete v dokumentu https://docs.microsoft.com/azure/azure-signalr/ služby Azure SignalR. string (povinné)

Omezení:
Minimální délka = 1
Maximální délka = 128

SignalRFeatureProperties

Název Description Hodnota
{přizpůsobená vlastnost} řetězec

LiveTraceConfiguration

Název Description Hodnota
categories Získá nebo nastaví seznam konfigurací kategorií. LiveTraceCategory[]
enabled Určuje, jestli je povolené živé trasování.
Když je nastavená hodnota true, klient živého trasování se může připojit ke službě.
Jinak se klient živého trasování nemůže ke službě připojit, takže nemůžete přijímat žádný protokol bez ohledu na to, co nakonfigurujete v kategoriích.
Dostupné hodnoty: true, false
Nerozlišují se malá a velká písmena.
 řetězec

LiveTraceCategory

Název Description Hodnota
enabled Označuje, jestli je povolená kategorie živého trasování nebo.
Dostupné hodnoty: true, false.
Nerozlišují se velká a malá písmena.		 řetězec
name Získá nebo nastaví název kategorie živého trasování.
Dostupné hodnoty: ConnectivityLogs, MessagingLogs.
Nerozlišují se velká a malá písmena.
 řetězec

SignalRNetworkACLs

Název Description Hodnota
defaultAction Akce seznamu ACL pro sítě Azure. 'Povolit'
"Odepřít"
ipRules Pravidla IP adres pro filtrování veřejného provozu IpRule[]

Omezení:
Maximální délka = 30
privátní koncové body Seznamy ACL pro požadavky z privátních koncových bodů PrivateEndpointACL[]
publicNetwork Seznam ACL sítě NetworkACL

IpRule

Název Description Hodnota
action Akce seznamu ACL pro sítě Azure. 'Povolit'
"Odepřít"
hodnota IP adresa nebo CIDR nebo servicetag řetězec

PrivateEndpointACL

Název Description Hodnota
Povolit Povolené typy požadavků. Hodnota může být jedna nebo více z těchto hodnot: ClientConnection, ServerConnection, RESTAPI. Pole řetězců obsahující některou z těchto možností:
'ClientConnection'
RESTAPI
ServerConnection
'Trasování'
Odepřít Typy zamítnutých požadavků. Hodnota může být jedna nebo více z těchto hodnot: ClientConnection, ServerConnection, RESTAPI. Pole řetězců obsahující některou z těchto možností:
'ClientConnection'
RESTAPI
ServerConnection
'Trasování'
name Název připojení privátního koncového bodu string (povinné)

NetworkACL

Název Description Hodnota
Povolit Povolené typy požadavků. Hodnota může být jedna nebo více z těchto hodnot: ClientConnection, ServerConnection, RESTAPI. Pole řetězců obsahující některou z těchto možností:
'ClientConnection'
RESTAPI
ServerConnection
'Trasování'
Odepřít Typy zamítnutých požadavků. Hodnota může být jedna nebo více z těchto hodnot: ClientConnection, ServerConnection, RESTAPI. Pole řetězců obsahující některou z těchto možností:
'ClientConnection'
RESTAPI
ServerConnection
'Trasování'

ResourceLogConfiguration

Název Description Hodnota
categories Získá nebo nastaví seznam konfigurací kategorií. ResourceLogCategory[]

ResourceLogCategory

Název Description Hodnota
enabled Označuje, jestli je povolená kategorie protokolu prostředků nebo.
Dostupné hodnoty: true, false.
Nerozlišují se malá a velká písmena.		 řetězec
name Získá nebo nastaví název kategorie protokolu prostředků.
Dostupné hodnoty: ConnectivityLogs, MessagingLogs.
Nerozlišují se malá a velká písmena.
 řetězec

Bezserverová nastavení

Název Description Hodnota
connectionTimeoutInSeconds Získá nebo nastaví vypršení časového limitu připojení klienta. Volitelné nastavení.
Hodnota v sekundách
Výchozí hodnota je 30 sekund.
Pokud se očekává odesílání zpráv v kratších intervalech, měl by zákazník nastavit časový limit na kratší dobu.
a chcete, aby se klient po odeslání poslední zprávy odpojil rychleji.
Pokud se očekává, že se zprávy odesílají v delších intervalech, můžete časový limit nastavit na delší dobu.
a chtějí během této relace zachovat stejné připojení klienta.
Služba považuje klienta za odpojeného, pokud v tomto intervalu neobdržela zprávu (včetně udržování připojení).
 int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 120

Nastavení SignalRTlsSettings

Název Description Hodnota
clientCertEnabled Vyžádejte si klientský certifikát během metody handshake protokolu TLS, pokud je povoleno. Nepodporuje se pro úroveň Free. Všechny vstupy budou ignorovány pro úroveň Free. bool

Nastavení bezserverového proudu

Název Description Hodnota
šablony Získá nebo nastaví seznam šablon nadřazené adresy URL. Pořadí je důležité a první odpovídající šablona má efekty. UpstreamTemplate[]

UpstreamOváplata

Název Description Hodnota
Auth Upstreamové nastavení ověřování. Pokud není nastavená, pro nadřazené zprávy se nepoužívá žádné ověřování. UpstreamAuthSettings
kategoriePattern Získá nebo nastaví vzor shody pro názvy kategorií. Pokud není nastavená, odpovídá libovolné kategorii.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu kategorie.
2. Zkombinujte více kategorií s ",", například "připojení,zprávy", odpovídá kategoriím "připojení" a "zprávy".
3. Jeden název kategorie, například "připojení", odpovídá kategorii "připojení".		 řetězec
eventPattern Získá nebo nastaví vzor shody pro názvy událostí. Pokud není nastavená, odpovídá jakékoli události.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu události.
2. Zkombinujte více událostí s ",", například "connect,disconnect", odpovídá událostem "connect" a "disconnect".
3. Název jedné události, například "connect", odpovídá "connect".		 řetězec
hubPattern Získá nebo nastaví vzor shody pro názvy center. Pokud není nastavená, odpovídá jakémukoli rozbočovači.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu centra.
2. Zkombinujte více rozbočovačů s ",", například "hub1,hub2", odpovídá "hub1" a "hub2".
3. Název jednoho centra, například "hub1", odpovídá "hub1".		 řetězec
urlNášplate Získá nebo nastaví šablonu nadřazené adresy URL. V šabloně můžete použít 3 předdefinované parametry {hub}, {category} {event}, hodnota upstreamové adresy URL se dynamicky počítá při přijetí požadavku klienta.
Pokud je http://example.com/{hub}/api/{event}například urlTemplate s požadavkem klienta z připojení centra chat , bude nejprve POST na tuto adresu URL: http://example.com/chat/api/connect.
 string (povinné)

UpstreamAuthSettings

Název Description Hodnota
spravovaná identita Nastavení spravované identity pro upstream ManagedIdentitySettings
typ Výčet typu upstreamové ověřování ManagedIdentity
'Žádný'

ManagedIdentitySettings

Název Description Hodnota
prostředek Prostředek označující identifikátor URI ID aplikace cílového prostředku.
Zobrazí se také v deklaraci identity aud (cílové skupiny) vydaného tokenu.
 řetězec

Sklad prostředků

Název Description Hodnota
capacity Volitelné, celé číslo. Počet jednotek prostředku. Ve výchozím nastavení je 1.

Pokud jsou k dispozici, jsou povoleny následující hodnoty:
Volný: 1;
Standardní: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;		 int
name Název skladové položky. Povinná hodnota.

Povolené hodnoty: Standard_S1, Free_F1 Premium_P1		 string (povinné)
tier Volitelná úroveň této konkrétní skladové položky 'Standard' nebo 'Free'.

Basic je zastaralý, použijte Standard místo toho.
 'Základní'
"Zdarma"
'Premium'
'Standard'

Šablony pro rychlý start

Následující šablony rychlého startu nasadí tento typ prostředku.

Template (Šablona) Description
Nasazení služby Azure SignalR

Nasazení do Azure		 Tato šablona vytvoří Azure SignalR Service pomocí šablony.

Definice prostředku šablony ARM

Typ prostředku signalR je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.SignalRService/signalR, přidejte do šablony následující kód JSON.

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2023-08-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "disableAadAuth": "bool",
    "disableLocalAuth": "bool",
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "liveTraceConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ],
      "enabled": "string"
    },
    "networkACLs": {
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "string",
          "value": "string"
        }
      ],
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "regionEndpointEnabled": "string",
    "resourceLogConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ]
    },
    "resourceStopped": "string",
    "serverless": {
      "connectionTimeoutInSeconds": "int"
    },
    "tls": {
      "clientCertEnabled": "bool"
    },
    "upstream": {
      "templates": [
        {
          "auth": {
            "managedIdentity": {
              "resource": "string"
            },
            "type": "string"
          },
          "categoryPattern": "string",
          "eventPattern": "string",
          "hubPattern": "string",
          "urlTemplate": "string"
        }
      ]
    }
  }
}

Hodnoty vlastností

signalR

Název Description Hodnota
typ Typ prostředku Microsoft.SignalRService/signalR
apiVersion Verze rozhraní API prostředků '2023-08-01-preview'
name Název prostředku string (povinné)

Limit počtu znaků: 3–63

Platné znaky:
Alfanumerické znaky a spojovníky.

Začněte písmenem. Končí písmenem nebo číslicí.

Název prostředku musí být v rámci Azure jedinečný.
location Geografické umístění, ve kterém se nachází prostředek string (povinné)
tags Značky prostředků. Slovník názvů značek a hodnot. Viz Značky v šablonách
Sku Fakturační údaje o prostředku. ResourceSku
Druhu Druh služby RawWebSockets
'SignalR'
identity Třída představuje spravované identity používané pro požadavky a odpovědi. Spravovaná identita
properties Třída, která popisuje vlastnosti prostředku SignalRVlastnosti

Spravovaná identita

Název Description Hodnota
typ Představuje typ identity: systemAssigned, userAssigned, None 'Žádný'
'SystemAssigned'
'UserAssigned'
userAssignedIdentity Získání nebo nastavení identit přiřazených uživatelem ManagedIdentityUserAssignedIdentities

ManagedIdentityUserAssignedIdentities

Název Description Hodnota
{přizpůsobená vlastnost} UserAssignedIdentityProperty

UserAssignedIdentityProperty

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.

SignalRVlastnosti

Název Description Hodnota
cors Nastavení sdílení prostředků mezi zdroji (CORS). Nastavení SignalRCorsSettings
disableAadAuth DisableLocalAuth
Povolení nebo zakázání ověřování aad
Pokud je nastavená hodnota true, připojení s AuthType=aad nebude fungovat.		 bool
disableLocalAuth DisableLocalAuth
Povolení nebo zakázání místního ověřování pomocí AccessKey
Pokud je nastavená hodnota true, připojení pomocí AccessKey=xxx nebude fungovat.		 bool
funkce Seznam funkcíFlags.

FeatureFlags, které nejsou zahrnuty v parametrech pro operaci aktualizace, nebudou změněny.
A odpověď bude obsahovat pouze funkceFlags, které jsou explicitně nastaveny.
Pokud není funkceFlag explicitně nastavená, použije se její globálně výchozí hodnota.
Mějte ale na paměti, že výchozí hodnota neznamená "false". Liší se v různých funkcích FeatureFlags.		 SignalRFeature[]
liveTraceConfiguration Konfigurace živého trasování prostředku Microsoft.SignalRService LiveTraceConfiguration
networkACLs Síťové seznamy ACL pro prostředek SignalRNetworkACLs
publicNetworkAccess Povolte nebo zakažte veřejný síťový přístup. Ve výchozím nastavení je povoleno.
I když je povoleno, síťové seznamy ACL stále platí.
Pokud je tato možnost zakázaná, veřejný síťový přístup je vždy zakázaný bez ohledu na to, co jste nastavili v síťových seznamech ACL.		 řetězec
regionEndpointEnabled Povolte nebo zakažte místní koncový bod. Ve výchozím nastavení je povoleno.
Pokud je tato možnost zakázaná, nebudou se nová připojení směrovat do tohoto koncového bodu, ale na stávající připojení to nebude mít vliv.
Tato vlastnost je specifická pro repliku. Zakázání místního koncového bodu bez repliky není povoleno.		 řetězec
resourceLogConfiguration Konfigurace protokolu prostředků prostředku Microsoft.SignalRService ResourceLogConfiguration
resourceStopped Zastavte nebo spusťte prostředek. Výchozí hodnota je Nepravda.
Pokud je to pravda, rovina dat prostředku se vypne.
Pokud je hodnota false, spustí se rovina dat prostředku.		 řetězec
Prostředí bez serveru Bezserverová nastavení. Nastavení bez serveru
Tls Nastavení protokolu TLS pro prostředek SignalRTlsSettings
upstream Nastavení upstreamu, když je služba v režimu bez serveru. Nastavení bezserverového proudu

Nastavení SignalRCorsSettings

Název Description Hodnota
allowedOrigins Získá nebo nastaví seznam původů, které by měly být povoleny k provádění volání mezi zdroji (například: http://example.com:12345). Pokud chcete povolit vše, použijte "*". Pokud ho vynecháte, ve výchozím nastavení povolte vše. string[]

SignalRFeature

Název Description Hodnota
flag FeatureFlags jsou podporované funkce služby Azure SignalR.
- ServiceMode: Příznak back-endového serveru pro službu SignalR. Povolené hodnoty: "Výchozí": mít vlastní back-endový server; "Bezserverový": vaše aplikace nemá back-endový server; "Classic": pro zpětnou kompatibilitu. Podpora výchozího i bezserverového režimu, ale nedoporučuje se; "Předdefinovanéonly": pro budoucí použití.
– EnableConnectivityLogs: "true"/"false", pokud chcete povolit nebo zakázat kategorii protokolu připojení.
– EnableMessagingLogs: "true"/"false", pokud chcete povolit nebo zakázat kategorii protokolu připojení.
– EnableLiveTrace: Živé trasování umožňuje zjistit, co se děje ve službě Azure SignalR, poskytne vám živé trasování v reálném čase, bude užitečné při vývoji vlastní webové aplikace založené na Azure SignalR nebo při řešení některých problémů. Upozorňujeme, že živá trasování se počítají jako odchozí zprávy, které se budou účtovat. Povolené hodnoty: "true"/"false" pro povolení nebo zakázání funkce živého trasování.		 EnableConnectivityLogs
EnableLiveTrace
EnableMessagingLogs
ServiceMode (povinné)
properties Volitelné vlastnosti související s touto funkcí SignalRFeatureProperties
hodnota Hodnota příznaku funkce. Povolené hodnoty najdete v dokumentu https://docs.microsoft.com/azure/azure-signalr/ služby Azure SignalR. string (povinné)

Omezení:
Minimální délka = 1
Maximální délka = 128

SignalRFeatureProperties

Název Description Hodnota
{přizpůsobená vlastnost} řetězec

LiveTraceConfiguration

Název Description Hodnota
categories Získá nebo nastaví seznam konfigurací kategorií. LiveTraceCategory[]
enabled Určuje, jestli povolí živé trasování.
Když je nastavená hodnota true, klient živého trasování se může ke službě připojit.
V opačném případě se klient živého trasování nemůže ke službě připojit, takže nemůžete přijímat žádný protokol bez ohledu na to, co nakonfigurujete v kategoriích.
Dostupné hodnoty: true, false.
Nerozlišují se velká a malá písmena.
 řetězec

LiveTraceCategory

Název Description Hodnota
enabled Označuje, jestli je povolená kategorie živého trasování nebo.
Dostupné hodnoty: true, false.
Nerozlišují se velká a malá písmena.		 řetězec
name Získá nebo nastaví název kategorie živého trasování.
Dostupné hodnoty: ConnectivityLogs, MessagingLogs.
Nerozlišují se velká a malá písmena.
 řetězec

SignalRNetworkACLs

Název Description Hodnota
defaultAction Akce seznamu ACL pro sítě Azure. 'Povolit'
"Odepřít"
ipRules Pravidla IP adres pro filtrování veřejného provozu IpRule[]

Omezení:
Maximální délka = 30
privátní koncové body Seznamy ACL pro požadavky z privátních koncových bodů PrivateEndpointACL[]
publicNetwork Seznam ACL sítě NetworkACL

IpRule

Název Description Hodnota
action Akce seznamu ACL pro sítě Azure. 'Povolit'
"Odepřít"
hodnota IP adresa nebo CIDR nebo servicetag řetězec

PrivateEndpointACL

Název Description Hodnota
Povolit Povolené typy požadavků. Hodnota může být jedna nebo více z těchto hodnot: ClientConnection, ServerConnection, RESTAPI. Pole řetězců obsahující některou z těchto možností:
'ClientConnection'
RESTAPI
ServerConnection
'Trasování'
Odepřít Typy zamítnutých požadavků. Hodnota může být jedna nebo více z těchto hodnot: ClientConnection, ServerConnection, RESTAPI. Pole řetězců obsahující některou z těchto možností:
'ClientConnection'
RESTAPI
ServerConnection
'Trasování'
name Název připojení privátního koncového bodu string (povinné)

NetworkACL

Název Description Hodnota
Povolit Povolené typy požadavků. Hodnota může být jedna nebo více z těchto hodnot: ClientConnection, ServerConnection, RESTAPI. Pole řetězců obsahující některou z těchto možností:
'ClientConnection'
RESTAPI
ServerConnection
'Trasování'
Odepřít Typy zamítnutých požadavků. Hodnota může být jedna nebo více z těchto hodnot: ClientConnection, ServerConnection, RESTAPI. Pole řetězců obsahující některou z těchto možností:
'ClientConnection'
RESTAPI
ServerConnection
'Trasování'

ResourceLogConfiguration

Název Description Hodnota
categories Získá nebo nastaví seznam konfigurací kategorií. ResourceLogCategory[]

ResourceLogCategory

Název Description Hodnota
enabled Označuje, jestli je povolená kategorie protokolu prostředků nebo.
Dostupné hodnoty: true, false.
Nerozlišují se velká a malá písmena.		 řetězec
name Získá nebo nastaví název kategorie protokolu prostředků.
Dostupné hodnoty: ConnectivityLogs, MessagingLogs.
Nerozlišují se velká a malá písmena.
 řetězec

Nastavení bez serveru

Název Description Hodnota
connectionTimeoutInSeconds Získá nebo nastaví časový limit připojení klienta. Volitelné nastavení.
Hodnota v sekundách.
Výchozí hodnota je 30 sekund.
Pokud se očekává odesílání zpráv v kratších intervalech, měl by zákazník nastavit časový limit na kratší dobu.
a chcete, aby se klient po odeslání poslední zprávy odpojil rychleji.
Pokud se očekává, že se zprávy posílají v delších intervalech, můžete nastavit časový limit na delší dobu.
a chtějí během této relace zachovat stejné připojení klienta.
Služba považuje klienta za odpojeného, pokud v tomto intervalu neobdržel zprávu (včetně zachování stavu).
 int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 120

SignalRTlsSettings

Název Description Hodnota
clientCertEnabled Vyžádejte si klientský certifikát během metody handshake protokolu TLS, pokud je povoleno. Nepodporuje se pro úroveň Free. Všechny vstupy budou ignorovány pro úroveň Free. bool

Nastavení bezserverového proudu

Název Description Hodnota
šablony Získá nebo nastaví seznam šablon nadřazených adres URL. Pořadí je důležité a první odpovídající šablona má efekty. UpstreamTemplate[]

UpstreamTemplate

Název Description Hodnota
Auth Nastavení nadřazeného ověřování. Pokud není nastaveno, pro upstreamové zprávy se nepoužívá žádné ověřování. UpstreamAuthSettings
kategoriePattern Získá nebo nastaví odpovídající vzor pro názvy kategorií. Pokud není nastavená, odpovídá libovolné kategorii.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu kategorie.
2. Zkombinujte více kategorií s ",", například "připojení,zprávy", odpovídá kategoriím "připojení" a "zprávy".
3. Název jedné kategorie, například "připojení", odpovídá kategorii "připojení".		 řetězec
eventPattern Získá nebo nastaví vzor shody pro názvy událostí. Pokud není nastavená, odpovídá jakékoli události.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu události.
2. Zkombinujte více událostí s ",", například "connect,disconnect", to odpovídá událostem "connect" a "disconnect".
3. Název jedné události, například "connect", odpovídá "connect".		 řetězec
hubPattern Získá nebo nastaví odpovídající vzor pro názvy center. Pokud není nastavená, odpovídá jakémukoli rozbočovači.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu centra.
2. Zkombinujte více rozbočovačů s ",", například "hub1,hub2", odpovídá "hub1" a "hub2".
3. Název jednoho centra, například "hub1", odpovídá "hub1".		 řetězec
urlTemplate Získá nebo nastaví upstream url šablony. V šabloně můžete použít 3 předdefinované parametry {hub}, {category} {event}. Hodnota upstreamové adresy URL se dynamicky vypočítá při přijetí požadavku klienta.
Pokud je http://example.com/{hub}/api/{event}například adresa urlTemplate , se žádostí klienta z centra chat se připojí, bude nejprve post na tuto adresu URL: http://example.com/chat/api/connect.
 string (povinné)

UpstreamAuthSettings

Název Description Hodnota
managedIdentity Nastavení spravované identity pro upstream. ManagedIdentitySettings
typ Upstreamový typ ověřování – výčet. ManagedIdentity
'Žádný'

ManagedIdentitySettings

Název Description Hodnota
prostředek Prostředek označující identifikátor URI ID aplikace cílového prostředku.
Zobrazí se také v deklaraci identity aud (cílové skupiny) vydaného tokenu.
 řetězec

ResourceSku

Název Description Hodnota
capacity Volitelné, celé číslo. Počet jednotek prostředku. Ve výchozím nastavení je 1.

Pokud jsou k dispozici, jsou povoleny následující hodnoty:
Volný: 1;
Standardní: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;		 int
name Název skladové položky. Povinná hodnota.

Povolené hodnoty: Standard_S1, Free_F1 Premium_P1		 string (povinné)
tier Volitelná úroveň této konkrétní skladové položky 'Standard' nebo 'Free'.

Basic je zastaralý, použijte Standard místo toho.
 'Základní'
"Zdarma"
'Premium'
'Standard'

Šablony pro rychlý start

Následující šablony rychlého startu nasadí tento typ prostředku.

Template (Šablona) Description
Nasazení služby Azure SignalR

Nasazení do Azure		 Tato šablona vytvoří Azure SignalR Service pomocí šablony.

Definice prostředku Terraformu (zprostředkovatele AzAPI)

Typ prostředku signalR je možné nasadit s operacemi, které cílí na:

  • Skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.SignalRService/signalR, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR@2023-08-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      disableAadAuth = bool
      disableLocalAuth = bool
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      liveTraceConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
        enabled = "string"
      }
      networkACLs = {
        defaultAction = "string"
        ipRules = [
          {
            action = "string"
            value = "string"
          }
        ]
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      regionEndpointEnabled = "string"
      resourceLogConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
      }
      resourceStopped = "string"
      serverless = {
        connectionTimeoutInSeconds = int
      }
      tls = {
        clientCertEnabled = bool
      }
      upstream = {
        templates = [
          {
            auth = {
              managedIdentity = {
                resource = "string"
              }
              type = "string"
            }
            categoryPattern = "string"
            eventPattern = "string"
            hubPattern = "string"
            urlTemplate = "string"
          }
        ]
      }
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
    kind = "string"
  })
}

Hodnoty vlastností

signalR

Název Description Hodnota
typ Typ prostředku Microsoft.SignalRService/signalR@2023-08-01-preview
name Název prostředku string (povinné)

Limit počtu znaků: 3–63

Platné znaky:
Alfanumerické znaky a spojovníky.

Začněte písmenem. Končí písmenem nebo číslicí.

Název prostředku musí být v rámci Azure jedinečný.
location Geografické umístění, ve kterém se nachází prostředek string (povinné)
parent_id K nasazení do skupiny prostředků použijte ID této skupiny prostředků. string (povinné)
tags Značky prostředků. Slovník názvů značek a hodnot.
Sku Fakturační údaje o prostředku. ResourceSku
Druhu Druh služby "RawWebSockets"
"SignalR"
identity Třída představuje spravované identity používané pro požadavky a odpovědi. Spravovaná identita
properties Třída, která popisuje vlastnosti prostředku SignalRVlastnosti

Spravovaná identita

Název Description Hodnota
typ Představuje typ identity: systemAssigned, userAssigned, None "SystemAssigned"
"UserAssigned"
identity_ids Získání nebo nastavení identit přiřazených uživatelem Pole ID identit uživatelů

ManagedIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} UserAssignedIdentityProperty

UserAssignedIdentityProperty

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.

Vlastnosti služby SignalR

Název Description Hodnota
cors Nastavení sdílení prostředků mezi zdroji (CORS). Nastavení SignalRCorsSettings
disableAadAuth DisableLocalAuth
Povolení nebo zakázání ověřování aad
Pokud je nastavená hodnota true, připojení s AuthType=aad nebude fungovat.		 bool
disableLocalAuth DisableLocalAuth
Povolení nebo zakázání místního ověřování pomocí accesskey
Pokud je nastavená hodnota true, připojení pomocí AccessKey=xxx nebude fungovat.		 bool
funkce Seznam funkcíFlags.

Vlastnosti FeatureFlags, které nejsou zahrnuty v parametrech pro operaci aktualizace, nebudou změněny.
A odpověď bude obsahovat pouze vlastnosti featureFlags, které jsou explicitně nastaveny.
Pokud není explicitně nastavená vlastnost featureFlag, použije se její globálně výchozí hodnota.
Mějte ale na paměti, že výchozí hodnota neznamená "false". Liší se z hlediska různých FeatureFlags.		 SignalRFeature[]
liveTraceConfiguration Konfigurace živého trasování prostředku Microsoft.SignalRService LiveTraceConfiguration
networkACLs Síťové seznamy ACL pro prostředek SignalRNetworkACLs
publicNetworkAccess Povolte nebo zakažte veřejný síťový přístup. Výchozí hodnota je "Povoleno".
Síťové seznamy ACL platí i v případě, že je povoleno.
Pokud je zakázaný, veřejný síťový přístup je vždy zakázán bez ohledu na to, co jste nastavili v seznamech ACL sítě.		 řetězec
regionEndpointEnabled Povolte nebo zakažte místní koncový bod. Výchozí hodnota je "Povoleno".
Pokud je tato možnost zakázaná, nová připojení se do tohoto koncového bodu nesměrují, ale na stávající připojení to nebude mít vliv.
Tato vlastnost je specifická pro repliku. Zakázání místního koncového bodu bez repliky není povolené.		 řetězec
resourceLogConfiguration Konfigurace protokolu prostředků prostředku Microsoft.SignalRService. Konfigurace protokolu prostředků
prostředekStopped Zastavte nebo spusťte prostředek. Výchozí hodnota je False.
Pokud je to pravda, rovina dat prostředku se vypne.
Když je hodnota false, spustí se rovina dat prostředku.		 řetězec
Prostředí bez serveru Bezserverová nastavení. Bezserverová nastavení
Tls Nastavení protokolu TLS pro prostředek Nastavení SignalRTlsSettings
upstream Nastavení upstreamu, když je služba v režimu bez serveru. Nastavení bezserverového proudu

Nastavení SignalRCorsSettings

Název Description Hodnota
allowedOrigins Získá nebo nastaví seznam původů, které by měly být povoleny pro volání mezi zdroji (například: http://example.com:12345). Pokud chcete povolit vše, použijte "*". Pokud tento parametr vynecháte, ve výchozím nastavení povolíte vše. string[]

SignalRFeature

Název Description Hodnota
flag FeatureFlags jsou podporované funkce služby Azure SignalR.
– ServiceMode: Příznak back-endového serveru pro službu SignalR. Povolené hodnoty: "Výchozí": máte vlastní back-endový server; "Bezserverový": vaše aplikace nemá back-endový server; "Classic": pro zpětnou kompatibilitu. Podpora výchozího i bezserverového režimu, ale nedoporučuje se; "PredefinedOnly": pro budoucí použití.
– EnableConnectivityLogs: "true"/"false", pokud chcete povolit nebo zakázat kategorii protokolu připojení.
– EnableMessagingLogs: "true"/"false", pokud chcete povolit nebo zakázat kategorii protokolu připojení.
– EnableLiveTrace: Živé trasování umožňuje zjistit, co se děje ve službě Azure SignalR, poskytne vám živé trasování v reálném čase a bude užitečné při vývoji vlastní webové aplikace založené na Azure SignalR nebo při vlastním řešení některých problémů. Upozorňujeme, že živé trasování se počítá jako odchozí zprávy, za které se budou účtovat poplatky. Povolené hodnoty: "true"/"false" pro povolení nebo zakázání funkce živého trasování.		 "EnableConnectivityLogs"
"EnableLiveTrace"
"EnableMessagingLogs"
"ServiceMode" (povinné)
properties Volitelné vlastnosti související s touto funkcí SignalRFeatureProperties
hodnota Hodnota příznaku funkce Povolené hodnoty najdete v dokumentu https://docs.microsoft.com/azure/azure-signalr/ služby Azure SignalR. string (povinné)

Omezení:
Minimální délka = 1
Maximální délka = 128

SignalRFeatureProperties

Název Description Hodnota
{přizpůsobená vlastnost} řetězec

LiveTraceConfiguration

Název Description Hodnota
categories Získá nebo nastaví seznam konfigurací kategorií. LiveTraceCategory[]
enabled Určuje, jestli je povolené živé trasování.
Když je nastavená hodnota true, klient živého trasování se může připojit ke službě.
Jinak se klient živého trasování nemůže ke službě připojit, takže nemůžete přijímat žádný protokol bez ohledu na to, co nakonfigurujete v kategoriích.
Dostupné hodnoty: true, false
Nerozlišují se malá a velká písmena.
 řetězec

LiveTraceCategory

Název Description Hodnota
enabled Určuje, jestli je povolená kategorie živého trasování nebo .
Dostupné hodnoty: true, false
Nerozlišují se malá a velká písmena.		 řetězec
name Získá nebo nastaví název kategorie živého trasování.
Dostupné hodnoty: ConnectivityLogs, MessagingLogs.
Nerozlišují se malá a velká písmena.
 řetězec

SignalRNetworkACLs

Název Description Hodnota
výchozí akce Akce seznamu ACL pro sítě Azure "Povolit"
"Odepřít"
pravidla ipRules Pravidla IP adres pro filtrování veřejného provozu Pravidla IP[]

Omezení:
Maximální délka = 30
privátní koncové body Seznamy ACL pro požadavky z privátních koncových bodů PrivateEndpointACL[]
publicNetwork Seznam ACL sítě Seznam NetworkACL

Pravidla PROTOKOLU IP

Název Description Hodnota
action Akce seznamu ACL pro sítě Azure "Povolit"
"Odepřít"
hodnota IP adresa, CIDR nebo značka služby řetězec

PrivateEndpointACL

Název Description Hodnota
Povolit Povolené typy požadavků. Hodnota může být jedna nebo více z těchto: ClientConnection, ServerConnection, RESTAPI. Pole řetězců obsahující některou z těchto možností:
"ClientConnection"
"RESTAPI"
"Připojení serveru"
"Trasování"
Odepřít Typy zamítnutých požadavků Hodnota může být jedna nebo více z těchto: ClientConnection, ServerConnection, RESTAPI. Pole řetězců obsahující některou z těchto možností:
"ClientConnection"
"RESTAPI"
"Připojení serveru"
"Trasování"
name Název připojení privátního koncového bodu string (povinné)

Seznam NetworkACL

Název Description Hodnota
Povolit Povolené typy požadavků. Hodnota může být jedna nebo více z těchto: ClientConnection, ServerConnection, RESTAPI. Pole řetězců obsahující některou z těchto možností:
"ClientConnection"
"RESTAPI"
"Připojení serveru"
"Trasování"
Odepřít Typy zamítnutých požadavků Hodnota může být jedna nebo více z těchto: ClientConnection, ServerConnection, RESTAPI. Pole řetězců obsahující některou z těchto možností:
"ClientConnection"
"RESTAPI"
"Připojení serveru"
"Trasování"

Konfigurace protokolu prostředků

Název Description Hodnota
categories Získá nebo nastaví seznam konfigurací kategorií. ResourceLogCategory[]

ResourceLogCategory

Název Description Hodnota
enabled Určuje, jestli je povolená kategorie protokolu prostředků nebo .
Dostupné hodnoty: true, false
Nerozlišují se malá a velká písmena.		 řetězec
name Získá nebo nastaví název kategorie protokolu prostředků.
Dostupné hodnoty: ConnectivityLogs, MessagingLogs.
Nerozlišují se malá a velká písmena.
 řetězec

Bezserverová nastavení

Název Description Hodnota
connectionTimeoutInSeconds Získá nebo nastaví vypršení časového limitu připojení klienta. Volitelné nastavení.
Hodnota v sekundách
Výchozí hodnota je 30 sekund.
Pokud se očekává odesílání zpráv v kratších intervalech, měl by zákazník nastavit časový limit na kratší dobu.
a chcete, aby se klient po odeslání poslední zprávy odpojil rychleji.
Pokud se očekává, že se zprávy odesílají v delších intervalech, můžete časový limit nastavit na delší dobu.
a chtějí během této relace zachovat stejné připojení klienta.
Služba považuje klienta za odpojeného, pokud v tomto intervalu neobdržela zprávu (včetně udržování připojení).
 int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 120

Nastavení SignalRTlsSettings

Název Description Hodnota
clientCertEnabled Vyžádejte si klientský certifikát během metody handshake protokolu TLS, pokud je povoleno. Nepodporuje se pro úroveň Free. Všechny vstupy budou ignorovány pro úroveň Free. bool

Nastavení bezserverového proudu

Název Description Hodnota
šablony Získá nebo nastaví seznam šablon nadřazené adresy URL. Pořadí je důležité a první odpovídající šablona má efekty. UpstreamTemplate[]

UpstreamOváplata

Název Description Hodnota
Auth Upstreamové nastavení ověřování. Pokud není nastavená, pro nadřazené zprávy se nepoužívá žádné ověřování. UpstreamAuthSettings
kategoriePattern Získá nebo nastaví vzor shody pro názvy kategorií. Pokud není nastavená, odpovídá libovolné kategorii.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu kategorie.
2. Zkombinujte více kategorií s ",", například "připojení,zprávy", odpovídá kategoriím "připojení" a "zprávy".
3. Jeden název kategorie, například "připojení", odpovídá kategorii "připojení".		 řetězec
eventPattern Získá nebo nastaví vzor shody pro názvy událostí. Pokud není nastavená, odpovídá jakékoli události.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu události.
2. Zkombinujte více událostí s ",", například "connect,disconnect", odpovídá událostem "connect" a "disconnect".
3. Název jedné události, například "connect", odpovídá "connect".		 řetězec
hubPattern Získá nebo nastaví vzor shody pro názvy center. Pokud není nastavená, odpovídá jakémukoli rozbočovači.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu centra.
2. Zkombinujte více rozbočovačů s ",", například "hub1,hub2", odpovídá "hub1" a "hub2".
3. Název jednoho centra, například "hub1", odpovídá "hub1".		 řetězec
urlNášplate Získá nebo nastaví šablonu nadřazené adresy URL. V šabloně můžete použít 3 předdefinované parametry {hub}, {category} {event}, hodnota upstreamové adresy URL se dynamicky počítá při přijetí požadavku klienta.
Pokud je http://example.com/{hub}/api/{event}například urlTemplate s požadavkem klienta z připojení centra chat , bude nejprve POST na tuto adresu URL: http://example.com/chat/api/connect.
 string (povinné)

UpstreamAuthSettings

Název Description Hodnota
spravovaná identita Nastavení spravované identity pro upstream ManagedIdentitySettings
typ Výčet typu upstreamové ověřování "Spravovaná identita"
"Žádné"

ManagedIdentitySettings

Název Description Hodnota
prostředek Prostředek označující identifikátor URI ID aplikace cílového prostředku.
Zobrazí se také v deklaraci identity aud (cílové skupiny) vydaného tokenu.
 řetězec

Sklad prostředků

Název Description Hodnota
capacity Volitelné, celé číslo. Počet jednotek prostředku. Ve výchozím nastavení je 1.

Pokud jsou k dispozici, jsou povoleny následující hodnoty:
Volný: 1;
Standardní: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;		 int
name Název skladové položky. Povinná hodnota.

Povolené hodnoty: Standard_S1, Free_F1, Premium_P1		 string (povinné)
tier Volitelná úroveň této konkrétní skladové položky 'Standard' nebo 'Free'.

Basic je zastaralá, místo toho použijte Standard .
 "Základní"
"Zdarma"
"Premium"
"Standardní"