Bagikan melalui


Microsoft.SignalRService signalR

Definisi sumber daya Bicep

Jenis sumber daya signalR dapat disebarkan dengan operasi yang menargetkan:

  • Grup sumber daya - Lihat perintah penyebaran grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.SignalRService/signalR, tambahkan Bicep berikut ke templat Anda.

resource symbolicname 'Microsoft.SignalRService/signalR@2024-08-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    applicationFirewall: {
      clientConnectionCountRules: [
        {
          type: 'string'
          // For remaining properties, see ClientConnectionCountRule objects
        }
      ]
    }
    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'
  }
}

Objek ClientConnectionCountRule

Atur properti jenis untuk menentukan jenis objek.

Untuk ThrottleByJwtCustomClaimRule, gunakan:

{
  claimName: 'string'
  maxCount: int
  type: 'ThrottleByJwtCustomClaimRule'
}

Untuk ThrottleByJwtSignatureRule, gunakan:

{
  maxCount: int
  type: 'ThrottleByJwtSignatureRule'
}

UntukThrottleByUserIdRule , gunakan:

{
  maxCount: int
  type: 'ThrottleByUserIdRule'
}

Nilai properti

ApplicationFirewallSettings

Nama Deskripsi Nilai
clientConnectionCountRules Aturan untuk mengontrol jumlah koneksi klien ClientConnectionCountRule[]

ClientConnectionCountRule

Nama Deskripsi Nilai
jenis Atur ke 'ThrottleByJwtCustomClaimRule' untuk jenis ThrottleByJwtCustomClaimRule. Atur ke 'ThrottleByJwtSignatureRule' untuk jenis ThrottleByJwtSignatureRule. Atur ke 'ThrottleByUserIdRule' untuk jenis ThrottleByUserIdRule. 'ThrottleByJwtCustomClaimRule'
'ThrottleByJwtSignatureRule'
'ThrottleByUserIdRule' (diperlukan)

IPRule

Nama Deskripsi Nilai
perbuatan Tindakan Azure Networking ACL. 'Izinkan'
'Tolak'
nilai IP atau CIDR atau ServiceTag tali

LiveTraceCategory

Nama Deskripsi Nilai
Diaktifkan Menunjukkan apakah atau kategori pelacakan langsung diaktifkan.
Nilai yang tersedia: true, false.
Tidak peka huruf besar/kecil.
tali
Nama Mendapatkan atau mengatur nama kategori pelacakan langsung.
Nilai yang tersedia: ConnectivityLogs, MessagingLogs.
Tidak peka huruf besar/kecil.
tali

LiveTraceConfiguration

Nama Deskripsi Nilai
Kategori Mendapatkan atau mengatur daftar konfigurasi kategori. LiveTraceCategory[]
Diaktifkan Menunjukkan apakah pelacakan langsung diaktifkan atau tidak.
Ketika diatur ke true, klien pelacakan langsung dapat terhubung ke layanan.
Jika tidak, klien pelacakan langsung tidak dapat terhubung ke layanan, sehingga Anda tidak dapat menerima log apa pun, apa pun yang Anda konfigurasi dalam "kategori".
Nilai yang tersedia: true, false.
Tidak peka huruf besar/kecil.
tali

ManagedIdentity

Nama Deskripsi Nilai
jenis Mewakili jenis identitas: systemAssigned, userAssigned, None 'Tidak Ada'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Mendapatkan atau mengatur identitas yang ditetapkan pengguna ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Nama Deskripsi Nilai
Sumber daya Sumber Daya yang menunjukkan URI ID Aplikasi dari sumber daya target.
Ini juga muncul dalam klaim aud (audiens) dari token yang dikeluarkan.
tali

ManagedIdentityUserAssignedIdentities

Nama Deskripsi Nilai

Microsoft.SignalRService/signalR

Nama Deskripsi Nilai
identitas Kelas mewakili identitas terkelola yang digunakan untuk permintaan dan respons ManagedIdentity
jenis Jenis layanan 'RawWebSockets'
'SignalR'
tempat Lokasi geografis tempat sumber daya berada string (diperlukan)
Nama Nama sumber daya tali

Kendala:
Panjang min = 3
Panjang maksimum = 3
Pola = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (diperlukan)
Properti Kelas yang menjelaskan properti sumber daya SignalRProperties
Sku Informasi penagihan sumber daya. ResourceSku
Tags Tag sumber daya Kamus nama dan nilai tag. Lihat Tag dalam templat

NetworkACL

Nama Deskripsi Nilai
memperbolehkan Jenis permintaan yang diizinkan. Nilainya bisa satu atau beberapa dari: ClientConnection, ServerConnection, RESTAPI. Array string yang berisi salah satu dari:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Lacak'
menyangkal Jenis permintaan yang ditolak. Nilainya bisa satu atau beberapa dari: ClientConnection, ServerConnection, RESTAPI. Array string yang berisi salah satu dari:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Lacak'

PrivateEndpointACL

Nama Deskripsi Nilai
memperbolehkan Jenis permintaan yang diizinkan. Nilainya bisa satu atau beberapa dari: ClientConnection, ServerConnection, RESTAPI. Array string yang berisi salah satu dari:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Lacak'
menyangkal Jenis permintaan yang ditolak. Nilainya bisa satu atau beberapa dari: ClientConnection, ServerConnection, RESTAPI. Array string yang berisi salah satu dari:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Lacak'
Nama Nama koneksi titik akhir privat string (diperlukan)

ResourceLogCategory

Nama Deskripsi Nilai
Diaktifkan Menunjukkan apakah atau kategori log sumber daya diaktifkan.
Nilai yang tersedia: true, false.
Tidak peka huruf besar/kecil.
tali
Nama Mendapatkan atau mengatur nama kategori log sumber daya.
Nilai yang tersedia: ConnectivityLogs, MessagingLogs.
Tidak peka huruf besar/kecil.
tali

ResourceLogConfiguration

Nama Deskripsi Nilai
Kategori Mendapatkan atau mengatur daftar konfigurasi kategori. ResourceLogCategory[]

ResourceSku

Nama Deskripsi Nilai
kapasitas Opsional, bilangan bulat. Jumlah unit sumber daya.
1 untuk Free_F1/Standard_S1/Premium_P1, 100 untuk Premium_P2 secara default.

Jika ada, nilai berikut diizinkan:
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
Nama Nama SKU. Diperlukan.

Nilai yang diizinkan: Standard_S1, Free_F1, Premium_P1, Premium_P2
string (diperlukan)
Tier Tingkat opsional dari SKU khusus ini. 'Standar' atau 'Gratis'.

