通过

你当前正在访问 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' = {
  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 服务的地理位置。 例如美国西部 美国东部 美国中北部 美国中南部。 字符串
名字 资源名称 string （必需）
性能 用于预配或配置资源的设置 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”
名字 专用终结点连接的名称 string （必需）

ResourceSku

名字 描述 价值
能力 可选，整数。 SignalR 资源的单位计数。 默认情况下为 1。

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

允许的值：Standard_S1、Free_F1		 string （必需）
层 此特定 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 服务的后端服务器的标志。 允许的值：“Default”：具有自己的后端服务器;“无服务器”：应用程序没有后端服务器;“经典”：为了向后兼容。 支持默认模式和无服务器模式，但不建议这样做;“PredefinedOnly”：供将来使用。
- EnableConnectivityLogs：“true”/“false”，分别启用/禁用连接日志类别。		 “EnableConnectivityLogs”
“EnableMessagingLogs”
“ServiceMode”（必需）
性能 与此功能相关的可选属性。 SignalRFeatureProperties
价值 功能标志的值。 有关允许的值，请参阅 Azure SignalR 服务文档 /azure/azure-signalr/ 。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）

SignalRFeatureProperties

名字 描述 价值

SignalRNetworkACLs

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

SignalRProperties

名字 描述 价值
cors 跨域资源共享 （CORS） 设置。 SignalRCorsSettings
特征 SignalR featureFlags 的列表。 例如 ServiceMode。

不会修改更新操作的参数中包含的 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 的客户端请求会连接，则它将首先发布到此 URL：http://example.com/chat/api/connect。		 string （必需）

快速入门示例

以下快速入门示例部署此资源类型。

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 服务的地理位置。 例如美国西部 美国东部 美国中北部 美国中南部。 字符串
名字 资源名称 string （必需）
性能 用于预配或配置资源的设置 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”
名字 专用终结点连接的名称 string （必需）

ResourceSku

名字 描述 价值
能力 可选，整数。 SignalR 资源的单位计数。 默认情况下为 1。

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

允许的值：Standard_S1、Free_F1		 string （必需）
层 此特定 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 服务的后端服务器的标志。 允许的值：“Default”：具有自己的后端服务器;“无服务器”：应用程序没有后端服务器;“经典”：为了向后兼容。 支持默认模式和无服务器模式，但不建议这样做;“PredefinedOnly”：供将来使用。
- EnableConnectivityLogs：“true”/“false”，分别启用/禁用连接日志类别。		 “EnableConnectivityLogs”
“EnableMessagingLogs”
“ServiceMode”（必需）
性能 与此功能相关的可选属性。 SignalRFeatureProperties
价值 功能标志的值。 有关允许的值，请参阅 Azure SignalR 服务文档 /azure/azure-signalr/ 。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）

SignalRFeatureProperties

名字 描述 价值

SignalRNetworkACLs

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

SignalRProperties

名字 描述 价值
cors 跨域资源共享 （CORS） 设置。 SignalRCorsSettings
特征 SignalR featureFlags 的列表。 例如 ServiceMode。

不会修改更新操作的参数中包含的 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 的客户端请求会连接，则它将首先发布到此 URL：http://example.com/chat/api/connect。		 string （必需）

快速入门模板

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

模板 描述
部署 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 服务的地理位置。 例如美国西部 美国东部 美国中北部 美国中南部。 字符串
名字 资源名称 string （必需）
性能 用于预配或配置资源的设置 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”
名字 专用终结点连接的名称 string （必需）

ResourceSku

名字 描述 价值
能力 可选，整数。 SignalR 资源的单位计数。 默认情况下为 1。

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

允许的值：Standard_S1、Free_F1		 string （必需）
层 此特定 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 服务的后端服务器的标志。 允许的值：“Default”：具有自己的后端服务器;“无服务器”：应用程序没有后端服务器;“经典”：为了向后兼容。 支持默认模式和无服务器模式，但不建议这样做;“PredefinedOnly”：供将来使用。
- EnableConnectivityLogs：“true”/“false”，分别启用/禁用连接日志类别。		 “EnableConnectivityLogs”
“EnableMessagingLogs”
“ServiceMode”（必需）
性能 与此功能相关的可选属性。 SignalRFeatureProperties
价值 功能标志的值。 有关允许的值，请参阅 Azure SignalR 服务文档 /azure/azure-signalr/ 。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）

SignalRFeatureProperties

名字 描述 价值

SignalRNetworkACLs

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

SignalRProperties

名字 描述 价值
cors 跨域资源共享 （CORS） 设置。 SignalRCorsSettings
特征 SignalR featureFlags 的列表。 例如 ServiceMode。

不会修改更新操作的参数中包含的 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 的客户端请求会连接，则它将首先发布到此 URL：http://example.com/chat/api/connect。		 string （必需）