Microsoft.SignalRService signalR 2023-06-01-preview

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.SignalRService/signalR@2023-06-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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'
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
    }
    serverless: {
      connectionTimeoutInSeconds: int
    }
    tls: {
      clientCertEnabled: bool
    }
    upstream: {
      templates: [
        {
          auth: {
            managedIdentity: {
              resource: 'string'
            }
            type: 'string'
          }
          categoryPattern: 'string'
          eventPattern: 'string'
          hubPattern: 'string'
          urlTemplate: 'string'
        }
      ]
    }
  }
}

プロパティ値

signalR

名前 説明
name リソース名 string (必須)

文字数制限: 3 から 63

有効な文字:
英数字とハイフン。

文字で開始します。 文字または数字で終了します。

リソース名は、Azure 全体で一意である必要があります。
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
sku リソースの課金情報。 ResourceSku
kind サービスの種類 'RawWebSockets'
'SignalR'
identity クラスは、要求と応答に使用されるマネージド ID を表します ManagedIdentity
properties リソースのプロパティを記述するクラス SignalRProperties

ManagedIdentity

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

ManagedIdentityUserAssignedIdentities

名前 説明
{カスタマイズされたプロパティ} UserAssignedIdentityProperty

UserAssignedIdentityProperty

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

SignalRProperties

名前 説明
cors クロスオリジン リソース共有 (CORS) 設定。 SignalRCorsSettings
disableAadAuth DisableLocalAuth
aad 認証を有効または無効にする
true に設定すると、AuthType=aad との接続は機能しません。
[bool]
disableLocalAuth DisableLocalAuth
AccessKey を使用してローカル認証を有効または無効にする
true に設定すると、AccessKey=xxx との接続は機能しません。
[bool]
features featureFlags の一覧。

更新操作のパラメーターに含まれていない FeatureFlags は変更されません。
応答には、明示的に設定された featureFlags のみが含まれます。
featureFlag が明示的に設定されていない場合、グローバルな既定値が使用されます
ただし、既定値は "false" を意味するわけではない点に注意してください。 これは、異なる FeatureFlags の観点から異なります。
SignalRFeature[]
liveTraceConfiguration Microsoft.SignalRService リソースのライブ トレース構成。 LiveTraceConfiguration
networkACLs リソースのネットワーク ACL SignalRNetworkACLs
publicNetworkAccess パブリック ネットワーク アクセスを有効または無効にします。 既定値は "Enabled" です。
有効になっている場合でも、ネットワーク ACL が適用されます。
[無効] にすると、ネットワーク ACL で設定した内容に関係なく、パブリック ネットワーク アクセスは常に無効になります。
string
resourceLogConfiguration Microsoft.SignalRService リソースのリソース ログ構成。 ResourceLogConfiguration
サーバーレス サーバーレス設定。 ServerlessSettings
Tls リソースの TLS 設定 SignalRTlsSettings
アップストリーム サービスがサーバーレス モードの場合のアップストリームの設定。 ServerlessUpstreamSettings

SignalRCorsSettings