Basic tidak digunakan lagi, gunakan Standard sebagai gantinya.
'Dasar'
'Gratis'
'Premium'
'Standar'

ServerlessSettings

Nama Deskripsi Nilai
connectionTimeoutInSeconds Mendapatkan atau mengatur Batas Waktu Koneksi Klien. Opsional untuk diatur.
Nilai dalam detik.
Nilai defaultnya adalah 30 detik.
Pelanggan harus mengatur batas waktu ke periode yang lebih singkat jika pesan diharapkan dikirim dalam interval yang lebih pendek,
dan ingin klien terputus lebih cepat setelah pesan terakhir dikirim.
Anda dapat mengatur batas waktu ke periode yang lebih lama jika pesan diharapkan dikirim dalam interval yang lebih lama,
dan mereka ingin menjaga koneksi klien yang sama tetap hidup selama sesi ini.
Layanan mempertimbangkan klien terputus jika belum menerima pesan (termasuk tetap hidup) dalam interval ini.
Int

Kendala:
Nilai min = 1
Nilai maks = 120

ServerlessUpstreamSettings

Nama Deskripsi Nilai
Template Mendapatkan atau mengatur daftar templat URL Upstream. Masalah pesanan, dan templat pencocokan pertama mengambil efek. UpstreamTemplate []

SignalRCorsSettings

Nama Deskripsi Nilai
allowedOrigins Mendapatkan atau mengatur daftar asal yang harus diizinkan untuk melakukan panggilan lintas asal (misalnya: http://example.com:12345). Gunakan "*" untuk mengizinkan semua. Jika dihilangkan, izinkan semua secara default. string[]

SignalRFeature

Nama Deskripsi Nilai
bendera FeatureFlags adalah fitur yang didukung dari layanan Azure SignalR.
- ServiceMode: Bendera untuk server backend untuk layanan SignalR. Nilai yang diizinkan: "Default": memiliki server backend Anda sendiri; "Tanpa Server": aplikasi Anda tidak memiliki server backend; "Klasik": untuk kompatibilitas mundur. Mendukung mode Default dan Tanpa Server tetapi tidak disarankan; "PredefinedOnly": untuk penggunaan di masa mendatang.
- EnableConnectivityLogs: "true"/"false", untuk mengaktifkan/menonaktifkan kategori log konektivitas masing-masing.
- EnableMessagingLogs: "true"/"false", untuk mengaktifkan/menonaktifkan kategori log konektivitas masing-masing.
- EnableLiveTrace: Live Trace memungkinkan Anda mengetahui apa yang terjadi di dalam layanan Azure SignalR, itu akan memberi Anda jejak langsung secara real time, akan sangat membantu ketika Anda mengembangkan aplikasi web berbasis Azure SignalR Anda sendiri atau memecahkan masalah sendiri beberapa masalah. Harap dicatat bahwa jejak langsung dihitung sebagai pesan keluar yang akan dikenakan biaya. Nilai yang diizinkan: "true"/"false", untuk mengaktifkan/menonaktifkan fitur pelacakan langsung.
'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'ServiceMode' (diperlukan)
Properti Properti opsional yang terkait dengan fitur ini. SignalRFeatureProperties
nilai Nilai bendera fitur. Lihat Dokumen layanan Azure SignalR /azure/azure-signalr/ untuk nilai yang diizinkan. tali

Kendala:
Panjang min = 1
Panjang maksimum = 1 (diperlukan)

SignalRFeatureProperties

Nama Deskripsi Nilai

SignalRNetworkACLs

Nama Deskripsi Nilai
defaultAction Tindakan Azure Networking ACL. 'Izinkan'
'Tolak'
ipRules Aturan IP untuk memfilter lalu lintas publik IPRule []
privateEndpoints ACL untuk permintaan dari titik akhir privat PrivateEndpointACL[]
publicNetwork ACL Jaringan NetworkACL

SignalRProperties

Nama Deskripsi Nilai
applicationFirewall Pengaturan firewall aplikasi untuk sumber daya ApplicationFirewallSettings
cors Pengaturan Berbagi Sumber Daya Lintas Asal (CORS). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Mengaktifkan atau menonaktifkan autentikasi aad
Saat diatur sebagai true, koneksi dengan AuthType=aad tidak akan berfungsi.
bool
disableLocalAuth DisableLocalAuth
Mengaktifkan atau menonaktifkan autentikasi lokal dengan AccessKey
Ketika diatur sebagai true, koneksi dengan AccessKey=xxx tidak akan berfungsi.
bool
Fitur Daftar fiturFlags.

FeatureFlags yang tidak disertakan dalam parameter untuk operasi pembaruan tidak akan dimodifikasi.
Dan respons hanya akan mencakup featureFlags yang secara eksplisit diatur.
Ketika featureFlag tidak diatur secara eksplisit, nilai default globalnya akan digunakan
Tetapi perlu diingat, nilai default tidak berarti "false". Ini bervariasi dalam hal FiturFlags yang berbeda.
SignalRFeature[]
liveTraceConfiguration Konfigurasi pelacakan langsung sumber daya Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACL jaringan untuk sumber daya SignalRNetworkACLs
publicNetworkAccess Mengaktifkan atau menonaktifkan akses jaringan publik. Default ke "Diaktifkan".
Saat Diaktifkan, ACL jaringan masih berlaku.
Saat Dinonaktifkan, akses jaringan publik selalu dinonaktifkan apa pun yang Anda tetapkan di ACL jaringan.
tali
regionEndpointEnabled Aktifkan atau nonaktifkan titik akhir regional. Default ke "Diaktifkan".
Ketika Dinonaktifkan, koneksi baru tidak akan dirutekan ke titik akhir ini, namun koneksi yang ada tidak akan terpengaruh.
Properti ini spesifik untuk replika. Nonaktifkan titik akhir regional tanpa replika tidak diperbolehkan.
tali
resourceLogConfiguration Konfigurasi log sumber daya sumber daya sumber daya Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Hentikan atau mulai sumber daya. Default ke "False".
Jika benar, bidang data sumber daya dimatikan.
Saat salah, bidang data sumber daya dimulai.
tali
tanpa server Pengaturan tanpa server. ServerlessSettings
tls Pengaturan TLS untuk sumber daya SignalRTlsSettings
hulu Pengaturan untuk Upstream saat layanan dalam mode tanpa server. ServerlessUpstreamSettings

SignalRTlsSettings

Nama Deskripsi Nilai
clientCertEnabled Minta sertifikat klien selama jabat tangan TLS jika diaktifkan. Tidak didukung untuk tingkat gratis. Input apa pun akan diabaikan untuk tingkat gratis. bool

ThrottleByJwtCustomClaimRule

Nama Deskripsi Nilai
claimName Nama klaim dalam token JWT. Koneksi klien dengan nilai klaim yang sama akan diagregasi. Jika klaim tidak ditemukan dalam token, koneksi akan diizinkan. string (diperlukan)
maxCount Jumlah koneksi maksimum yang diizinkan untuk nilai klaim Jwt yang sama. Klien dengan klaim Jwt yang sama akan ditolak jika jumlah koneksi melebihi nilai ini. Nilai defaultnya adalah 20. Int

Kendala:
Nilai min = 0
Nilai maks = 2147483647
jenis 'ThrottleByJwtCustomClaimRule' (diperlukan)

ThrottleByJwtSignatureRule

Nama Deskripsi Nilai
maxCount Jumlah koneksi maksimum yang diizinkan untuk tanda tangan JWT yang sama. Klien dengan tanda tangan JWT yang sama akan ditolak jika jumlah koneksi melebihi nilai ini. Nilai defaultnya adalah 20. Int

Kendala:
Nilai min = 0
Nilai maks = 2147483647
jenis 'ThrottleByJwtSignatureRule' (diperlukan)

ThrottleByUserIdRule

Nama Deskripsi Nilai
maxCount Jumlah koneksi maksimum yang diizinkan untuk ID pengguna yang sama. Klien dengan ID pengguna yang sama akan ditolak jika jumlah koneksi melebihi nilai ini. Nilai defaultnya adalah 20. Int

Kendala:
Nilai min = 0
Nilai maks = 2147483647
jenis 'ThrottleByUserIdRule' (diperlukan)

TrackedResourceTags

Nama Deskripsi Nilai

UpstreamAuthSettings

Nama Deskripsi Nilai
managedIdentity Pengaturan identitas terkelola untuk upstream. ManagedIdentitySettings
jenis Enum jenis autentikasi upstream. 'ManagedIdentity'
'Tidak Ada'

UpstreamTemplate

Nama Deskripsi Nilai
Auth Pengaturan autentikasi upstream. Jika tidak diatur, tidak ada autentikasi yang digunakan untuk pesan upstram. UpstreamAuthSettings
categoryPattern Mendapatkan atau mengatur pola yang cocok untuk nama kategori. Jika tidak diatur, ini cocok dengan kategori apa pun.
Ada 3 jenis pola yang didukung:
1. "*", cocok dengan nama kategori apa pun.
2. Gabungkan beberapa kategori dengan ",", misalnya "koneksi,pesan", cocok dengan kategori "koneksi" dan "pesan".
3. Nama kategori tunggal, misalnya, "koneksi", cocok dengan kategori "koneksi".
tali
eventPattern Mendapatkan atau mengatur pola yang cocok untuk nama peristiwa. Jika tidak diatur, ini cocok dengan peristiwa apa pun.
Ada 3 jenis pola yang didukung:
1. "*", untuk mencocokkan nama peristiwa apa pun.
2. Gabungkan beberapa peristiwa dengan ",", misalnya "connect,disconnect", cocok dengan event "connect" dan "disconnect".
3. Nama peristiwa tunggal, misalnya, "connect", cocok dengan "connect".
tali
hubPattern Mendapatkan atau mengatur pola yang cocok untuk nama hub. Jika tidak diatur, itu cocok dengan hub apa pun.
Ada 3 jenis pola yang didukung:
1. "*", agar sesuai dengan nama hub apa pun.
2. Gabungkan beberapa hub dengan ",", misalnya "hub1,hub2", cocok dengan "hub1" dan "hub2".
3. Nama hub tunggal, misalnya, "hub1", cocok dengan "hub1".
tali
urlTemplate Mendapatkan atau mengatur templat URL Upstream. Anda dapat menggunakan 3 parameter yang telah ditentukan sebelumnya {hub}, {category} {event} di dalam templat, nilai URL Upstream dihitung secara dinamis saat permintaan klien masuk.
Misalnya, jika urlTemplate http://example.com/{hub}/api/{event}, dengan permintaan klien dari hub chat tersambung, pertama-tama akan POST ke URL ini: http://example.com/chat/api/connect.
string (diperlukan)

UserAssignedIdentityProperty

Nama Deskripsi Nilai

Sampel mulai cepat

Sampel mulai cepat berikut menyebarkan jenis sumber daya ini.

Bicep File Deskripsi
Menyebarkan layanan Azure SignalR Templat ini membuat Azure SignalR Service menggunakan templat.

Definisi sumber daya templat ARM

Jenis sumber daya signalR dapat disebarkan dengan operasi yang menargetkan:

  • Grup sumber daya - Lihat perintah penyebaran grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.SignalRService/signalR, tambahkan JSON berikut ke templat Anda.

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2024-08-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "applicationFirewall": {
      "clientConnectionCountRules": [ {
        "type": "string"
        // For remaining properties, see ClientConnectionCountRule objects
      } ]
    },
    "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"
  }
}

