Dela via

Microsoft.SignalRService signalR 2022-08-01-preview

  • Artikel

Bicep-resursdefinition

SignalR-resurstypen kan distribueras med åtgärder som mål:

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@2022-08-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'
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: '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'
  }
}

Egenskapsvärden

LiveTraceCategory

Namn Beskrivning Värde
Aktiverat Anger om eller livespårningskategorin är aktiverad.
Tillgängliga värden: sant, falskt.
Skiftlägesokänsligt.		 sträng
Namn Hämtar eller anger namnet på livespårningskategorin.
Tillgängliga värden: ConnectivityLogs, MessagingLogs.
Skiftlägesokänsligt.		 sträng

LiveTraceConfiguration

Namn Beskrivning Värde
Kategorier Hämtar eller anger listan över kategorikonfigurationer. LiveTraceCategory[]
Aktiverat Anger om aktivering av livespårning ska aktiveras eller inte.
När den är inställd på true kan livespårningsklienten ansluta till tjänsten.
Annars kan livespårningsklienten inte ansluta till tjänsten, så att du inte kan ta emot någon logg, oavsett vad du konfigurerar i "kategorier".
Tillgängliga värden: sant, falskt.
Skiftlägesokänsligt.		 sträng

Hanterad identitet

Namn Beskrivning Värde
typ Representerar identitetstypen: systemAssigned, userAssigned, None "Ingen"
"SystemAssigned"
"UserAssigned"
userAssignedIdentities Hämta eller ange användartilldelade identiteter ManagedIdentityUserAssignedIdentiteter

ManagedIdentitySettings

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 En klass representerar hanterade identiteter som används för begäran och svar ManagedIdentity
sort Typen av tjänst, det kan vara SignalR eller RawWebSockets "RawWebSockets"
"SignalR"
plats Resursens GEO-plats. t.ex. USA, västra Östra USA USA, norra centrala USA, södra centrala. sträng
Namn Resursnamnet sträng (krävs)
Egenskaper En klass som beskriver resursens egenskaper SignalRProperties
Sku Faktureringsinformation för resursen. ResourceSku
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

NetworkACL

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

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)

ResourceLogCategory

Namn Beskrivning Värde
Aktiverat Anger om eller resursloggkategorin är aktiverad.
Tillgängliga värden: sant, falskt.
Skiftlägesokänsligt.		 sträng
Namn Hämtar eller anger resursloggkategorins namn.
Tillgängliga värden: ConnectivityLogs, MessagingLogs.
Skiftlägesokänsligt.		 sträng

ResourceLogConfiguration

Namn Beskrivning Värde
Kategorier Hämtar eller anger listan över kategorikonfigurationer. ResourceLogCategory[]

ResourceSku

Namn Beskrivning Värde
kapacitet Valfritt heltal. Antalet enheter för resursen. 1 som standard.

Om det finns tillåts följande värden:
Gratis: 1;
Standard: 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
Namn Namnet på SKU:n. Krävs.

Tillåtna värden: Standard_S1, Free_F1, Premium_P1		 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"

ServerlessSettings

Namn Beskrivning Värde
connectionTimeoutInSeconds Hämtar eller anger tidsgränsen för klientanslutning. Valfritt att ställa in.
Värde i sekunder.
Standardvärdet är 30 sekunder.
Kunden bör ange tidsgränsen till en kortare period om meddelanden förväntas skickas med kortare intervall.
och vill att klienten ska kopplas från snabbare när det senaste meddelandet har skickats.
Du kan ange tidsgränsen till en längre period om meddelanden förväntas skickas med längre intervall.
och de vill hålla samma klientanslutning vid liv under den här sessionen.
Tjänsten anser att klienten är frånkopplad om den inte har tagit emot ett meddelande (inklusive keep-alive) i det här intervallet.		 Int

Begränsningar:
Minsta värde = 1
Maxvärde = 120

ServerlessUpstreamSettings

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. UpstreamTemplate[]

SignalRCorsSettings

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. string[]

SignalRFeature

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
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

Namn Beskrivning Värde

SignalRNetworkACLs

Namn Beskrivning Värde
defaultAction Azure Networking ACL-åtgärd. "Tillåt"
"Neka"
privateEndpoints ACL:er för begäranden från privata slutpunkter PrivateEndpointACL[]
publicNetwork Nätverks-ACL NetworkACL

SignalRProperties

