共用方式為

Microsoft.SignalRService signalR 2020-05-01

  • 發行項

Bicep 資源定義

signalR 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.SignalRService/signalR 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.SignalRService/signalR@2020-05-01' = {
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    networkACLs: {
      defaultAction: 'string'
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    upstream: {
      templates: [
        {
          categoryPattern: 'string'
          eventPattern: 'string'
          hubPattern: 'string'
          urlTemplate: 'string'
        }
      ]
    }
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

Microsoft.SignalRService/signalR

名字 描述 價值
類 服務的種類 ，例如 “SignalR” 或 “RawWebSockets” 代表 “Microsoft.SignalRService/SignalR” 'RawWebSockets'
'SignalR'
位置 SignalR 服務的地理位置。 例如美國西部 美國東部 美國中北部 美國中南部。 字串
名字 資源名稱 字串 （必要）
性能 用來布建或設定資源的設定 SignalRProperties
sku 資源的計費資訊。（如免費、標準） ResourceSku
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

NetworkACL

名字 描述 價值
允許 允許的要求類型。 此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。 包含任何的字串數組：
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
否認 拒絕的要求類型。 此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。 包含任何的字串數組：
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'

PrivateEndpointACL

名字 描述 價值
允許 允許的要求類型。 此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。 包含任何的字串數組：
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
否認 拒絕的要求類型。 此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。 包含任何的字串數組：
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
名字 私人端點連線的名稱 字串 （必要）

ResourceSku

名字 描述 價值
能力 選擇性的整數。 SignalR 資源的單位計數。 預設為 1。

如果存在，則允許下列值：
免費：1
標準：1,2,5,10,20,50,100		 int
名字 SKU 的名稱。 必填。

允許的值：Standard_S1、Free_F1		 字串 （必要）
層 這個特定 SKU 的選擇性層。 'Standard' 或 'Free'。

Basic 已被取代，請改用 Standard。		 'Basic'
'Free'
'Premium'
'Standard'

ServerlessUpstreamSettings

名字 描述 價值
範本 取得或設定上游 URL 範本的清單。 順序很重要，而第一個比對範本會生效。 UpstreamTemplate[]

SignalRCorsSettings

名字 描述 價值
allowedOrigins 取得或設定應該允許進行跨原始來源呼叫的來源清單（例如：http://example.com:12345）。 使用 「*」 來允許所有專案。 如果省略，則默認允許全部。 string[]

SignalRFeature

名字 描述 價值
旗 FeatureFlags 是 Azure SignalR 服務支援的功能。
- ServiceMode：SignalR 服務的後端伺服器旗標。 允許的值：「預設值」：有自己的後端伺服器;「無伺服器」：您的應用程式沒有後端伺服器;“Classic”：用於回溯兼容性。 同時支援預設和無伺服器模式，但不建議;“PredefinedOnly”：供日後使用。
- EnableConnectivityLogs：“true”/“false”，分別啟用/停用連線記錄類別。		 'EnableConnectivityLogs'
'EnableMessagingLogs'
'ServiceMode' （必要）
性能 與此功能相關的選擇性屬性。 SignalRFeatureProperties
價值 功能旗標的值。 如需允許的值，請參閱 Azure SignalR 服務檔 /azure/azure-signalr/ 。 字串

約束：
最小長度 = 1
最大長度 = 128 （必要）

SignalRFeatureProperties

名字 描述 價值

SignalRNetworkACLs

名字 描述 價值
defaultAction 沒有其他規則相符時的預設動作 'Allow'
'Deny'
privateEndpoints 私人端點要求的 ACL PrivateEndpointACL[]
publicNetwork 來自公用網路之要求的 ACL NetworkACL

SignalRProperties

名字 描述 價值
cors 跨原始來源資源分享 （CORS） 設定。 SignalRCorsSettings
特徵 SignalR featureFlags 的清單。 例如 ServiceMode。

不會修改未包含在更新作業參數中的FeatureFlags。
回應只會包含明確設定的featureFlags。
未明確設定featureFlag時，SignalR 服務會使用其全域預設值。
但請記住，預設值並不表示 「false」。 其會因不同的FeatureFlags而有所不同。		 SignalRFeature[]
networkACLs 網路 ACL SignalRNetworkACLs
上游 當 Azure SignalR 處於無伺服器模式時，上游設定。 ServerlessUpstreamSettings

TrackedResourceTags

名字 描述 價值

UpstreamTemplate

名字 描述 價值
categoryPattern 取得或設定類別名稱的比對模式。 如果未設定，它會比對任何類別。
支援 3 種模式：
1. “*”，它符合任何類別名稱
2. 將多個類別與 “，”，例如“connections，messages”，它會比對類別 “connections” 和 “messages”
3. 單一類別名稱，例如“connections”，它符合類別 “connections”		 字串
eventPattern 取得或設定事件名稱的比對模式。 如果未設定，它會比對任何事件。
支援 3 種模式：
1. “*”，它會比對任何事件名稱
2.將多個事件與 “，”，例如“connect，disconnect”，它會比對事件 “connect” 和 “disconnect”
3. 單一事件名稱，例如 “connect”，它符合 “connect”		 字串
hubPattern 取得或設定中樞名稱的比對模式。 如果未設定，它會比對任何中樞。
支援 3 種模式：
1. “*”，它會比對任何中樞名稱
2.將多個中樞與 “，”，例如 “hub1，hub2”，它符合 “hub1” 和 “hub2”
3. 單一中樞名稱，例如 “hub1”，它符合 “hub1”		 字串
urlTemplate 取得或設定上游 URL 範本。 您可以在範本內使用 3 個預先定義的參數 {hub}、{category} {event}，當用戶端要求傳入時，會動態計算上游 URL 的值。
例如，如果urlTemplate是 http://example.com/{hub}/api/{event}，且從中樞 chat 連線的用戶端要求，它會先POST至此 URL：http://example.com/chat/api/connect。		 字串 （必要）

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案 描述
部署 Azure SignalR 服務 此範本會使用範本建立 Azure SignalR 服務。

ARM 樣本資源定義

signalR 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.SignalRService/signalR 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2020-05-01",
  "name": "string",
  "kind": "string",
  "location": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "networkACLs": {
      "defaultAction": "string",
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "upstream": {
      "templates": [
        {
          "categoryPattern": "string",
          "eventPattern": "string",
          "hubPattern": "string",
          "urlTemplate": "string"
        }
      ]
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

Microsoft.SignalRService/signalR

名字 描述 價值
apiVersion API 版本 '2020-05-01'
類 服務的種類 ，例如 “SignalR” 或 “RawWebSockets” 代表 “Microsoft.SignalRService/SignalR” 'RawWebSockets'
'SignalR'
位置 SignalR 服務的地理位置。 例如美國西部 美國東部 美國中北部 美國中南部。 字串
名字 資源名稱 字串 （必要）
性能 用來布建或設定資源的設定 SignalRProperties
sku 資源的計費資訊。（如免費、標準） ResourceSku
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.SignalRService/signalR'

NetworkACL

名字 描述 價值
允許 允許的要求類型。 此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。 包含任何的字串數組：
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
否認 拒絕的要求類型。 此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。 包含任何的字串數組：
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'

PrivateEndpointACL

名字 描述 價值
允許 允許的要求類型。 此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。 包含任何的字串數組：
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
否認 拒絕的要求類型。 此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。 包含任何的字串數組：
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
名字 私人端點連線的名稱 字串 （必要）

ResourceSku

名字 描述 價值
能力 選擇性的整數。 SignalR 資源的單位計數。 預設為 1。

如果存在，則允許下列值：
免費：1
標準：1,2,5,10,20,50,100		 int
名字 SKU 的名稱。 必填。

允許的值：Standard_S1、Free_F1		 字串 （必要）
層 這個特定 SKU 的選擇性層。 'Standard' 或 'Free'。

Basic 已被取代，請改用 Standard。		 'Basic'
'Free'
'Premium'
'Standard'

ServerlessUpstreamSettings

名字 描述 價值
範本 取得或設定上游 URL 範本的清單。 順序很重要，而第一個比對範本會生效。 UpstreamTemplate[]

SignalRCorsSettings

名字 描述 價值
allowedOrigins 取得或設定應該允許進行跨原始來源呼叫的來源清單（例如：http://example.com:12345）。 使用 「*」 來允許所有專案。 如果省略，則默認允許全部。 string[]

SignalRFeature

名字 描述 價值
旗 FeatureFlags 是 Azure SignalR 服務支援的功能。
- ServiceMode：SignalR 服務的後端伺服器旗標。 允許的值：「預設值」：有自己的後端伺服器;「無伺服器」：您的應用程式沒有後端伺服器;“Classic”：用於回溯兼容性。 同時支援預設和無伺服器模式，但不建議;“PredefinedOnly”：供日後使用。
- EnableConnectivityLogs：“true”/“false”，分別啟用/停用連線記錄類別。		 'EnableConnectivityLogs'
'EnableMessagingLogs'
'ServiceMode' （必要）
性能 與此功能相關的選擇性屬性。 SignalRFeatureProperties
價值 功能旗標的值。 如需允許的值，請參閱 Azure SignalR 服務檔 /azure/azure-signalr/ 。 字串

約束：
最小長度 = 1
最大長度 = 128 （必要）

SignalRFeatureProperties

名字 描述 價值

SignalRNetworkACLs

名字 描述 價值
defaultAction 沒有其他規則相符時的預設動作 'Allow'
'Deny'
privateEndpoints 私人端點要求的 ACL PrivateEndpointACL[]
publicNetwork 來自公用網路之要求的 ACL NetworkACL

SignalRProperties

名字 描述 價值
cors 跨原始來源資源分享 （CORS） 設定。 SignalRCorsSettings
特徵 SignalR featureFlags 的清單。 例如 ServiceMode。

不會修改未包含在更新作業參數中的FeatureFlags。
回應只會包含明確設定的featureFlags。
未明確設定featureFlag時，SignalR 服務會使用其全域預設值。
但請記住，預設值並不表示 「false」。 其會因不同的FeatureFlags而有所不同。		 SignalRFeature[]
networkACLs 網路 ACL SignalRNetworkACLs
上游 當 Azure SignalR 處於無伺服器模式時，上游設定。 ServerlessUpstreamSettings

TrackedResourceTags

名字 描述 價值

UpstreamTemplate

名字 描述 價值
categoryPattern 取得或設定類別名稱的比對模式。 如果未設定，它會比對任何類別。
支援 3 種模式：
1. “*”，它符合任何類別名稱
2. 將多個類別與 “，”，例如“connections，messages”，它會比對類別 “connections” 和 “messages”
3. 單一類別名稱，例如“connections”，它符合類別 “connections”		 字串
eventPattern 取得或設定事件名稱的比對模式。 如果未設定，它會比對任何事件。
支援 3 種模式：
1. “*”，它會比對任何事件名稱
2.將多個事件與 “，”，例如“connect，disconnect”，它會比對事件 “connect” 和 “disconnect”
3. 單一事件名稱，例如 “connect”，它符合 “connect”		 字串
hubPattern 取得或設定中樞名稱的比對模式。 如果未設定，它會比對任何中樞。
支援 3 種模式：
1. “*”，它會比對任何中樞名稱
2.將多個中樞與 “，”，例如 “hub1，hub2”，它符合 “hub1” 和 “hub2”
3. 單一中樞名稱，例如 “hub1”，它符合 “hub1”		 字串
urlTemplate 取得或設定上游 URL 範本。 您可以在範本內使用 3 個預先定義的參數 {hub}、{category} {event}，當用戶端要求傳入時，會動態計算上游 URL 的值。
例如，如果urlTemplate是 http://example.com/{hub}/api/{event}，且從中樞 chat 連線的用戶端要求，它會先POST至此 URL：http://example.com/chat/api/connect。		 字串 （必要）

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
部署 Azure SignalR 服務

部署至 Azure 		此範本會使用範本建立 Azure SignalR 服務。

Terraform （AzAPI 提供者） 資源定義

signalR 資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.SignalRService/signalR 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR@2020-05-01"
  name = "string"
  kind = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      networkACLs = {
        defaultAction = "string"
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      upstream = {
        templates = [
          {
            categoryPattern = "string"
            eventPattern = "string"
            hubPattern = "string"
            urlTemplate = "string"
          }
        ]
      }
    }
  })
}