Objek ClientConnectionCountRule

Atur properti jenis untuk menentukan jenis objek.

Untuk ThrottleByJwtCustomClaimRule, gunakan:

{
  "claimName": "string",
  "maxCount": "int",
  "type": "ThrottleByJwtCustomClaimRule"
}

Untuk ThrottleByJwtSignatureRule, gunakan:

{
  "maxCount": "int",
  "type": "ThrottleByJwtSignatureRule"
}

UntukThrottleByUserIdRule , gunakan:

{
  "maxCount": "int",
  "type": "ThrottleByUserIdRule"
}

Nilai properti

ApplicationFirewallSettings

Nama Deskripsi Nilai
clientConnectionCountRules Aturan untuk mengontrol jumlah koneksi klien ClientConnectionCountRule[]

ClientConnectionCountRule

Nama Deskripsi Nilai
jenis Atur ke 'ThrottleByJwtCustomClaimRule' untuk jenis ThrottleByJwtCustomClaimRule. Atur ke 'ThrottleByJwtSignatureRule' untuk jenis ThrottleByJwtSignatureRule. Atur ke 'ThrottleByUserIdRule' untuk jenis ThrottleByUserIdRule. 'ThrottleByJwtCustomClaimRule'
'ThrottleByJwtSignatureRule'
'ThrottleByUserIdRule' (diperlukan)

IPRule

Nama Deskripsi Nilai
perbuatan Tindakan Azure Networking ACL. 'Izinkan'
'Tolak'
nilai IP atau CIDR atau ServiceTag tali

LiveTraceCategory

