Sdílet prostřednictvím


Microsoft.SignalRService signalR 2024-01-01-preview

Definice prostředku Bicep

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

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@2024-01-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'
      }
    ]
    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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Hodnoty vlastností

IpRule

Jméno Popis Hodnota
akce Akce seznamu ACL sítě Azure Povolit
"Odepřít"
hodnota IP adresa nebo CIDR nebo ServiceTag řetězec

LiveTraceCategory

Jméno Popis Hodnota
zpřístupněný Určuje, jestli je povolená kategorie živého trasování.
Dostupné hodnoty: true, false.
Nerozlišují se malá a velká písmena.
řetězec
Jméno 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

LiveTraceConfiguration

Jméno Popis Hodnota
Kategorie Získá nebo nastaví seznam konfigurací kategorií. LiveTraceCategory[]
zpřístupněný Určuje, jestli živé trasování povolíte nebo ne.
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 připojit ke službě, takže nebudete moct přijímat žádné protokoly bez ohledu na to, co nakonfigurujete v kategoriích.
Dostupné hodnoty: true, false.
Nerozlišují se malá a velká písmena.
řetězec

ManagedIdentity

Jméno Popis Hodnota
typ Představuje typ identity: systemAssigned, userAssigned, None None (Žádný)
SystemAssigned
UserAssigned
userAssignedIdentities Získání nebo nastavení identit přiřazených uživatelem ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Jméno Popis Hodnota
zdroj Prostředek označující identifikátor URI ID aplikace cílového prostředku.
Zobrazí se také v deklaraci identity vydaného tokenu (cílová skupina).
řetězec

ManagedIdentityUserAssignedIdentities

Jméno Popis Hodnota

Microsoft.SignalRService/signalR

Jméno Popis Hodnota
identita Třída představuje spravované identity používané pro požadavek a odpověď. ManagedIdentity
laskavý Druh služby RawWebSockets
SignalR
umístění Geografické umístění, ve kterém se nachází zdroj string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 3
Maximální délka = 3
Model = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (povinné)
vlastnosti Třída, která popisuje vlastnosti prostředku SignalRProperties
sku Fakturační údaje o prostředku. ResourceSku
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

NetworkACL

Jméno Popis Hodnota
povolit Povolené typy požadavků. Hodnota může být jedna nebo více z: ClientConnection, ServerConnection, RESTAPI. Řetězcové pole obsahující některou z těchto možností:
ClientConnection
RESTAPI
ServerConnection
Trasování
popřít Odepřené typy požadavků. Hodnota může být jedna nebo více z: ClientConnection, ServerConnection, RESTAPI. Řetězcové pole obsahující některou z těchto možností:
ClientConnection
RESTAPI
ServerConnection
Trasování

PrivateEndpointACL

Jméno Popis Hodnota
povolit Povolené typy požadavků. Hodnota může být jedna nebo více z: ClientConnection, ServerConnection, RESTAPI. Řetězcové pole obsahující některou z těchto možností:
ClientConnection
RESTAPI
ServerConnection
Trasování
popřít Odepřené typy požadavků. Hodnota může být jedna nebo více z: ClientConnection, ServerConnection, RESTAPI. Řetězcové pole obsahující některou z těchto možností:
ClientConnection
RESTAPI
ServerConnection
Trasování
Jméno Název připojení privátního koncového bodu string (povinné)

ResourceLogCategory

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

ResourceLogConfiguration

Jméno Popis Hodnota
Kategorie Získá nebo nastaví seznam konfigurací kategorií. ResourceLogCategory[]

ResourceSku

Jméno Popis Hodnota
kapacita Volitelné celé číslo. Počet jednotek prostředku.
1 pro Free_F1/Standard_S1/Premium_P1, 100 pro Premium_P2 ve výchozím nastavení.

Pokud jsou k dispozici, jsou povoleny následující hodnoty:
Free_F1: 1;
Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P2: 100 200 300 400 500 600 700 800 900 1000;
Int
Jméno Název skladové položky. Požadovaný.

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

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

Bezserverové nastavení

Jméno Popis Hodnota
connectionTimeoutInSeconds Získá nebo nastaví časový limit připojení klienta. Volitelné, které se mají nastavit.
Hodnota v sekundách
Výchozí hodnota je 30 sekund.
Zákazník by měl nastavit časový limit na kratší dobu, pokud se očekává, že se zprávy posílají v kratších intervalech,
a chcete, aby se klient po odeslání poslední zprávy odpojil rychleji.
Časový limit můžete nastavit na delší dobu, pokud se očekává, že se zprávy posílají v delších intervalech.
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 nepřišela zpráva (včetně zachování).
Int

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