Namn Beskrivning Värde
cors CORS-inställningar (Cross-Origin Resource Sharing). SignalRCorsSettings
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[]
liveTraceConfiguration Livespårningskonfiguration av en Microsoft.SignalRService-resurs. LiveTraceConfiguration
networkACLs Nätverks-ACL:er för resursen SignalRNetworkACLs
publicNetworkAccess 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
resourceLogConfiguration Konfiguration av resurslogg för en Microsoft.SignalRService-resurs. ResourceLogConfiguration
serverlös Serverlösa inställningar. ServerlessSettings
tls TLS-inställningar för resursen SignalRTlsSettings
uppströms Inställningarna för Upstream när tjänsten är i serverlöst läge. ServerlessUpstreamSettings

SignalRTlsSettings

Namn Beskrivning Värde
clientCertEnabled Begär klientcertifikat under TLS-handskakning om det är aktiverat Bool

TrackedResourceTags

Namn Beskrivning Värde

UpstreamAuthSettings

Namn Beskrivning Värde
managedIdentity Hanterade identitetsinställningar för uppströms. ManagedIdentitySettings
typ Uppströms autentiseringstyp uppräkning. "ManagedIdentity"
"Ingen"

UpstreamTemplate

Namn Beskrivning Värde
Auth Inställningar för överordnad autentisering. Om den inte har angetts används ingen autentisering för överordnade meddelanden. UpstreamAuthSettings
categoryPattern 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
eventPattern 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 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)

UserAssignedIdentityProperty

Namn Beskrivning Värde

Snabbstartsexempel

Följande snabbstartsexempel distribuerar 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:

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": "2022-08-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",
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "resourceLogConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "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"
  }
}

Egenskapsvärden

LiveTraceCategory

Namn Beskrivning Värde
Aktiverat Anger om eller livespårningskategorin är aktiverad.
Tillgängliga värden: sant, falskt.
Skiftlägesokänsligt.		 sträng
Namn Hämtar eller anger namnet på livespårningskategorin.
Tillgängliga värden: ConnectivityLogs, MessagingLogs.
Skiftlägesokänsligt.		 sträng

LiveTraceConfiguration

Namn Beskrivning Värde
Kategorier Hämtar eller anger listan över kategorikonfigurationer. LiveTraceCategory[]
Aktiverat Anger om aktivering av livespårning ska aktiveras eller inte.
När den är inställd på true kan livespårningsklienten ansluta till tjänsten.
Annars kan livespårningsklienten inte ansluta till tjänsten, så att du inte kan ta emot någon logg, oavsett vad du konfigurerar i "kategorier".
Tillgängliga värden: sant, falskt.
Skiftlägesokänsligt.		 sträng

Hanterad identitet

Namn Beskrivning Värde
typ Representerar identitetstypen: systemAssigned, userAssigned, None "Ingen"
"SystemAssigned"
"UserAssigned"
userAssignedIdentities Hämta eller ange användartilldelade identiteter ManagedIdentityUserAssignedIdentiteter

ManagedIdentitySettings

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 "2022-08-01-preview"
identitet En klass representerar hanterade identiteter som används för begäran och svar ManagedIdentity
sort Typen av tjänst, det kan vara SignalR eller RawWebSockets "RawWebSockets"
"SignalR"
plats Resursens GEO-plats. t.ex. USA, västra Östra USA USA, norra centrala USA, södra centrala. sträng
Namn Resursnamnet sträng (krävs)
Egenskaper En klass som beskriver resursens egenskaper SignalRProperties
Sku Faktureringsinformation för resursen. ResourceSku
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.SignalRService/signalR"

NetworkACL

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

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)

ResourceLogCategory

Namn Beskrivning Värde
Aktiverat Anger om eller resursloggkategorin är aktiverad.
Tillgängliga värden: sant, falskt.
Skiftlägesokänsligt.		 sträng
Namn Hämtar eller anger resursloggkategorins namn.
Tillgängliga värden: ConnectivityLogs, MessagingLogs.
Skiftlägesokänsligt.		 sträng

ResourceLogConfiguration

Namn Beskrivning Värde
Kategorier Hämtar eller anger listan över kategorikonfigurationer. ResourceLogCategory[]

ResourceSku

Namn Beskrivning Värde
kapacitet Valfritt heltal. Antalet enheter för resursen. 1 som standard.

Om det finns tillåts följande värden:
Gratis: 1;
Standard: 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
Namn Namnet på SKU:n. Krävs.

Tillåtna värden: Standard_S1, Free_F1, Premium_P1		 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"

ServerlessSettings

