次の方法で共有

Microsoft.SignalRService signalR 2024-01-01-preview

  • [アーティクル]

Bicep リソース定義

signalR リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.SignalRService/signalR リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.SignalRService/signalR@2024-01-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'
      }
    ]
    liveTraceConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
      enabled: 'string'
    }
    networkACLs: {
      defaultAction: 'string'
      ipRules: [
        {
          action: 'string'
          value: 'string'
        }
      ]
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    regionEndpointEnabled: 'string'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
    }
    resourceStopped: 'string'
    serverless: {
      connectionTimeoutInSeconds: int
    }
    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'
  }
}

プロパティ値

IPRule

名前 形容 価値
アクション Azure ネットワーク ACL アクション。 'Allow'
'Deny'
価値 IP または CIDR または ServiceTag 糸

LiveTraceCategory

名前 形容 価値
有効 ライブ トレース カテゴリが有効かどうかを示します。
使用可能な値: true、false。
大文字と小文字は区別されません。		 糸
名前 ライブ トレース カテゴリの名前を取得または設定します。
使用可能な値: ConnectivityLogs、MessagingLogs。
大文字と小文字は区別されません。		 糸

LiveTraceConfiguration

名前 形容 価値
カテゴリ カテゴリ構成の一覧を取得または設定します。 LiveTraceCategory[]
有効 ライブ トレースを有効にするかどうかを示します。
true に設定すると、ライブ トレース クライアントはサービスに接続できます。
それ以外の場合、ライブ トレース クライアントはサービスに接続できないため、"カテゴリ" で構成した内容に関係なく、ログを受信できなくなります。
使用可能な値: true、false。
大文字と小文字は区別されません。		 糸

ManagedIdentity

名前 形容 価値
種類 id の種類を表します: systemAssigned、userAssigned、None 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities ユーザー割り当て ID を取得または設定する ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

名前 形容 価値
資源 ターゲット リソースのアプリ ID URI を示すリソース。
また、発行されたトークンの aud (対象ユーザー) 要求にも表示されます。		 糸

ManagedIdentityUserAssignedIdentities

名前 形容 価値

Microsoft.SignalRService/signalR

名前 形容 価値
同一性 クラスは、要求と応答に使用されるマネージド ID を表します ManagedIdentity
種類 サービスの種類 'RawWebSockets'
'SignalR'
場所 リソースが存在する地理的な場所 string (必須)
名前 リソース名 糸

制約：
最小長 = 3
最大長 = 3
パターン = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (必須)
プロパティ リソースのプロパティを記述するクラス SignalRProperties の
sku リソースの課金情報。 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 (必須)

ResourceLogCategory

名前 形容 価値
有効 リソース ログ カテゴリが有効かどうかを示します。
使用可能な値: true、false。
大文字と小文字は区別されません。		 糸
名前 リソース ログ カテゴリの名前を取得または設定します。
使用可能な値: ConnectivityLogs、MessagingLogs。
大文字と小文字は区別されません。		 糸

ResourceLogConfiguration

名前 形容 価値
カテゴリ カテゴリ構成の一覧を取得または設定します。 ResourceLogCategory[]

ResourceSku

名前 形容 価値
能力 省略可能、整数。 リソースの単位数。
Free_F1/Standard_S1/Premium_P1 の場合は 1、既定ではPremium_P2では 100。

存在する場合は、次の値を使用できます。
Free_F1: 1;
Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P2: 100,200,300,400,500,600,700,800,900,1000;		 int
名前 SKU の名前。 必須。

使用できる値: Standard_S1、Free_F1、Premium_P1、Premium_P2		 string (必須)
層 この特定の SKU のオプションレベル。 'Standard' または 'Free'。

非推奨の Basic は、代わりに Standard を使用してください。		 'Basic'
'Free'
'Premium'
'Standard'

ServerlessSettings

