你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.SignalRService signalR 2020-05-01

  • 项目

Bicep 资源定义

可以使用针对以下操作部署 signalR 资源类型：

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.SignalRService/signalR 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.SignalRService/signalR@2020-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  kind: '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'
        }
      ]
    }
  }
}

属性值

signalR

名称 说明 值
name 资源名称 字符串 (必需)

字符限制：3-63

有效字符：
字母数字和连字符。

以字母开头。 以字母或数字结尾。

资源名称在 Azure 中必须是唯一的。
location SignalR 服务的地理位置。 例如美国西部、美国东部、美国中北部、美国中南部。 string
标记 服务的标记，它是描述资源的键值对的列表。 标记名称和值的字典。 请参阅 模板中的标记
sku resource. (的计费信息，例如免费、标准) ResourceSku
kind 服务的种类 - 例如“SignalR”或“Microsoft.SignalRService/SignalR”的“RawWebSockets” “RawWebSockets”
“SignalR”
properties 用于预配或配置资源的设置 SignalRProperties

SignalRProperties

名称 说明 值
cors 跨源资源共享 (CORS) 设置。 SignalRCorsSettings
features SignalR featureFlags 列表。 例如 ServiceMode。

不会修改更新操作的参数中未包括的 FeatureFlag。
响应将仅包括显式设置的 featureFlag。
如果未显式设置 featureFlag，SignalR 服务将使用其全局默认值。
但请记住，默认值并不意味着“false”。 它因 FeatureFlag 的不同而异。		 SignalRFeature[]
networkACLs 网络 ACL SignalRNetworkACLs
上游 Azure SignalR 处于无服务器模式时的上游设置。 ServerlessUpstreamSettings

SignalRCorsSettings

名称 说明 值
allowedOrigins 获取或设置应允许 (进行跨域调用的源列表，例如： http://example.com:12345) 。 使用“*”，允许所有来源。 如果省略，则默认允许所有。 string[]

SignalRFeature

名称 说明 值
flag FeatureFlags 是 Azure SignalR 服务支持的功能。
- ServiceMode：SignalR 服务的后端服务器的标志。 允许的值：“Default”：具有自己的后端服务器;“无服务器”：应用程序没有后端服务器;“经典”：用于向后兼容。 支持默认模式和无服务器模式，但不建议使用;“PredefinedOnly”：供将来使用。
- EnableConnectivityLogs：“true”/“false”，分别启用/禁用连接日志类别。		 “EnableConnectivityLogs”
“EnableMessagingLogs”
“ServiceMode” (必需)
properties 与此功能相关的可选属性。 SignalRFeatureProperties
value 功能标志的值。 有关允许的值，请参阅 Azure SignalR 服务文档 https://docs.microsoft.com/azure/azure-signalr/ 。 字符串 (必需)

约束：
最小长度 = 1
最大长度 = 128

SignalRFeatureProperties

名称 说明 值
{customized property} 字符串

SignalRNetworkACLs

名称 说明 值
defaultAction 没有其他规则匹配时的默认操作 “允许”
“拒绝”
privateEndpoints 来自专用终结点的请求的 ACL PrivateEndpointACL[]
publicNetwork 来自公用网络的请求的 ACL NetworkACL

PrivateEndpointACL

名称 说明 值
allow 允许的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。 包含任何一项的字符串数组：
“ClientConnection”
'RESTAPI'
“ServerConnection”
“Trace”
deny 拒绝的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。 包含任何一项的字符串数组：
“ClientConnection”
'RESTAPI'
“ServerConnection”
“Trace”
name 专用终结点连接的名称 字符串 (必需)

NetworkACL

名称 说明 值
allow 允许的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。 包含任何一项的字符串数组：
“ClientConnection”
'RESTAPI'
“ServerConnection”
“Trace”
deny 拒绝的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。 包含任何一项的字符串数组：
“ClientConnection”
'RESTAPI'
“ServerConnection”
“Trace”

ServerlessUpstreamSettings

名称 说明 值
模板 获取或设置上游 URL 模板的列表。 顺序很重要，第一个匹配模板生效。 UpstreamTemplate[]

UpstreamTemplate

名称 说明 值
categoryPattern 获取或设置类别名称的匹配模式。 如果未设置，则与任何类别匹配。
支持 3 种模式：
1. “*”，它与任何类别名称匹配
2. 将多个类别与 “，”（例如“connections，messages”）合并，它匹配类别“connections”和“messages”
3. 单个类别名称（例如“connections”）与类别“connections”匹配		 string
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 的值会动态计算。 字符串 (必需)

ResourceSku

名称 说明 值
容量 可选，整数。 SignalR 资源的单位计数。 默认情况下为 1。

如果存在，则允许使用以下值：
免费：1
标准：1、2、5、10、20、50、100		 int
name SKU 的名称。 必需。

允许的值：Standard_S1、Free_F1		 字符串 (必需)
层 此特定 SKU 的可选层。 “标准”或“免费”。

Basic 已弃用，请改用 Standard。
 “Basic”
“免费”
“Premium”
“Standard”

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
部署 Azure SignalR 服务

部署到 Azure		 此模板使用模板创建Azure SignalR 服务。

ARM 模板资源定义

可以使用针对以下操作部署 signalR 资源类型：

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.SignalRService/signalR 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2020-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "kind": "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"
        }
      ]
    }
  }
}

