Delen via

Microsoft.SignalRService signalR 2023-02-01

  • Artikel

Bicep-resourcedefinitie

Het resourcetype signalR kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.SignalRService/signalR-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.SignalRService/signalR@2023-02-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    disableAadAuth: bool
    disableLocalAuth: bool
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    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'
  }
}

Eigenschapswaarden

LiveTraceCategory

Naam Beschrijving Waarde
Ingeschakeld Geeft aan of de livetraceringscategorie is ingeschakeld.
Beschikbare waarden: waar, onwaar.
Hoofdlettergevoelig.		 snaar
naam Hiermee haalt u de naam van de live traceringscategorie op of stelt u deze in.
Beschikbare waarden: ConnectivityLogs, MessagingLogs.
Hoofdlettergevoelig.		 snaar

LiveTraceConfiguration

Naam Beschrijving Waarde
Categorieën Hiermee haalt u de lijst met categorieconfiguraties op of stelt u deze in. LiveTraceCategory[]
Ingeschakeld Hiermee wordt aangegeven of livetracering al dan niet is ingeschakeld.
Als deze is ingesteld op true, kan de live trace-client verbinding maken met de service.
Anders kan de livetraceringsclient geen verbinding maken met de service, zodat u geen logboeken kunt ontvangen, ongeacht wat u configureert in 'categorieën'.
Beschikbare waarden: waar, onwaar.
Hoofdlettergevoelig.		 snaar

ManagedIdentity

Naam Beschrijving Waarde
type Vertegenwoordigt het identiteitstype: systemAssigned, userAssigned, None 'Geen'
'SystemAssigned'
UserAssigned
userAssignedIdentities De door de gebruiker toegewezen identiteiten ophalen of instellen ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Naam Beschrijving Waarde
hulpbron De resource die de app-id-URI van de doelresource aangeeft.
Het wordt ook weergegeven in de claim aud (doelgroep) van het uitgegeven token.		 snaar

ManagedIdentityUserAssignedIdentities

Naam Beschrijving Waarde

Microsoft.SignalRService/signalR

Naam Beschrijving Waarde
identiteit Een klasse vertegenwoordigt beheerde identiteiten die worden gebruikt voor aanvragen en antwoorden ManagedIdentity-
soort Het type service, het kan SignalR of RawWebSockets zijn 'RawWebSockets'
'SignalR'
plaats De GEO-locatie van de resource. bijvoorbeeld VS - west VS - oost VS - noord-centraal VS - zuid-centraal. snaar
naam De resourcenaam tekenreeks (vereist)
Eigenschappen Een klasse die de eigenschappen van de resource beschrijft SignalRProperties-
Sku De factureringsgegevens van de resource. ResourceSku-
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

NetworkACL

Naam Beschrijving Waarde
toestaan Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. Tekenreeksmatrix met een van de volgende waarden:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Traceren'
ontkennen Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. Tekenreeksmatrix met een van de volgende waarden:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Traceren'

PrivateEndpointACL

Naam Beschrijving Waarde
toestaan Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. Tekenreeksmatrix met een van de volgende waarden:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Traceren'
ontkennen Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. Tekenreeksmatrix met een van de volgende waarden:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Traceren'
naam Naam van de privé-eindpuntverbinding tekenreeks (vereist)

ResourceLogCategory

Naam Beschrijving Waarde
Ingeschakeld Hiermee wordt aangegeven of de categorie resourcelogboek is ingeschakeld.
Beschikbare waarden: waar, onwaar.
Hoofdlettergevoelig.		 snaar
naam Hiermee haalt u de naam van de resourcelogboekcategorie op of stelt u deze in.
Beschikbare waarden: ConnectivityLogs, MessagingLogs.
Hoofdlettergevoelig.		 snaar

ResourceLogConfiguration

Naam Beschrijving Waarde
Categorieën Hiermee haalt u de lijst met categorieconfiguraties op of stelt u deze in. ResourceLogCategory[]

ResourceSku

Naam Beschrijving Waarde
capaciteit Optioneel, geheel getal. Het aantal eenheden van de resource. 1 standaard.

Indien aanwezig, zijn de volgende waarden toegestaan:
Gratis: 1;
Standaard: 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
naam De naam van de SKU. Vereist.

Toegestane waarden: Standard_S1, Free_F1, Premium_P1		 tekenreeks (vereist)
rang Optionele laag van deze specifieke SKU. 'Standaard' of 'Gratis'.

Basic is afgeschaft, gebruikt u in plaats daarvan Standard.		 'Basis'
'Gratis'
'Premium'
'Standaard'

ServerlessSettings