名前 説明
allowedOrigins クロスオリジン呼び出しを許可する必要がある配信元の一覧を取得または設定します (例: http://example.com:12345)。 すべてを許可するには "*" を使用します。 省略した場合は、既定ですべて許可します。 string[]

SignalRFeature

名前 説明
flag FeatureFlags は、Azure SignalR サービスでサポートされている機能です。
- ServiceMode: SignalR サービスのバックエンド サーバーにフラグを設定します。 使用できる値: "Default": 独自のバックエンド サーバーがあります。"サーバーレス": アプリケーションにバックエンド サーバーがありません。"クラシック": 下位互換性のため。 既定モードとサーバーレス モードの両方をサポートしますが、推奨されません。"PredefinedOnly": 将来使用します。
- EnableConnectivityLogs: "true"/"false"、接続ログ カテゴリをそれぞれ有効または無効にします。
- EnableMessagingLogs: "true"/"false"、接続ログ カテゴリをそれぞれ有効または無効にします。
- EnableLiveTrace: Live Trace を使用すると、Azure SignalR サービス内で何が起こっているかを知ることができます。リアルタイムでライブ トレースが提供されます。独自の Azure SignalR ベースの Web アプリケーションを開発したり、いくつかの問題を自己トラブルシューティングしたりする場合に役立ちます。 ライブ トレースは、課金される送信メッセージとしてカウントされることに注意してください。 使用可能な値: "true"/"false"。ライブ トレース機能を有効または無効にします。
'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'ServiceMode' (必須)
properties この機能に関連する省略可能なプロパティ。 SignalRFeatureProperties
value 機能フラグの値。 許可される値については、Azure SignalR サービスのドキュメントを参照してください https://docs.microsoft.com/azure/azure-signalr/ string (必須)

制約:
最小長 = 1
最大長 = 128

SignalRFeatureProperties

名前 説明
{カスタマイズされたプロパティ} string

LiveTraceConfiguration

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

LiveTraceCategory

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

SignalRNetworkACL

名前 説明
defaultAction Azure ネットワーク ACL アクション。 'Allow'
'Deny'
privateEndpoints プライベート エンドポイントからの要求の ACL PrivateEndpointACL[]
publicNetwork Network ACL NetworkACL

PrivateEndpointACL

名前 説明
allow 許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 次のいずれかを含む文字列配列:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
deny 拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 次のいずれかを含む文字列配列:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
name プライベート エンドポイント接続の名前 string (必須)

NetworkACL

名前 説明
allow 許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 次のいずれかを含む文字列配列:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
deny 拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 次のいずれかを含む文字列配列:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'

ResourceLogConfiguration

名前 説明
categories カテゴリ構成の一覧を取得または設定します。 ResourceLogCategory[]

ResourceLogCategory

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

ServerlessSettings

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

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

SignalRTlsSettings

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

ServerlessUpstreamSettings

名前 説明
テンプレート アップストリーム URL テンプレートの一覧を取得または設定します。 順序は重要であり、最初に一致するテンプレートが効果を受け取ります。 UpstreamTemplate[]

UpstreamTemplate

名前 説明
auth アップストリーム認証設定。 設定されていない場合、アップストリーム メッセージには認証は使用されません。 UpstreamAuthSettings
categoryPattern カテゴリ名の一致パターンを取得または設定します。 設定されていない場合は、任意のカテゴリと一致します。
次の 3 種類のパターンがサポートされています。
1. "*", それは、任意のカテゴリ名に一致します.
2. 複数のカテゴリを "," ("connections,messages" など) と組み合わせると、カテゴリ "connections" と "messages" と一致します。
3. 単一のカテゴリ名 ("connections"など) は、カテゴリ "connections" と一致します。
string
eventPattern イベント名の一致パターンを取得または設定します。 設定されていない場合は、任意のイベントと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のイベント名と一致します。
2.複数のイベントを "、"connect,disconnect" などと組み合わせると、イベント "connect" と "disconnect" と一致します。
3. 単一のイベント名 (例: "connect"、"connect" と一致します)。
string
hubPattern ハブ名の一致パターンを取得または設定します。 設定されていない場合は、任意のハブと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のハブ名と一致します。
2. 複数のハブを ","(たとえば"hub1,hub2") と組み合わせると、"hub1" と "hub2" と一致します。
3. 単一のハブ名 ("hub1" など) は、"hub1" と一致します。
string
urlTemplate アップストリーム URL テンプレートを取得または設定します。 テンプレート内で 3 つの定義済みパラメーター {hub}、{category} {event} を使用できます。アップストリーム URL の値は、クライアント要求が入ったときに動的に計算されます。
たとえば、urlTemplate が のhttp://example.com/{hub}/api/{event}場合、ハブchatからのクライアント要求が接続されると、最初に次の URL に POST されます。 http://example.com/chat/api/connect
string (必須)

UpstreamAuthSettings

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

ManagedIdentitySettings

名前 説明
resource ターゲット リソースのアプリ ID URI を示すリソース。
また、発行されたトークンの aud (対象ユーザー) 要求にも表示されます。
string

ResourceSku

名前 説明
capacity 省略可能、整数。 リソースの単位数。 既定では 1。

存在する場合は、次の値を使用できます。
無料: 1;
標準: 1,2,3,4,5,6,7,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
INT
name SKU の名前。 必須。

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

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

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
Azure SignalR サービスをデプロイする

Azure にデプロイする
このテンプレートは、テンプレートを使用してAzure SignalR Serviceを作成します。

ARM テンプレート リソース定義

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

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

リソース形式

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

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "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",
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "resourceLogConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ]
    },
    "serverless": {
      "connectionTimeoutInSeconds": "int"
    },
    "tls": {
      "clientCertEnabled": "bool"
    },
    "upstream": {
      "templates": [
        {
          "auth": {
            "managedIdentity": {
              "resource": "string"
            },
            "type": "string"
          },
          "categoryPattern": "string",
          "eventPattern": "string",
          "hubPattern": "string",
          "urlTemplate": "string"
        }
      ]
    }
  }
}