属性值

signalR

名称 说明 Value
type 资源类型 “Microsoft.SignalRService/signalR”
apiVersion 资源 API 版本 '2020-05-01'
name 资源名称 字符串 (必需)

字符限制：3-63

有效字符：
字母数字和连字符。

以字母开头。 以字母或数字结尾。

资源名称在 Azure 中必须是唯一的。
location SignalR 服务的地理位置。 例如美国西部、美国东部、美国中北部、美国中南部。 字符串
标记 服务的标记，它是描述资源的键值对的列表。 标记名称和值的字典。 请参阅 模板中的标记
sku resource. (的计费信息，例如免费、标准) ResourceSku
kind 服务的种类 - 例如“SignalR”或“Microsoft.SignalRService/SignalR”的“RawWebSockets” “RawWebSockets”
“SignalR”
properties 用于预配或配置资源的设置 SignalRProperties

SignalRProperties

名称 说明 值
cors 跨源资源共享 (CORS) 设置。 SignalRCorsSettings
features SignalR featureFlags 列表。 例如 ServiceMode。

不会修改更新操作的参数中未包括的 FeatureFlag。
响应将仅包括显式设置的 featureFlag。
如果未显式设置 featureFlag，SignalR 服务将使用其全局默认值。
但请记住，默认值并不意味着“false”。 它因 FeatureFlag 的不同而异。		 SignalRFeature[]
networkACLs 网络 ACL SignalRNetworkACLs
上游 Azure SignalR 处于无服务器模式时的上游设置。 ServerlessUpstreamSettings

SignalRCorsSettings