名前 形容 価値
connectionTimeoutInSeconds クライアント接続のタイムアウトを取得または設定します。 設定する省略可能。
秒単位の値。
既定値は 30 秒です。
メッセージが短い間隔で送信されることが予想される場合は、タイムアウトを短い期間に設定する必要があります。
最後のメッセージが送信された後、クライアントがより迅速に切断するようにします。
メッセージが長い間隔で送信されることが予想される場合は、タイムアウトを長い期間に設定できます。
このセッション中も同じクライアント接続を維持する必要があります。
この間隔でメッセージ (キープアライブを含む) を受信していない場合、サービスはクライアントが切断されたと見なします。		 int

制約：
最小値 = 1
最大値 = 120

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 Azure ネットワーク ACL アクション。 'Allow'
'Deny'
ipRules パブリック トラフィックをフィルター処理するための IP 規則 IPRule[]
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[]
liveTraceConfiguration Microsoft.SignalRService リソースのライブ トレース構成。 LiveTraceConfiguration
networkACLs リソースのネットワーク ACL SignalRNetwork ACL
publicNetworkAccess パブリック ネットワーク アクセスを有効または無効にします。 既定値は "Enabled" です。
有効になっている場合でも、ネットワーク ACL が適用されます。
無効にすると、ネットワーク ACL で設定した内容に関係なく、パブリック ネットワーク アクセスは常に無効になります。		 糸
regionEndpointEnabled リージョン エンドポイントを有効または無効にします。 既定値は "Enabled" です。
無効にすると、新しい接続はこのエンドポイントにルーティングされませんが、既存の接続は影響を受けなくなります。
このプロパティはレプリカ固有です。 レプリカのないリージョン エンドポイントを無効にすることはできません。		 糸
resourceLogConfiguration Microsoft.SignalRService リソースのリソース ログ構成。 ResourceLogConfiguration
resourceStopped リソースを停止または開始します。 既定値は "False" です。
true の場合、リソースのデータ プレーンはシャットダウンされます。
false の場合、リソースのデータ プレーンが開始されます。		 糸
サーバーレス サーバーレス設定。 ServerlessSettings
tls リソースの TLS 設定 SignalRTlsSettings
川上 サービスがサーバーレス モードの場合のアップストリームの設定。 ServerlessUpstreamSettings

SignalRTlsSettings

名前 形容 価値
clientCertEnabled TLS ハンドシェイク中にクライアント証明書を要求します (有効な場合)。 Free レベルではサポートされていません。 Free レベルでは、入力はすべて無視されます。 bool

TrackedResourceTags

名前 形容 価値

UpstreamAuthSettings

名前 形容 価値
managedIdentity アップストリームのマネージド ID 設定。 ManagedIdentitySettings
種類 アップストリーム認証の種類列挙型。 'ManagedIdentity'
'None'

UpstreamTemplate

名前 形容 価値
認証 アップストリーム認証設定。 設定しない場合、アップストリーム メッセージには認証は使用されません。 UpstreamAuthSettings の
categoryPattern カテゴリ名の一致パターンを取得または設定します。 設定されていない場合は、任意のカテゴリと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のカテゴリ名と一致します。
2. 複数のカテゴリを "," ("connections,messages" など) と組み合わせると、カテゴリ "connections" と "messages" と一致します。
3. 単一のカテゴリ名 ("connections" など) は、カテゴリ "connections" と一致します。		 糸
eventPattern イベント名の一致パターンを取得または設定します。 設定されていない場合は、任意のイベントと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のイベント名と一致します。
2. 複数のイベントを "," と組み合わせます(例: "connect,disconnect", it matches event "connect" and "disconnect")。
3. 単一のイベント名 ("connect" など)、"connect" と一致します。		 糸
hubPattern ハブ名の一致パターンを取得または設定します。 設定されていない場合は、任意のハブと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のハブ名と一致します。
2. 複数のハブを "," と組み合わせます(例: "hub1,hub2", it matches "hub1" and "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": "2024-01-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"
      }
    ],
    "liveTraceConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ],
      "enabled": "string"
    },
    "networkACLs": {
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "string",
          "value": "string"
        }
      ],
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "regionEndpointEnabled": "string",
    "resourceLogConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ]
    },
    "resourceStopped": "string",
    "serverless": {
      "connectionTimeoutInSeconds": "int"
    },
    "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"
  }
}