Naam Beschrijving Waarde
connectionTimeoutInSeconds Hiermee haalt u time-out voor clientverbindingen op of stelt u deze in. Optioneel om in te stellen.
Waarde in seconden.
De standaardwaarde is 30 seconden.
De klant moet de time-out instellen op een kortere periode als berichten naar verwachting in kortere intervallen worden verzonden,
en wilt dat de client sneller wordt verbroken nadat het laatste bericht is verzonden.
U kunt de time-out instellen op een langere periode als berichten naar verwachting met langere intervallen worden verzonden.
en ze willen dezelfde clientverbinding actief houden tijdens deze sessie.
De service beschouwt de verbinding met de client verbroken als er in dit interval geen bericht (inclusief keep-alive) is ontvangen.		 Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 120

ServerlessUpstreamSettings

Naam Beschrijving Waarde
Sjablonen Hiermee haalt u de lijst met Upstream-URL-sjablonen op of stelt u deze in. Volgorde is belangrijk en de eerste overeenkomende sjabloon heeft gevolgen. UpstreamTemplate[]

SignalRCorsSettings

Naam Beschrijving Waarde
allowedOrigins Hiermee haalt u de lijst met oorsprongen op die moeten worden toegestaan om cross-origin-aanroepen te maken (bijvoorbeeld: http://example.com:12345). Gebruik *om alles toe te staan. Als u dit weglaat, staat u alle standaard toe. tekenreeks[]

SignalRFeature

Naam Beschrijving Waarde
vlag FeatureFlags is de ondersteunde functies van de Azure SignalR-service.
- ServiceMode: Vlag voor back-endserver voor SignalR-service. Toegestane waarden: 'Standaard': uw eigen back-endserver hebben; 'Serverloos': uw toepassing heeft geen back-endserver; "Klassiek": voor achterwaartse compatibiliteit. Ondersteuning voor zowel de standaardmodus als de serverloze modus, maar wordt niet aanbevolen; "PredefinedOnly": voor toekomstig gebruik.
- EnableConnectivityLogs: 'true'/'false', om respectievelijk de connectiviteitslogboekcategorie in of uit te schakelen.
- EnableMessagingLogs: 'true'/'false', om respectievelijk de categorie connectiviteitslogboek in of uit te schakelen.
- EnableLiveTrace: Met Live Trace kunt u weten wat er gebeurt in de Azure SignalR-service. Hiermee krijgt u live traceringen in realtime. Het is handig wanneer u uw eigen op Azure SignalR gebaseerde webtoepassing ontwikkelt of zelf problemen kunt oplossen. Houd er rekening mee dat livetraceringen worden geteld als uitgaande berichten die in rekening worden gebracht. Toegestane waarden: 'true'/'false' om de live traceringsfunctie in of uit te schakelen.		 EnableConnectivityLogs
EnableLiveTrace
'EnableMessagingLogs'
'ServiceMode' (vereist)
Eigenschappen Optionele eigenschappen met betrekking tot deze functie. SignalRFeatureProperties-
waarde Waarde van de functievlag. Zie het azure SignalR-servicedocument /azure/azure-signalr/ voor toegestane waarden. snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)

SignalRFeatureProperties

Naam Beschrijving Waarde

SignalRNetworkACLs

Naam Beschrijving Waarde
defaultAction Azure Networking ACL Action. 'Toestaan'
'Weigeren'
privateEndpoints ACL's voor aanvragen van privé-eindpunten PrivateEndpointACL[]
publicNetwork Netwerk-ACL NetworkACL-

SignalRProperties

Naam Beschrijving Waarde
cors CORS-instellingen (Cross-Origin Resource Sharing). SignalRCorsSettings
disableAadAuth DisableLocalAuth
AAD-verificatie in- of uitschakelen
Als de instelling waar is, werkt de verbinding met AuthType=aad niet.		 Bool
disableLocalAuth DisableLocalAuth
Lokale verificatie in- of uitschakelen met AccessKey
Als deze is ingesteld als waar, werkt de verbinding met AccessKey=xxx niet.		 Bool
Functies Lijst met de featureFlags.

FeatureFlags die niet zijn opgenomen in de parameters voor de updatebewerking, worden niet gewijzigd.
En het antwoord bevat alleen featureFlags die expliciet zijn ingesteld.
Wanneer een featureFlag niet expliciet is ingesteld, wordt de globaal standaardwaarde gebruikt
Maar houd er rekening mee dat de standaardwaarde niet 'false' betekent. Het verschilt in termen van verschillende FeatureFlags.		 SignalRFeature[]
liveTraceConfiguration Live trace-configuratie van een Microsoft.SignalRService-resource. LiveTraceConfiguration-
networkACLs Netwerk-ACL's voor de resource SignalRNetworkACLs
publicNetworkAccess Openbare netwerktoegang in- of uitschakelen. De standaardwaarde is Ingeschakeld.
Wanneer deze functie is ingeschakeld, zijn netwerk-ACL's nog steeds van toepassing.
Wanneer deze optie is uitgeschakeld, wordt openbare netwerktoegang altijd uitgeschakeld, ongeacht wat u instelt in netwerk-ACL's.		 snaar
resourceLogConfiguration Configuratie van resourcelogboek van een Microsoft.SignalRService-resource. ResourceLogConfiguration-
serverloos Serverloze instellingen. ServerlessSettings
tls TLS-instellingen voor de resource SignalRTlsSettings
stroomopwaarts De instellingen voor de Upstream wanneer de service zich in de serverloze modus bevindt. ServerlessUpstreamSettings