プロパティ値

signalR

名前 説明
type リソースの種類 'Microsoft.SignalRService/signalR'
apiVersion リソース API のバージョン '2023-06-01-preview'
name リソース名 string (必須)

文字制限: 3 から 63

有効な文字:
英数字とハイフン。

文字で開始します。 文字または数字で終了します。

リソース名は、Azure 全体で一意である必要があります。
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
sku リソースの課金情報。 ResourceSku
kind サービスの種類 'RawWebSockets'
'SignalR'
identity クラスは、要求と応答に使用されるマネージド ID を表します ManagedIdentity
properties リソースのプロパティを記述するクラス SignalRProperties

ManagedIdentity

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

ManagedIdentityUserAssignedIdentities

名前 説明
{カスタマイズされたプロパティ} UserAssignedIdentityProperty

UserAssignedIdentityProperty

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

SignalRProperties

名前 説明
cors クロスオリジン リソース共有 (CORS) 設定。 SignalRCorsSettings
disableAadAuth DisableLocalAuth
aad 認証を有効または無効にする
true に設定すると、AuthType=aad との接続は機能しません。
[bool]
disableLocalAuth DisableLocalAuth
AccessKey を使用してローカル認証を有効または無効にする
true に設定すると、AccessKey=xxx との接続は機能しません。
[bool]
features featureFlags の一覧。

更新操作のパラメーターに含まれていない FeatureFlags は変更されません。
応答には、明示的に設定された featureFlags のみが含まれます。
featureFlag が明示的に設定されていない場合、グローバルな既定値が使用されます
ただし、既定値は "false" を意味するわけではない点に注意してください。 これは、異なる FeatureFlags の観点から異なります。
SignalRFeature[]
liveTraceConfiguration Microsoft.SignalRService リソースのライブ トレース構成。 LiveTraceConfiguration
networkACLs リソースのネットワーク ACL SignalRNetworkACLs
publicNetworkAccess パブリック ネットワーク アクセスを有効または無効にします。 既定値は "Enabled" です。
有効にすると、ネットワーク ACL は引き続き適用されます。
[無効] にすると、ネットワーク ACL で設定した内容に関係なく、パブリック ネットワーク アクセスは常に無効になります。
string
resourceLogConfiguration Microsoft.SignalRService リソースのリソース ログ構成。 ResourceLogConfiguration
サーバーレス サーバーレス設定。 ServerlessSettings
Tls リソースの TLS 設定 SignalRTlsSettings
アップストリーム サービスがサーバーレス モードの場合のアップストリームの設定。 ServerlessUpstreamSettings

SignalRCorsSettings

