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 區域：例如美國西部 | 美國東部 | 美國中北部 | 美國中南部 | 西歐 | 北歐 | 東亞 | 東南亞 | 等。 資源的地理區域在建立之後永遠不會變更。 |
字串 （必要） |
| 名字 | 資源名稱 | 字串 （必要） | ||||||||
| 性能 | 用來布建或設定資源的設定 | SignalRCreateOrUpdatePropertiesOrSignalRProperties | ||||||||
| sku | 資源的計費資訊。（例如基本與標準） | ResourceSku | ||||||||
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
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' |
SignalRCorsSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| allowedOrigins | 取得或設定應該允許進行跨原始來源呼叫的來源清單（例如：http://example.com:12345）。 使用 「*」 來允許所有專案。 如果省略，則默認允許全部。 | string[] |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| cors | 跨原始來源資源分享 （CORS） 設定。 | SignalRCorsSettings |
| 特徵 | SignalR featureFlags 的清單。 例如 ServiceMode。 不會修改未包含在更新作業參數中的FeatureFlags。 回應只會包含明確設定的featureFlags。 未明確設定featureFlag時，SignalR 服務會使用其全域預設值。 但請記住，預設值並不表示 「false」。 其會因不同的FeatureFlags而有所不同。 |
SignalRFeature[] |
| hostNamePrefix | SignalR 服務的 hostName 前置詞。 保留以供日後使用。 主機名的格式為：<hostNamePrefix>.service.signalr.net。 |
字串 |
SignalRFeature
| 名字 | 描述 | 價值 |
|---|---|---|
| 旗 | FeatureFlags 是 Azure SignalR 服務支援的功能。 - ServiceMode：SignalR 服務的後端伺服器旗標。 允許的值：「預設值」：有自己的後端伺服器;「無伺服器」：您的應用程式沒有後端伺服器;“Classic”：用於回溯兼容性。 同時支援預設和無伺服器模式，但不建議;“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 區域：例如美國西部 | 美國東部 | 美國中北部 | 美國中南部 | 西歐 | 北歐 | 東亞 | 東南亞 | 等。 資源的地理區域在建立之後永遠不會變更。 |
字串 （必要） |
| 名字 | 資源名稱 | 字串 （必要） | ||||||||
| 性能 | 用來布建或設定資源的設定 | SignalRCreateOrUpdatePropertiesOrSignalRProperties | ||||||||
| sku | 資源的計費資訊。（例如基本與標準） | ResourceSku | ||||||||
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 | ||||||||
| 類型 | 資源類型 | 'Microsoft.SignalRService/signalR' |
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' |
SignalRCorsSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| allowedOrigins | 取得或設定應該允許進行跨原始來源呼叫的來源清單（例如：http://example.com:12345）。 使用 「*」 來允許所有專案。 如果省略，則默認允許全部。 | string[] |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| cors | 跨原始來源資源分享 （CORS） 設定。 | SignalRCorsSettings |
| 特徵 | SignalR featureFlags 的清單。 例如 ServiceMode。 不會修改未包含在更新作業參數中的FeatureFlags。 回應只會包含明確設定的featureFlags。 未明確設定featureFlag時，SignalR 服務會使用其全域預設值。 但請記住，預設值並不表示 「false」。 其會因不同的FeatureFlags而有所不同。 |
SignalRFeature[] |
| hostNamePrefix | SignalR 服務的 hostName 前置詞。 保留以供日後使用。 主機名的格式為：<hostNamePrefix>.service.signalr.net。 |
字串 |
SignalRFeature
| 名字 | 描述 | 價值 |
|---|---|---|
| 旗 | FeatureFlags 是 Azure SignalR 服務支援的功能。 - ServiceMode：SignalR 服務的後端伺服器旗標。 允許的值：「預設值」：有自己的後端伺服器;「無伺服器」：您的應用程式沒有後端伺服器;“Classic”：用於回溯兼容性。 同時支援預設和無伺服器模式，但不建議;“PredefinedOnly”：供日後使用。 - EnableConnectivityLogs：“true”/“false”，分別啟用/停用連線記錄類別。 |
'EnableConnectivityLogs' 'ServiceMode' （必要） |
| 性能 | 與此功能相關的選擇性屬性。 | SignalRFeatureProperties |
| 價值 | 功能旗標的值。 如需允許的值，請參閱 Azure SignalR 服務檔 /azure/azure-signalr/ 。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
SignalRFeatureProperties
| 名字 | 描述 | 價值 |
|---|
SignalRUpdateParametersTags
| 名字 | 描述 | 價值 |
|---|
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
部署 Azure SignalR 服務
|
此範本會使用範本建立 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"
body = jsonencode({
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 區域：例如美國西部 | 美國東部 | 美國中北部 | 美國中南部 | 西歐 | 北歐 | 東亞 | 東南亞 | 等。 資源的地理區域在建立之後永遠不會變更。 |
字串 （必要） |
| 名字 | 資源名稱 | 字串 （必要） | ||||||||
| 性能 | 用來布建或設定資源的設定 | 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 |
字串 （必要） |
| 大小 | 選擇性字串。 供日後使用。 | 字串 |
| 層 | 這個特定 SKU 的選擇性層。 'Standard' 或 'Free'。 Basic 已被取代，請改用 Standard。 |
'Basic' 'Free' 'Premium' 'Standard' |
SignalRCorsSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| allowedOrigins | 取得或設定應該允許進行跨原始來源呼叫的來源清單（例如：http://example.com:12345）。 使用 「*」 來允許所有專案。 如果省略，則默認允許全部。 | string[] |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| cors | 跨原始來源資源分享 （CORS） 設定。 | SignalRCorsSettings |
| 特徵 | SignalR featureFlags 的清單。 例如 ServiceMode。 不會修改未包含在更新作業參數中的FeatureFlags。 回應只會包含明確設定的featureFlags。 未明確設定featureFlag時，SignalR 服務會使用其全域預設值。 但請記住，預設值並不表示 「false」。 其會因不同的FeatureFlags而有所不同。 |
SignalRFeature[] |
| hostNamePrefix | SignalR 服務的 hostName 前置詞。 保留以供日後使用。 主機名的格式為：<hostNamePrefix>.service.signalr.net。 |
字串 |
SignalRFeature
| 名字 | 描述 | 價值 |
|---|---|---|
| 旗 | FeatureFlags 是 Azure SignalR 服務支援的功能。 - ServiceMode：SignalR 服務的後端伺服器旗標。 允許的值：「預設值」：有自己的後端伺服器;「無伺服器」：您的應用程式沒有後端伺服器;“Classic”：用於回溯兼容性。 同時支援預設和無伺服器模式，但不建議;“PredefinedOnly”：供日後使用。 - EnableConnectivityLogs：“true”/“false”，分別啟用/停用連線記錄類別。 |
'EnableConnectivityLogs' 'ServiceMode' （必要） |
| 性能 | 與此功能相關的選擇性屬性。 | SignalRFeatureProperties |
| 價值 | 功能旗標的值。 如需允許的值，請參閱 Azure SignalR 服務檔 /azure/azure-signalr/ 。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
SignalRFeatureProperties
| 名字 | 描述 | 價值 |
|---|
SignalRUpdateParametersTags
| 名字 | 描述 | 價值 |
|---|