名称 说明 值
allowedOrigins 获取或设置应允许 (进行跨域调用的源列表，例如： http://example.com:12345) 。 使用“*”，允许所有来源。 如果省略，则默认允许所有。 string[]

SignalRFeature

名称 说明 值
flag FeatureFlags 是 Azure SignalR 服务支持的功能。
- ServiceMode：SignalR 服务的后端服务器的标志。 允许的值：“Default”：具有自己的后端服务器;“无服务器”：应用程序没有后端服务器;“经典”：用于向后兼容。 支持默认模式和无服务器模式，但不建议使用;“PredefinedOnly”：供将来使用。
- EnableConnectivityLogs：“true”/“false”，分别启用/禁用连接日志类别。		 “EnableConnectivityLogs”
“EnableMessagingLogs”
“ServiceMode” (必需)
properties 与此功能相关的可选属性。 SignalRFeatureProperties
value 功能标志的值。 有关允许的值，请参阅 Azure SignalR 服务文档 https://docs.microsoft.com/azure/azure-signalr/ 。 字符串 (必需)

约束：
最小长度 = 1
最大长度 = 128

SignalRFeatureProperties

名称 说明 值
{customized property} 字符串

SignalRNetworkACLs

名称 说明 值
defaultAction 没有其他规则匹配时的默认操作 “允许”
“拒绝”
privateEndpoints 来自专用终结点的请求的 ACL PrivateEndpointACL[]
publicNetwork 来自公用网络的请求的 ACL NetworkACL

PrivateEndpointACL

名称 说明 值
allow 允许的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。 包含任意项的字符串数组：
“ClientConnection”
'RESTAPI'
“ServerConnection”
“跟踪”
deny 拒绝的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。 包含任意项的字符串数组：
“ClientConnection”
'RESTAPI'
“ServerConnection”
“跟踪”
name 专用终结点连接的名称 字符串 (必需)

NetworkACL

名称 说明 值
allow 允许的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。 包含任意项的字符串数组：
“ClientConnection”
'RESTAPI'
“ServerConnection”
“跟踪”
deny 拒绝的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。 包含任意项的字符串数组：
“ClientConnection”
'RESTAPI'
“ServerConnection”
“跟踪”

ServerlessUpstreamSettings

名称 说明 值
模板 获取或设置上游 URL 模板的列表。 顺序很重要，第一个匹配的模板会生效。 UpstreamTemplate[]

UpstreamTemplate

名称 说明 值
categoryPattern 获取或设置类别名称的匹配模式。 如果未设置，则与任何类别匹配。
支持 3 种模式：
1. “*”，用于匹配任何类别名称
2. 将多个类别与 “，”合并，例如“connections，messages”，它匹配类别“connections”和“messages”
3. 单个类别名称（例如“connections”）与类别“connections”匹配		 字符串
eventPattern 获取或设置事件名称的匹配模式。 如果未设置，它将匹配任何事件。
支持 3 种模式：
1. “*”，它匹配任何事件名称
2. 将多个事件与 “，”（例如“connect，disconnect”）合并，它匹配事件“connect”和“disconnect”
3. 单个事件名称（例如“connect”）与“connect”匹配		 string
hubPattern 获取或设置中心名称的匹配模式。 如果未设置，则与任何中心匹配。
支持 3 种模式：
1. “*”，用于匹配任何中心名称
2. 将多个中心与 “、”合并，例如“hub1，hub2”，它匹配“hub1”和“hub2”
3. 单个中心名称（例如“hub1”）与“hub1”匹配		 string
urlTemplate 获取或设置上游 URL 模板。 可以在模板中使用 3 个预定义参数 {hub}、{category} {event}，当客户端请求传入时，上游 URL 的值会动态计算。 字符串 (必需)

ResourceSku

名称 说明 值
容量 可选，整数。 SignalR 资源的单位计数。 默认情况下为 1。

如果存在，则允许使用以下值：
免费：1
标准：1、2、5、10、20、50、100		 int
name SKU 的名称。 必需。

允许的值：Standard_S1、Free_F1		 字符串 (必需)
层 此特定 SKU 的可选层。 “标准”或“免费”。

Basic 已弃用，请改用 Standard。
 “Basic”
“免费”
“Premium”
“Standard”

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
部署 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"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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"
          }
        ]
      }
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
    kind = "string"
  })
}

属性值

signalR

名称 说明 Value
type 资源类型 “Microsoft.SignalRService/signalR@2020-05-01”
name 资源名称 字符串 (必需)

字符限制：3-63

有效字符：
字母数字和连字符。

以字母开头。 以字母或数字结尾。

资源名称在 Azure 中必须是唯一的。
location SignalR 服务的地理位置。 例如，美国西部、美国东部、美国中北部、美国中南部。 字符串
parent_id 若要部署到资源组，请使用该资源组的 ID。 字符串 (必需)
标记 服务的标记，它是描述资源的键值对的列表。 标记名称和值的字典。
sku resource. (的计费信息，例如免费、标准) ResourceSku
kind 服务类型 - 例如“SignalR”或“Microsoft.SignalRService/SignalR”的“RawWebSockets” “RawWebSockets”
“SignalR”
properties 用于预配或配置资源的设置 SignalRProperties

SignalRProperties

名称 说明 值
cors 跨域资源共享 (CORS) 设置。 SignalRCorsSettings
features SignalR featureFlags 列表。 例如 ServiceMode。

不会修改更新操作的参数中未包含的 FeatureFlag。
响应将仅包括显式设置的 featureFlag。
如果未显式设置 featureFlag，SignalR 服务将使用其全局默认值。
但请记住，默认值并不意味着“false”。 它因 FeatureFlag 的不同而异。		 SignalRFeature[]
networkACLs 网络 ACL SignalRNetworkACLs
上游 Azure SignalR 处于无服务器模式时的上游设置。 ServerlessUpstreamSettings