Bezserverové nastaveníUpstreamSettings

Jméno Popis Hodnota
šablony Získá nebo nastaví seznam upstreamových šablon URL. Pořadí záleží a první odpovídající šablona přebírá efekty. upstreamTemplate[]

SignalRCorsSettings

Jméno Popis 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, povolte ve výchozím nastavení vše. string[]

SignalRFeature

Jméno Popis Hodnota
vlajka FeatureFlags je podporované funkce služby Azure SignalR.
– ServiceMode: Příznak back-endového serveru pro službu SignalR. Povolené hodnoty: "Default": mají váš 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í.
- PovolitConnectivityLogs: "true"/"false", pokud chcete povolit nebo zakázat kategorii protokolu připojení.
- EnableMessagingLogs: "true"/"false", aby bylo možné 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 samoobslužné řešení některých problémů. Upozorňujeme, že živé trasování se počítá jako odchozí zprávy, které se budou účtovat. Povolené hodnoty: "true"/"false", aby bylo možné povolit nebo zakázat funkci živého trasování.
EnableConnectivityLogs
EnableLiveTrace
EnableMessagingLogs
ServiceMode (povinné)
vlastnosti Volitelné vlastnosti související s touto funkcí SignalRFeatureProperties
hodnota Hodnota příznaku funkce Informace o povolených hodnotách najdete v dokumentu služby Azure SignalR /azure/azure-signalr/. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)

SignalRFeatureProperties

Jméno Popis Hodnota

Knihovny SignalRNetworkACLs

Jméno Popis Hodnota
defaultAction Akce seznamu ACL sítě Azure Povolit
"Odepřít"
IpRules Pravidla PROTOKOLU IP pro filtrování veřejného provozu IPRule []
privateEndpoints Seznamy ACL pro žádosti z privátních koncových bodů privateEndpointACL[]
publicNetwork Seznam ACL sítě NetworkACL

SignalRProperties

Jméno Popis Hodnota
cors Nastavení sdílení prostředků mezi zdroji (CORS). 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 nastavíte hodnotu true, připojení k AccessKey=xxx nebude fungovat.
Bool
rysy Seznam funkcíFlags

FeatureFlags, které nejsou součástí parametrů pro operaci aktualizace, nebudou změněny.
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 závislosti na různých funkcích FeatureFlags.
SignalRFeature []
liveTraceConfiguration Konfigurace živého trasování prostředku Microsoft.SignalRService LiveTraceConfiguration
NetworkACLs Seznamy ACL sítě pro prostředek knihovny SignalRNetworkACLs
publicNetworkAccess Povolte nebo zakažte přístup k veřejné síti. Ve výchozím nastavení je povoleno.
Pokud je povolená, síťové seznamy ACL se stále použijí.
Když je zakázaný, přístup k veřejné síti je vždy zakázaný bez ohledu na to, co jste nastavili v seznamech ACL sítě.
řetězec
regionEndpointEnabled Povolte nebo zakažte regionální koncový bod. Ve výchozím nastavení je povoleno.
Pokud je zakázaná, nová připojení nebudou směrována do tohoto koncového bodu, ale stávající připojení nebudou ovlivněna.
Tato vlastnost je specifická pro repliku. Zakázání regionální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 False.
Pokud je to pravda, rovina dat prostředku se vypne.
Když je hodnota false, spustí se rovina dat prostředku.
řetězec
bez serveru Bezserverová nastavení. bezserverové nastavení
tls Nastavení protokolu TLS pro prostředek SignalRTlsSettings
proti proudu Nastavení upstreamu, pokud je služba v režimu bez serveru. serverlessUpstreamSettings

SignalRTlsSettings

Jméno Popis Hodnota
clientCertEnabled Pokud je povolený protokol HANDShake protokolu TLS, požádejte o klientský certifikát. Nepodporuje se pro úroveň Free. Jakýkoli vstup se bude ignorovat pro úroveň Free. Bool

TrackedResourceTags

Jméno Popis Hodnota

UpstreamAuthSettings