Nama Deskripsi Nilai
Diaktifkan Menunjukkan apakah atau kategori pelacakan langsung diaktifkan.
Nilai yang tersedia: true, false.
Tidak peka huruf besar/kecil.
tali
Nama Mendapatkan atau mengatur nama kategori pelacakan langsung.
Nilai yang tersedia: ConnectivityLogs, MessagingLogs.
Tidak peka huruf besar/kecil.
tali

LiveTraceConfiguration

Nama Deskripsi Nilai
Kategori Mendapatkan atau mengatur daftar konfigurasi kategori. LiveTraceCategory[]
Diaktifkan Menunjukkan apakah pelacakan langsung diaktifkan atau tidak.
Ketika diatur ke true, klien pelacakan langsung dapat terhubung ke layanan.
Jika tidak, klien pelacakan langsung tidak dapat terhubung ke layanan, sehingga Anda tidak dapat menerima log apa pun, apa pun yang Anda konfigurasi dalam "kategori".
Nilai yang tersedia: true, false.
Tidak peka huruf besar/kecil.
tali

ManagedIdentity

Nama Deskripsi Nilai
jenis Mewakili jenis identitas: systemAssigned, userAssigned, None 'Tidak Ada'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Mendapatkan atau mengatur identitas yang ditetapkan pengguna ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Nama Deskripsi Nilai
Sumber daya Sumber Daya yang menunjukkan URI ID Aplikasi dari sumber daya target.
Ini juga muncul dalam klaim aud (audiens) dari token yang dikeluarkan.
tali

ManagedIdentityUserAssignedIdentities

Nama Deskripsi Nilai

Microsoft.SignalRService/signalR

Nama Deskripsi Nilai
apiVersion Versi api '2024-08-01-preview'
identitas Kelas mewakili identitas terkelola yang digunakan untuk permintaan dan respons ManagedIdentity
jenis Jenis layanan 'RawWebSockets'
'SignalR'
tempat Lokasi geografis tempat sumber daya berada string (diperlukan)
Nama Nama sumber daya tali

Kendala:
Panjang min = 3
Panjang maksimum = 3
Pola = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (diperlukan)
Properti Kelas yang menjelaskan properti sumber daya SignalRProperties
Sku Informasi penagihan sumber daya. ResourceSku
Tags Tag sumber daya Kamus nama dan nilai tag. Lihat Tag dalam templat
jenis Jenis sumber daya 'Microsoft.SignalRService/signalR'

NetworkACL

Nama Deskripsi Nilai
memperbolehkan Jenis permintaan yang diizinkan. Nilainya bisa satu atau beberapa dari: ClientConnection, ServerConnection, RESTAPI. Array string yang berisi salah satu dari:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Lacak'
menyangkal Jenis permintaan yang ditolak. Nilainya bisa satu atau beberapa dari: ClientConnection, ServerConnection, RESTAPI. Array string yang berisi salah satu dari:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Lacak'

PrivateEndpointACL

Nama Deskripsi Nilai
memperbolehkan Jenis permintaan yang diizinkan. Nilainya bisa satu atau beberapa dari: ClientConnection, ServerConnection, RESTAPI. Array string yang berisi salah satu dari:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Lacak'
menyangkal Jenis permintaan yang ditolak. Nilainya bisa satu atau beberapa dari: ClientConnection, ServerConnection, RESTAPI. Array string yang berisi salah satu dari:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Lacak'
Nama Nama koneksi titik akhir privat string (diperlukan)

ResourceLogCategory

Nama Deskripsi Nilai
Diaktifkan Menunjukkan apakah atau kategori log sumber daya diaktifkan.
Nilai yang tersedia: true, false.
Tidak peka huruf besar/kecil.
tali
Nama Mendapatkan atau mengatur nama kategori log sumber daya.
Nilai yang tersedia: ConnectivityLogs, MessagingLogs.
Tidak peka huruf besar/kecil.
tali

ResourceLogConfiguration

Nama Deskripsi Nilai
Kategori Mendapatkan atau mengatur daftar konfigurasi kategori. ResourceLogCategory[]

ResourceSku

Nama Deskripsi Nilai
kapasitas Opsional, bilangan bulat. Jumlah unit sumber daya.
1 untuk Free_F1/Standard_S1/Premium_P1, 100 untuk Premium_P2 secara default.

Jika ada, nilai berikut diizinkan:
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
Nama Nama SKU. Diperlukan.

Nilai yang diizinkan: Standard_S1, Free_F1, Premium_P1, Premium_P2
string (diperlukan)
Tier Tingkat opsional dari SKU khusus ini. 'Standar' atau 'Gratis'.

Basic tidak digunakan lagi, gunakan Standard sebagai gantinya.
'Dasar'
'Gratis'
'Premium'
'Standar'

ServerlessSettings

Nama Deskripsi Nilai
connectionTimeoutInSeconds Mendapatkan atau mengatur Batas Waktu Koneksi Klien. Opsional untuk diatur.
Nilai dalam detik.
Nilai defaultnya adalah 30 detik.
Pelanggan harus mengatur batas waktu ke periode yang lebih singkat jika pesan diharapkan dikirim dalam interval yang lebih pendek,
dan ingin klien terputus lebih cepat setelah pesan terakhir dikirim.
Anda dapat mengatur batas waktu ke periode yang lebih lama jika pesan diharapkan dikirim dalam interval yang lebih lama,
dan mereka ingin menjaga koneksi klien yang sama tetap hidup selama sesi ini.
Layanan mempertimbangkan klien terputus jika belum menerima pesan (termasuk tetap hidup) dalam interval ini.
Int

Kendala:
Nilai min = 1
Nilai maks = 120

ServerlessUpstreamSettings

Nama Deskripsi Nilai
Template Mendapatkan atau mengatur daftar templat URL Upstream. Masalah pesanan, dan templat pencocokan pertama mengambil efek. UpstreamTemplate []

SignalRCorsSettings