SignalRTlsSettings

Naam Beschrijving Waarde
clientCertEnabled Clientcertificaat aanvragen tijdens TLS-handshake indien ingeschakeld Bool

TrackedResourceTags

Naam Beschrijving Waarde

UpstreamAuthSettings

Naam Beschrijving Waarde
managedIdentity Instellingen voor beheerde identiteiten voor upstream. ManagedIdentitySettings
type Upstream-verificatietype enum. ManagedIdentity
'Geen'

UpstreamTemplate

Naam Beschrijving Waarde
Auth Upstream-verificatie-instellingen. Als dit niet is ingesteld, wordt er geen verificatie gebruikt voor upstream-berichten. UpstreamAuthSettings-
categoryPattern Hiermee haalt u het overeenkomende patroon voor categorienamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een categorie.
Er worden drie soorten patronen ondersteund:
1. "*", komt overeen met elke categorienaam.
2. Combineer meerdere categorieën met ',', bijvoorbeeld 'verbindingen,berichten', het komt overeen met categorie 'verbindingen' en 'berichten'.
3. De naam van één categorie, bijvoorbeeld 'verbindingen', komt overeen met de categorie 'verbindingen'.		 snaar
eventPattern Hiermee haalt u het overeenkomende patroon voor gebeurtenisnamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een gebeurtenis.
Er worden drie soorten patronen ondersteund:
1. "*", deze komt overeen met elke gebeurtenisnaam.
2. Combineer meerdere gebeurtenissen met ',', bijvoorbeeld 'verbinding maken,verbinding verbreken', het komt overeen met de gebeurtenis 'verbinding maken' en 'verbinding verbreken'.
3. De naam van één gebeurtenis, bijvoorbeeld 'verbinding maken', komt overeen met 'verbinding'.		 snaar
hubPattern Hiermee haalt u het overeenkomende patroon voor hubnamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een hub.
Er worden drie soorten patronen ondersteund:
1. "*", komt overeen met elke hubnaam.
2. Combineer meerdere hubs met ',', bijvoorbeeld 'hub1,hub2', het komt overeen met 'hub1' en 'hub2'.
3. De naam van één hub, bijvoorbeeld 'hub1', komt overeen met 'hub1'.		 snaar
urlTemplate Hiermee haalt u de upstream-URL-sjabloon op of stelt u deze in. U kunt drie vooraf gedefinieerde parameters {hub}, {category} {event} in de sjabloon gebruiken. De waarde van de Upstream-URL wordt dynamisch berekend wanneer de clientaanvraag binnenkomt.
Als de urlTemplate bijvoorbeeld is http://example.com/{hub}/api/{event}, met een clientaanvraag van de hub chat verbinding maakt, wordt deze eerst post naar deze URL: http://example.com/chat/api/connect.		 tekenreeks (vereist)

UserAssignedIdentityProperty

Naam Beschrijving Waarde

Quickstart-voorbeelden

In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.

Bicep-bestand Beschrijving
Een Azure SignalR-service implementeren Met deze sjabloon maakt u een Azure SignalR-service met behulp van een sjabloon.

Resourcedefinitie van ARM-sjabloon

Het resourcetype signalR kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.SignalRService/signalR-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2023-02-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "disableAadAuth": "bool",
    "disableLocalAuth": "bool",
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "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"
  }
}

Eigenschapswaarden

LiveTraceCategory

Naam Beschrijving Waarde
Ingeschakeld Geeft aan of de livetraceringscategorie is ingeschakeld.
Beschikbare waarden: waar, onwaar.
Hoofdlettergevoelig.		 snaar
naam Hiermee haalt u de naam van de live traceringscategorie op of stelt u deze in.
Beschikbare waarden: ConnectivityLogs, MessagingLogs.
Hoofdlettergevoelig.		 snaar

LiveTraceConfiguration

Naam Beschrijving Waarde
Categorieën Hiermee haalt u de lijst met categorieconfiguraties op of stelt u deze in. LiveTraceCategory[]
Ingeschakeld Hiermee wordt aangegeven of livetracering al dan niet is ingeschakeld.
Als deze is ingesteld op true, kan de live trace-client verbinding maken met de service.
Anders kan de livetraceringsclient geen verbinding maken met de service, zodat u geen logboeken kunt ontvangen, ongeacht wat u configureert in 'categorieën'.
Beschikbare waarden: waar, onwaar.
Hoofdlettergevoelig.		 snaar

ManagedIdentity

Naam Beschrijving Waarde
type Vertegenwoordigt het identiteitstype: systemAssigned, userAssigned, None 'Geen'
'SystemAssigned'
UserAssigned
userAssignedIdentities De door de gebruiker toegewezen identiteiten ophalen of instellen ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Naam Beschrijving Waarde
hulpbron De resource die de app-id-URI van de doelresource aangeeft.
Het wordt ook weergegeven in de claim aud (doelgroep) van het uitgegeven token.		 snaar