Jméno Popis Hodnota
managedIdentity Nastavení spravované identity pro upstream. ManagedIdentitySettings
typ Upstream typ ověřování – výčet. ManagedIdentity
None (Žádný)

UpstreamTemplate

Jméno Popis Hodnota
Auth Upstream nastavení ověřování Pokud není nastavené, pro upstreamové zprávy se nepoužívá žádné ověřování. upstreamAuthSettings
categoryPattern Získá nebo nastaví odpovídající vzor pro názvy kategorií. Pokud není nastavená, odpovídá žádné 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á kategorii "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í odpovídající vzor pro názvy událostí. Pokud není nastavená, odpovídá žádné události.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu události.
2. Kombinování více událostí s ",", například "connect,disconnect", odpovídá události "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 rozbočovače. Pokud není nastavená, odpovídá jakémukoli centru.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu centra.
2. Kombinování 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 šablonu. Můžete použít 3 předdefinované parametry {hub}, {category} {event} uvnitř šablony, hodnota upstreamové adresy URL se dynamicky vypočítá, když přijde požadavek klienta.
Pokud je například adresa URLTemplate http://example.com/{hub}/api/{event}, s požadavkem klienta z centra chat připojí, bude nejprve POST na tuto adresu URL: http://example.com/chat/api/connect.
string (povinné)

UserAssignedIdentityProperty

Jméno Popis Hodnota

Ukázky rychlého startu

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

Soubor Bicep Popis
nasazení služby Azure SignalR Tato šablona vytvoří službu Azure SignalR pomocí šablony.

Definice prostředku šablony ARM

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

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í JSON.

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2024-01-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"
      }
    ],
    "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Hodnoty vlastností

IpRule

Jméno Popis Hodnota
akce Akce seznamu ACL sítě Azure Povolit
"Odepřít"
hodnota IP adresa nebo CIDR nebo ServiceTag řetězec

LiveTraceCategory

Jméno Popis Hodnota
zpřístupněný Určuje, jestli je povolená kategorie živého trasování.
Dostupné hodnoty: true, false.
Nerozlišují se malá a velká písmena.
řetězec
Jméno 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

LiveTraceConfiguration

Jméno Popis Hodnota
Kategorie Získá nebo nastaví seznam konfigurací kategorií. LiveTraceCategory[]
zpřístupněný Určuje, jestli živé trasování povolíte nebo ne.
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 připojit ke službě, takže nebudete moct přijímat žádné protokoly bez ohledu na to, co nakonfigurujete v kategoriích.
Dostupné hodnoty: true, false.
Nerozlišují se malá a velká písmena.
řetězec

ManagedIdentity

Jméno Popis Hodnota
typ Představuje typ identity: systemAssigned, userAssigned, None None (Žádný)
SystemAssigned
UserAssigned
userAssignedIdentities Získání nebo nastavení identit přiřazených uživatelem ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Jméno Popis Hodnota
zdroj Prostředek označující identifikátor URI ID aplikace cílového prostředku.
Zobrazí se také v deklaraci identity vydaného tokenu (cílová skupina).
řetězec

ManagedIdentityUserAssignedIdentities

Jméno Popis Hodnota

Microsoft.SignalRService/signalR

Jméno Popis Hodnota
apiVersion Verze rozhraní API 2024-01-01-preview
identita Třída představuje spravované identity používané pro požadavek a odpověď. ManagedIdentity
laskavý Druh služby RawWebSockets
SignalR
umístění Geografické umístění, ve kterém se nachází zdroj string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 3
Maximální délka = 3
Model = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (povinné)
vlastnosti Třída, která popisuje vlastnosti prostředku SignalRProperties
sku Fakturační údaje o prostředku. ResourceSku
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.SignalRService/signalR

NetworkACL

Jméno Popis Hodnota
povolit Povolené typy požadavků. Hodnota může být jedna nebo více z: ClientConnection, ServerConnection, RESTAPI. Řetězcové pole obsahující některou z těchto možností:
ClientConnection
RESTAPI
ServerConnection
Trasování
popřít Odepřené typy požadavků. Hodnota může být jedna nebo více z: ClientConnection, ServerConnection, RESTAPI. Řetězcové pole obsahující některou z těchto možností:
ClientConnection
RESTAPI
ServerConnection
Trasování

PrivateEndpointACL