プロパティ値

IPRule

名前 形容 価値
アクション Azure ネットワーク ACL アクション。 'Allow'
'Deny'
価値 IP または CIDR または ServiceTag 糸

LiveTraceCategory

名前 形容 価値
有効 ライブ トレース カテゴリが有効かどうかを示します。
使用可能な値: true、false。
大文字と小文字は区別されません。		 糸
名前 ライブ トレース カテゴリの名前を取得または設定します。
使用可能な値: ConnectivityLogs、MessagingLogs。
大文字と小文字は区別されません。		 糸

LiveTraceConfiguration

名前 形容 価値
カテゴリ カテゴリ構成の一覧を取得または設定します。 LiveTraceCategory[]
有効 ライブ トレースを有効にするかどうかを示します。
true に設定すると、ライブ トレース クライアントはサービスに接続できます。
それ以外の場合、ライブ トレース クライアントはサービスに接続できないため、"カテゴリ" で構成した内容に関係なく、ログを受信できなくなります。
使用可能な値: true、false。
大文字と小文字は区別されません。		 糸

ManagedIdentity

名前 形容 価値
種類 id の種類を表します: systemAssigned、userAssigned、None 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities ユーザー割り当て ID を取得または設定する ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

名前 形容 価値
資源 ターゲット リソースのアプリ ID URI を示すリソース。
また、発行されたトークンの aud (対象ユーザー) 要求にも表示されます。		 糸

ManagedIdentityUserAssignedIdentities

名前 形容 価値

Microsoft.SignalRService/signalR

名前 形容 価値
apiVersion API のバージョン '2024-01-01-preview'
同一性 クラスは、要求と応答に使用されるマネージド ID を表します ManagedIdentity
種類 サービスの種類 'RawWebSockets'
'SignalR'
場所 リソースが存在する地理的な場所 string (必須)
名前 リソース名 糸

制約：
最小長 = 3
最大長 = 3
パターン = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (必須)
プロパティ リソースのプロパティを記述するクラス SignalRProperties の
sku リソースの課金情報。 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 (必須)

ResourceLogCategory

名前 形容 価値
有効 リソース ログ カテゴリが有効かどうかを示します。
使用可能な値: true、false。
大文字と小文字は区別されません。		 糸
名前 リソース ログ カテゴリの名前を取得または設定します。
使用可能な値: ConnectivityLogs、MessagingLogs。
大文字と小文字は区別されません。		 糸

ResourceLogConfiguration

名前 形容 価値
カテゴリ カテゴリ構成の一覧を取得または設定します。 ResourceLogCategory[]

ResourceSku

名前 形容 価値
能力 省略可能、整数。 リソースの単位数。
Free_F1/Standard_S1/Premium_P1 の場合は 1、既定ではPremium_P2では 100。

存在する場合は、次の値を使用できます。
Free_F1: 1;
Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P2: 100,200,300,400,500,600,700,800,900,1000;		 int
名前 SKU の名前。 必須。

使用できる値: Standard_S1、Free_F1、Premium_P1、Premium_P2		 string (必須)
層 この特定の SKU のオプションレベル。 'Standard' または 'Free'。

非推奨の Basic は、代わりに Standard を使用してください。		 'Basic'
'Free'
'Premium'
'Standard'

ServerlessSettings

