Microsoft.SignalRService signalR 2021-09-01-preview
Bicep 資源定義
signalR 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.SignalRService/signalR 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.SignalRService/signalR@2021-09-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
cors: {
allowedOrigins: [
'string'
]
}
disableAadAuth: bool
disableLocalAuth: bool
features: [
{
flag: 'string'
properties: {
{customized property}: 'string'
}
value: 'string'
}
]
networkACLs: {
defaultAction: 'string'
privateEndpoints: [
{
allow: [
'string'
]
deny: [
'string'
]
name: 'string'
}
]
publicNetwork: {
allow: [
'string'
]
deny: [
'string'
]
}
}
publicNetworkAccess: 'string'
tls: {
clientCertEnabled: bool
}
upstream: {
templates: [
{
auth: {
managedIdentity: {
resource: 'string'
}
type: 'string'
}
categoryPattern: 'string'
eventPattern: 'string'
hubPattern: 'string'
urlTemplate: 'string'
}
]
}
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
屬性值
ManagedIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 代表身分識別類型：systemAssigned、userAssigned、None | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | 取得或設定使用者指派的身分識別 | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
| 名字 | 描述 | 價值 |
|---|---|---|
| 資源 | 資源，指出目標資源的應用程式識別碼 URI。 它也會出現在已發行令牌的 aud （audience） 宣告中。 |
字串 |
ManagedIdentityUserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|
Microsoft.SignalRService/signalR
| 名字 | 描述 | 價值 | |||
|---|---|---|---|---|---|
| 身份 | 受控識別回應 | ManagedIdentity | |||
| 類 | 服務的種類 ，例如 “Microsoft.SignalRService/SignalR” 的 “SignalR” | 'RawWebSockets' '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
| 名字 | 描述 | 價值 |
|---|---|---|
| 能力 | 選擇性的整數。 資源的單位計數。 預設為 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”，分別啟用/停用連線記錄類別。 - EnableMessagingLogs：“true”/“false”，分別啟用/停用聯機記錄類別。 - EnableLiveTrace：實時追蹤可讓您知道 Azure SignalR 服務內發生的情況，它會即時為您提供即時追蹤，當您開發自己的 Azure SignalR 型 Web 應用程式或自行疑難解答一些問題時，將會很有説明。 請注意，實時追蹤會計算為將收取費用的輸出訊息。 允許的值：「true」/false” |
'EnableConnectivityLogs' 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' （必要） |
| 性能 | 與此功能相關的選擇性屬性。 | SignalRFeatureProperties |
| 價值 | 功能旗標的值。 如需允許的值，請參閱 Azure SignalR 服務檔 /azure/azure-signalr/ 。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
SignalRFeatureProperties
| 名字 | 描述 | 價值 |
|---|
SignalRNetworkACLs
| 名字 | 描述 | 價值 |
|---|---|---|
| defaultAction | 沒有其他規則相符時的預設動作 | 'Allow' 'Deny' |
| privateEndpoints | 私人端點要求的 ACL | PrivateEndpointACL[] |
| publicNetwork | 來自公用網路之要求的 ACL | NetworkACL |
SignalRProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| cors | 跨原始來源資源分享 （CORS） 設定。 | SignalRCorsSettings |
| disableAadAuth | DisableLocalAuth 啟用或停用 aad 驗證 當設定為 true 時，與 AuthType=aad 的連線將無法運作。 |
bool |
| disableLocalAuth | DisableLocalAuth 使用 AccessKey 啟用或停用本機驗證 當設定為 true 時，與 AccessKey=xxx 的連線將無法運作。 |
bool |
| 特徵 | featureFlags 的清單。 不會修改未包含在更新作業參數中的FeatureFlags。 回應只會包含明確設定的featureFlags。 未明確設定featureFlag時，將會使用其全域預設值 但請記住，預設值並不表示 「false」。 其會因不同的FeatureFlags而有所不同。 |
SignalRFeature[] |
| networkACLs | 網路 ACL | SignalRNetworkACLs |
| publicNetworkAccess | 啟用或停用公用網路存取。 預設為 「Enabled」。 啟用時，仍會套用網路 ACL。 停用時，不論您在網路 ACL 中設定什麼，公用網路存取一律會停用。 |
字串 |
| tls | TLS 設定。 | SignalRTlsSettings |
| 上游 | 當服務處於無伺服器模式時，上游設定。 | ServerlessUpstreamSettings |
SignalRTlsSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| clientCertEnabled | 如果啟用，請在 TLS 交握期間要求客戶端憑證 | bool |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
UpstreamAuthSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| managedIdentity | 取得或設定受控識別設定。 如果驗證類型設定為ManagedIdentity，則為必要專案。 | ManagedIdentitySettings |
| 類型 | 取得或設定驗證的類型。目前不支援無或ManagedIdentity。 | 'ManagedIdentity' 'None' |
UpstreamTemplate
| 名字 | 描述 | 價值 |
|---|---|---|
| 認證 | 取得或設定上游的驗證設定。 如果未設定，則上游訊息不會使用驗證。 | UpstreamAuthSettings |
| 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。 |
字串 （必要） |
UserAssignedIdentityProperty
| 名字 | 描述 | 價值 |
|---|
快速入門範例
下列快速入門範例會部署此資源類型。
| Bicep 檔案 | 描述 |
|---|---|
| 部署 Azure SignalR 服務 | 此範本會使用範本建立 Azure SignalR 服務。 |
ARM 樣本資源定義
signalR 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.SignalRService/signalR 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2021-09-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"cors": {
"allowedOrigins": [ "string" ]
},
"disableAadAuth": "bool",
"disableLocalAuth": "bool",
"features": [
{
"flag": "string",
"properties": {
"{customized property}": "string"
},
"value": "string"
}
],
"networkACLs": {
"defaultAction": "string",
"privateEndpoints": [
{
"allow": [ "string" ],
"deny": [ "string" ],
"name": "string"
}
],
"publicNetwork": {
"allow": [ "string" ],
"deny": [ "string" ]
}
},
"publicNetworkAccess": "string",
"tls": {
"clientCertEnabled": "bool"
},
"upstream": {
"templates": [
{
"auth": {
"managedIdentity": {
"resource": "string"
},
"type": "string"
},
"categoryPattern": "string",
"eventPattern": "string",
"hubPattern": "string",
"urlTemplate": "string"
}
]
}
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
屬性值
ManagedIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 代表身分識別類型：systemAssigned、userAssigned、None | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | 取得或設定使用者指派的身分識別 | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
| 名字 | 描述 | 價值 |
|---|---|---|
| 資源 | 資源，指出目標資源的應用程式識別碼 URI。 它也會出現在已發行令牌的 aud （audience） 宣告中。 |
字串 |
ManagedIdentityUserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|
Microsoft.SignalRService/signalR
| 名字 | 描述 | 價值 | |||
|---|---|---|---|---|---|
| apiVersion | API 版本 | '2021-09-01-preview' | |||
| 身份 | 受控識別回應 | ManagedIdentity | |||
| 類 | 服務的種類 ，例如 “Microsoft.SignalRService/SignalR” 的 “SignalR” | 'RawWebSockets' '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
| 名字 | 描述 | 價值 |
|---|---|---|
| 能力 | 選擇性的整數。 資源的單位計數。 預設為 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”，分別啟用/停用連線記錄類別。 - EnableMessagingLogs：“true”/“false”，分別啟用/停用聯機記錄類別。 - EnableLiveTrace：實時追蹤可讓您知道 Azure SignalR 服務內發生的情況，它會即時為您提供即時追蹤，當您開發自己的 Azure SignalR 型 Web 應用程式或自行疑難解答一些問題時，將會很有説明。 請注意，實時追蹤會計算為將收取費用的輸出訊息。 允許的值：「true」/false” |
'EnableConnectivityLogs' 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' （必要） |
| 性能 | 與此功能相關的選擇性屬性。 | SignalRFeatureProperties |
| 價值 | 功能旗標的值。 如需允許的值，請參閱 Azure SignalR 服務檔 /azure/azure-signalr/ 。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
SignalRFeatureProperties
| 名字 | 描述 | 價值 |
|---|
SignalRNetworkACLs
| 名字 | 描述 | 價值 |
|---|---|---|
| defaultAction | 沒有其他規則相符時的預設動作 | 'Allow' 'Deny' |
| privateEndpoints | 私人端點要求的 ACL | PrivateEndpointACL[] |
| publicNetwork | 來自公用網路之要求的 ACL | NetworkACL |
SignalRProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| cors | 跨原始來源資源分享 （CORS） 設定。 | SignalRCorsSettings |
| disableAadAuth | DisableLocalAuth 啟用或停用 aad 驗證 當設定為 true 時，與 AuthType=aad 的連線將無法運作。 |
bool |
| disableLocalAuth | DisableLocalAuth 使用 AccessKey 啟用或停用本機驗證 當設定為 true 時，與 AccessKey=xxx 的連線將無法運作。 |
bool |
| 特徵 | featureFlags 的清單。 不會修改未包含在更新作業參數中的FeatureFlags。 回應只會包含明確設定的featureFlags。 未明確設定featureFlag時，將會使用其全域預設值 但請記住，預設值並不表示 「false」。 其會因不同的FeatureFlags而有所不同。 |
SignalRFeature[] |
| networkACLs | 網路 ACL | SignalRNetworkACLs |
| publicNetworkAccess | 啟用或停用公用網路存取。 預設為 「Enabled」。 啟用時，仍會套用網路 ACL。 停用時，不論您在網路 ACL 中設定什麼，公用網路存取一律會停用。 |
字串 |
| tls | TLS 設定。 | SignalRTlsSettings |
| 上游 | 當服務處於無伺服器模式時，上游設定。 | ServerlessUpstreamSettings |
SignalRTlsSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| clientCertEnabled | 如果啟用，請在 TLS 交握期間要求客戶端憑證 | bool |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
UpstreamAuthSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| managedIdentity | 取得或設定受控識別設定。 如果驗證類型設定為ManagedIdentity，則為必要專案。 | ManagedIdentitySettings |
| 類型 | 取得或設定驗證的類型。目前不支援無或ManagedIdentity。 | 'ManagedIdentity' 'None' |
UpstreamTemplate
| 名字 | 描述 | 價值 |
|---|---|---|
| 認證 | 取得或設定上游的驗證設定。 如果未設定，則上游訊息不會使用驗證。 | UpstreamAuthSettings |
| 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。 |
字串 （必要） |
UserAssignedIdentityProperty
| 名字 | 描述 | 價值 |
|---|
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
部署 Azure SignalR 服務
|
此範本會使用範本建立 Azure SignalR 服務。 |
Terraform （AzAPI 提供者） 資源定義
signalR 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.SignalRService/signalR 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SignalRService/signalR@2021-09-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
kind = "string"
location = "string"
body = jsonencode({
properties = {
cors = {
allowedOrigins = [
"string"
]
}
disableAadAuth = bool
disableLocalAuth = bool
features = [
{
flag = "string"
properties = {
{customized property} = "string"
}
value = "string"
}
]
networkACLs = {
defaultAction = "string"
privateEndpoints = [
{
allow = [
"string"
]
deny = [
"string"
]
name = "string"
}
]
publicNetwork = {
allow = [
"string"
]
deny = [
"string"
]
}
}
publicNetworkAccess = "string"
tls = {
clientCertEnabled = bool
}
upstream = {
templates = [
{
auth = {
managedIdentity = {
resource = "string"
}
type = "string"
}
categoryPattern = "string"
eventPattern = "string"
hubPattern = "string"
urlTemplate = "string"
}
]
}
}
})
sku = {
capacity = int
name = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
}
屬性值
ManagedIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 代表身分識別類型：systemAssigned、userAssigned、None | 'None' 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentities | 取得或設定使用者指派的身分識別 | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
| 名字 | 描述 | 價值 |
|---|---|---|
| 資源 | 資源，指出目標資源的應用程式識別碼 URI。 它也會出現在已發行令牌的 aud （audience） 宣告中。 |
字串 |
ManagedIdentityUserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|
Microsoft.SignalRService/signalR
| 名字 | 描述 | 價值 | |||
|---|---|---|---|---|---|
| 身份 | 受控識別回應 | ManagedIdentity | |||
| 類 | 服務的種類 ，例如 “Microsoft.SignalRService/SignalR” 的 “SignalR” | 'RawWebSockets' 'SignalR' |
|||
| 位置 | 資源的地理位置。 例如美國西部 | 美國東部 | 美國中北部 | 美國中南部。 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） | |||
| 性能 | 用來布建或設定資源的設定 | SignalRProperties | |||
| sku | 資源的計費資訊。（如免費、標準） | ResourceSku | |||
| 標籤 | 資源標籤 | 標記名稱和值的字典。 | |||
| 類型 | 資源類型 | “Microsoft.SignalRService/signalR@2021-09-01-preview” |
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
| 名字 | 描述 | 價值 |
|---|---|---|
| 能力 | 選擇性的整數。 資源的單位計數。 預設為 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”，分別啟用/停用連線記錄類別。 - EnableMessagingLogs：“true”/“false”，分別啟用/停用聯機記錄類別。 - EnableLiveTrace：實時追蹤可讓您知道 Azure SignalR 服務內發生的情況，它會即時為您提供即時追蹤，當您開發自己的 Azure SignalR 型 Web 應用程式或自行疑難解答一些問題時，將會很有説明。 請注意，實時追蹤會計算為將收取費用的輸出訊息。 允許的值：「true」/false” |
'EnableConnectivityLogs' 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' （必要） |
| 性能 | 與此功能相關的選擇性屬性。 | SignalRFeatureProperties |
| 價值 | 功能旗標的值。 如需允許的值，請參閱 Azure SignalR 服務檔 /azure/azure-signalr/ 。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
SignalRFeatureProperties
| 名字 | 描述 | 價值 |
|---|
SignalRNetworkACLs
| 名字 | 描述 | 價值 |
|---|---|---|
| defaultAction | 沒有其他規則相符時的預設動作 | 'Allow' 'Deny' |
| privateEndpoints | 私人端點要求的 ACL | PrivateEndpointACL[] |
| publicNetwork | 來自公用網路之要求的 ACL | NetworkACL |
SignalRProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| cors | 跨原始來源資源分享 （CORS） 設定。 | SignalRCorsSettings |
| disableAadAuth | DisableLocalAuth 啟用或停用 aad 驗證 當設定為 true 時，與 AuthType=aad 的連線將無法運作。 |
bool |
| disableLocalAuth | DisableLocalAuth 使用 AccessKey 啟用或停用本機驗證 當設定為 true 時，與 AccessKey=xxx 的連線將無法運作。 |
bool |
| 特徵 | featureFlags 的清單。 不會修改未包含在更新作業參數中的FeatureFlags。 回應只會包含明確設定的featureFlags。 未明確設定featureFlag時，將會使用其全域預設值 但請記住，預設值並不表示 「false」。 其會因不同的FeatureFlags而有所不同。 |
SignalRFeature[] |
| networkACLs | 網路 ACL | SignalRNetworkACLs |
| publicNetworkAccess | 啟用或停用公用網路存取。 預設為 「Enabled」。 啟用時，仍會套用網路 ACL。 停用時，不論您在網路 ACL 中設定什麼，公用網路存取一律會停用。 |
字串 |
| tls | TLS 設定。 | SignalRTlsSettings |
| 上游 | 當服務處於無伺服器模式時，上游設定。 | ServerlessUpstreamSettings |
SignalRTlsSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| clientCertEnabled | 如果啟用，請在 TLS 交握期間要求客戶端憑證 | bool |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
UpstreamAuthSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| managedIdentity | 取得或設定受控識別設定。 如果驗證類型設定為ManagedIdentity，則為必要專案。 | ManagedIdentitySettings |
| 類型 | 取得或設定驗證的類型。目前不支援無或ManagedIdentity。 | 'ManagedIdentity' 'None' |
UpstreamTemplate
| 名字 | 描述 | 價值 |
|---|---|---|
| 認證 | 取得或設定上游的驗證設定。 如果未設定，則上游訊息不會使用驗證。 | UpstreamAuthSettings |
| 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。 |
字串 （必要） |
UserAssignedIdentityProperty
| 名字 | 描述 | 價值 |
|---|