Jméno Popis Hodnota
povolit Povolené typy požadavků. Hodnota může být jedna nebo více z: ClientConnection, ServerConnection, RESTAPI. Řetězcové pole obsahující některou z těchto možností:
ClientConnection
RESTAPI
ServerConnection
Trasování
popřít Odepřené typy požadavků. Hodnota může být jedna nebo více z: ClientConnection, ServerConnection, RESTAPI. Řetězcové pole obsahující některou z těchto možností:
ClientConnection
RESTAPI
ServerConnection
Trasování
Jméno Název připojení privátního koncového bodu string (povinné)

ResourceLogCategory

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

ResourceLogConfiguration

Jméno Popis Hodnota
Kategorie Získá nebo nastaví seznam konfigurací kategorií. ResourceLogCategory[]

ResourceSku

Jméno Popis Hodnota
kapacita Volitelné celé číslo. Počet jednotek prostředku.
1 pro Free_F1/Standard_S1/Premium_P1, 100 pro Premium_P2 ve výchozím nastavení.

Pokud jsou k dispozici, jsou povoleny následující hodnoty:
Free_F1: 1;
Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P2: 100 200 300 400 500 600 700 800 900 1000;
Int
Jméno Název skladové položky. Požadovaný.

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

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

Bezserverové nastavení

Jméno Popis Hodnota
connectionTimeoutInSeconds Získá nebo nastaví časový limit připojení klienta. Volitelné, které se mají nastavit.
Hodnota v sekundách
Výchozí hodnota je 30 sekund.
Zákazník by měl nastavit časový limit na kratší dobu, pokud se očekává, že se zprávy posílají v kratších intervalech,
a chcete, aby se klient po odeslání poslední zprávy odpojil rychleji.
Časový limit můžete nastavit na delší dobu, pokud se očekává, že se zprávy posílají v delších intervalech.
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 nepřišela zpráva (včetně zachování).
Int

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

Bezserverové nastaveníUpstreamSettings

Jméno Popis Hodnota
šablony Získá nebo nastaví seznam upstreamových šablon URL. Pořadí záleží a první odpovídající šablona přebírá efekty. upstreamTemplate[]

SignalRCorsSettings

Jméno Popis 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, povolte ve výchozím nastavení vše. string[]

SignalRFeature

Jméno Popis Hodnota
vlajka FeatureFlags je podporované funkce služby Azure SignalR.
– ServiceMode: Příznak back-endového serveru pro službu SignalR. Povolené hodnoty: "Default": mají váš 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í.
- PovolitConnectivityLogs: "true"/"false", pokud chcete povolit nebo zakázat kategorii protokolu připojení.
- EnableMessagingLogs: "true"/"false", aby bylo možné 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 samoobslužné řešení některých problémů. Upozorňujeme, že živé trasování se počítá jako odchozí zprávy, které se budou účtovat. Povolené hodnoty: "true"/"false", aby bylo možné povolit nebo zakázat funkci živého trasování.
EnableConnectivityLogs
EnableLiveTrace
EnableMessagingLogs
ServiceMode (povinné)
vlastnosti Volitelné vlastnosti související s touto funkcí SignalRFeatureProperties
hodnota Hodnota příznaku funkce Informace o povolených hodnotách najdete v dokumentu služby Azure SignalR /azure/azure-signalr/. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)

SignalRFeatureProperties

Jméno Popis Hodnota

Knihovny SignalRNetworkACLs

Jméno Popis Hodnota
defaultAction Akce seznamu ACL sítě Azure Povolit
"Odepřít"
IpRules Pravidla PROTOKOLU IP pro filtrování veřejného provozu IPRule []
privateEndpoints Seznamy ACL pro žádosti z privátních koncových bodů privateEndpointACL[]
publicNetwork Seznam ACL sítě NetworkACL

SignalRProperties

Jméno Popis Hodnota
cors Nastavení sdílení prostředků mezi zdroji (CORS). 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 nastavíte hodnotu true, připojení k AccessKey=xxx nebude fungovat.
Bool
rysy Seznam funkcíFlags