名前 説明
allowedOrigins クロスオリジン呼び出しを許可する必要がある配信元の一覧を取得または設定します (例: http://example.com:12345)。 すべてを許可するには "*" を使用します。 省略した場合は、既定ですべての を許可します。 string[]

SignalRFeature

名前 説明
flag FeatureFlags は、Azure SignalR サービスでサポートされている機能です。
- ServiceMode: SignalR サービスのバックエンド サーバーのフラグ。 許可される値: "Default": 独自のバックエンド サーバーがあります。"サーバーレス": アプリケーションにバックエンド サーバーがありません。"クラシック": 下位互換性のため。 既定モードとサーバーレス モードの両方をサポートしますが、推奨されません。"PredefinedOnly": 将来の使用に使用します。
- EnableConnectivityLogs: "true"/"false"。接続ログ カテゴリをそれぞれ有効または無効にします。
- EnableMessagingLogs: "true"/"false"。接続ログ カテゴリをそれぞれ有効または無効にします。
- EnableLiveTrace: ライブ トレースを使用すると、Azure SignalR サービス内で何が起こっているかを知ることができます。リアルタイムでライブ トレースが提供されます。独自の Azure SignalR ベースの Web アプリケーションを開発したり、いくつかの問題を自己トラブルシューティングしたりする場合に役立ちます。 ライブ トレースは、課金される送信メッセージとしてカウントされることに注意してください。 許可される値: "true"/"false"。ライブ トレース機能を有効または無効にします。
'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'ServiceMode' (必須)
properties この機能に関連する省略可能なプロパティ。 SignalRFeatureProperties
value 機能フラグの値。 許可される値については、Azure SignalR サービスのドキュメントを参照してください https://docs.microsoft.com/azure/azure-signalr/ string (必須)

制約:
最小長 = 1
最大長 = 128

SignalRFeatureProperties

名前 説明
{カスタマイズされたプロパティ} string

LiveTraceConfiguration

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

LiveTraceCategory

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

SignalRNetworkACL

名前 説明
defaultAction Azure ネットワーク ACL アクション。 'Allow'
'Deny'
privateEndpoints プライベート エンドポイントからの要求の ACL PrivateEndpointACL[]
publicNetwork Network ACL NetworkACL

PrivateEndpointACL

名前 説明
allow 許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 次のいずれかを含む文字列配列:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
deny 拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 次のいずれかを含む文字列配列:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
name プライベート エンドポイント接続の名前 string (必須)

NetworkACL

名前 説明
allow 許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 次のいずれかを含む文字列配列:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
deny 拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 次のいずれかを含む文字列配列:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'

ResourceLogConfiguration

名前 説明
categories カテゴリ構成の一覧を取得または設定します。 ResourceLogCategory[]

ResourceLogCategory

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

ServerlessSettings

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

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

SignalRTlsSettings

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

ServerlessUpstreamSettings

名前 説明
テンプレート アップストリーム URL テンプレートの一覧を取得または設定します。 順序は重要であり、最初に一致するテンプレートが効果を受け取ります。 UpstreamTemplate[]

UpstreamTemplate

名前 説明
auth アップストリーム認証設定。 設定されていない場合、アップストリーム メッセージには認証は使用されません。 UpstreamAuthSettings
categoryPattern カテゴリ名の一致パターンを取得または設定します。 設定されていない場合は、任意のカテゴリと一致します。
次の 3 種類のパターンがサポートされています。
1. "*", それは、任意のカテゴリ名に一致します.
2. 複数のカテゴリを "," ("connections,messages" など) と組み合わせると、カテゴリ "connections" と "messages" と一致します。
3. 単一のカテゴリ名 ("connections"など) は、カテゴリ "connections" と一致します。
string
eventPattern イベント名の一致パターンを取得または設定します。 設定されていない場合は、任意のイベントと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のイベント名と一致します。
2.複数のイベントを "、"connect,disconnect" などと組み合わせると、イベント "connect" と "disconnect" と一致します。
3. 単一のイベント名 (例: "connect"、"connect" と一致します)。
string
hubPattern ハブ名の一致パターンを取得または設定します。 設定されていない場合は、任意のハブと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のハブ名と一致します。
2. 複数のハブを ","(たとえば"hub1,hub2") と組み合わせると、"hub1" と "hub2" と一致します。
3. 単一のハブ名 ("hub1" など) は、"hub1" と一致します。
string
urlTemplate アップストリーム URL テンプレートを取得または設定します。 テンプレート内で 3 つの定義済みパラメーター {hub}、{category} {event} を使用できます。アップストリーム URL の値は、クライアント要求が入ったときに動的に計算されます。
たとえば、urlTemplate が のhttp://example.com/{hub}/api/{event}場合、ハブchatからのクライアント要求が接続されると、最初に次の URL に POST されます。 http://example.com/chat/api/connect
string (必須)

UpstreamAuthSettings

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

ManagedIdentitySettings

名前 説明
resource ターゲット リソースのアプリ ID URI を示すリソース。
また、発行されたトークンの aud (対象ユーザー) 要求にも表示されます。
string

ResourceSku

名前 説明
capacity 省略可能、整数。 リソースの単位数。 既定では 1。

存在する場合は、次の値を使用できます。
無料: 1;
標準: 1,2,3,4,5,6,7,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
INT
name SKU の名前。 必須。

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

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

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
Azure SignalR サービスをデプロイする

Azure にデプロイする
このテンプレートは、テンプレートを使用してAzure SignalR Serviceを作成します。

Terraform (AzAPI プロバイダー) リソース定義

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR@2023-06-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  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"
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      resourceLogConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "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"
    }
    kind = "string"
  })
}