屬性值

Microsoft.SignalRService/signalR

名字 描述 價值
類 服務的種類 ，例如 “SignalR” 或 “RawWebSockets” 代表 “Microsoft.SignalRService/SignalR” 'RawWebSockets'
'SignalR'
位置 SignalR 服務的地理位置。 例如美國西部 美國東部 美國中北部 美國中南部。 字串
名字 資源名稱 字串 （必要）
性能 用來布建或設定資源的設定 SignalRProperties
sku 資源的計費資訊。（如免費、標準） ResourceSku
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.SignalRService/signalR@2020-05-01”

NetworkACL

名字 描述 價值
允許 允許的要求類型。 此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。 包含任何的字串數組：
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
否認 拒絕的要求類型。 此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。 包含任何的字串數組：
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'

PrivateEndpointACL

名字 描述 價值
允許 允許的要求類型。 此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。 包含任何的字串數組：
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
否認 拒絕的要求類型。 此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。 包含任何的字串數組：
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
名字 私人端點連線的名稱 字串 （必要）

ResourceSku

名字 描述 價值
能力 選擇性的整數。 SignalR 資源的單位計數。 預設為 1。

如果存在，則允許下列值：
免費：1
標準：1,2,5,10,20,50,100		 int
名字 SKU 的名稱。 必填。