Namn Beskrivning Värde
connectionTimeoutInSeconds Hämtar eller anger tidsgränsen för klientanslutning. Valfritt att ställa in.
Värde i sekunder.
Standardvärdet är 30 sekunder.
Kunden bör ange tidsgränsen till en kortare period om meddelanden förväntas skickas med kortare intervall.
och vill att klienten ska kopplas från snabbare när det senaste meddelandet har skickats.
Du kan ange tidsgränsen till en längre period om meddelanden förväntas skickas med längre intervall.
och de vill hålla samma klientanslutning vid liv under den här sessionen.
Tjänsten anser att klienten är frånkopplad om den inte har tagit emot ett meddelande (inklusive keep-alive) i det här intervallet.		 Int

Begränsningar:
Minsta värde = 1
Maxvärde = 120

ServerlessUpstreamSettings

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. UpstreamTemplate[]

SignalRCorsSettings

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. string[]

SignalRFeature

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
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

Namn Beskrivning Värde

SignalRNetworkACLs

Namn Beskrivning Värde
defaultAction Azure Networking ACL-åtgärd. "Tillåt"
"Neka"
privateEndpoints ACL:er för begäranden från privata slutpunkter PrivateEndpointACL[]
publicNetwork Nätverks-ACL NetworkACL

SignalRProperties

Namn Beskrivning Värde
cors CORS-inställningar (Cross-Origin Resource Sharing). SignalRCorsSettings
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[]
liveTraceConfiguration Livespårningskonfiguration av en Microsoft.SignalRService-resurs. LiveTraceConfiguration
networkACLs Nätverks-ACL:er för resursen SignalRNetworkACLs
publicNetworkAccess 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
resourceLogConfiguration Konfiguration av resurslogg för en Microsoft.SignalRService-resurs. ResourceLogConfiguration
serverlös Serverlösa inställningar. ServerlessSettings
tls TLS-inställningar för resursen SignalRTlsSettings
uppströms Inställningarna för Upstream när tjänsten är i serverlöst läge. ServerlessUpstreamSettings

SignalRTlsSettings

Namn Beskrivning Värde
clientCertEnabled Begär klientcertifikat under TLS-handskakning om det är aktiverat Bool

TrackedResourceTags

Namn Beskrivning Värde

UpstreamAuthSettings

Namn Beskrivning Värde
managedIdentity Hanterade identitetsinställningar för uppströms. ManagedIdentitySettings
typ Uppströms autentiseringstyp uppräkning. "ManagedIdentity"
"Ingen"

UpstreamTemplate

Namn Beskrivning Värde
Auth Inställningar för överordnad autentisering. Om den inte har angetts används ingen autentisering för överordnade meddelanden. UpstreamAuthSettings
categoryPattern 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
eventPattern 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 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)

UserAssignedIdentityProperty

Namn Beskrivning Värde

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
Distribuera en Azure SignalR-tjänst

Distribuera till Azure 		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@2022-08-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"
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      resourceLogConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
      }
      serverless = {
        connectionTimeoutInSeconds = int
      }
      tls = {
        clientCertEnabled = bool
      }
      upstream = {
        templates = [
          {
            auth = {
              managedIdentity = {
                resource = "string"
              }
              type = "string"
            }
            categoryPattern = "string"
            eventPattern = "string"
            hubPattern = "string"
            urlTemplate = "string"
          }
        ]
      }
    }
  })
}

Egenskapsvärden

LiveTraceCategory

Namn Beskrivning Värde
Aktiverat Anger om eller livespårningskategorin är aktiverad.
Tillgängliga värden: sant, falskt.
Skiftlägesokänsligt.		 sträng
Namn Hämtar eller anger namnet på livespårningskategorin.
Tillgängliga värden: ConnectivityLogs, MessagingLogs.
Skiftlägesokänsligt.		 sträng

LiveTraceConfiguration

Namn Beskrivning Värde
Kategorier Hämtar eller anger listan över kategorikonfigurationer. LiveTraceCategory[]
Aktiverat Anger om aktivering av livespårning ska aktiveras eller inte.
När den är inställd på true kan livespårningsklienten ansluta till tjänsten.
Annars kan livespårningsklienten inte ansluta till tjänsten, så att du inte kan ta emot någon logg, oavsett vad du konfigurerar i "kategorier".
Tillgängliga värden: sant, falskt.
Skiftlägesokänsligt.		 sträng

Hanterad identitet

Namn Beskrivning Värde
typ Representerar identitetstypen: systemAssigned, userAssigned, None "Ingen"
"SystemAssigned"
"UserAssigned"
userAssignedIdentities Hämta eller ange användartilldelade identiteter ManagedIdentityUserAssignedIdentiteter