プロパティ値

signalR

名前 説明
type リソースの種類 "Microsoft.SignalRService/signalR@2023-06-01-preview"
name リソース名 string (必須)

文字数制限: 3 から 63

有効な文字:
英数字とハイフン。

文字で開始します。 文字または数字で終了します。

リソース名は、Azure 全体で一意である必要があります。
location リソースが保存されている地理的な場所 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。
sku リソースの課金情報。 ResourceSku
kind サービスの種類 "RawWebSockets"
"SignalR"
identity クラスは、要求と応答に使用されるマネージド ID を表します ManagedIdentity
properties リソースのプロパティを記述するクラス SignalRProperties

ManagedIdentity

名前 説明
type id の種類を表します: systemAssigned、userAssigned、None "SystemAssigned"
"UserAssigned"
identity_ids ユーザー割り当て ID を取得または設定する ユーザー ID ID の配列。

ManagedIdentityUserAssignedIdentities

名前 説明
{カスタマイズされたプロパティ} UserAssignedIdentityProperty

UserAssignedIdentityProperty

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

SignalRProperties

名前 説明
cors クロスオリジン リソース共有 (CORS) 設定。 SignalRCorsSettings
disableAadAuth DisableLocalAuth
aad 認証を有効または無効にする
true に設定すると、AuthType=aad との接続は機能しません。
[bool]
disableLocalAuth DisableLocalAuth
AccessKey を使用してローカル認証を有効または無効にする
true に設定すると、AccessKey=xxx との接続は機能しません。
[bool]
features featureFlags の一覧。

更新操作のパラメーターに含まれていない FeatureFlags は変更されません。
また、応答には、明示的に設定された featureFlags のみが含まれます。
featureFlag が明示的に設定されていない場合、そのグローバルな既定値が使用されます
ただし、既定値は "false" を意味するものではありません。 FeatureFlags によって異なります。
SignalRFeature[]
liveTraceConfiguration Microsoft.SignalRService リソースのライブ トレース構成。 LiveTraceConfiguration
networkACLs リソースのネットワーク ACL SignalRNetworkACL
publicNetworkAccess パブリック ネットワーク アクセスを有効または無効にします。 既定値は "Enabled" です。
有効にすると、ネットワーク ACL は引き続き適用されます。
[無効] にすると、ネットワーク ACL で設定した内容に関係なく、パブリック ネットワーク アクセスは常に無効になります。
string
resourceLogConfiguration Microsoft.SignalRService リソースのリソース ログ構成。 ResourceLogConfiguration
サーバーレス サーバーレス設定。 ServerlessSettings
Tls リソースの TLS 設定 SignalRTlsSettings
アップストリーム サービスがサーバーレス モードの場合のアップストリームの設定。 ServerlessUpstreamSettings

SignalRCorsSettings