FeatureFlags, které nejsou součástí parametrů pro operaci aktualizace, nebudou změněny.
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 závislosti na různých funkcích FeatureFlags.
SignalRFeature []
liveTraceConfiguration Konfigurace živého trasování prostředku Microsoft.SignalRService LiveTraceConfiguration
NetworkACLs Seznamy ACL sítě pro prostředek knihovny SignalRNetworkACLs
publicNetworkAccess Povolte nebo zakažte přístup k veřejné síti. Ve výchozím nastavení je povoleno.
Pokud je povolená, síťové seznamy ACL se stále použijí.
Když je zakázaný, přístup k veřejné síti je vždy zakázaný bez ohledu na to, co jste nastavili v seznamech ACL sítě.
řetězec
regionEndpointEnabled Povolte nebo zakažte regionální koncový bod. Ve výchozím nastavení je povoleno.
Pokud je zakázaná, nová připojení nebudou směrována do tohoto koncového bodu, ale stávající připojení nebudou ovlivněna.
Tato vlastnost je specifická pro repliku. Zakázání regionální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 False.
Pokud je to pravda, rovina dat prostředku se vypne.
Když je hodnota false, spustí se rovina dat prostředku.
řetězec
bez serveru Bezserverová nastavení. bezserverové nastavení
tls Nastavení protokolu TLS pro prostředek SignalRTlsSettings
proti proudu Nastavení upstreamu, pokud je služba v režimu bez serveru. serverlessUpstreamSettings

SignalRTlsSettings

Jméno Popis Hodnota
clientCertEnabled Pokud je povolený protokol HANDShake protokolu TLS, požádejte o klientský certifikát. Nepodporuje se pro úroveň Free. Jakýkoli vstup se bude ignorovat pro úroveň Free. Bool

TrackedResourceTags

Jméno Popis Hodnota

UpstreamAuthSettings

Jméno Popis Hodnota
managedIdentity Nastavení spravované identity pro upstream. ManagedIdentitySettings
typ Upstream typ ověřování – výčet. ManagedIdentity
None (Žádný)

UpstreamTemplate

Jméno Popis Hodnota
Auth Upstream nastavení ověřování Pokud není nastavené, pro upstreamové zprávy se nepoužívá žádné ověřování. upstreamAuthSettings
categoryPattern Získá nebo nastaví odpovídající vzor pro názvy kategorií. Pokud není nastavená, odpovídá žádné 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á kategorii "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í odpovídající vzor pro názvy událostí. Pokud není nastavená, odpovídá žádné události.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu události.
2. Kombinování více událostí s ",", například "connect,disconnect", odpovídá události "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 rozbočovače. Pokud není nastavená, odpovídá jakémukoli centru.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu centra.
2. Kombinování 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 šablonu. Můžete použít 3 předdefinované parametry {hub}, {category} {event} uvnitř šablony, hodnota upstreamové adresy URL se dynamicky vypočítá, když přijde požadavek klienta.
Pokud je například adresa URLTemplate http://example.com/{hub}/api/{event}, s požadavkem klienta z centra chat připojí, bude nejprve POST na tuto adresu URL: http://example.com/chat/api/connect.
string (povinné)

UserAssignedIdentityProperty

Jméno Popis Hodnota

Šablony pro rychlý start

Následující šablony pro rychlý start nasazují tento typ prostředku.

Šablona Popis
nasazení služby Azure SignalR

nasazení do Azure
Tato šablona vytvoří službu Azure SignalR pomocí šablony.

Definice prostředku Terraformu (poskytovatel AzAPI)

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

  • 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@2024-01-01-preview"
  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"
        }
      ]
      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í

IpRule

Jméno Popis Hodnota
akce Akce seznamu ACL sítě Azure Povolit
"Odepřít"
hodnota IP adresa nebo CIDR nebo ServiceTag řetězec

LiveTraceCategory

Jméno Popis Hodnota
zpřístupněný Určuje, jestli je povolená kategorie živého trasování.
Dostupné hodnoty: true, false.
Nerozlišují se malá a velká písmena.
řetězec
Jméno 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

LiveTraceConfiguration

Jméno Popis Hodnota
Kategorie Získá nebo nastaví seznam konfigurací kategorií. LiveTraceCategory[]
zpřístupněný Určuje, jestli živé trasování povolíte nebo ne.
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 připojit ke službě, takže nebudete moct přijímat žádné protokoly bez ohledu na to, co nakonfigurujete v kategoriích.
Dostupné hodnoty: true, false.
Nerozlišují se malá a velká písmena.
řetězec

ManagedIdentity

Jméno Popis Hodnota
typ Představuje typ identity: systemAssigned, userAssigned, None None (Žádný)
SystemAssigned
UserAssigned
userAssignedIdentities Získání nebo nastavení identit přiřazených uživatelem ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Jméno Popis Hodnota
zdroj Prostředek označující identifikátor URI ID aplikace cílového prostředku.
Zobrazí se také v deklaraci identity vydaného tokenu (cílová skupina).
řetězec

