Microsoft.SignalRService signalR 2021-06-01-preview
- 最新の を
する - 2024-08-01-preview
- 2024-04-01-preview
- 2024-03-01
- 2024-01-01-preview
- 2023-08-01-preview
- 2023-06-01-preview
- 2023-03-01-preview
- 2023-02-01
- 2022-08-01-preview
- 2022-02-01
- 2021-10-01
- 2021-09-01-preview
- 2021-06-01-preview
- 2021-04-01-preview
- 2020-07-01-preview
- 2020-05-01
- 2018-10-01
- 2018-03-01-preview
Bicep リソース定義
signalR リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.SignalRService/signalR リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.SignalRService/signalR@2021-06-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
名前 | 形容 | 価値 |
---|---|---|
種類 | id の種類を表します: systemAssigned、userAssigned、None | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | ユーザー割り当て ID を取得または設定する | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
名前 | 形容 | 価値 |
---|---|---|
資源 | ターゲット リソースのアプリ ID URI を示すリソース。 また、発行されたトークンの aud (対象ユーザー) 要求にも表示されます。 |
糸 |
ManagedIdentityUserAssignedIdentities
名前 | 形容 | 価値 |
---|
Microsoft.SignalRService/signalR
名前 | 形容 | 価値 | |||
---|---|---|---|---|---|
同一性 | マネージド ID の応答 | ManagedIdentity | |||
種類 | サービスの種類 ("Microsoft.SignalRService/SignalR" の "SignalR" など) | 'RawWebSockets' 'SignalR' |
|||
場所 | リソースの GEO の場所。 例: 米国西部 | 米国東部 | 米国中北部 | 米国中南部。 | 糸 |
名前 | リソース名 | string (必須) | |||
プロパティ | リソースのプロビジョニングまたは構成に使用する設定 | SignalRProperties の |
|||
sku | リソースの課金情報。(例: Free、Standard) | ResourceSku | |||
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
NetworkACL
名前 | 形容 | 価値 |
---|---|---|
許す | 許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 | 次のいずれかを含む文字列配列: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
打ち消す | 拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 | 次のいずれかを含む文字列配列: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
PrivateEndpointACL
名前 | 形容 | 価値 |
---|---|---|
許す | 許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 | 次のいずれかを含む文字列配列: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
打ち消す | 拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 | 次のいずれかを含む文字列配列: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
名前 | プライベート エンドポイント接続の名前 | string (必須) |
ResourceSku
名前 | 形容 | 価値 |
---|---|---|
能力 | 省略可能、整数。 リソースの単位数。 既定では 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": 独自のバックエンド サーバーがあります。"サーバーレス": アプリケーションにバックエンド サーバーがありません。"Classic": 下位互換性のため。 既定モードとサーバーレス モードの両方をサポートしますが、推奨されません。"PredefinedOnly": 将来使用します。 - EnableConnectivityLogs: "true"/"false"。接続ログ カテゴリをそれぞれ有効または無効にします。 - EnableMessagingLogs: "true"/"false"。接続ログ カテゴリをそれぞれ有効または無効にします。 - EnableLiveTrace: Live Trace を使用すると、Azure SignalR サービス内で何が起こっているかを知ることができます。リアルタイムでライブ トレースが提供されます。独自の Azure SignalR ベースの Web アプリケーションを開発したり、いくつかの問題を自己トラブルシューティングしたりする際に役立ちます。 ライブ トレースは、課金される送信メッセージとしてカウントされることに注意してください。 ライブ トレース機能を有効または無効にするには、"true"/"false" を指定できます。 |
'EnableConnectivityLogs' 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' (必須) |
プロパティ | この機能に関連する省略可能なプロパティ。 | SignalRFeatureProperties の |
価値 | 機能フラグの値。 使用できる値については、Azure SignalR サービスのドキュメント /azure/azure-signalr/ を参照してください。 | 糸 制約: 最小長 = 1 最大長 = 1 (必須) |
SignalRFeatureProperties
名前 | 形容 | 価値 |
---|
SignalRNetwork ACL
名前 | 形容 | 価値 |
---|---|---|
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 の一覧。 更新操作のパラメーターに含まれていない FeatureFlag は変更されません。 また、応答には、明示的に設定された featureFlags のみが含まれます。 featureFlag が明示的に設定されていない場合、そのグローバルな既定値が使用されます ただし、既定値は "false" を意味しません。 FeatureFlags によって異なります。 |
SignalRFeature[] |
networkACLs | ネットワーク ACL | SignalRNetwork ACL |
publicNetworkAccess | パブリック ネットワーク アクセスを有効または無効にします。 既定値は "Enabled" です。 有効になっている場合でも、ネットワーク ACL が適用されます。 無効にすると、ネットワーク ACL で設定した内容に関係なく、パブリック ネットワーク アクセスは常に無効になります。 |
糸 |
tls | TLS 設定。 | SignalRTlsSettings |
川上 | サービスがサーバーレス モードの場合のアップストリーム設定。 | ServerlessUpstreamSettings |
SignalRTlsSettings
名前 | 形容 | 価値 |
---|---|---|
clientCertEnabled | TLS ハンドシェイク中にクライアント証明書を要求する (有効な場合) | bool |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
UpstreamAuthSettings
名前 | 形容 | 価値 |
---|---|---|
managedIdentity | マネージド ID の設定を取得または設定します。 認証の種類が ManagedIdentity に設定されている場合は必須です。 | ManagedIdentitySettings |
種類 | 認証の種類を取得または設定します。現在、None または ManagedIdentity がサポートされています。 | 'ManagedIdentity' 'None' |
UpstreamTemplate
名前 | 形容 | 価値 |
---|---|---|
認証 | アップストリームの認証設定を取得または設定します。 設定しない場合、アップストリーム メッセージには認証は使用されません。 | UpstreamAuthSettings の |
categoryPattern | カテゴリ名の一致パターンを取得または設定します。 設定されていない場合は、任意のカテゴリと一致します。 次の 3 種類のパターンがサポートされています。 1. "*"、 任意のカテゴリ名と一致します 2. 複数のカテゴリを "," ("接続,メッセージ" など) と組み合わせて、カテゴリ "connections" と "messages" に一致します 3. 1 つのカテゴリ名 (例: "connections")、カテゴリ "connections" と一致する |
糸 |
eventPattern | イベント名の一致パターンを取得または設定します。 設定されていない場合は、任意のイベントと一致します。 次の 3 種類のパターンがサポートされています。 1. "*"、任意のイベント名と一致します 2. 複数のイベントを "," と組み合わせる (例: "connect,disconnect", it matches event "connect" and "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 に POST されます。http://example.com/chat/api/connect 。 |
string (必須) |
UserAssignedIdentityProperty
名前 | 形容 | 価値 |
---|
クイック スタートのサンプル
次のクイック スタート サンプルでは、このリソースの種類をデプロイします。
Bicep ファイル | 形容 |
---|---|
Azure SignalR サービス をデプロイする | このテンプレートは、テンプレートを使用して Azure SignalR Service を作成します。 |
ARM テンプレート リソース定義
signalR リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.SignalRService/signalR リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2021-06-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
名前 | 形容 | 価値 |
---|---|---|
種類 | id の種類を表します: systemAssigned、userAssigned、None | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | ユーザー割り当て ID を取得または設定する | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
名前 | 形容 | 価値 |
---|---|---|
資源 | ターゲット リソースのアプリ ID URI を示すリソース。 また、発行されたトークンの aud (対象ユーザー) 要求にも表示されます。 |
糸 |
ManagedIdentityUserAssignedIdentities
名前 | 形容 | 価値 |
---|
Microsoft.SignalRService/signalR
名前 | 形容 | 価値 | |||
---|---|---|---|---|---|
apiVersion | API のバージョン | '2021-06-01-preview' | |||
同一性 | マネージド ID の応答 | ManagedIdentity | |||
種類 | サービスの種類 ("Microsoft.SignalRService/SignalR" の "SignalR" など) | 'RawWebSockets' 'SignalR' |
|||
場所 | リソースの GEO の場所。 例: 米国西部 | 米国東部 | 米国中北部 | 米国中南部。 | 糸 |
名前 | リソース名 | string (必須) | |||
プロパティ | リソースのプロビジョニングまたは構成に使用する設定 | SignalRProperties の |
|||
sku | リソースの課金情報。(例: Free、Standard) | ResourceSku | |||
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
|||
種類 | リソースの種類 | 'Microsoft.SignalRService/signalR' |
NetworkACL
名前 | 形容 | 価値 |
---|---|---|
許す | 許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 | 次のいずれかを含む文字列配列: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
打ち消す | 拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 | 次のいずれかを含む文字列配列: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
PrivateEndpointACL
名前 | 形容 | 価値 |
---|---|---|
許す | 許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 | 次のいずれかを含む文字列配列: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
打ち消す | 拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 | 次のいずれかを含む文字列配列: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
名前 | プライベート エンドポイント接続の名前 | string (必須) |
ResourceSku
名前 | 形容 | 価値 |
---|---|---|
能力 | 省略可能、整数。 リソースの単位数。 既定では 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": 独自のバックエンド サーバーがあります。"サーバーレス": アプリケーションにバックエンド サーバーがありません。"Classic": 下位互換性のため。 既定モードとサーバーレス モードの両方をサポートしますが、推奨されません。"PredefinedOnly": 将来使用します。 - EnableConnectivityLogs: "true"/"false"。接続ログ カテゴリをそれぞれ有効または無効にします。 - EnableMessagingLogs: "true"/"false"。接続ログ カテゴリをそれぞれ有効または無効にします。 - EnableLiveTrace: Live Trace を使用すると、Azure SignalR サービス内で何が起こっているかを知ることができます。リアルタイムでライブ トレースが提供されます。独自の Azure SignalR ベースの Web アプリケーションを開発したり、いくつかの問題を自己トラブルシューティングしたりする際に役立ちます。 ライブ トレースは、課金される送信メッセージとしてカウントされることに注意してください。 ライブ トレース機能を有効または無効にするには、"true"/"false" を指定できます。 |
'EnableConnectivityLogs' 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' (必須) |
プロパティ | この機能に関連する省略可能なプロパティ。 | SignalRFeatureProperties の |
価値 | 機能フラグの値。 使用できる値については、Azure SignalR サービスのドキュメント /azure/azure-signalr/ を参照してください。 | 糸 制約: 最小長 = 1 最大長 = 1 (必須) |
SignalRFeatureProperties
名前 | 形容 | 価値 |
---|
SignalRNetwork ACL
名前 | 形容 | 価値 |
---|---|---|
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 の一覧。 更新操作のパラメーターに含まれていない FeatureFlag は変更されません。 また、応答には、明示的に設定された featureFlags のみが含まれます。 featureFlag が明示的に設定されていない場合、そのグローバルな既定値が使用されます ただし、既定値は "false" を意味しません。 FeatureFlags によって異なります。 |
SignalRFeature[] |
networkACLs | ネットワーク ACL | SignalRNetwork ACL |
publicNetworkAccess | パブリック ネットワーク アクセスを有効または無効にします。 既定値は "Enabled" です。 有効になっている場合でも、ネットワーク ACL が適用されます。 無効にすると、ネットワーク ACL で設定した内容に関係なく、パブリック ネットワーク アクセスは常に無効になります。 |
糸 |
tls | TLS 設定。 | SignalRTlsSettings |
川上 | サービスがサーバーレス モードの場合のアップストリーム設定。 | ServerlessUpstreamSettings |
SignalRTlsSettings
名前 | 形容 | 価値 |
---|---|---|
clientCertEnabled | TLS ハンドシェイク中にクライアント証明書を要求する (有効な場合) | bool |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
UpstreamAuthSettings
名前 | 形容 | 価値 |
---|---|---|
managedIdentity | マネージド ID の設定を取得または設定します。 認証の種類が ManagedIdentity に設定されている場合は必須です。 | ManagedIdentitySettings |
種類 | 認証の種類を取得または設定します。現在、None または ManagedIdentity がサポートされています。 | 'ManagedIdentity' 'None' |
UpstreamTemplate
名前 | 形容 | 価値 |
---|---|---|
認証 | アップストリームの認証設定を取得または設定します。 設定しない場合、アップストリーム メッセージには認証は使用されません。 | UpstreamAuthSettings の |
categoryPattern | カテゴリ名の一致パターンを取得または設定します。 設定されていない場合は、任意のカテゴリと一致します。 次の 3 種類のパターンがサポートされています。 1. "*"、 任意のカテゴリ名と一致します 2. 複数のカテゴリを "," ("接続,メッセージ" など) と組み合わせて、カテゴリ "connections" と "messages" に一致します 3. 1 つのカテゴリ名 (例: "connections")、カテゴリ "connections" と一致する |
糸 |
eventPattern | イベント名の一致パターンを取得または設定します。 設定されていない場合は、任意のイベントと一致します。 次の 3 種類のパターンがサポートされています。 1. "*"、任意のイベント名と一致します 2. 複数のイベントを "," と組み合わせる (例: "connect,disconnect", it matches event "connect" and "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 に POST されます。http://example.com/chat/api/connect 。 |
string (必須) |
UserAssignedIdentityProperty
名前 | 形容 | 価値 |
---|
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
テンプレート | 形容 |
---|---|
Azure SignalR サービス をデプロイする Azure にデプロイする |
このテンプレートは、テンプレートを使用して Azure SignalR Service を作成します。 |
Terraform (AzAPI プロバイダー) リソース定義
signalR リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.SignalRService/signalR リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SignalRService/signalR@2021-06-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
名前 | 形容 | 価値 |
---|---|---|
種類 | id の種類を表します: systemAssigned、userAssigned、None | 'None' 'SystemAssigned' 'UserAssigned' |
userAssignedIdentities | ユーザー割り当て ID を取得または設定する | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
名前 | 形容 | 価値 |
---|---|---|
資源 | ターゲット リソースのアプリ ID URI を示すリソース。 また、発行されたトークンの aud (対象ユーザー) 要求にも表示されます。 |
糸 |
ManagedIdentityUserAssignedIdentities
名前 | 形容 | 価値 |
---|
Microsoft.SignalRService/signalR
名前 | 形容 | 価値 | |||
---|---|---|---|---|---|
同一性 | マネージド ID の応答 | ManagedIdentity | |||
種類 | サービスの種類 ("Microsoft.SignalRService/SignalR" の "SignalR" など) | 'RawWebSockets' 'SignalR' |
|||
場所 | リソースの GEO の場所。 例: 米国西部 | 米国東部 | 米国中北部 | 米国中南部。 | 糸 |
名前 | リソース名 | string (必須) | |||
プロパティ | リソースのプロビジョニングまたは構成に使用する設定 | SignalRProperties の |
|||
sku | リソースの課金情報。(例: Free、Standard) | ResourceSku | |||
タグ | リソース タグ | タグ名と値のディクショナリ。 | |||
種類 | リソースの種類 | "Microsoft.SignalRService/signalR@2021-06-01-preview" |
NetworkACL
名前 | 形容 | 価値 |
---|---|---|
許す | 許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 | 次のいずれかを含む文字列配列: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
打ち消す | 拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 | 次のいずれかを含む文字列配列: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
PrivateEndpointACL
名前 | 形容 | 価値 |
---|---|---|
許す | 許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 | 次のいずれかを含む文字列配列: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
打ち消す | 拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 | 次のいずれかを含む文字列配列: 'ClientConnection' 'RESTAPI' 'ServerConnection' 'Trace' |
名前 | プライベート エンドポイント接続の名前 | string (必須) |
ResourceSku
名前 | 形容 | 価値 |
---|---|---|
能力 | 省略可能、整数。 リソースの単位数。 既定では 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": 独自のバックエンド サーバーがあります。"サーバーレス": アプリケーションにバックエンド サーバーがありません。"Classic": 下位互換性のため。 既定モードとサーバーレス モードの両方をサポートしますが、推奨されません。"PredefinedOnly": 将来使用します。 - EnableConnectivityLogs: "true"/"false"。接続ログ カテゴリをそれぞれ有効または無効にします。 - EnableMessagingLogs: "true"/"false"。接続ログ カテゴリをそれぞれ有効または無効にします。 - EnableLiveTrace: Live Trace を使用すると、Azure SignalR サービス内で何が起こっているかを知ることができます。リアルタイムでライブ トレースが提供されます。独自の Azure SignalR ベースの Web アプリケーションを開発したり、いくつかの問題を自己トラブルシューティングしたりする際に役立ちます。 ライブ トレースは、課金される送信メッセージとしてカウントされることに注意してください。 ライブ トレース機能を有効または無効にするには、"true"/"false" を指定できます。 |
'EnableConnectivityLogs' 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' (必須) |
プロパティ | この機能に関連する省略可能なプロパティ。 | SignalRFeatureProperties の |
価値 | 機能フラグの値。 使用できる値については、Azure SignalR サービスのドキュメント /azure/azure-signalr/ を参照してください。 | 糸 制約: 最小長 = 1 最大長 = 1 (必須) |
SignalRFeatureProperties
名前 | 形容 | 価値 |
---|
SignalRNetwork ACL
名前 | 形容 | 価値 |
---|---|---|
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 の一覧。 更新操作のパラメーターに含まれていない FeatureFlag は変更されません。 また、応答には、明示的に設定された featureFlags のみが含まれます。 featureFlag が明示的に設定されていない場合、そのグローバルな既定値が使用されます ただし、既定値は "false" を意味しません。 FeatureFlags によって異なります。 |
SignalRFeature[] |
networkACLs | ネットワーク ACL | SignalRNetwork ACL |
publicNetworkAccess | パブリック ネットワーク アクセスを有効または無効にします。 既定値は "Enabled" です。 有効になっている場合でも、ネットワーク ACL が適用されます。 無効にすると、ネットワーク ACL で設定した内容に関係なく、パブリック ネットワーク アクセスは常に無効になります。 |
糸 |
tls | TLS 設定。 | SignalRTlsSettings |
川上 | サービスがサーバーレス モードの場合のアップストリーム設定。 | ServerlessUpstreamSettings |
SignalRTlsSettings
名前 | 形容 | 価値 |
---|---|---|
clientCertEnabled | TLS ハンドシェイク中にクライアント証明書を要求する (有効な場合) | bool |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
UpstreamAuthSettings
名前 | 形容 | 価値 |
---|---|---|
managedIdentity | マネージド ID の設定を取得または設定します。 認証の種類が ManagedIdentity に設定されている場合は必須です。 | ManagedIdentitySettings |
種類 | 認証の種類を取得または設定します。現在、None または ManagedIdentity がサポートされています。 | 'ManagedIdentity' 'None' |
UpstreamTemplate
名前 | 形容 | 価値 |
---|---|---|
認証 | アップストリームの認証設定を取得または設定します。 設定しない場合、アップストリーム メッセージには認証は使用されません。 | UpstreamAuthSettings の |
categoryPattern | カテゴリ名の一致パターンを取得または設定します。 設定されていない場合は、任意のカテゴリと一致します。 次の 3 種類のパターンがサポートされています。 1. "*"、 任意のカテゴリ名と一致します 2. 複数のカテゴリを "," ("接続,メッセージ" など) と組み合わせて、カテゴリ "connections" と "messages" に一致します 3. 1 つのカテゴリ名 (例: "connections")、カテゴリ "connections" と一致する |
糸 |
eventPattern | イベント名の一致パターンを取得または設定します。 設定されていない場合は、任意のイベントと一致します。 次の 3 種類のパターンがサポートされています。 1. "*"、任意のイベント名と一致します 2. 複数のイベントを "," と組み合わせる (例: "connect,disconnect", it matches event "connect" and "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 に POST されます。http://example.com/chat/api/connect 。 |
string (必須) |
UserAssignedIdentityProperty
名前 | 形容 | 価値 |
---|