名前 説明
allowedOrigins クロスオリジン呼び出しを許可する必要がある配信元の一覧を取得または設定します (例: http://example.com:12345)。 すべてを許可するには "*" を使用します。 省略した場合は、既定ですべて許可します。 string[]

SignalRFeature

名前 説明
flag FeatureFlags は、Azure SignalR サービスでサポートされている機能です。
- ServiceMode: SignalR サービスのバックエンド サーバーにフラグを設定します。 使用できる値: "Default": 独自のバックエンド サーバーがあります。"サーバーレス": アプリケーションにバックエンド サーバーがありません。"クラシック": 下位互換性のため。 既定モードとサーバーレス モードの両方をサポートしますが、推奨されません。"PredefinedOnly": 将来使用します。
- EnableConnectivityLogs: "true"/"false"、接続ログ カテゴリをそれぞれ有効または無効にします。
- EnableMessagingLogs: "true"/"false"、接続ログ カテゴリをそれぞれ有効または無効にします。
- EnableLiveTrace: Live Trace を使用すると、Azure SignalR サービス内で何が起こっているかを知ることができます。リアルタイムでライブ トレースが提供されます。独自の Azure SignalR ベースの Web アプリケーションを開発したり、いくつかの問題を自己トラブルシューティングしたりする場合に役立ちます。 ライブ トレースは、課金される送信メッセージとしてカウントされることに注意してください。 使用可能な値: "true"/"false"。ライブ トレース機能を有効または無効にします。
"EnableConnectivityLogs"
"EnableLiveTrace"
"EnableMessagingLogs"
"ServiceMode" (必須)
properties この機能に関連する省略可能なプロパティ。 SignalRFeatureProperties
value 機能フラグの値。 許可される値については、Azure SignalR サービスのドキュメントを参照してください https://docs.microsoft.com/azure/azure-signalr/ string (必須)

制約:
最小長 = 1
最大長 = 128

SignalRFeatureProperties

名前 説明
{カスタマイズされたプロパティ} string

LiveTraceConfiguration

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

LiveTraceCategory

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

SignalRNetworkACLs

名前 説明
defaultAction Azure ネットワーク ACL アクション。 "許可"
"Deny"
privateEndpoints プライベート エンドポイントからの要求の ACL PrivateEndpointACL[]
publicNetwork Network ACL NetworkACL

PrivateEndpointACL

名前 説明
allow 許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 次のいずれかを含む文字列配列:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Trace"
deny 拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 次のいずれかを含む文字列配列:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Trace"
name プライベート エンドポイント接続の名前 string (必須)

NetworkACL

名前 説明
allow 許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 次のいずれかを含む文字列配列:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Trace"
deny 拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。 次のいずれかを含む文字列配列:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Trace"

ResourceLogConfiguration

名前 説明
categories カテゴリ構成の一覧を取得または設定します。 ResourceLogCategory[]

ResourceLogCategory

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

ServerlessSettings

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

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

SignalRTlsSettings

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

ServerlessUpstreamSettings

名前 説明
テンプレート アップストリーム URL テンプレートの一覧を取得または設定します。 順序は重要であり、最初に一致するテンプレートが効果を受け取ります。 UpstreamTemplate[]

UpstreamTemplate

名前 説明
auth アップストリーム認証設定。 設定されていない場合、アップストリーム メッセージには認証は使用されません。 UpstreamAuthSettings
categoryPattern カテゴリ名の一致パターンを取得または設定します。 設定されていない場合は、任意のカテゴリと一致します。
次の 3 種類のパターンがサポートされています。
1. "*", それは任意のカテゴリ名に一致します.
2. 複数のカテゴリを "," と組み合わせます(例: "connections,messages", it matches category "connections" and "messages")。
3. 単一のカテゴリ名 ("connections"など) は、カテゴリ "connections" と一致します。
string
eventPattern イベント名の一致パターンを取得または設定します。 設定されていない場合は、任意のイベントと一致します。
次の 3 種類のパターンがサポートされています。
1. "*", それは、任意のイベント名に一致します.
2. 複数のイベントを "," と組み合わせます(例: "connect,disconnect", it matches event "connect" and "disconnect")。
3. 単一のイベント名 ("connect" など) は、"connect" と一致します。
string
hubPattern ハブ名の一致パターンを取得または設定します。 設定されていない場合は、任意のハブと一致します。
次の 3 種類のパターンがサポートされています。
1. "*" は、任意のハブ名と一致します。
2. 複数のハブを "," と組み合わせます。たとえば、"hub1,hub2" のように、"hub1" と "hub2" と一致します。
3. 1 つのハブ名 ("hub1" など) は、"hub1" と一致します。
string
urlTemplate アップストリーム URL テンプレートを取得または設定します。 テンプレート内には 3 つの定義済みパラメーター {hub}、{category} {event} を使用できます。アップストリーム URL の値は、クライアント要求が入ったときに動的に計算されます。
たとえば、urlTemplate が のhttp://example.com/{hub}/api/{event}場合、ハブchatからのクライアント要求が接続されると、最初に次の URL に POST されます。 http://example.com/chat/api/connect
string (必須)

UpstreamAuthSettings

名前 説明
managedIdentity アップストリームのマネージド ID 設定。 ManagedIdentitySettings
アップストリーム認証の種類列挙型。 "ManagedIdentity"
"None"

ManagedIdentitySettings

名前 説明
resource ターゲット リソースのアプリ ID URI を示すリソース。
また、発行されたトークンの aud (対象ユーザー) 要求にも表示されます。
string

ResourceSku

名前 説明
capacity 省略可能、整数。 リソースの単位数。 既定では 1 です。

存在する場合は、次の値を使用できます。
無料: 1;
標準: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
INT
name SKU の名前。 必須。

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

Basic は非推奨です。代わりに Standard を使用してください。
"Basic"
"Free"
"Premium"
"Standard"