名前 形容 価値
connectionTimeoutInSeconds クライアント接続のタイムアウトを取得または設定します。 設定する省略可能。
秒単位の値。
既定値は 30 秒です。
メッセージが短い間隔で送信されることが予想される場合は、タイムアウトを短い期間に設定する必要があります。
最後のメッセージが送信された後、クライアントがより迅速に切断するようにします。
メッセージが長い間隔で送信されることが予想される場合は、タイムアウトを長い期間に設定できます。
このセッション中も同じクライアント接続を維持する必要があります。
この間隔でメッセージ (キープアライブを含む) を受信していない場合、サービスはクライアントが切断されたと見なします。		 int

制約：
最小値 = 1
最大値 = 120

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 Azure ネットワーク ACL アクション。 'Allow'
'Deny'
ipRules パブリック トラフィックをフィルター処理するための IP 規則 IPRule[]
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[]
liveTraceConfiguration Microsoft.SignalRService リソースのライブ トレース構成。 LiveTraceConfiguration
networkACLs リソースのネットワーク ACL SignalRNetwork ACL
publicNetworkAccess パブリック ネットワーク アクセスを有効または無効にします。 既定値は "Enabled" です。
有効になっている場合でも、ネットワーク ACL が適用されます。
無効にすると、ネットワーク ACL で設定した内容に関係なく、パブリック ネットワーク アクセスは常に無効になります。		 糸
regionEndpointEnabled リージョン エンドポイントを有効または無効にします。 既定値は "Enabled" です。
無効にすると、新しい接続はこのエンドポイントにルーティングされませんが、既存の接続は影響を受けなくなります。
このプロパティはレプリカ固有です。 レプリカのないリージョン エンドポイントを無効にすることはできません。		 糸
resourceLogConfiguration Microsoft.SignalRService リソースのリソース ログ構成。 ResourceLogConfiguration
resourceStopped リソースを停止または開始します。 既定値は "False" です。
true の場合、リソースのデータ プレーンはシャットダウンされます。
false の場合、リソースのデータ プレーンが開始されます。		 糸
サーバーレス サーバーレス設定。 ServerlessSettings
tls リソースの TLS 設定 SignalRTlsSettings
川上 サービスがサーバーレス モードの場合のアップストリームの設定。 ServerlessUpstreamSettings

SignalRTlsSettings

名前 形容 価値
clientCertEnabled TLS ハンドシェイク中にクライアント証明書を要求します (有効な場合)。 Free レベルではサポートされていません。 Free レベルでは、入力はすべて無視されます。 bool

TrackedResourceTags

名前 形容 価値

UpstreamAuthSettings

名前 形容 価値
managedIdentity アップストリームのマネージド ID 設定。 ManagedIdentitySettings
種類 アップストリーム認証の種類列挙型。 'ManagedIdentity'
'None'

UpstreamTemplate

名前 形容 価値
認証 アップストリーム認証設定。 設定しない場合、アップストリーム メッセージには認証は使用されません。 UpstreamAuthSettings の
categoryPattern カテゴリ名の一致パターンを取得または設定します。 設定されていない場合は、任意のカテゴリと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のカテゴリ名と一致します。
2. 複数のカテゴリを "," ("connections,messages" など) と組み合わせると、カテゴリ "connections" と "messages" と一致します。
3. 単一のカテゴリ名 ("connections" など) は、カテゴリ "connections" と一致します。		 糸
eventPattern イベント名の一致パターンを取得または設定します。 設定されていない場合は、任意のイベントと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のイベント名と一致します。
2. 複数のイベントを "," と組み合わせます(例: "connect,disconnect", it matches event "connect" and "disconnect")。
3. 単一のイベント名 ("connect" など)、"connect" と一致します。		 糸
hubPattern ハブ名の一致パターンを取得または設定します。 設定されていない場合は、任意のハブと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のハブ名と一致します。
2. 複数のハブを "," と組み合わせます(例: "hub1,hub2", it matches "hub1" and "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@2024-01-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"
        }
      ]
      liveTraceConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
        enabled = "string"
      }
      networkACLs = {
        defaultAction = "string"
        ipRules = [
          {
            action = "string"
            value = "string"
          }
        ]
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      regionEndpointEnabled = "string"
      resourceLogConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
      }
      resourceStopped = "string"
      serverless = {
        connectionTimeoutInSeconds = int
      }
      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"
  }
}