ManagedIdentityUserAssignedIdentities

Naam Beschrijving Waarde

Microsoft.SignalRService/signalR

Naam Beschrijving Waarde
apiVersion De API-versie '2023-02-01'
identiteit Een klasse vertegenwoordigt beheerde identiteiten die worden gebruikt voor aanvragen en antwoorden ManagedIdentity-
soort Het type service, het kan SignalR of RawWebSockets zijn 'RawWebSockets'
'SignalR'
plaats De GEO-locatie van de resource. bijvoorbeeld VS - west VS - oost VS - noord-centraal VS - zuid-centraal. snaar
naam De resourcenaam tekenreeks (vereist)
Eigenschappen Een klasse die de eigenschappen van de resource beschrijft SignalRProperties-
Sku De factureringsgegevens van de resource. ResourceSku-
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type Het resourcetype 'Microsoft.SignalRService/signalR'

NetworkACL

Naam Beschrijving Waarde
toestaan Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. Tekenreeksmatrix met een van de volgende waarden:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Traceren'
ontkennen Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. Tekenreeksmatrix met een van de volgende waarden:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Traceren'

PrivateEndpointACL

Naam Beschrijving Waarde
toestaan Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. Tekenreeksmatrix met een van de volgende waarden:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Traceren'
ontkennen Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. Tekenreeksmatrix met een van de volgende waarden:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Traceren'
naam Naam van de privé-eindpuntverbinding tekenreeks (vereist)

ResourceLogCategory

Naam Beschrijving Waarde
Ingeschakeld Hiermee wordt aangegeven of de categorie resourcelogboek is ingeschakeld.
Beschikbare waarden: waar, onwaar.
Hoofdlettergevoelig.		 snaar
naam Hiermee haalt u de naam van de resourcelogboekcategorie op of stelt u deze in.
Beschikbare waarden: ConnectivityLogs, MessagingLogs.
Hoofdlettergevoelig.		 snaar

ResourceLogConfiguration

Naam Beschrijving Waarde
Categorieën Hiermee haalt u de lijst met categorieconfiguraties op of stelt u deze in. ResourceLogCategory[]

ResourceSku

Naam Beschrijving Waarde
capaciteit Optioneel, geheel getal. Het aantal eenheden van de resource. 1 standaard.

Indien aanwezig, zijn de volgende waarden toegestaan:
Gratis: 1;
Standaard: 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
naam De naam van de SKU. Vereist.

Toegestane waarden: Standard_S1, Free_F1, Premium_P1		 tekenreeks (vereist)
rang Optionele laag van deze specifieke SKU. 'Standaard' of 'Gratis'.

Basic is afgeschaft, gebruikt u in plaats daarvan Standard.		 'Basis'
'Gratis'
'Premium'
'Standaard'

ServerlessSettings

Naam Beschrijving Waarde
connectionTimeoutInSeconds Hiermee haalt u time-out voor clientverbindingen op of stelt u deze in. Optioneel om in te stellen.
Waarde in seconden.
De standaardwaarde is 30 seconden.
De klant moet de time-out instellen op een kortere periode als berichten naar verwachting in kortere intervallen worden verzonden,
en wilt dat de client sneller wordt verbroken nadat het laatste bericht is verzonden.
U kunt de time-out instellen op een langere periode als berichten naar verwachting met langere intervallen worden verzonden.
en ze willen dezelfde clientverbinding actief houden tijdens deze sessie.
De service beschouwt de verbinding met de client verbroken als er in dit interval geen bericht (inclusief keep-alive) is ontvangen.		 Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 120

ServerlessUpstreamSettings

Naam Beschrijving Waarde
Sjablonen Hiermee haalt u de lijst met Upstream-URL-sjablonen op of stelt u deze in. Volgorde is belangrijk en de eerste overeenkomende sjabloon heeft gevolgen. UpstreamTemplate[]

SignalRCorsSettings