ManagedIdentityUserAssignedIdentities

Jméno Popis Hodnota

Microsoft.SignalRService/signalR

Jméno Popis Hodnota
identita Třída představuje spravované identity používané pro požadavek a odpověď. ManagedIdentity
laskavý Druh služby RawWebSockets
SignalR
umístění Geografické umístění, ve kterém se nachází zdroj string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 3
Maximální délka = 3
Model = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (povinné)
vlastnosti Třída, která popisuje vlastnosti prostředku SignalRProperties
sku Fakturační údaje o prostředku. ResourceSku
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.SignalRService/signalR@2024-01-01-preview

NetworkACL

Jméno Popis Hodnota
povolit Povolené typy požadavků. Hodnota může být jedna nebo více z: ClientConnection, ServerConnection, RESTAPI. Řetězcové pole obsahující některou z těchto možností:
ClientConnection
RESTAPI
ServerConnection
Trasování
popřít Odepřené typy požadavků. Hodnota může být jedna nebo více z: ClientConnection, ServerConnection, RESTAPI. Řetězcové pole obsahující některou z těchto možností:
ClientConnection
RESTAPI
ServerConnection
Trasování

PrivateEndpointACL

Jméno Popis Hodnota
povolit Povolené typy požadavků. Hodnota může být jedna nebo více z: ClientConnection, ServerConnection, RESTAPI. Řetězcové pole obsahující některou z těchto možností:
ClientConnection
RESTAPI
ServerConnection
Trasování
popřít Odepřené typy požadavků. Hodnota může být jedna nebo více z: ClientConnection, ServerConnection, RESTAPI. Řetězcové pole obsahující některou z těchto možností:
ClientConnection
RESTAPI
ServerConnection
Trasování
Jméno Název připojení privátního koncového bodu string (povinné)

ResourceLogCategory

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

ResourceLogConfiguration

Jméno Popis Hodnota
Kategorie Získá nebo nastaví seznam konfigurací kategorií. ResourceLogCategory[]

ResourceSku

Jméno Popis Hodnota
kapacita Volitelné celé číslo. Počet jednotek prostředku.
1 pro Free_F1/Standard_S1/Premium_P1, 100 pro Premium_P2 ve výchozím nastavení.

Pokud jsou k dispozici, jsou povoleny následující hodnoty:
Free_F1: 1;
Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P2: 100 200 300 400 500 600 700 800 900 1000;
Int
Jméno Název skladové položky. Požadovaný.

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

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

Bezserverové nastavení

Jméno Popis Hodnota
connectionTimeoutInSeconds Získá nebo nastaví časový limit připojení klienta. Volitelné, které se mají nastavit.
Hodnota v sekundách
Výchozí hodnota je 30 sekund.
Zákazník by měl nastavit časový limit na kratší dobu, pokud se očekává, že se zprávy posílají v kratších intervalech,
a chcete, aby se klient po odeslání poslední zprávy odpojil rychleji.
Časový limit můžete nastavit na delší dobu, pokud se očekává, že se zprávy posílají v delších intervalech.
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 nepřišela zpráva (včetně zachování).
Int

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

Bezserverové nastaveníUpstreamSettings

Jméno Popis Hodnota
šablony Získá nebo nastaví seznam upstreamových šablon URL. Pořadí záleží a první odpovídající šablona přebírá efekty. upstreamTemplate[]

SignalRCorsSettings

Jméno Popis 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, povolte ve výchozím nastavení vše. string[]

SignalRFeature

Jméno Popis Hodnota
vlajka FeatureFlags je podporované funkce služby Azure SignalR.
– ServiceMode: Příznak back-endového serveru pro službu SignalR. Povolené hodnoty: "Default": mají váš 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í.
- PovolitConnectivityLogs: "true"/"false", pokud chcete povolit nebo zakázat kategorii protokolu připojení.
- EnableMessagingLogs: "true"/"false", aby bylo možné 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 samoobslužné řešení některých problémů. Upozorňujeme, že živé trasování se počítá jako odchozí zprávy, které se budou účtovat. Povolené hodnoty: "true"/"false", aby bylo možné povolit nebo zakázat funkci živého trasování.
EnableConnectivityLogs
EnableLiveTrace
EnableMessagingLogs
ServiceMode (povinné)
vlastnosti Volitelné vlastnosti související s touto funkcí SignalRFeatureProperties
hodnota Hodnota příznaku funkce Informace o povolených hodnotách najdete v dokumentu služby Azure SignalR /azure/azure-signalr/. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)