允許的值：Standard_S1、Free_F1		 字串 （必要）
層 這個特定 SKU 的選擇性層。 'Standard' 或 'Free'。

Basic 已被取代，請改用 Standard。		 'Basic'
'Free'
'Premium'
'Standard'

ServerlessUpstreamSettings

名字 描述 價值
範本 取得或設定上游 URL 範本的清單。 順序很重要，而第一個比對範本會生效。 UpstreamTemplate[]

SignalRCorsSettings

名字 描述 價值
allowedOrigins 取得或設定應該允許進行跨原始來源呼叫的來源清單（例如：http://example.com:12345）。 使用 「*」 來允許所有專案。 如果省略，則默認允許全部。 string[]

SignalRFeature

名字 描述 價值
旗 FeatureFlags 是 Azure SignalR 服務支援的功能。
- ServiceMode：SignalR 服務的後端伺服器旗標。 允許的值：「預設值」：有自己的後端伺服器;「無伺服器」：您的應用程式沒有後端伺服器;“Classic”：用於回溯兼容性。 同時支援預設和無伺服器模式，但不建議;“PredefinedOnly”：供日後使用。
- EnableConnectivityLogs：“true”/“false”，分別啟用/停用連線記錄類別。		 'EnableConnectivityLogs'
'EnableMessagingLogs'
'ServiceMode' （必要）
性能 與此功能相關的選擇性屬性。 SignalRFeatureProperties
價值 功能旗標的值。 如需允許的值，請參閱 Azure SignalR 服務檔 /azure/azure-signalr/ 。 字串