Naam Beschrijving Waarde
allowedOrigins Hiermee haalt u de lijst met oorsprongen op die moeten worden toegestaan om cross-origin-aanroepen te maken (bijvoorbeeld: http://example.com:12345). Gebruik *om alles toe te staan. Als u dit weglaat, staat u alle standaard toe. tekenreeks[]

SignalRFeature

Naam Beschrijving Waarde
vlag FeatureFlags is de ondersteunde functies van de Azure SignalR-service.
- ServiceMode: Vlag voor back-endserver voor SignalR-service. Toegestane waarden: 'Standaard': uw eigen back-endserver hebben; 'Serverloos': uw toepassing heeft geen back-endserver; "Klassiek": voor achterwaartse compatibiliteit. Ondersteuning voor zowel de standaardmodus als de serverloze modus, maar wordt niet aanbevolen; "PredefinedOnly": voor toekomstig gebruik.
- EnableConnectivityLogs: 'true'/'false', om respectievelijk de connectiviteitslogboekcategorie in of uit te schakelen.
- EnableMessagingLogs: 'true'/'false', om respectievelijk de categorie connectiviteitslogboek in of uit te schakelen.
- EnableLiveTrace: Met Live Trace kunt u weten wat er gebeurt in de Azure SignalR-service. Hiermee krijgt u live traceringen in realtime. Het is handig wanneer u uw eigen op Azure SignalR gebaseerde webtoepassing ontwikkelt of zelf problemen kunt oplossen. Houd er rekening mee dat livetraceringen worden geteld als uitgaande berichten die in rekening worden gebracht. Toegestane waarden: 'true'/'false' om de live traceringsfunctie in of uit te schakelen.		 EnableConnectivityLogs
EnableLiveTrace
'EnableMessagingLogs'
'ServiceMode' (vereist)
Eigenschappen Optionele eigenschappen met betrekking tot deze functie. SignalRFeatureProperties-
waarde Waarde van de functievlag. Zie het azure SignalR-servicedocument /azure/azure-signalr/ voor toegestane waarden. snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)

SignalRFeatureProperties

Naam Beschrijving Waarde

SignalRNetworkACLs

Naam Beschrijving Waarde
defaultAction Azure Networking ACL Action. 'Toestaan'
'Weigeren'
privateEndpoints ACL's voor aanvragen van privé-eindpunten PrivateEndpointACL[]
publicNetwork Netwerk-ACL NetworkACL-

SignalRProperties

Naam Beschrijving Waarde
cors CORS-instellingen (Cross-Origin Resource Sharing). SignalRCorsSettings
disableAadAuth DisableLocalAuth
AAD-verificatie in- of uitschakelen
Als de instelling waar is, werkt de verbinding met AuthType=aad niet.		 Bool
disableLocalAuth DisableLocalAuth
Lokale verificatie in- of uitschakelen met AccessKey
Als deze is ingesteld als waar, werkt de verbinding met AccessKey=xxx niet.		 Bool
Functies Lijst met de featureFlags.

FeatureFlags die niet zijn opgenomen in de parameters voor de updatebewerking, worden niet gewijzigd.
En het antwoord bevat alleen featureFlags die expliciet zijn ingesteld.
Wanneer een featureFlag niet expliciet is ingesteld, wordt de globaal standaardwaarde gebruikt
Maar houd er rekening mee dat de standaardwaarde niet 'false' betekent. Het verschilt in termen van verschillende FeatureFlags.		 SignalRFeature[]
liveTraceConfiguration Live trace-configuratie van een Microsoft.SignalRService-resource. LiveTraceConfiguration-
networkACLs Netwerk-ACL's voor de resource SignalRNetworkACLs
publicNetworkAccess Openbare netwerktoegang in- of uitschakelen. De standaardwaarde is Ingeschakeld.
Wanneer deze functie is ingeschakeld, zijn netwerk-ACL's nog steeds van toepassing.
Wanneer deze optie is uitgeschakeld, wordt openbare netwerktoegang altijd uitgeschakeld, ongeacht wat u instelt in netwerk-ACL's.		 snaar
resourceLogConfiguration Configuratie van resourcelogboek van een Microsoft.SignalRService-resource. ResourceLogConfiguration-
serverloos Serverloze instellingen. ServerlessSettings
tls TLS-instellingen voor de resource SignalRTlsSettings
stroomopwaarts De instellingen voor de Upstream wanneer de service zich in de serverloze modus bevindt. ServerlessUpstreamSettings

SignalRTlsSettings

Naam Beschrijving Waarde
clientCertEnabled Clientcertificaat aanvragen tijdens TLS-handshake indien ingeschakeld Bool

TrackedResourceTags

Naam Beschrijving Waarde

UpstreamAuthSettings

Naam Beschrijving Waarde
managedIdentity Instellingen voor beheerde identiteiten voor upstream. ManagedIdentitySettings
type Upstream-verificatietype enum. ManagedIdentity
'Geen'

UpstreamTemplate