Nama Deskripsi Nilai
allowedOrigins Mendapatkan atau mengatur daftar asal yang harus diizinkan untuk melakukan panggilan lintas asal (misalnya: http://example.com:12345). Gunakan "*" untuk mengizinkan semua. Jika dihilangkan, izinkan semua secara default. string[]

SignalRFeature

Nama Deskripsi Nilai
bendera FeatureFlags adalah fitur yang didukung dari layanan Azure SignalR.
- ServiceMode: Bendera untuk server backend untuk layanan SignalR. Nilai yang diizinkan: "Default": memiliki server backend Anda sendiri; "Tanpa Server": aplikasi Anda tidak memiliki server backend; "Klasik": untuk kompatibilitas mundur. Mendukung mode Default dan Tanpa Server tetapi tidak disarankan; "PredefinedOnly": untuk penggunaan di masa mendatang.
- EnableConnectivityLogs: "true"/"false", untuk mengaktifkan/menonaktifkan kategori log konektivitas masing-masing.
- EnableMessagingLogs: "true"/"false", untuk mengaktifkan/menonaktifkan kategori log konektivitas masing-masing.
- EnableLiveTrace: Live Trace memungkinkan Anda mengetahui apa yang terjadi di dalam layanan Azure SignalR, itu akan memberi Anda jejak langsung secara real time, akan sangat membantu ketika Anda mengembangkan aplikasi web berbasis Azure SignalR Anda sendiri atau memecahkan masalah sendiri beberapa masalah. Harap dicatat bahwa jejak langsung dihitung sebagai pesan keluar yang akan dikenakan biaya. Nilai yang diizinkan: "true"/"false", untuk mengaktifkan/menonaktifkan fitur pelacakan langsung.
'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'ServiceMode' (diperlukan)
Properti Properti opsional yang terkait dengan fitur ini. SignalRFeatureProperties
nilai Nilai bendera fitur. Lihat Dokumen layanan Azure SignalR /azure/azure-signalr/ untuk nilai yang diizinkan. tali

Kendala:
Panjang min = 1
Panjang maksimum = 1 (diperlukan)

SignalRFeatureProperties

Nama Deskripsi Nilai

SignalRNetworkACLs

Nama Deskripsi Nilai
defaultAction Tindakan Azure Networking ACL. 'Izinkan'
'Tolak'
ipRules Aturan IP untuk memfilter lalu lintas publik IPRule []
privateEndpoints ACL untuk permintaan dari titik akhir privat PrivateEndpointACL[]
publicNetwork ACL Jaringan NetworkACL

SignalRProperties

Nama Deskripsi Nilai
applicationFirewall Pengaturan firewall aplikasi untuk sumber daya ApplicationFirewallSettings
cors Pengaturan Berbagi Sumber Daya Lintas Asal (CORS). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Mengaktifkan atau menonaktifkan autentikasi aad
Saat diatur sebagai true, koneksi dengan AuthType=aad tidak akan berfungsi.
bool
disableLocalAuth DisableLocalAuth
Mengaktifkan atau menonaktifkan autentikasi lokal dengan AccessKey
Ketika diatur sebagai true, koneksi dengan AccessKey=xxx tidak akan berfungsi.
bool
Fitur Daftar fiturFlags.

FeatureFlags yang tidak disertakan dalam parameter untuk operasi pembaruan tidak akan dimodifikasi.
Dan respons hanya akan mencakup featureFlags yang secara eksplisit diatur.
Ketika featureFlag tidak diatur secara eksplisit, nilai default globalnya akan digunakan
Tetapi perlu diingat, nilai default tidak berarti "false". Ini bervariasi dalam hal FiturFlags yang berbeda.
SignalRFeature[]
liveTraceConfiguration Konfigurasi pelacakan langsung sumber daya Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACL jaringan untuk sumber daya SignalRNetworkACLs
publicNetworkAccess Mengaktifkan atau menonaktifkan akses jaringan publik. Default ke "Diaktifkan".
Saat Diaktifkan, ACL jaringan masih berlaku.
Saat Dinonaktifkan, akses jaringan publik selalu dinonaktifkan apa pun yang Anda tetapkan di ACL jaringan.
tali
regionEndpointEnabled Aktifkan atau nonaktifkan titik akhir regional. Default ke "Diaktifkan".
Ketika Dinonaktifkan, koneksi baru tidak akan dirutekan ke titik akhir ini, namun koneksi yang ada tidak akan terpengaruh.
Properti ini spesifik untuk replika. Nonaktifkan titik akhir regional tanpa replika tidak diperbolehkan.
tali
resourceLogConfiguration Konfigurasi log sumber daya sumber daya sumber daya Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Hentikan atau mulai sumber daya. Default ke "False".
Jika benar, bidang data sumber daya dimatikan.
Saat salah, bidang data sumber daya dimulai.
tali
tanpa server Pengaturan tanpa server. ServerlessSettings
tls Pengaturan TLS untuk sumber daya SignalRTlsSettings
hulu Pengaturan untuk Upstream saat layanan dalam mode tanpa server. ServerlessUpstreamSettings

SignalRTlsSettings

Nama Deskripsi Nilai
clientCertEnabled Minta sertifikat klien selama jabat tangan TLS jika diaktifkan. Tidak didukung untuk tingkat gratis. Input apa pun akan diabaikan untuk tingkat gratis. bool

ThrottleByJwtCustomClaimRule

Nama Deskripsi Nilai
claimName Nama klaim dalam token JWT. Koneksi klien dengan nilai klaim yang sama akan diagregasi. Jika klaim tidak ditemukan dalam token, koneksi akan diizinkan. string (diperlukan)
maxCount Jumlah koneksi maksimum yang diizinkan untuk nilai klaim Jwt yang sama. Klien dengan klaim Jwt yang sama akan ditolak jika jumlah koneksi melebihi nilai ini. Nilai defaultnya adalah 20. Int

Kendala:
Nilai min = 0
Nilai maks = 2147483647
jenis 'ThrottleByJwtCustomClaimRule' (diperlukan)

ThrottleByJwtSignatureRule

Nama Deskripsi Nilai
maxCount Jumlah koneksi maksimum yang diizinkan untuk tanda tangan JWT yang sama. Klien dengan tanda tangan JWT yang sama akan ditolak jika jumlah koneksi melebihi nilai ini. Nilai defaultnya adalah 20. Int

Kendala:
Nilai min = 0
Nilai maks = 2147483647
jenis 'ThrottleByJwtSignatureRule' (diperlukan)

ThrottleByUserIdRule

Nama Deskripsi Nilai
maxCount Jumlah koneksi maksimum yang diizinkan untuk ID pengguna yang sama. Klien dengan ID pengguna yang sama akan ditolak jika jumlah koneksi melebihi nilai ini. Nilai defaultnya adalah 20. Int

Kendala:
Nilai min = 0
Nilai maks = 2147483647
jenis 'ThrottleByUserIdRule' (diperlukan)

TrackedResourceTags

Nama Deskripsi Nilai

UpstreamAuthSettings

Nama Deskripsi Nilai
managedIdentity Pengaturan identitas terkelola untuk upstream. ManagedIdentitySettings
jenis Enum jenis autentikasi upstream. 'ManagedIdentity'
'Tidak Ada'

UpstreamTemplate

Nama Deskripsi Nilai
Auth Pengaturan autentikasi upstream. Jika tidak diatur, tidak ada autentikasi yang digunakan untuk pesan upstram. UpstreamAuthSettings
categoryPattern Mendapatkan atau mengatur pola yang cocok untuk nama kategori. Jika tidak diatur, ini cocok dengan kategori apa pun.
Ada 3 jenis pola yang didukung:
1. "*", cocok dengan nama kategori apa pun.
2. Gabungkan beberapa kategori dengan ",", misalnya "koneksi,pesan", cocok dengan kategori "koneksi" dan "pesan".
3. Nama kategori tunggal, misalnya, "koneksi", cocok dengan kategori "koneksi".
tali
eventPattern Mendapatkan atau mengatur pola yang cocok untuk nama peristiwa. Jika tidak diatur, ini cocok dengan peristiwa apa pun.
Ada 3 jenis pola yang didukung:
1. "*", untuk mencocokkan nama peristiwa apa pun.
2. Gabungkan beberapa peristiwa dengan ",", misalnya "connect,disconnect", cocok dengan event "connect" dan "disconnect".
3. Nama peristiwa tunggal, misalnya, "connect", cocok dengan "connect".
tali
hubPattern Mendapatkan atau mengatur pola yang cocok untuk nama hub. Jika tidak diatur, itu cocok dengan hub apa pun.
Ada 3 jenis pola yang didukung:
1. "*", agar sesuai dengan nama hub apa pun.
2. Gabungkan beberapa hub dengan ",", misalnya "hub1,hub2", cocok dengan "hub1" dan "hub2".
3. Nama hub tunggal, misalnya, "hub1", cocok dengan "hub1".
tali
urlTemplate Mendapatkan atau mengatur templat URL Upstream. Anda dapat menggunakan 3 parameter yang telah ditentukan sebelumnya {hub}, {category} {event} di dalam templat, nilai URL Upstream dihitung secara dinamis saat permintaan klien masuk.
Misalnya, jika urlTemplate http://example.com/{hub}/api/{event}, dengan permintaan klien dari hub chat tersambung, pertama-tama akan POST ke URL ini: http://example.com/chat/api/connect.
string (diperlukan)

UserAssignedIdentityProperty

Nama Deskripsi Nilai

Templat mulai cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Menyebarkan layanan Azure SignalR

Sebarkan ke Azure
Templat ini membuat Azure SignalR Service menggunakan templat.

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya signalR dapat disebarkan dengan operasi yang menargetkan:

  • grup Sumber Daya

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.SignalRService/signalR, tambahkan Terraform berikut ke templat Anda.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR@2024-08-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      applicationFirewall = {
        clientConnectionCountRules = [
          {
            type = "string"
            // For remaining properties, see ClientConnectionCountRule objects
          }
        ]
      }
      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"
  }
}