プロパティ値

IPRule

名前 形容 価値
アクション Azure ネットワーク ACL アクション。 'Allow'
'Deny'
価値 IP または CIDR または ServiceTag 糸

LiveTraceCategory

名前 形容 価値
有効 ライブ トレース カテゴリが有効かどうかを示します。
使用可能な値: true、false。
大文字と小文字は区別されません。		 糸
名前 ライブ トレース カテゴリの名前を取得または設定します。
使用可能な値: ConnectivityLogs、MessagingLogs。
大文字と小文字は区別されません。		 糸

LiveTraceConfiguration

名前 形容 価値
カテゴリ カテゴリ構成の一覧を取得または設定します。 LiveTraceCategory[]
有効 ライブ トレースを有効にするかどうかを示します。
true に設定すると、ライブ トレース クライアントはサービスに接続できます。
それ以外の場合、ライブ トレース クライアントはサービスに接続できないため、"カテゴリ" で構成した内容に関係なく、ログを受信できなくなります。
使用可能な値: true、false。
大文字と小文字は区別されません。		 糸

ManagedIdentity

名前 形容 価値
種類 id の種類を表します: systemAssigned、userAssigned、None 'None'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities ユーザー割り当て ID を取得または設定する ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

名前 形容 価値
資源 ターゲット リソースのアプリ ID URI を示すリソース。
また、発行されたトークンの aud (対象ユーザー) 要求にも表示されます。		 糸

ManagedIdentityUserAssignedIdentities

名前 形容 価値

Microsoft.SignalRService/signalR

名前 形容 価値
同一性 クラスは、要求と応答に使用されるマネージド ID を表します ManagedIdentity
種類 サービスの種類 'RawWebSockets'
'SignalR'
場所 リソースが存在する地理的な場所 string (必須)
名前 リソース名 糸

制約：
最小長 = 3
最大長 = 3
パターン = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (必須)
プロパティ リソースのプロパティを記述するクラス SignalRProperties の
sku リソースの課金情報。 ResourceSku
タグ リソース タグ タグ名と値のディクショナリ。
種類 リソースの種類 "Microsoft.SignalRService/signalR@2024-01-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 (必須)

ResourceLogCategory

名前 形容 価値
有効 リソース ログ カテゴリが有効かどうかを示します。
使用可能な値: true、false。
大文字と小文字は区別されません。		 糸
名前 リソース ログ カテゴリの名前を取得または設定します。
使用可能な値: ConnectivityLogs、MessagingLogs。
大文字と小文字は区別されません。		 糸

ResourceLogConfiguration

名前 形容 価値
カテゴリ カテゴリ構成の一覧を取得または設定します。 ResourceLogCategory[]

ResourceSku

名前 形容 価値
能力 省略可能、整数。 リソースの単位数。
Free_F1/Standard_S1/Premium_P1 の場合は 1、既定ではPremium_P2では 100。

存在する場合は、次の値を使用できます。
Free_F1: 1;
Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P2: 100,200,300,400,500,600,700,800,900,1000;		 int
名前 SKU の名前。 必須。

使用できる値: Standard_S1、Free_F1、Premium_P1、Premium_P2		 string (必須)
層 この特定の SKU のオプションレベル。 'Standard' または 'Free'。

非推奨の Basic は、代わりに Standard を使用してください。		 'Basic'
'Free'
'Premium'
'Standard'

ServerlessSettings