Naam Beschrijving Waarde
Auth Upstream-verificatie-instellingen. Als dit niet is ingesteld, wordt er geen verificatie gebruikt voor upstream-berichten. UpstreamAuthSettings-
categoryPattern Hiermee haalt u het overeenkomende patroon voor categorienamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een categorie.
Er worden drie soorten patronen ondersteund:
1. "*", komt overeen met elke categorienaam.
2. Combineer meerdere categorieën met ',', bijvoorbeeld 'verbindingen,berichten', het komt overeen met categorie 'verbindingen' en 'berichten'.
3. De naam van één categorie, bijvoorbeeld 'verbindingen', komt overeen met de categorie 'verbindingen'.		 snaar
eventPattern Hiermee haalt u het overeenkomende patroon voor gebeurtenisnamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een gebeurtenis.
Er worden drie soorten patronen ondersteund:
1. "*", deze komt overeen met elke gebeurtenisnaam.
2. Combineer meerdere gebeurtenissen met ',', bijvoorbeeld 'verbinding maken,verbinding verbreken', het komt overeen met de gebeurtenis 'verbinding maken' en 'verbinding verbreken'.
3. De naam van één gebeurtenis, bijvoorbeeld 'verbinding maken', komt overeen met 'verbinding'.		 snaar
hubPattern Hiermee haalt u het overeenkomende patroon voor hubnamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een hub.
Er worden drie soorten patronen ondersteund:
1. "*", komt overeen met elke hubnaam.
2. Combineer meerdere hubs met ',', bijvoorbeeld 'hub1,hub2', het komt overeen met 'hub1' en 'hub2'.
3. De naam van één hub, bijvoorbeeld 'hub1', komt overeen met 'hub1'.		 snaar
urlTemplate Hiermee haalt u de upstream-URL-sjabloon op of stelt u deze in. U kunt drie vooraf gedefinieerde parameters {hub}, {category} {event} in de sjabloon gebruiken. De waarde van de Upstream-URL wordt dynamisch berekend wanneer de clientaanvraag binnenkomt.
Als de urlTemplate bijvoorbeeld is http://example.com/{hub}/api/{event}, met een clientaanvraag van de hub chat verbinding maakt, wordt deze eerst post naar deze URL: http://example.com/chat/api/connect.		 tekenreeks (vereist)

UserAssignedIdentityProperty

Naam Beschrijving Waarde

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon Beschrijving
Een Azure SignalR-service implementeren