SignalRFeatureProperties

Jméno Popis Hodnota

Knihovny SignalRNetworkACLs

Jméno Popis Hodnota
defaultAction Akce seznamu ACL sítě Azure Povolit
"Odepřít"
IpRules Pravidla PROTOKOLU IP pro filtrování veřejného provozu IPRule []
privateEndpoints Seznamy ACL pro žádosti z privátních koncových bodů privateEndpointACL[]
publicNetwork Seznam ACL sítě NetworkACL

SignalRProperties

Jméno Popis Hodnota
cors Nastavení sdílení prostředků mezi zdroji (CORS). 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 nastavíte hodnotu true, připojení k AccessKey=xxx nebude fungovat.
Bool
rysy Seznam funkcíFlags

FeatureFlags, které nejsou součástí parametrů pro operaci aktualizace, nebudou změněny.
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 závislosti na různých funkcích FeatureFlags.
SignalRFeature []
liveTraceConfiguration Konfigurace živého trasování prostředku Microsoft.SignalRService LiveTraceConfiguration
NetworkACLs Seznamy ACL sítě pro prostředek knihovny SignalRNetworkACLs
publicNetworkAccess Povolte nebo zakažte přístup k veřejné síti. Ve výchozím nastavení je povoleno.
Pokud je povolená, síťové seznamy ACL se stále použijí.
Když je zakázaný, přístup k veřejné síti je vždy zakázaný bez ohledu na to, co jste nastavili v seznamech ACL sítě.
řetězec
regionEndpointEnabled Povolte nebo zakažte regionální koncový bod. Ve výchozím nastavení je povoleno.
Pokud je zakázaná, nová připojení nebudou směrována do tohoto koncového bodu, ale stávající připojení nebudou ovlivněna.
Tato vlastnost je specifická pro repliku. Zakázání regionální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 False.
Pokud je to pravda, rovina dat prostředku se vypne.
Když je hodnota false, spustí se rovina dat prostředku.
řetězec
bez serveru Bezserverová nastavení. bezserverové nastavení
tls Nastavení protokolu TLS pro prostředek SignalRTlsSettings
proti proudu Nastavení upstreamu, pokud je služba v režimu bez serveru. serverlessUpstreamSettings

SignalRTlsSettings

Jméno Popis Hodnota
clientCertEnabled Pokud je povolený protokol HANDShake protokolu TLS, požádejte o klientský certifikát. Nepodporuje se pro úroveň Free. Jakýkoli vstup se bude ignorovat pro úroveň Free. Bool

TrackedResourceTags

Jméno Popis Hodnota

UpstreamAuthSettings

Jméno Popis Hodnota
managedIdentity Nastavení spravované identity pro upstream. ManagedIdentitySettings
typ Upstream typ ověřování – výčet. ManagedIdentity
None (Žádný)

UpstreamTemplate

Jméno Popis Hodnota
Auth Upstream nastavení ověřování Pokud není nastavené, pro upstreamové zprávy se nepoužívá žádné ověřování. upstreamAuthSettings
categoryPattern Získá nebo nastaví odpovídající vzor pro názvy kategorií. Pokud není nastavená, odpovídá žádné 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á kategorii "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í odpovídající vzor pro názvy událostí. Pokud není nastavená, odpovídá žádné události.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu události.
2. Kombinování více událostí s ",", například "connect,disconnect", odpovídá události "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 rozbočovače. Pokud není nastavená, odpovídá jakémukoli centru.
Podporují se 3 druhy vzorů:
1. "*", odpovídá libovolnému názvu centra.
2. Kombinování 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 šablonu. Můžete použít 3 předdefinované parametry {hub}, {category} {event} uvnitř šablony, hodnota upstreamové adresy URL se dynamicky vypočítá, když přijde požadavek klienta.
Pokud je například adresa URLTemplate http://example.com/{hub}/api/{event}, s požadavkem klienta z centra chat připojí, bude nejprve POST na tuto adresu URL: http://example.com/chat/api/connect.
string (povinné)

UserAssignedIdentityProperty

Jméno Popis Hodnota