名前 形容 価値
connectionTimeoutInSeconds クライアント接続のタイムアウトを取得または設定します。 設定する省略可能。
秒単位の値。
既定値は 30 秒です。
メッセージが短い間隔で送信されることが予想される場合は、タイムアウトを短い期間に設定する必要があります。
最後のメッセージが送信された後、クライアントがより迅速に切断するようにします。
メッセージが長い間隔で送信されることが予想される場合は、タイムアウトを長い期間に設定できます。
このセッション中も同じクライアント接続を維持する必要があります。
この間隔でメッセージ (キープアライブを含む) を受信していない場合、サービスはクライアントが切断されたと見なします。		 int

制約：
最小値 = 1
最大値 = 120

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 Azure ネットワーク ACL アクション。 'Allow'
'Deny'
ipRules パブリック トラフィックをフィルター処理するための IP 規則 IPRule[]
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[]
liveTraceConfiguration Microsoft.SignalRService リソースのライブ トレース構成。 LiveTraceConfiguration
networkACLs リソースのネットワーク ACL SignalRNetwork ACL
publicNetworkAccess パブリック ネットワーク アクセスを有効または無効にします。 既定値は "Enabled" です。
有効になっている場合でも、ネットワーク ACL が適用されます。
無効にすると、ネットワーク ACL で設定した内容に関係なく、パブリック ネットワーク アクセスは常に無効になります。		 糸
regionEndpointEnabled リージョン エンドポイントを有効または無効にします。 既定値は "Enabled" です。
無効にすると、新しい接続はこのエンドポイントにルーティングされませんが、既存の接続は影響を受けなくなります。
このプロパティはレプリカ固有です。 レプリカのないリージョン エンドポイントを無効にすることはできません。		 糸
resourceLogConfiguration Microsoft.SignalRService リソースのリソース ログ構成。 ResourceLogConfiguration
resourceStopped リソースを停止または開始します。 既定値は "False" です。
true の場合、リソースのデータ プレーンはシャットダウンされます。
false の場合、リソースのデータ プレーンが開始されます。		 糸
サーバーレス サーバーレス設定。 ServerlessSettings
tls リソースの TLS 設定 SignalRTlsSettings
川上 サービスがサーバーレス モードの場合のアップストリームの設定。 ServerlessUpstreamSettings

SignalRTlsSettings

名前 形容 価値
clientCertEnabled TLS ハンドシェイク中にクライアント証明書を要求します (有効な場合)。 Free レベルではサポートされていません。 Free レベルでは、入力はすべて無視されます。 bool

TrackedResourceTags

名前 形容 価値

UpstreamAuthSettings

名前 形容 価値
managedIdentity アップストリームのマネージド ID 設定。 ManagedIdentitySettings
種類 アップストリーム認証の種類列挙型。 'ManagedIdentity'
'None'

UpstreamTemplate

名前 形容 価値
認証 アップストリーム認証設定。 設定しない場合、アップストリーム メッセージには認証は使用されません。 UpstreamAuthSettings の
categoryPattern カテゴリ名の一致パターンを取得または設定します。 設定されていない場合は、任意のカテゴリと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のカテゴリ名と一致します。
2. 複数のカテゴリを "," ("connections,messages" など) と組み合わせると、カテゴリ "connections" と "messages" と一致します。
3. 単一のカテゴリ名 ("connections" など) は、カテゴリ "connections" と一致します。		 糸
eventPattern イベント名の一致パターンを取得または設定します。 設定されていない場合は、任意のイベントと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のイベント名と一致します。
2. 複数のイベントを "," と組み合わせます(例: "connect,disconnect", it matches event "connect" and "disconnect")。
3. 単一のイベント名 ("connect" など)、"connect" と一致します。		 糸
hubPattern ハブ名の一致パターンを取得または設定します。 設定されていない場合は、任意のハブと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のハブ名と一致します。
2. 複数のハブを "," と組み合わせます(例: "hub1,hub2", it matches "hub1" and "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

名前 形容 価値