Objek ClientConnectionCountRule

Atur properti jenis untuk menentukan jenis objek.

Untuk ThrottleByJwtCustomClaimRule, gunakan:

{
  claimName = "string"
  maxCount = int
  type = "ThrottleByJwtCustomClaimRule"
}

Untuk ThrottleByJwtSignatureRule, gunakan:

{
  maxCount = int
  type = "ThrottleByJwtSignatureRule"
}

UntukThrottleByUserIdRule , gunakan:

{
  maxCount = int
  type = "ThrottleByUserIdRule"
}

Nilai properti

ApplicationFirewallSettings

Nama Deskripsi Nilai
clientConnectionCountRules Aturan untuk mengontrol jumlah koneksi klien ClientConnectionCountRule[]

ClientConnectionCountRule

Nama Deskripsi Nilai
jenis Atur ke 'ThrottleByJwtCustomClaimRule' untuk jenis ThrottleByJwtCustomClaimRule. Atur ke 'ThrottleByJwtSignatureRule' untuk jenis ThrottleByJwtSignatureRule. Atur ke 'ThrottleByUserIdRule' untuk jenis ThrottleByUserIdRule. 'ThrottleByJwtCustomClaimRule'
'ThrottleByJwtSignatureRule'
'ThrottleByUserIdRule' (diperlukan)

IPRule

Nama Deskripsi Nilai
perbuatan Tindakan Azure Networking ACL. 'Izinkan'
'Tolak'
nilai IP atau CIDR atau ServiceTag tali

LiveTraceCategory

Nama Deskripsi Nilai
Diaktifkan Menunjukkan apakah atau kategori pelacakan langsung diaktifkan.
Nilai yang tersedia: true, false.
Tidak peka huruf besar/kecil.
tali
Nama Mendapatkan atau mengatur nama kategori pelacakan langsung.
Nilai yang tersedia: ConnectivityLogs, MessagingLogs.
Tidak peka huruf besar/kecil.
tali

LiveTraceConfiguration

Nama Deskripsi Nilai
Kategori Mendapatkan atau mengatur daftar konfigurasi kategori. LiveTraceCategory[]
Diaktifkan Menunjukkan apakah pelacakan langsung diaktifkan atau tidak.
Ketika diatur ke true, klien pelacakan langsung dapat terhubung ke layanan.
Jika tidak, klien pelacakan langsung tidak dapat terhubung ke layanan, sehingga Anda tidak dapat menerima log apa pun, apa pun yang Anda konfigurasi dalam "kategori".
Nilai yang tersedia: true, false.
Tidak peka huruf besar/kecil.
tali

ManagedIdentity

Nama Deskripsi Nilai
jenis Mewakili jenis identitas: systemAssigned, userAssigned, None 'Tidak Ada'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Mendapatkan atau mengatur identitas yang ditetapkan pengguna ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Nama Deskripsi Nilai
Sumber daya Sumber Daya yang menunjukkan URI ID Aplikasi dari sumber daya target.
Ini juga muncul dalam klaim aud (audiens) dari token yang dikeluarkan.
tali

ManagedIdentityUserAssignedIdentities

Nama Deskripsi Nilai

Microsoft.SignalRService/signalR

Nama Deskripsi Nilai
identitas Kelas mewakili identitas terkelola yang digunakan untuk permintaan dan respons ManagedIdentity
jenis Jenis layanan 'RawWebSockets'
'SignalR'
tempat Lokasi geografis tempat sumber daya berada string (diperlukan)
Nama Nama sumber daya tali

Kendala:
Panjang min = 3
Panjang maksimum = 3
Pola = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (diperlukan)
Properti Kelas yang menjelaskan properti sumber daya SignalRProperties
Sku Informasi penagihan sumber daya. ResourceSku
Tags Tag sumber daya Kamus nama dan nilai tag.
jenis Jenis sumber daya "Microsoft.SignalRService/signalR@2024-08-01-preview"