implementeren in Azure 		Met deze sjabloon maakt u een Azure SignalR-service met behulp van een sjabloon.

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype signalR kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.SignalRService/signalR-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR@2023-02-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "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"
          }
        ]
      }
    }
  })
  sku = {
    capacity = int
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

Eigenschapswaarden

LiveTraceCategory

Naam Beschrijving Waarde
Ingeschakeld Geeft aan of de livetraceringscategorie is ingeschakeld.
Beschikbare waarden: waar, onwaar.
Hoofdlettergevoelig.		 snaar
naam Hiermee haalt u de naam van de live traceringscategorie op of stelt u deze in.
Beschikbare waarden: ConnectivityLogs, MessagingLogs.
Hoofdlettergevoelig.		 snaar

LiveTraceConfiguration

Naam Beschrijving Waarde
Categorieën Hiermee haalt u de lijst met categorieconfiguraties op of stelt u deze in. LiveTraceCategory[]
Ingeschakeld Hiermee wordt aangegeven of livetracering al dan niet is ingeschakeld.
Als deze is ingesteld op true, kan de live trace-client verbinding maken met de service.
Anders kan de livetraceringsclient geen verbinding maken met de service, zodat u geen logboeken kunt ontvangen, ongeacht wat u configureert in 'categorieën'.
Beschikbare waarden: waar, onwaar.
Hoofdlettergevoelig.		 snaar

ManagedIdentity

Naam Beschrijving Waarde
type Vertegenwoordigt het identiteitstype: systemAssigned, userAssigned, None 'Geen'
'SystemAssigned'
UserAssigned
userAssignedIdentities De door de gebruiker toegewezen identiteiten ophalen of instellen ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Naam Beschrijving Waarde
hulpbron De resource die de app-id-URI van de doelresource aangeeft.
Het wordt ook weergegeven in de claim aud (doelgroep) van het uitgegeven token.		 snaar

ManagedIdentityUserAssignedIdentities

Naam Beschrijving Waarde

Microsoft.SignalRService/signalR

Naam Beschrijving Waarde
identiteit Een klasse vertegenwoordigt beheerde identiteiten die worden gebruikt voor aanvragen en antwoorden ManagedIdentity-
soort Het type service, het kan SignalR of RawWebSockets zijn 'RawWebSockets'
'SignalR'
plaats De GEO-locatie van de resource. bijvoorbeeld VS - west VS - oost VS - noord-centraal VS - zuid-centraal. snaar
naam De resourcenaam tekenreeks (vereist)
Eigenschappen Een klasse die de eigenschappen van de resource beschrijft SignalRProperties-
Sku De factureringsgegevens van de resource. ResourceSku-
Tags Resourcetags Woordenlijst met tagnamen en -waarden.
type Het resourcetype "Microsoft.SignalRService/signalR@2023-02-01"

NetworkACL

Naam Beschrijving Waarde
toestaan Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. Tekenreeksmatrix met een van de volgende waarden:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Traceren'
ontkennen Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. Tekenreeksmatrix met een van de volgende waarden:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Traceren'

PrivateEndpointACL

Naam Beschrijving Waarde
toestaan Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. Tekenreeksmatrix met een van de volgende waarden:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Traceren'
ontkennen Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI. Tekenreeksmatrix met een van de volgende waarden:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Traceren'
naam Naam van de privé-eindpuntverbinding tekenreeks (vereist)

ResourceLogCategory

Naam Beschrijving Waarde
Ingeschakeld Hiermee wordt aangegeven of de categorie resourcelogboek is ingeschakeld.
Beschikbare waarden: waar, onwaar.
Hoofdlettergevoelig.		 snaar
naam Hiermee haalt u de naam van de resourcelogboekcategorie op of stelt u deze in.
Beschikbare waarden: ConnectivityLogs, MessagingLogs.
Hoofdlettergevoelig.		 snaar

ResourceLogConfiguration

Naam Beschrijving Waarde
Categorieën Hiermee haalt u de lijst met categorieconfiguraties op of stelt u deze in. ResourceLogCategory[]

ResourceSku

Naam Beschrijving Waarde
capaciteit Optioneel, geheel getal. Het aantal eenheden van de resource. 1 standaard.

Indien aanwezig, zijn de volgende waarden toegestaan:
Gratis: 1;
Standaard: 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
naam De naam van de SKU. Vereist.

Toegestane waarden: Standard_S1, Free_F1, Premium_P1		 tekenreeks (vereist)
rang Optionele laag van deze specifieke SKU. 'Standaard' of 'Gratis'.

Basic is afgeschaft, gebruikt u in plaats daarvan Standard.		 'Basis'
'Gratis'
'Premium'
'Standaard'

ServerlessSettings

Naam Beschrijving Waarde
connectionTimeoutInSeconds Hiermee haalt u time-out voor clientverbindingen op of stelt u deze in. Optioneel om in te stellen.
Waarde in seconden.
De standaardwaarde is 30 seconden.
De klant moet de time-out instellen op een kortere periode als berichten naar verwachting in kortere intervallen worden verzonden,
en wilt dat de client sneller wordt verbroken nadat het laatste bericht is verzonden.
U kunt de time-out instellen op een langere periode als berichten naar verwachting met langere intervallen worden verzonden.
en ze willen dezelfde clientverbinding actief houden tijdens deze sessie.
De service beschouwt de verbinding met de client verbroken als er in dit interval geen bericht (inclusief keep-alive) is ontvangen.		 Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 120

ServerlessUpstreamSettings

Naam Beschrijving Waarde
Sjablonen Hiermee haalt u de lijst met Upstream-URL-sjablonen op of stelt u deze in. Volgorde is belangrijk en de eerste overeenkomende sjabloon heeft gevolgen. UpstreamTemplate[]

SignalRCorsSettings

Naam Beschrijving Waarde
allowedOrigins Hiermee haalt u de lijst met oorsprongen op die moeten worden toegestaan om cross-origin-aanroepen te maken (bijvoorbeeld: http://example.com:12345). Gebruik *om alles toe te staan. Als u dit weglaat, staat u alle standaard toe. tekenreeks[]

SignalRFeature

Naam Beschrijving Waarde
vlag FeatureFlags is de ondersteunde functies van de Azure SignalR-service.
- ServiceMode: Vlag voor back-endserver voor SignalR-service. Toegestane waarden: 'Standaard': uw eigen back-endserver hebben; 'Serverloos': uw toepassing heeft geen back-endserver; "Klassiek": voor achterwaartse compatibiliteit. Ondersteuning voor zowel de standaardmodus als de serverloze modus, maar wordt niet aanbevolen; "PredefinedOnly": voor toekomstig gebruik.
- EnableConnectivityLogs: 'true'/'false', om respectievelijk de connectiviteitslogboekcategorie in of uit te schakelen.
- EnableMessagingLogs: 'true'/'false', om respectievelijk de categorie connectiviteitslogboek in of uit te schakelen.
- EnableLiveTrace: Met Live Trace kunt u weten wat er gebeurt in de Azure SignalR-service. Hiermee krijgt u live traceringen in realtime. Het is handig wanneer u uw eigen op Azure SignalR gebaseerde webtoepassing ontwikkelt of zelf problemen kunt oplossen. Houd er rekening mee dat livetraceringen worden geteld als uitgaande berichten die in rekening worden gebracht. Toegestane waarden: 'true'/'false' om de live traceringsfunctie in of uit te schakelen.		 EnableConnectivityLogs
EnableLiveTrace
'EnableMessagingLogs'
'ServiceMode' (vereist)
Eigenschappen Optionele eigenschappen met betrekking tot deze functie. SignalRFeatureProperties-
waarde Waarde van de functievlag. Zie het azure SignalR-servicedocument /azure/azure-signalr/ voor toegestane waarden. snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1 (vereist)

SignalRFeatureProperties

Naam Beschrijving Waarde

SignalRNetworkACLs

Naam Beschrijving Waarde
defaultAction Azure Networking ACL Action. 'Toestaan'
'Weigeren'
privateEndpoints ACL's voor aanvragen van privé-eindpunten PrivateEndpointACL[]
publicNetwork Netwerk-ACL NetworkACL-

SignalRProperties

Naam Beschrijving Waarde
cors CORS-instellingen (Cross-Origin Resource Sharing). SignalRCorsSettings
disableAadAuth DisableLocalAuth
AAD-verificatie in- of uitschakelen
Als de instelling waar is, werkt de verbinding met AuthType=aad niet.		 Bool
disableLocalAuth DisableLocalAuth
Lokale verificatie in- of uitschakelen met AccessKey
Als deze is ingesteld als waar, werkt de verbinding met AccessKey=xxx niet.		 Bool
Functies Lijst met de featureFlags.

FeatureFlags die niet zijn opgenomen in de parameters voor de updatebewerking, worden niet gewijzigd.
En het antwoord bevat alleen featureFlags die expliciet zijn ingesteld.
Wanneer een featureFlag niet expliciet is ingesteld, wordt de globaal standaardwaarde gebruikt
Maar houd er rekening mee dat de standaardwaarde niet 'false' betekent. Het verschilt in termen van verschillende FeatureFlags.		 SignalRFeature[]
liveTraceConfiguration Live trace-configuratie van een Microsoft.SignalRService-resource. LiveTraceConfiguration-
networkACLs Netwerk-ACL's voor de resource SignalRNetworkACLs
publicNetworkAccess Openbare netwerktoegang in- of uitschakelen. De standaardwaarde is Ingeschakeld.
Wanneer deze functie is ingeschakeld, zijn netwerk-ACL's nog steeds van toepassing.
Wanneer deze optie is uitgeschakeld, wordt openbare netwerktoegang altijd uitgeschakeld, ongeacht wat u instelt in netwerk-ACL's.		 snaar
resourceLogConfiguration Configuratie van resourcelogboek van een Microsoft.SignalRService-resource. ResourceLogConfiguration-
serverloos Serverloze instellingen. ServerlessSettings
tls TLS-instellingen voor de resource SignalRTlsSettings
stroomopwaarts De instellingen voor de Upstream wanneer de service zich in de serverloze modus bevindt. ServerlessUpstreamSettings

SignalRTlsSettings

Naam Beschrijving Waarde
clientCertEnabled Clientcertificaat aanvragen tijdens TLS-handshake indien ingeschakeld Bool

TrackedResourceTags

Naam Beschrijving Waarde

UpstreamAuthSettings

Naam Beschrijving Waarde
managedIdentity Instellingen voor beheerde identiteiten voor upstream. ManagedIdentitySettings
type Upstream-verificatietype enum. ManagedIdentity
'Geen'

UpstreamTemplate

Naam Beschrijving Waarde
Auth Upstream-verificatie-instellingen. Als dit niet is ingesteld, wordt er geen verificatie gebruikt voor upstream-berichten. UpstreamAuthSettings-
categoryPattern Hiermee haalt u het overeenkomende patroon voor categorienamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een categorie.
Er worden drie soorten patronen ondersteund:
1. "*", komt overeen met elke categorienaam.
2. Combineer meerdere categorieën met ',', bijvoorbeeld 'verbindingen,berichten', het komt overeen met categorie 'verbindingen' en 'berichten'.
3. De naam van één categorie, bijvoorbeeld 'verbindingen', komt overeen met de categorie 'verbindingen'.		 snaar
eventPattern Hiermee haalt u het overeenkomende patroon voor gebeurtenisnamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een gebeurtenis.
Er worden drie soorten patronen ondersteund:
1. "*", deze komt overeen met elke gebeurtenisnaam.
2. Combineer meerdere gebeurtenissen met ',', bijvoorbeeld 'verbinding maken,verbinding verbreken', het komt overeen met de gebeurtenis 'verbinding maken' en 'verbinding verbreken'.
3. De naam van één gebeurtenis, bijvoorbeeld 'verbinding maken', komt overeen met 'verbinding'.		 snaar
hubPattern Hiermee haalt u het overeenkomende patroon voor hubnamen op of stelt u dit in. Als deze niet is ingesteld, komt deze overeen met een hub.
Er worden drie soorten patronen ondersteund:
1. "*", komt overeen met elke hubnaam.
2. Combineer meerdere hubs met ',', bijvoorbeeld 'hub1,hub2', het komt overeen met 'hub1' en 'hub2'.
3. De naam van één hub, bijvoorbeeld 'hub1', komt overeen met 'hub1'.		 snaar
urlTemplate Hiermee haalt u de upstream-URL-sjabloon op of stelt u deze in. U kunt drie vooraf gedefinieerde parameters {hub}, {category} {event} in de sjabloon gebruiken. De waarde van de Upstream-URL wordt dynamisch berekend wanneer de clientaanvraag binnenkomt.
Als de urlTemplate bijvoorbeeld is http://example.com/{hub}/api/{event}, met een clientaanvraag van de hub chat verbinding maakt, wordt deze eerst post naar deze URL: http://example.com/chat/api/connect.		 tekenreeks (vereist)

UserAssignedIdentityProperty

Naam Beschrijving Waarde