Dela via


Microsoft.SignalRService signalR 2018-10-01

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@2018-10-01' = {
  location: 'string'
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    hostNamePrefix: 'string'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Egenskapsvärden

Microsoft.SignalRService/signalR

Namn Beskrivning Värde
plats Azure GEO-region: t.ex. USA, västra Östra USA USA, norra centrala Södra centrala USA Europa, västra Europa, norra Asien, östra Sydostasien osv.
Geo-regionen för en resurs ändras aldrig när den har skapats.
sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Inställningar som används för att etablera eller konfigurera resursen SignalRCreateOrUpdatePropertiesOrSignalRProperties
Sku Faktureringsinformation för resursen. (t.ex. basic kontra standard) ResourceSku
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

ResourceSku

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

Om det finns tillåts följande värden:
Kostnadsfritt: 1
Standard: 1,2,5,10,20,50,100
Int
familj Valfri sträng. För framtida användning. sträng
Namn Namnet på SKU:n. Krävs.

Tillåtna värden: Standard_S1, Free_F1
sträng (krävs)
storlek Valfri sträng. För framtida användning. sträng
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"

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

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Namn Beskrivning Värde
cors CORS-inställningar (Cross-Origin Resource Sharing). SignalRCorsSettings
Funktioner Lista över SignalR-funktionerFlags. t.ex. ServiceMode.

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 har angetts använder SignalR-tjänsten sitt globala standardvärde.
Men kom ihåg att standardvärdet inte betyder "false". Det varierar beroende på olika FeatureFlags.
SignalRFeature[]
hostNamePrefix Prefix för värdnamnet för SignalR-tjänsten. Behålls för framtida användning.
Värdnamnet har formatet: <hostNamePrefix>.service.signalr.net.
sträng

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.
"EnableConnectivityLogs"
"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

SignalRUpdateParametersTags

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": "2018-10-01",
  "name": "string",
  "location": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "hostNamePrefix": "string"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Egenskapsvärden

Microsoft.SignalRService/signalR

Namn Beskrivning Värde
apiVersion API-versionen '2018-10-01'
plats Azure GEO-region: t.ex. USA, västra Östra USA USA, norra centrala Södra centrala USA Europa, västra Europa, norra Asien, östra Sydostasien osv.
Geo-regionen för en resurs ändras aldrig när den har skapats.
sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Inställningar som används för att etablera eller konfigurera resursen SignalRCreateOrUpdatePropertiesOrSignalRProperties
Sku Faktureringsinformation för resursen. (t.ex. basic kontra standard) ResourceSku
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.SignalRService/signalR"

ResourceSku

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

Om det finns tillåts följande värden:
Kostnadsfritt: 1
Standard: 1,2,5,10,20,50,100
Int
familj Valfri sträng. För framtida användning. sträng
Namn Namnet på SKU:n. Krävs.

Tillåtna värden: Standard_S1, Free_F1
sträng (krävs)
storlek Valfri sträng. För framtida användning. sträng
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"

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

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Namn Beskrivning Värde
cors CORS-inställningar (Cross-Origin Resource Sharing). SignalRCorsSettings
Funktioner Lista över SignalR-funktionerFlags. t.ex. ServiceMode.

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 har angetts använder SignalR-tjänsten sitt globala standardvärde.
Men kom ihåg att standardvärdet inte betyder "false". Det varierar beroende på olika FeatureFlags.
SignalRFeature[]
hostNamePrefix Prefix för värdnamnet för SignalR-tjänsten. Behålls för framtida användning.
Värdnamnet har formatet: <hostNamePrefix>.service.signalr.net.
sträng

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.
"EnableConnectivityLogs"
"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

SignalRUpdateParametersTags

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@2018-10-01"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      hostNamePrefix = "string"
    }
  })
}

Egenskapsvärden

Microsoft.SignalRService/signalR

Namn Beskrivning Värde
plats Azure GEO-region: t.ex. USA, västra Östra USA USA, norra centrala Södra centrala USA Europa, västra Europa, norra Asien, östra Sydostasien osv.
Geo-regionen för en resurs ändras aldrig när den har skapats.
sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Inställningar som används för att etablera eller konfigurera resursen SignalRCreateOrUpdatePropertiesOrSignalRProperties
Sku Faktureringsinformation för resursen. (t.ex. basic kontra standard) ResourceSku
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.SignalRService/signalR@2018-10-01"

ResourceSku

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

Om det finns tillåts följande värden:
Kostnadsfritt: 1
Standard: 1,2,5,10,20,50,100
Int
familj Valfri sträng. För framtida användning. sträng
Namn Namnet på SKU:n. Krävs.

Tillåtna värden: Standard_S1, Free_F1
sträng (krävs)
storlek Valfri sträng. För framtida användning. sträng
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"

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

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Namn Beskrivning Värde
cors CORS-inställningar (Cross-Origin Resource Sharing). SignalRCorsSettings
Funktioner Lista över SignalR-funktionerFlags. t.ex. ServiceMode.

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 har angetts använder SignalR-tjänsten sitt globala standardvärde.
Men kom ihåg att standardvärdet inte betyder "false". Det varierar beroende på olika FeatureFlags.
SignalRFeature[]
hostNamePrefix Prefix för värdnamnet för SignalR-tjänsten. Behålls för framtida användning.
Värdnamnet har formatet: <hostNamePrefix>.service.signalr.net.
sträng

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.
"EnableConnectivityLogs"
"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

SignalRUpdateParametersTags

Namn Beskrivning Värde