NetworkACL

Nama Deskripsi Nilai
memperbolehkan Jenis permintaan yang diizinkan. Nilainya bisa satu atau beberapa dari: ClientConnection, ServerConnection, RESTAPI. Array string yang berisi salah satu dari:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Lacak'
menyangkal Jenis permintaan yang ditolak. Nilainya bisa satu atau beberapa dari: ClientConnection, ServerConnection, RESTAPI. Array string yang berisi salah satu dari:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Lacak'

PrivateEndpointACL

Nama Deskripsi Nilai
memperbolehkan Jenis permintaan yang diizinkan. Nilainya bisa satu atau beberapa dari: ClientConnection, ServerConnection, RESTAPI. Array string yang berisi salah satu dari:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Lacak'
menyangkal Jenis permintaan yang ditolak. Nilainya bisa satu atau beberapa dari: ClientConnection, ServerConnection, RESTAPI. Array string yang berisi salah satu dari:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Lacak'
Nama Nama koneksi titik akhir privat string (diperlukan)

ResourceLogCategory

Nama Deskripsi Nilai
Diaktifkan Menunjukkan apakah atau kategori log sumber daya diaktifkan.
Nilai yang tersedia: true, false.
Tidak peka huruf besar/kecil.
tali
Nama Mendapatkan atau mengatur nama kategori log sumber daya.
Nilai yang tersedia: ConnectivityLogs, MessagingLogs.
Tidak peka huruf besar/kecil.
tali

ResourceLogConfiguration

Nama Deskripsi Nilai
Kategori Mendapatkan atau mengatur daftar konfigurasi kategori. ResourceLogCategory[]

ResourceSku

Nama Deskripsi Nilai
kapasitas Opsional, bilangan bulat. Jumlah unit sumber daya.
1 untuk Free_F1/Standard_S1/Premium_P1, 100 untuk Premium_P2 secara default.

Jika ada, nilai berikut diizinkan:
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
Nama Nama SKU. Diperlukan.

Nilai yang diizinkan: Standard_S1, Free_F1, Premium_P1, Premium_P2
string (diperlukan)
Tier Tingkat opsional dari SKU khusus ini. 'Standar' atau 'Gratis'.

Basic tidak digunakan lagi, gunakan Standard sebagai gantinya.
'Dasar'
'Gratis'
'Premium'
'Standar'

ServerlessSettings

Nama Deskripsi Nilai
connectionTimeoutInSeconds Mendapatkan atau mengatur Batas Waktu Koneksi Klien. Opsional untuk diatur.
Nilai dalam detik.
Nilai defaultnya adalah 30 detik.
Pelanggan harus mengatur batas waktu ke periode yang lebih singkat jika pesan diharapkan dikirim dalam interval yang lebih pendek,
dan ingin klien terputus lebih cepat setelah pesan terakhir dikirim.
Anda dapat mengatur batas waktu ke periode yang lebih lama jika pesan diharapkan dikirim dalam interval yang lebih lama,
dan mereka ingin menjaga koneksi klien yang sama tetap hidup selama sesi ini.
Layanan mempertimbangkan klien terputus jika belum menerima pesan (termasuk tetap hidup) dalam interval ini.
Int

Kendala:
Nilai min = 1
Nilai maks = 120

ServerlessUpstreamSettings

Nama Deskripsi Nilai
Template Mendapatkan atau mengatur daftar templat URL Upstream. Masalah pesanan, dan templat pencocokan pertama mengambil efek. UpstreamTemplate []

SignalRCorsSettings