ManagedIdentitySettings

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 En klass representerar hanterade identiteter som används för begäran och svar ManagedIdentity
sort Typen av tjänst, det kan vara SignalR eller RawWebSockets "RawWebSockets"
"SignalR"
plats Resursens GEO-plats. t.ex. USA, västra Östra USA USA, norra centrala USA, södra centrala. sträng
Namn Resursnamnet sträng (krävs)
Egenskaper En klass som beskriver resursens egenskaper SignalRProperties
Sku Faktureringsinformation för resursen. ResourceSku
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.SignalRService/signalR@2022-08-01-preview"

NetworkACL

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

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)

ResourceLogCategory

Namn Beskrivning Värde
Aktiverat Anger om eller resursloggkategorin är aktiverad.
Tillgängliga värden: sant, falskt.
Skiftlägesokänsligt.		 sträng
Namn Hämtar eller anger resursloggkategorins namn.
Tillgängliga värden: ConnectivityLogs, MessagingLogs.
Skiftlägesokänsligt.		 sträng

ResourceLogConfiguration

Namn Beskrivning Värde
Kategorier Hämtar eller anger listan över kategorikonfigurationer. ResourceLogCategory[]

ResourceSku

Namn Beskrivning Värde
kapacitet Valfritt heltal. Antalet enheter för resursen. 1 som standard.

Om det finns tillåts följande värden:
Gratis: 1;
Standard: 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
Namn Namnet på SKU:n. Krävs.

Tillåtna värden: Standard_S1, Free_F1, Premium_P1		 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"

ServerlessSettings

Namn Beskrivning Värde
connectionTimeoutInSeconds Hämtar eller anger tidsgränsen för klientanslutning. Valfritt att ställa in.
Värde i sekunder.
Standardvärdet är 30 sekunder.
Kunden bör ange tidsgränsen till en kortare period om meddelanden förväntas skickas med kortare intervall.
och vill att klienten ska kopplas från snabbare när det senaste meddelandet har skickats.
Du kan ange tidsgränsen till en längre period om meddelanden förväntas skickas med längre intervall.
och de vill hålla samma klientanslutning vid liv under den här sessionen.
Tjänsten anser att klienten är frånkopplad om den inte har tagit emot ett meddelande (inklusive keep-alive) i det här intervallet.		 Int

Begränsningar:
Minsta värde = 1
Maxvärde = 120

ServerlessUpstreamSettings

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. UpstreamTemplate[]

SignalRCorsSettings

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. string[]

SignalRFeature

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
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

Namn Beskrivning Värde

SignalRNetworkACLs

Namn Beskrivning Värde
defaultAction Azure Networking ACL-åtgärd. "Tillåt"
"Neka"
privateEndpoints ACL:er för begäranden från privata slutpunkter PrivateEndpointACL[]
publicNetwork Nätverks-ACL NetworkACL

SignalRProperties

Namn Beskrivning Värde
cors CORS-inställningar (Cross-Origin Resource Sharing). SignalRCorsSettings
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[]
liveTraceConfiguration Livespårningskonfiguration av en Microsoft.SignalRService-resurs. LiveTraceConfiguration
networkACLs Nätverks-ACL:er för resursen SignalRNetworkACLs
publicNetworkAccess 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
resourceLogConfiguration Konfiguration av resurslogg för en Microsoft.SignalRService-resurs. ResourceLogConfiguration
serverlös Serverlösa inställningar. ServerlessSettings
tls TLS-inställningar för resursen SignalRTlsSettings
uppströms Inställningarna för Upstream när tjänsten är i serverlöst läge. ServerlessUpstreamSettings

SignalRTlsSettings

Namn Beskrivning Värde
clientCertEnabled Begär klientcertifikat under TLS-handskakning om det är aktiverat Bool

TrackedResourceTags

Namn Beskrivning Värde

UpstreamAuthSettings

Namn Beskrivning Värde
managedIdentity Hanterade identitetsinställningar för uppströms. ManagedIdentitySettings
typ Uppströms autentiseringstyp uppräkning. "ManagedIdentity"
"Ingen"

UpstreamTemplate

Namn Beskrivning Värde
Auth Inställningar för överordnad autentisering. Om den inte har angetts används ingen autentisering för överordnade meddelanden. UpstreamAuthSettings
categoryPattern 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
eventPattern 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 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)

UserAssignedIdentityProperty

Namn Beskrivning Värde