通过

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

Microsoft.SignalRService signalR 2018-10-01

  • 项目

Bicep 资源定义

可以使用目标操作部署 signalR 资源类型：

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

资源格式

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

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'
  }
}

属性值

Microsoft.SignalRService/signalR

名字 描述 价值
位置 Azure GEO 区域：例如美国西部 美国东部 美国中北部 美国中南部 西欧 北欧 东亚 东南亚 等。
资源的地理区域在创建后永远不会更改。		 string （必需）
名字 资源名称 string （必需）
性能 用于预配或配置资源的设置 SignalRCreateOrUpdatePropertiesOrSignalRProperties
sku 资源的计费信息。（例如基本与标准） ResourceSku
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

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”

SignalRCorsSettings

名字 描述 价值
allowedOrigins 获取或设置应允许进行跨域调用的源列表（例如：http://example.com:12345）。 使用“*”允许所有。 如果省略，则默认允许全部。 string[]

SignalRCreateOrUpdatePropertiesOrSignalRProperties

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

不会修改更新操作的参数中包含的 FeatureFlags。
响应将仅包含显式设置的功能标志。
如果未显式设置 featureFlag，SignalR 服务将使用其全局默认值。
但请记住，默认值并不意味着“false”。 它因不同的 FeatureFlags 而异。		 SignalRFeature[]
hostNamePrefix SignalR 服务的主机名前缀。 保留以供将来使用。
主机名的格式为：<hostNamePrefix>.service.signalr.net。		 字符串

SignalRFeature

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

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

SignalRFeatureProperties

名字 描述 价值

SignalRUpdateParametersTags

名字 描述 价值

快速入门示例

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

Bicep 文件 描述
部署 Azure SignalR 服务 此模板使用模板创建 Azure SignalR 服务。

ARM 模板资源定义

可以使用目标操作部署 signalR 资源类型：

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

资源格式

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

{
  "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"
  }
}

属性值

Microsoft.SignalRService/signalR

名字 描述 价值
apiVersion API 版本 '2018-10-01'
位置 Azure GEO 区域：例如美国西部 美国东部 美国中北部 美国中南部 西欧 北欧 东亚 东南亚 等。
资源的地理区域在创建后永远不会更改。		 string （必需）
名字 资源名称 string （必需）
性能 用于预配或配置资源的设置 SignalRCreateOrUpdatePropertiesOrSignalRProperties
sku 资源的计费信息。（例如基本与标准） ResourceSku
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.SignalRService/signalR”

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”

SignalRCorsSettings

名字 描述 价值
allowedOrigins 获取或设置应允许进行跨域调用的源列表（例如：http://example.com:12345）。 使用“*”允许所有。 如果省略，则默认允许全部。 string[]

SignalRCreateOrUpdatePropertiesOrSignalRProperties

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

不会修改更新操作的参数中包含的 FeatureFlags。
响应将仅包含显式设置的功能标志。
如果未显式设置 featureFlag，SignalR 服务将使用其全局默认值。
但请记住，默认值并不意味着“false”。 它因不同的 FeatureFlags 而异。		 SignalRFeature[]
hostNamePrefix SignalR 服务的主机名前缀。 保留以供将来使用。
主机名的格式为：<hostNamePrefix>.service.signalr.net。		 字符串

SignalRFeature

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

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

SignalRFeatureProperties

名字 描述 价值

SignalRUpdateParametersTags

名字 描述 价值

快速入门模板

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

模板 描述
部署 Azure SignalR 服务

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

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 signalR 资源类型：

  • 资源组

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

资源格式

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

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"
    }
  })
}

属性值

Microsoft.SignalRService/signalR

名字 描述 价值
位置 Azure GEO 区域：例如美国西部 美国东部 美国中北部 美国中南部 西欧 北欧 东亚 东南亚 等。
资源的地理区域在创建后永远不会更改。		 string （必需）
名字 资源名称 string （必需）
性能 用于预配或配置资源的设置 SignalRCreateOrUpdatePropertiesOrSignalRProperties
sku 资源的计费信息。（例如基本与标准） ResourceSku
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.SignalRService/signalR@2018-10-01”

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”

SignalRCorsSettings

名字 描述 价值
allowedOrigins 获取或设置应允许进行跨域调用的源列表（例如：http://example.com:12345）。 使用“*”允许所有。 如果省略，则默认允许全部。 string[]

SignalRCreateOrUpdatePropertiesOrSignalRProperties

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

不会修改更新操作的参数中包含的 FeatureFlags。
响应将仅包含显式设置的功能标志。
如果未显式设置 featureFlag，SignalR 服务将使用其全局默认值。
但请记住，默认值并不意味着“false”。 它因不同的 FeatureFlags 而异。		 SignalRFeature[]
hostNamePrefix SignalR 服务的主机名前缀。 保留以供将来使用。
主机名的格式为：<hostNamePrefix>.service.signalr.net。		 字符串

SignalRFeature

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

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

SignalRFeatureProperties

名字 描述 价值

SignalRUpdateParametersTags

名字 描述 价值