Nama Deskripsi Nilai
allowedOrigins Mendapatkan atau mengatur daftar asal yang harus diizinkan untuk melakukan panggilan lintas asal (misalnya: http://example.com:12345). Gunakan "*" untuk mengizinkan semua. Jika dihilangkan, izinkan semua secara default. string[]

SignalRFeature

Nama Deskripsi Nilai
bendera FeatureFlags adalah fitur yang didukung dari layanan Azure SignalR.
- ServiceMode: Bendera untuk server backend untuk layanan SignalR. Nilai yang diizinkan: "Default": memiliki server backend Anda sendiri; "Tanpa Server": aplikasi Anda tidak memiliki server backend; "Klasik": untuk kompatibilitas mundur. Mendukung mode Default dan Tanpa Server tetapi tidak disarankan; "PredefinedOnly": untuk penggunaan di masa mendatang.
- EnableConnectivityLogs: "true"/"false", untuk mengaktifkan/menonaktifkan kategori log konektivitas masing-masing.
- EnableMessagingLogs: "true"/"false", untuk mengaktifkan/menonaktifkan kategori log konektivitas masing-masing.
- EnableLiveTrace: Live Trace memungkinkan Anda mengetahui apa yang terjadi di dalam layanan Azure SignalR, itu akan memberi Anda jejak langsung secara real time, akan sangat membantu ketika Anda mengembangkan aplikasi web berbasis Azure SignalR Anda sendiri atau memecahkan masalah sendiri beberapa masalah. Harap dicatat bahwa jejak langsung dihitung sebagai pesan keluar yang akan dikenakan biaya. Nilai yang diizinkan: "true"/"false", untuk mengaktifkan/menonaktifkan fitur pelacakan langsung.
'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'ServiceMode' (diperlukan)
Properti Properti opsional yang terkait dengan fitur ini. SignalRFeatureProperties
nilai Nilai bendera fitur. Lihat Dokumen layanan Azure SignalR /azure/azure-signalr/ untuk nilai yang diizinkan. tali

Kendala:
Panjang min = 1
Panjang maksimum = 1 (diperlukan)

SignalRFeatureProperties

Nama Deskripsi Nilai

SignalRNetworkACLs

Nama Deskripsi Nilai
defaultAction Tindakan Azure Networking ACL. 'Izinkan'
'Tolak'
ipRules Aturan IP untuk memfilter lalu lintas publik IPRule []
privateEndpoints ACL untuk permintaan dari titik akhir privat PrivateEndpointACL[]
publicNetwork ACL Jaringan NetworkACL

SignalRProperties

Nama Deskripsi Nilai
applicationFirewall Pengaturan firewall aplikasi untuk sumber daya ApplicationFirewallSettings
cors Pengaturan Berbagi Sumber Daya Lintas Asal (CORS). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Mengaktifkan atau menonaktifkan autentikasi aad
Saat diatur sebagai true, koneksi dengan AuthType=aad tidak akan berfungsi.
bool
disableLocalAuth DisableLocalAuth
Mengaktifkan atau menonaktifkan autentikasi lokal dengan AccessKey
Ketika diatur sebagai true, koneksi dengan AccessKey=xxx tidak akan berfungsi.
bool
Fitur Daftar fiturFlags.

FeatureFlags yang tidak disertakan dalam parameter untuk operasi pembaruan tidak akan dimodifikasi.
Dan respons hanya akan mencakup featureFlags yang secara eksplisit diatur.
Ketika featureFlag tidak diatur secara eksplisit, nilai default globalnya akan digunakan
Tetapi perlu diingat, nilai default tidak berarti "false". Ini bervariasi dalam hal FiturFlags yang berbeda.
SignalRFeature[]
liveTraceConfiguration Konfigurasi pelacakan langsung sumber daya Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACL jaringan untuk sumber daya SignalRNetworkACLs
publicNetworkAccess Mengaktifkan atau menonaktifkan akses jaringan publik. Default ke "Diaktifkan".
Saat Diaktifkan, ACL jaringan masih berlaku.
Saat Dinonaktifkan, akses jaringan publik selalu dinonaktifkan apa pun yang Anda tetapkan di ACL jaringan.
tali
regionEndpointEnabled Aktifkan atau nonaktifkan titik akhir regional. Default ke "Diaktifkan".
Ketika Dinonaktifkan, koneksi baru tidak akan dirutekan ke titik akhir ini, namun koneksi yang ada tidak akan terpengaruh.
Properti ini spesifik untuk replika. Nonaktifkan titik akhir regional tanpa replika tidak diperbolehkan.
tali
resourceLogConfiguration Konfigurasi log sumber daya sumber daya sumber daya Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Hentikan atau mulai sumber daya. Default ke "False".
Jika benar, bidang data sumber daya dimatikan.
Saat salah, bidang data sumber daya dimulai.
tali
tanpa server Pengaturan tanpa server. ServerlessSettings
tls Pengaturan TLS untuk sumber daya SignalRTlsSettings
hulu Pengaturan untuk Upstream saat layanan dalam mode tanpa server. ServerlessUpstreamSettings

SignalRTlsSettings

Nama Deskripsi Nilai
clientCertEnabled Minta sertifikat klien selama jabat tangan TLS jika diaktifkan. Tidak didukung untuk tingkat gratis. Input apa pun akan diabaikan untuk tingkat gratis. bool

ThrottleByJwtCustomClaimRule

Nama Deskripsi Nilai
claimName Nama klaim dalam token JWT. Koneksi klien dengan nilai klaim yang sama akan diagregasi. Jika klaim tidak ditemukan dalam token, koneksi akan diizinkan. string (diperlukan)
maxCount Jumlah koneksi maksimum yang diizinkan untuk nilai klaim Jwt yang sama. Klien dengan klaim Jwt yang sama akan ditolak jika jumlah koneksi melebihi nilai ini. Nilai defaultnya adalah 20. Int

Kendala:
Nilai min = 0
Nilai maks = 2147483647
jenis 'ThrottleByJwtCustomClaimRule' (diperlukan)

ThrottleByJwtSignatureRule

Nama Deskripsi Nilai
maxCount Jumlah koneksi maksimum yang diizinkan untuk tanda tangan JWT yang sama. Klien dengan tanda tangan JWT yang sama akan ditolak jika jumlah koneksi melebihi nilai ini. Nilai defaultnya adalah 20. Int

Kendala:
Nilai min = 0
Nilai maks = 2147483647
jenis 'ThrottleByJwtSignatureRule' (diperlukan)

ThrottleByUserIdRule

Nama Deskripsi Nilai
maxCount Jumlah koneksi maksimum yang diizinkan untuk ID pengguna yang sama. Klien dengan ID pengguna yang sama akan ditolak jika jumlah koneksi melebihi nilai ini. Nilai defaultnya adalah 20. Int

Kendala:
Nilai min = 0
Nilai maks = 2147483647
jenis 'ThrottleByUserIdRule' (diperlukan)

TrackedResourceTags

Nama Deskripsi Nilai

UpstreamAuthSettings

Nama Deskripsi Nilai
managedIdentity Pengaturan identitas terkelola untuk upstream. ManagedIdentitySettings
jenis Enum jenis autentikasi upstream. 'ManagedIdentity'
'Tidak Ada'

UpstreamTemplate

Nama Deskripsi Nilai
Auth Pengaturan autentikasi upstream. Jika tidak diatur, tidak ada autentikasi yang digunakan untuk pesan upstram. UpstreamAuthSettings
categoryPattern Mendapatkan atau mengatur pola yang cocok untuk nama kategori. Jika tidak diatur, ini cocok dengan kategori apa pun.
Ada 3 jenis pola yang didukung:
1. "*", cocok dengan nama kategori apa pun.
2. Gabungkan beberapa kategori dengan ",", misalnya "koneksi,pesan", cocok dengan kategori "koneksi" dan "pesan".
3. Nama kategori tunggal, misalnya, "koneksi", cocok dengan kategori "koneksi".
tali
eventPattern Mendapatkan atau mengatur pola yang cocok untuk nama peristiwa. Jika tidak diatur, ini cocok dengan peristiwa apa pun.
Ada 3 jenis pola yang didukung:
1. "*", untuk mencocokkan nama peristiwa apa pun.
2. Gabungkan beberapa peristiwa dengan ",", misalnya "connect,disconnect", cocok dengan event "connect" dan "disconnect".
3. Nama peristiwa tunggal, misalnya, "connect", cocok dengan "connect".
tali
hubPattern Mendapatkan atau mengatur pola yang cocok untuk nama hub. Jika tidak diatur, itu cocok dengan hub apa pun.
Ada 3 jenis pola yang didukung:
1. "*", agar sesuai dengan nama hub apa pun.
2. Gabungkan beberapa hub dengan ",", misalnya "hub1,hub2", cocok dengan "hub1" dan "hub2".
3. Nama hub tunggal, misalnya, "hub1", cocok dengan "hub1".
tali
urlTemplate Mendapatkan atau mengatur templat URL Upstream. Anda dapat menggunakan 3 parameter yang telah ditentukan sebelumnya {hub}, {category} {event} di dalam templat, nilai URL Upstream dihitung secara dinamis saat permintaan klien masuk.
Misalnya, jika urlTemplate http://example.com/{hub}/api/{event}, dengan permintaan klien dari hub chat tersambung, pertama-tama akan POST ke URL ini: http://example.com/chat/api/connect.
string (diperlukan)

UserAssignedIdentityProperty

Nama Deskripsi Nilai