SignalRCorsSettings

名称 说明 值
allowedOrigins 获取或设置应允许 (进行跨源调用的源列表，例如： http://example.com:12345) 。 使用“*”，允许所有来源。 如果省略，则默认允许全部。 string[]

SignalRFeature

名称 说明 值
flag FeatureFlags 是 Azure SignalR 服务支持的功能。
- ServiceMode：SignalR 服务的后端服务器的标志。 允许的值：“Default”：有自己的后端服务器;“无服务器”：应用程序没有后端服务器;“经典”：用于向后兼容。 支持默认模式和无服务器模式，但不建议使用;“PredefinedOnly”：供将来使用。
- EnableConnectivityLogs：“true”/“false”，分别启用/禁用连接日志类别。		 “EnableConnectivityLogs”
“EnableMessagingLogs”
“ServiceMode” (必需)
properties 与此功能相关的可选属性。 SignalRFeatureProperties
value 功能标志的值。 有关允许的值，请参阅 Azure SignalR 服务文档 https://docs.microsoft.com/azure/azure-signalr/ 。 字符串 (必需)

约束：
最小长度 = 1
最大长度 = 128

SignalRFeatureProperties

名称 说明 值
{customized property} 字符串

SignalRNetworkACLs

名称 说明 值
defaultAction 没有其他规则匹配时的默认操作 “允许”
“拒绝”
privateEndpoints 来自专用终结点的请求的 ACL PrivateEndpointACL[]
publicNetwork 来自公用网络的请求的 ACL NetworkACL

PrivateEndpointACL

名称 说明 值
allow 允许的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。 包含任何一项的字符串数组：
“ClientConnection”
“RESTAPI”
“ServerConnection”
“跟踪”
deny 拒绝的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。 包含任何一项的字符串数组：
“ClientConnection”
“RESTAPI”
“ServerConnection”
“跟踪”
name 专用终结点连接的名称 字符串 (必需)

NetworkACL

名称 说明 值
allow 允许的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。 包含任何一项的字符串数组：
“ClientConnection”
“RESTAPI”
“ServerConnection”
“跟踪”
deny 拒绝的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。 包含任何一项的字符串数组：
“ClientConnection”
“RESTAPI”
“ServerConnection”
“跟踪”

ServerlessUpstreamSettings

名称 说明 值
模板 获取或设置上游 URL 模板的列表。 顺序很重要，第一个匹配模板生效。 UpstreamTemplate[]

UpstreamTemplate

名称 说明 值
categoryPattern 获取或设置类别名称的匹配模式。 如果未设置，则与任何类别匹配。
支持 3 种模式：
1. “*”，它与任何类别名称匹配
2. 将多个类别与 “，”（例如“connections，messages”）合并，它匹配类别“connections”和“messages”
3. 单个类别名称（例如“connections”）与类别“connections”匹配		 string
eventPattern 获取或设置事件名称的匹配模式。 如果未设置，则与任何事件匹配。
支持 3 种模式：
1. “*”，它与任何事件名称匹配
2. 将多个事件与 “，”（例如“connect，disconnect”）合并，它匹配事件“connect”和“disconnect”
3. 单个事件名称（例如“connect”）与“connect”匹配		 字符串
hubPattern 获取或设置中心名称的匹配模式。 如果未设置，则与任何中心匹配。
支持 3 种模式：
1. “*”，它与任何中心名称匹配
2. 将多个中心与 “、”（例如“hub1，hub2”）合并，它匹配“hub1”和“hub2”
3. 单个中心名称（例如“hub1”）与“hub1”匹配		 string
urlTemplate 获取或设置上游 URL 模板。 可以在模板中使用 3 个预定义参数 {hub}、{category} {event}，上游 URL 的值在客户端请求传入时动态计算。 字符串 (必需)

ResourceSku

名称 说明 值
容量 可选，整数。 SignalR 资源的单位计数。 默认情况下为 1。

如果存在，则允许以下值：
免费：1
标准：1,2,5,10,20,50,100		 int
name SKU 的名称。 必需。

允许的值：Standard_S1、Free_F1		 字符串 (必需)
层 此特定 SKU 的可选层。 “标准”或“免费”。

Basic 已弃用，请改用 Standard。
 "Basic"
"Free"
“Premium”
“Standard”