約束：
最小長度 = 1
最大長度 = 128 （必要）

SignalRFeatureProperties

名字 描述 價值

SignalRNetworkACLs

名字 描述 價值
defaultAction 沒有其他規則相符時的預設動作 'Allow'
'Deny'
privateEndpoints 私人端點要求的 ACL PrivateEndpointACL[]
publicNetwork 來自公用網路之要求的 ACL NetworkACL

SignalRProperties

名字 描述 價值
cors 跨原始來源資源分享 （CORS） 設定。 SignalRCorsSettings
特徵 SignalR featureFlags 的清單。 例如 ServiceMode。

不會修改未包含在更新作業參數中的FeatureFlags。
回應只會包含明確設定的featureFlags。
未明確設定featureFlag時，SignalR 服務會使用其全域預設值。
但請記住，預設值並不表示 「false」。 其會因不同的FeatureFlags而有所不同。		 SignalRFeature[]
networkACLs 網路 ACL SignalRNetworkACLs
上游 當 Azure SignalR 處於無伺服器模式時，上游設定。 ServerlessUpstreamSettings

TrackedResourceTags

名字 描述 價值

UpstreamTemplate

名字 描述 價值
categoryPattern 取得或設定類別名稱的比對模式。 如果未設定，它會比對任何類別。
支援 3 種模式：
1. “*”，它符合任何類別名稱
2. 將多個類別與 “，”，例如“connections，messages”，它會比對類別 “connections” 和 “messages”
3. 單一類別名稱，例如“connections”，它符合類別 “connections”		 字串
eventPattern 取得或設定事件名稱的比對模式。 如果未設定，它會比對任何事件。
支援 3 種模式：
1. “*”，它會比對任何事件名稱
2.將多個事件與 “，”，例如“connect，disconnect”，它會比對事件 “connect” 和 “disconnect”
3. 單一事件名稱，例如 “connect”，它符合 “connect”		 字串
hubPattern 取得或設定中樞名稱的比對模式。 如果未設定，它會比對任何中樞。
支援 3 種模式：
1. “*”，它會比對任何中樞名稱
2.將多個中樞與 “，”，例如 “hub1，hub2”，它符合 “hub1” 和 “hub2”
3. 單一中樞名稱，例如 “hub1”，它符合 “hub1”		 字串
urlTemplate 取得或設定上游 URL 範本。 您可以在範本內使用 3 個預先定義的參數 {hub}、{category} {event}，當用戶端要求傳入時，會動態計算上游 URL 的值。
例如，如果urlTemplate是 http://example.com/{hub}/api/{event}，且從中樞 chat 連線的用戶端要求，它會先POST至此 URL：http://example.com/chat/api/connect。		 字串 （必要）