Uwaga
Dostęp do tej strony wymaga autoryzacji. Może spróbować zalogować się lub zmienić katalogi.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
- najnowsze
- 2025-01-01-podgląd
- 2024-10-01-podgląd
- 2024-08-01-podgląd
- 2024-04-01-podgląd
- 2024-03-01
- 2024-01-01-podgląd
-
2023-08-01-preview - 2023-06-01-podgląd
- 2023-03-01-podgląd
- 2023-02-01
- 2022-08-01-podgląd
- 2022-02-01
- 2021-10-01
- 2021-09-01-podgląd
- 2021-06-01-podgląd
- 2021-04-01-podgląd
- 2020-07-01-podgląd
- 2020-05-01
- 2018-10-01
- 2018-03-01-podgląd
Definicja zasobu Bicep
Typ zasobu signalR można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.SignalRService/signalR, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.SignalRService/signalR@2025-01-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
}
]
clientTrafficControlRules: [
{
type: 'string'
// For remaining properties, see ClientTrafficControlRule objects
}
]
maxClientConnectionLifetimeInSeconds: int
}
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'
routeSettings: {
connectionBalanceWeight: int
latencyWeight: int
serverBalanceWeight: int
}
serverless: {
connectionTimeoutInSeconds: int
keepAliveIntervalInSeconds: 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'
}
}
Obiekty ClientTrafficControlRule
Ustaw właściwość , aby określić typ obiektu.
W przypadku TrafficThrottleByJwtCustomClaimRuleużyj:
{
aggregationWindowInSeconds: int
claimName: 'string'
maxInboundMessageBytes: int
type: 'TrafficThrottleByJwtCustomClaimRule'
}
W przypadku TrafficThrottleByJwtSignatureRuleużyj:
{
aggregationWindowInSeconds: int
maxInboundMessageBytes: int
type: 'TrafficThrottleByJwtSignatureRule'
}
W przypadku TrafficThrottleByUserIdRuleużyj:
{
aggregationWindowInSeconds: int
maxInboundMessageBytes: int
type: 'TrafficThrottleByUserIdRule'
}
Obiekty ClientConnectionCountRule
Ustaw właściwość , aby określić typ obiektu.
W przypadku throttleByJwtCustomClaimRuleużyj:
{
claimName: 'string'
maxCount: int
type: 'ThrottleByJwtCustomClaimRule'
}
W przypadku ThrottleByJwtSignatureRuleużyj:
{
maxCount: int
type: 'ThrottleByJwtSignatureRule'
}
W przypadku throttleByUserIdRuleużyj:
{
maxCount: int
type: 'ThrottleByUserIdRule'
}
Wartości właściwości
Microsoft.SignalRService/signalR
Nazwa | Opis | Wartość |
---|---|---|
tożsamość | Klasa reprezentuje tożsamości zarządzane używane do żądania i odpowiedzi | Identyfikator zarządzany |
rodzaj | Rodzaj usługi | "RawWebSockets" "SignalR" |
lokalizacja | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 3 Maksymalna długość = 63 Wzorzec = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (wymagane) |
Właściwości | Klasa opisując właściwości zasobu | SignalRProperties |
Numer jednostki magazynowej | Informacje o rozliczeniach zasobu. | Jednostka SKU zasobów |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
ApplicationFirewallSettings (Ustawienia zapory aplikacji)
Nazwa | Opis | Wartość |
---|---|---|
clientConnectionCountRules (Reguły licznika) | Reguły kontrolowania liczby połączeń klienta | Reguła ClientConnectionCount[] |
clientTrafficControlRules (reguły) | Reguły kontrolowania ruchu klienta | Reguła ClientTrafficControl[] |
maxClientConnectionLifetimeInSeconds | Konfiguracja do kontrolowania żywotności połączenia klienta w ciągu kilku sekund, można ustawić na 0, aby wyłączyć konfigurację | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 604800 |
Reguła ClientConnectionCountRule
Nazwa | Opis | Wartość |
---|---|---|
typ | Ustaw wartość "ThrottleByJwtCustomClaimRule" dla typu ThrottleByJwtCustomClaimRule. Ustaw wartość "ThrottleByJwtSignatureRule" dla typu ThrottleByJwtSignatureRule. Ustaw wartość "ThrottleByUserIdRule" dla typu ThrottleByUserIdRule. | "ThrottleByJwtCustomClaimRule" "ThrottleByJwtSignatureRule" "ThrottleByUserIdRule" (wymagane) |
Reguła ClientTrafficControlRule
Nazwa | Opis | Wartość |
---|---|---|
typ | Ustaw wartość "TrafficThrottleByJwtCustomClaimRule" dla typu TrafficThrottleByJwtCustomClaimRule. Ustaw wartość "TrafficThrottleByJwtSignatureRule" dla typu TrafficThrottleByJwtSignatureRule. Ustaw wartość "TrafficThrottleByUserIdRule" dla typu TrafficThrottleByUserIdRule. | "TrafficThrottleByJwtCustomClaimRule" "TrafficThrottleByJwtSignatureRule" "TrafficThrottleByUserIdRule" (wymagane) |
Adres IPRule
Nazwa | Opis | Wartość |
---|---|---|
akcja | Akcja listy ACL sieci platformy Azure. | "Zezwalaj" "Odmów" |
wartość | Adres IP lub ciDR lub serviceTag | struna |
Kategoria LiveTrace
Nazwa | Opis | Wartość |
---|---|---|
Włączone | Wskazuje, czy kategoria śledzenia na żywo jest włączona. Dostępne wartości: true, false. Bez uwzględniania wielkości liter. |
struna |
nazwa | Pobiera lub ustawia nazwę kategorii śledzenia na żywo. Dostępne wartości: ConnectivityLogs, MessagingLogs. Bez uwzględniania wielkości liter. |
struna |
Konfiguracja LiveTrace
Nazwa | Opis | Wartość |
---|---|---|
Kategorie | Pobiera lub ustawia listę konfiguracji kategorii. | Kategoria LiveTrace[] |
Włączone | Wskazuje, czy włączono śledzenie na żywo. Po ustawieniu wartości true klient śledzenia na żywo może nawiązać połączenie z usługą. W przeciwnym razie klient śledzenia na żywo nie może nawiązać połączenia z usługą, aby nie można było odebrać żadnego dziennika, niezależnie od tego, co skonfigurowaliśmy w "kategoriach". Dostępne wartości: true, false. Bez uwzględniania wielkości liter. |
struna |
Identyfikator zarządzany
Nazwa | Opis | Wartość |
---|---|---|
typ | Reprezentuje typ tożsamości: systemAssigned, userAssigned, None | "Brak" "SystemAssigned" "UserAssigned" |
tożsamości przypisane użytkownikom | Pobieranie lub ustawianie tożsamości przypisanych przez użytkownika | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
Nazwa | Opis | Wartość |
---|---|---|
zasób | Zasób wskazujący identyfikator URI identyfikatora aplikacji zasobu docelowego. Pojawia się również w oświadczeniu aud (odbiorców) wystawionego tokenu. |
struna |
ManagedIdentityUserAssignedIdentities
Nazwa | Opis | Wartość |
---|
Lista ACL sieci (NetworkACL)
Nazwa | Opis | Wartość |
---|---|---|
pozwolić | Dozwolone typy żądań. Wartość może być jedną lub większą częścią: ClientConnection, ServerConnection, RESTAPI. | Tablica ciągów zawierająca dowolną z: "ClientConnection" "RESTAPI" "ServerConnection" "Ślad" |
zaprzeczać | Niedozwolone typy żądań. Wartość może być jedną lub większą częścią: ClientConnection, ServerConnection, RESTAPI. | Tablica ciągów zawierająca dowolną z: "ClientConnection" "RESTAPI" "ServerConnection" "Ślad" |
PrivateEndpointACL
Nazwa | Opis | Wartość |
---|---|---|
pozwolić | Dozwolone typy żądań. Wartość może być jedną lub większą częścią: ClientConnection, ServerConnection, RESTAPI. | Tablica ciągów zawierająca dowolną z: "ClientConnection" "RESTAPI" "ServerConnection" "Ślad" |
zaprzeczać | Niedozwolone typy żądań. Wartość może być jedną lub większą częścią: ClientConnection, ServerConnection, RESTAPI. | Tablica ciągów zawierająca dowolną z: "ClientConnection" "RESTAPI" "ServerConnection" "Ślad" |
nazwa | Nazwa połączenia prywatnego punktu końcowego | ciąg (wymagany) |
Kategoria ResourceLogCategory
Nazwa | Opis | Wartość |
---|---|---|
Włączone | Wskazuje, czy kategoria dziennika zasobów jest włączona. Dostępne wartości: true, false. Bez uwzględniania wielkości liter. |
struna |
nazwa | Pobiera lub ustawia nazwę kategorii dziennika zasobów. Dostępne wartości: ConnectivityLogs, MessagingLogs. Bez uwzględniania wielkości liter. |
struna |
Konfiguracja dziennika zasobów
Nazwa | Opis | Wartość |
---|---|---|
Kategorie | Pobiera lub ustawia listę konfiguracji kategorii. | Kategoria Dziennika Zasobów[] |
Jednostka SKU zasobów
Nazwa | Opis | Wartość |
---|---|---|
pojemność | Opcjonalnie, liczba całkowita. Liczba jednostek zasobu. 1 dla Free_F1/Standard_S1/Premium_P1, 100 dla Premium_P2 domyślnie. Jeśli są obecne, dozwolone są następujące wartości: 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 |
nazwa | Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1, Premium_P1, Premium_P2 |
ciąg (wymagany) |
kondygnacja | Opcjonalna warstwa tej konkretnej jednostki SKU. "Standardowa" lub "Bezpłatna". Basic jest przestarzały, zamiast tego użyj Standard . |
"Podstawowa" "Bezpłatna" "Premium" "Standardowa" |
Ustawienia trasy
Nazwa | Opis | Wartość |
---|---|---|
connectionBalanceWeight (Waga) | Pobiera lub ustawia wagę równoważenia połączenia. Wyższa wartość oznacza większą równowagę połączeń klientów między różnymi połączeniami serwera. Wartość 0 rozdziela połączenia losowo, podczas gdy wartość 255 zapewnia maksymalne równoważenie. Wartość domyślna to 255. Zalecany 255 we wszystkich przypadkach. |
Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 255 |
opóźnienieWaga | Pobiera lub ustawia wagę routingu opartego na opóźnieniach. Wyższa wartość zwiększa wpływ routingu opartego na opóźnieniach. Wartość 0 całkowicie wyłącza routing oparty na opóźnieniach, podczas gdy wartość 255 umożliwia go w pełni. Wartość domyślna to 0. Zalecane 255 dla replik lub serwerów aplikacji w różnych regionach na potrzeby odzyskiwania po awarii. |
Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 255 |
serverBalanceWeight (waga serwera) | Pobiera lub ustawia wagę balansu serwera. Wyższa wartość oznacza większą równowagę połączeń klientów między różnymi wystąpieniami serwera aplikacji. Wartość 0 rozdziela połączenia losowo, podczas gdy wartość 255 zapewnia maksymalne równoważenie. Wartość domyślna to 255. Zalecane 255 dla wielu serwerów aplikacji w tym samym rozmiarze. |
Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 255 |
Ustawienia bezserwerowe
Nazwa | Opis | Wartość |
---|---|---|
connectionTimeoutInSeconds (Limit czasupołączenia w sekundach) | Pobiera lub ustawia limit czasu połączenia klienta. Opcjonalnie do ustawienia. Wartość w sekundach. Wartość domyślna to 30 sekund. Klient powinien ustawić limit czasu na krótszy okres, jeśli komunikaty mają być wysyłane w krótszych odstępach czasu, i chcesz, aby klient szybciej rozłączył się po wysłaniu ostatniej wiadomości. Limit czasu można ustawić na dłuższy okres, jeśli komunikaty mają być wysyłane w dłuższych odstępach czasu, i chcą zachować to samo połączenie klienta w trakcie tej sesji. Usługa uwzględnia rozłączenie klienta, jeśli nie odebrano komunikatu (w tym zachowania aktywności) w tym interwale. |
Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 120 |
keepAliveIntervalInSeconds | Pobiera lub ustawia interwał Keep-Alive. Opcjonalnie, aby ustawić. Wartość jest wyrażona w sekundach. Wartość domyślna to 15 sekund. Klienci powinni ustawić tę wartość na krótszy okres, jeśli chcą, aby usługa wysyłała komunikaty o zachowaniu aktywności częściej, zapewnienie terminowego sprawdzania stanu połączenia. Z drugiej strony klienci mogą ustawić tę wartość na dłuższy okres, jeśli chcą, aby usługa wysyłała komunikaty o zachowaniu aktywności rzadziej, zmniejszenie ruchu sieciowego, ale należy pamiętać, że wykrycie rozłączenia może potrwać dłużej. Ten interwał gwarantuje, że połączenie jest utrzymywane przez wysyłanie okresowych komunikatów o zachowaniu aktywności do klienta. |
Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 120 |
ServerlessUpstreamSettings
Nazwa | Opis | Wartość |
---|---|---|
Szablony | Pobiera lub ustawia listę nadrzędnych szablonów adresów URL. Kolejność ma znaczenie, a pierwszy pasujący szablon przyjmuje efekty. | Szablon nadrzędny[] |
SignalRCorsSettings
Nazwa | Opis | Wartość |
---|---|---|
allowedOrigins (dozwolone źródła) | Pobiera lub ustawia listę źródeł, które powinny być dozwolone do tworzenia wywołań między źródłami (na przykład: http://example.com:12345 ). Użyj ciągu "*", aby zezwolić na wszystkie. Jeśli pominięto, zezwól na wszystkie domyślnie. |
ciąg znakowy[] |
SignalRFeature
Nazwa | Opis | Wartość |
---|---|---|
flaga | FeatureFlags to obsługiwane funkcje usługi Azure SignalR. - ServiceMode: flaga serwera zaplecza dla usługi SignalR. Dozwolone wartości: "Default": have your own backend server; "Bezserwerowe": aplikacja nie ma serwera zaplecza; "Klasyczny": w celu zapewnienia zgodności z poprzednimi wersjami. Obsługa trybu domyślnego i bezserwerowego, ale nie jest zalecana; "PredefinedOnly": do użytku w przyszłości. - EnableConnectivityLogs: "true"/"false", aby włączyć/wyłączyć odpowiednio kategorię dziennika łączności. - EnableMessagingLogs: "true"/"false", aby włączyć/wyłączyć odpowiednio kategorię dziennika łączności. - EnableLiveTrace: Funkcja śledzenia na żywo pozwala wiedzieć, co dzieje się w usłudze Azure SignalR Service, zapewni ona śledzenie na żywo w czasie rzeczywistym, będzie pomocne podczas tworzenia własnej aplikacji internetowej opartej na usłudze Azure SignalR lub samodzielnego rozwiązywania niektórych problemów. Należy pamiętać, że ślady na żywo są liczone jako komunikaty wychodzące, które zostaną naliczone. Dozwolone wartości: "true"/"false", aby włączyć/wyłączyć funkcję śledzenia na żywo. |
"EnableConnectivityLogs" "EnableLiveTrace" "EnableMessagingLogs" "ServiceMode" (wymagane) |
Właściwości | Opcjonalne właściwości związane z tą funkcją. | Właściwości SignalRFeature |
wartość | Wartość flagi funkcji. Aby uzyskać dozwolone wartości, zobacz dokument usługi Azure SignalR Service /azure/azure-signalr/. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 128 (wymagana) |
Właściwości SignalRFeature
Nazwa | Opis | Wartość |
---|
SignalRNetworkACLs
Nazwa | Opis | Wartość |
---|---|---|
defaultAction (akcja domyślna) | Akcja listy ACL sieci platformy Azure. | "Zezwalaj" "Odmów" |
Reguły ip | Reguły adresów IP do filtrowania ruchu publicznego | IPRule [] |
prywatne punkty końcowe | Listy ACL dla żądań z prywatnych punktów końcowych | privateEndpointACL[] |
publicNetwork (sieć publiczna) | Lista ACL sieci | Lista ACL sieci (NetworkACL) |
SignalRProperties
Nazwa | Opis | Wartość |
---|---|---|
applicationZapora sieciowa | Ustawienia zapory aplikacji dla zasobu | ApplicationFirewallSettings (Ustawienia zapory aplikacji) |
CORS (Współdzielenie zasobów między źródłami) | Ustawienia współużytkowania zasobów między źródłami (CORS). | SignalRCorsSettings |
wyłączyćAadAuth | Wyłącz uwierzytelnianie lokalne Włączanie lub wyłączanie uwierzytelniania usługi aad Po ustawieniu wartości true połączenie z parametrem AuthType=aad nie będzie działać. |
Bool |
disableLocalAuth (wyłącz uwierzytelnianie lokalne) | Wyłącz uwierzytelnianie lokalne Włączanie lub wyłączanie lokalnego uwierzytelniania za pomocą AccessKey Po ustawieniu wartości true połączenie z wartością AccessKey=xxx nie będzie działać. |
Bool |
Funkcje | Lista funkcjiFlags. FunkcjeFlags, które nie są uwzględnione w parametrach operacji aktualizacji, nie zostaną zmodyfikowane. Odpowiedź będzie zawierać tylko funkcjeFlags, które są jawnie ustawione. Jeśli funkcjaFlag nie jest jawnie ustawiona, zostanie użyta jej globalnie domyślna wartość Należy jednak pamiętać, że wartość domyślna nie oznacza wartości "false". Różni się w zależności od różnych funkcjiFlags. |
SygnałRFeature[] |
Konfiguracja liveTrace | Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService. | |
networkACL (listy ACL sieci) | Listy ACL sieci dla zasobu | SignalRNetworkACLs |
dostęp do sieci publicznej | Włączanie lub wyłączanie dostępu do sieci publicznej. Wartość domyślna to "Włączone". Po włączeniu listy ACL sieci nadal mają zastosowanie. Po wyłączeniu dostęp do sieci publicznej jest zawsze wyłączony niezależnie od tego, co zostało ustawione w listach ACL sieci. |
struna |
regionEndpointEnabled (Włączony punkt końcowy) | Włącz lub wyłącz regionalny punkt końcowy. Wartość domyślna to "Włączone". Po wyłączeniu nowe połączenia nie będą kierowane do tego punktu końcowego, ale istniejące połączenia nie będą miały wpływu. Ta właściwość jest specyficzna dla repliki. Wyłącz regionalny punkt końcowy bez dozwolonej repliki. |
struna |
resourceLogConfiguration (konfiguracja dziennika zasobów) | Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService. | Konfiguracja dziennika zasobów |
resourceZatrzymany | Zatrzymaj lub uruchom zasób. Wartość domyślna to "False". Gdy to prawda, płaszczyzna danych zasobu zostanie zamknięta. Gdy jest to fałsz, płaszczyzna danych zasobu jest uruchamiana. |
struna |
routeSettings (ustawienia trasy) | Ustawienia marszruty dla zasobu | Ustawienia trasy |
bezserwerowy | Ustawienia bezserwerowe. | Ustawienia bezserwerowe |
Protokół TLS | Ustawienia protokołu TLS dla zasobu | SignalRTlsSettings |
Nadrzędnego | Ustawienia nadrzędne, gdy usługa jest w trybie bezserwerowym. | ServerlessUpstreamSettings |
SignalRTlsSettings
Nazwa | Opis | Wartość |
---|---|---|
clientCertEnabled (klient CertWłączone) | Zażądaj certyfikatu klienta podczas uzgadniania protokołu TLS, jeśli jest włączona. Nieobsługiwane w warstwie Bezpłatna. Wszystkie dane wejściowe będą ignorowane dla warstwy Bezpłatna. | Bool |
ThrottleByJwtCustomClaimRule
Nazwa | Opis | Wartość |
---|---|---|
claimName (nazwa roszczenia) | Nazwa oświadczenia w tokenie JWT. Połączenie klienta z tą samą wartością oświadczenia zostanie zagregowane. Jeśli oświadczenie nie zostanie znalezione w tokenie, połączenie będzie dozwolone. | ciąg (wymagany) |
maxCount (maksymalna liczba) | Maksymalna dozwolona liczba połączeń dla tej samej wartości oświadczenia Jwt. Klienci z tym samym oświadczeniem Jwt zostaną odrzuceni, jeśli liczba połączeń przekroczy tę wartość. Wartość domyślna to 20. | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 2147483647 |
typ | "ThrottleByJwtCustomClaimRule" (wymagane) |
ThrottleByJwtSignatureRule
Nazwa | Opis | Wartość |
---|---|---|
maxCount (maksymalna liczba) | Maksymalna dozwolona liczba połączeń dla tego samego podpisu JWT. Klienci z tym samym podpisem JWT zostaną odrzuceni, jeśli liczba połączeń przekroczy tę wartość. Wartość domyślna to 20. | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 2147483647 |
typ | "ThrottleByJwtSignatureRule" (wymagane) |
ThrottleByUserIdRule
Nazwa | Opis | Wartość |
---|---|---|
maxCount (maksymalna liczba) | Maksymalna dozwolona liczba połączeń dla tego samego identyfikatora użytkownika. Klienci o tym samym identyfikatorze użytkownika zostaną odrzuceni, jeśli liczba połączeń przekroczy tę wartość. Wartość domyślna to 20. | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 2147483647 |
typ | "ThrottleByUserIdRule" (wymagane) |
Śledzone tagi zasobów
Nazwa | Opis | Wartość |
---|
TrafficThrottleByJwtCustomClaimRule
Nazwa | Opis | Wartość |
---|---|---|
aggregationWindowInSeconds | Okno agregacji dla bajtów komunikatów. Bajty komunikatów zostaną zagregowane w tym oknie i zostaną zresetowane po oknie. Wartość domyślna to 60 sekund. | Int Ograniczenia: Minimalna wartość = 10 Wartość maksymalna = 3600 |
claimName (nazwa roszczenia) | Nazwa oświadczenia w tokenie JWT. Bajty komunikatów o tej samej wartości oświadczenia zostaną zagregowane. Jeśli oświadczenie nie zostanie znalezione w tokenie, reguła zostanie pominięta. | ciąg (wymagany) |
maxInboundMessageBytes (Bajty maksymalnych wiadomości) | Maksymalna liczba skumulowanych bajtów komunikatów przychodzących dozwolonych dla tego samego podpisu JWT w przedziale czasu. Klienci z tym samym oświadczeniem JWT zostaną rozłączeni, jeśli bajty komunikatów przekraczają tę wartość. Wartość domyślna to 1 GB. | Int Ograniczenia: Minimalna wartość = 0 |
typ | "TrafficThrottleByJwtCustomClaimRule" (wymagane) |
TrafficThrottleByJwtSignatureRule
Nazwa | Opis | Wartość |
---|---|---|
aggregationWindowInSeconds | Okno agregacji dla bajtów komunikatów. Bajty komunikatów zostaną zagregowane w tym oknie i zostaną zresetowane po oknie. Wartość domyślna to 60 sekund. | Int Ograniczenia: Minimalna wartość = 10 Wartość maksymalna = 3600 |
maxInboundMessageBytes (Bajty maksymalnych wiadomości) | Maksymalna liczba skumulowanych bajtów komunikatów przychodzących dozwolonych dla tego samego podpisu JWT w przedziale czasu. Klienci z tym samym podpisem JWT zostaną rozłączani, jeśli bajty komunikatu przekraczają tę wartość. Wartość domyślna to 1 GB. | Int Ograniczenia: Minimalna wartość = 0 |
typ | "TrafficThrottleByJwtSignatureRule" (wymagane) |
TrafficThrottleByUserIdRule
Nazwa | Opis | Wartość |
---|---|---|
aggregationWindowInSeconds | Okno agregacji dla bajtów komunikatów. Bajty komunikatów zostaną zagregowane w tym oknie i zostaną zresetowane po oknie. Wartość domyślna to 60 sekund. | Int Ograniczenia: Minimalna wartość = 10 Wartość maksymalna = 3600 |
maxInboundMessageBytes (Bajty maksymalnych wiadomości) | Maksymalna liczba skumulowanych bajtów komunikatów przychodzących dozwolonych dla tego samego identyfikatora użytkownika w przedziale czasu. Klienci z tym samym identyfikatorem użytkownika zostaną rozłączone, jeśli bajty komunikatu przekraczają tę wartość. Wartość domyślna to 1 GB. | Int Ograniczenia: Minimalna wartość = 0 |
typ | "TrafficThrottleByUserIdRule" (wymagane) |
Ustawienia uwierzytelniania nadrzędnego
Nazwa | Opis | Wartość |
---|---|---|
managedIdentity (tożsamość zarządzana) | Ustawienia tożsamości zarządzanej dla nadrzędnego elementu. | ManagedIdentitySettings |
typ | Wyliczenie typu uwierzytelniania nadrzędnego. | "ManagedIdentity" "Brak" |
UpstreamTemplate (Szablon nadrzędny)
Nazwa | Opis | Wartość |
---|---|---|
Auth | Ustawienia uwierzytelniania nadrzędnego. Jeśli nie zostanie ustawiona, dla komunikatów nadrzędnych nie jest używane żadne uwierzytelnianie. | Ustawienia uwierzytelniania nadrzędnego |
categoryWzorzec | Pobiera lub ustawia pasujący wzorzec dla nazw kategorii. Jeśli nie zostanie ustawiona, pasuje do dowolnej kategorii. Obsługiwane są 3 rodzaje wzorców: 1. "*", aby pasować do dowolnej nazwy kategorii. 2. Połącz wiele kategorii z ",", na przykład "połączenia,komunikaty", pasuje do kategorii "connections" i "messages". 3. Nazwa pojedynczej kategorii, na przykład "connections", pasuje do kategorii "connections". |
struna |
eventPattern (wzorzec zdarzenia) | Pobiera lub ustawia pasujący wzorzec nazw zdarzeń. Jeśli nie zostanie ustawiona, pasuje do dowolnego zdarzenia. Obsługiwane są 3 rodzaje wzorców: 1. "*", aby pasować do dowolnej nazwy zdarzenia. 2. Połącz wiele zdarzeń z ",", na przykład "połącz,rozłącz", pasuje do zdarzenia "connect" i "disconnect". 3. Pojedyncza nazwa zdarzenia, na przykład "connect", pasuje do "connect". |
struna |
hubPattern (wzorzec piasty) | Pobiera lub ustawia pasujący wzorzec dla nazw centrów. Jeśli nie zostanie ustawiona, pasuje do dowolnego koncentratora. Obsługiwane są 3 rodzaje wzorców: 1. "*", aby pasować do dowolnej nazwy centrum. 2. Połącz wiele koncentratorów z ",", na przykład "hub1,hub2", pasuje do "hub1" i "hub2". 3. Nazwa pojedynczego centrum, na przykład "hub1", pasuje do "hub1". |
struna |
Szablon url | Pobiera lub ustawia szablon nadrzędny adres URL. W szablonie można użyć 3 wstępnie zdefiniowanych parametrów {hub}, {category} {event}. Wartość adresu URL nadrzędnego jest obliczana dynamicznie, gdy pojawia się żądanie klienta. Jeśli na przykład adres URLTemplate jest http://example.com/{hub}/api/{event} , z żądaniem klienta z centrum chat nawiązuje połączenie, najpierw post do tego adresu URL: http://example.com/chat/api/connect . |
ciąg (wymagany) |
UserAssignedIdentityProperty (Właściwość użytkownika)
Nazwa | Opis | Wartość |
---|
Przykłady użycia
Moduły zweryfikowane na platformie Azure
Następujące moduły zweryfikowane platformy Azure mogą służyć do wdrażania tego typu zasobu.
Moduł | Opis |
---|---|
Usługa SignalR SignalR | Moduł zasobów AVM dla usługi SignalR Service SignalR |
Przykłady szybkiego startu platformy Azure
Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.
Plik Bicep | Opis |
---|---|
wdrażanie usługi Azure SignalR Service | Ten szablon tworzy usługę Azure SignalR Service przy użyciu szablonu. |
Definicja zasobu szablonu usługi ARM
Typ zasobu signalR można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.SignalRService/signalR, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2025-01-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
} ],
"clientTrafficControlRules": [ {
"type": "string"
// For remaining properties, see ClientTrafficControlRule objects
} ],
"maxClientConnectionLifetimeInSeconds": "int"
},
"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",
"routeSettings": {
"connectionBalanceWeight": "int",
"latencyWeight": "int",
"serverBalanceWeight": "int"
},
"serverless": {
"connectionTimeoutInSeconds": "int",
"keepAliveIntervalInSeconds": "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"
}
}
Obiekty ClientTrafficControlRule
Ustaw właściwość , aby określić typ obiektu.
W przypadku TrafficThrottleByJwtCustomClaimRuleużyj:
{
"aggregationWindowInSeconds": "int",
"claimName": "string",
"maxInboundMessageBytes": "int",
"type": "TrafficThrottleByJwtCustomClaimRule"
}
W przypadku TrafficThrottleByJwtSignatureRuleużyj:
{
"aggregationWindowInSeconds": "int",
"maxInboundMessageBytes": "int",
"type": "TrafficThrottleByJwtSignatureRule"
}
W przypadku TrafficThrottleByUserIdRuleużyj:
{
"aggregationWindowInSeconds": "int",
"maxInboundMessageBytes": "int",
"type": "TrafficThrottleByUserIdRule"
}
Obiekty ClientConnectionCountRule
Ustaw właściwość , aby określić typ obiektu.
W przypadku throttleByJwtCustomClaimRuleużyj:
{
"claimName": "string",
"maxCount": "int",
"type": "ThrottleByJwtCustomClaimRule"
}
W przypadku ThrottleByJwtSignatureRuleużyj:
{
"maxCount": "int",
"type": "ThrottleByJwtSignatureRule"
}
W przypadku throttleByUserIdRuleużyj:
{
"maxCount": "int",
"type": "ThrottleByUserIdRule"
}
Wartości właściwości
Microsoft.SignalRService/signalR
Nazwa | Opis | Wartość |
---|---|---|
apiVersion (wersja interfejsu api) | Wersja interfejsu API | "2025-01-01-preview" |
tożsamość | Klasa reprezentuje tożsamości zarządzane używane do żądania i odpowiedzi | Identyfikator zarządzany |
rodzaj | Rodzaj usługi | "RawWebSockets" "SignalR" |
lokalizacja | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 3 Maksymalna długość = 63 Wzorzec = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (wymagane) |
Właściwości | Klasa opisując właściwości zasobu | SignalRProperties |
Numer jednostki magazynowej | Informacje o rozliczeniach zasobu. | Jednostka SKU zasobów |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
typ | Typ zasobu | "Microsoft.SignalRService/signalR" |
ApplicationFirewallSettings (Ustawienia zapory aplikacji)
Nazwa | Opis | Wartość |
---|---|---|
clientConnectionCountRules (Reguły licznika) | Reguły kontrolowania liczby połączeń klienta | Reguła ClientConnectionCount[] |
clientTrafficControlRules (reguły) | Reguły kontrolowania ruchu klienta | Reguła ClientTrafficControl[] |
maxClientConnectionLifetimeInSeconds | Konfiguracja do kontrolowania żywotności połączenia klienta w ciągu kilku sekund, można ustawić na 0, aby wyłączyć konfigurację | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 604800 |
Reguła ClientConnectionCountRule
Nazwa | Opis | Wartość |
---|---|---|
typ | Ustaw wartość "ThrottleByJwtCustomClaimRule" dla typu ThrottleByJwtCustomClaimRule. Ustaw wartość "ThrottleByJwtSignatureRule" dla typu ThrottleByJwtSignatureRule. Ustaw wartość "ThrottleByUserIdRule" dla typu ThrottleByUserIdRule. | "ThrottleByJwtCustomClaimRule" "ThrottleByJwtSignatureRule" "ThrottleByUserIdRule" (wymagane) |
Reguła ClientTrafficControlRule
Nazwa | Opis | Wartość |
---|---|---|
typ | Ustaw wartość "TrafficThrottleByJwtCustomClaimRule" dla typu TrafficThrottleByJwtCustomClaimRule. Ustaw wartość "TrafficThrottleByJwtSignatureRule" dla typu TrafficThrottleByJwtSignatureRule. Ustaw wartość "TrafficThrottleByUserIdRule" dla typu TrafficThrottleByUserIdRule. | "TrafficThrottleByJwtCustomClaimRule" "TrafficThrottleByJwtSignatureRule" "TrafficThrottleByUserIdRule" (wymagane) |
Adres IPRule
Nazwa | Opis | Wartość |
---|---|---|
akcja | Akcja listy ACL sieci platformy Azure. | "Zezwalaj" "Odmów" |
wartość | Adres IP lub ciDR lub serviceTag | struna |
Kategoria LiveTrace
Nazwa | Opis | Wartość |
---|---|---|
Włączone | Wskazuje, czy kategoria śledzenia na żywo jest włączona. Dostępne wartości: true, false. Bez uwzględniania wielkości liter. |
struna |
nazwa | Pobiera lub ustawia nazwę kategorii śledzenia na żywo. Dostępne wartości: ConnectivityLogs, MessagingLogs. Bez uwzględniania wielkości liter. |
struna |
Konfiguracja LiveTrace
Nazwa | Opis | Wartość |
---|---|---|
Kategorie | Pobiera lub ustawia listę konfiguracji kategorii. | Kategoria LiveTrace[] |
Włączone | Wskazuje, czy włączono śledzenie na żywo. Po ustawieniu wartości true klient śledzenia na żywo może nawiązać połączenie z usługą. W przeciwnym razie klient śledzenia na żywo nie może nawiązać połączenia z usługą, aby nie można było odebrać żadnego dziennika, niezależnie od tego, co skonfigurowaliśmy w "kategoriach". Dostępne wartości: true, false. Bez uwzględniania wielkości liter. |
struna |
Identyfikator zarządzany
Nazwa | Opis | Wartość |
---|---|---|
typ | Reprezentuje typ tożsamości: systemAssigned, userAssigned, None | "Brak" "SystemAssigned" "UserAssigned" |
tożsamości przypisane użytkownikom | Pobieranie lub ustawianie tożsamości przypisanych przez użytkownika | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
Nazwa | Opis | Wartość |
---|---|---|
zasób | Zasób wskazujący identyfikator URI identyfikatora aplikacji zasobu docelowego. Pojawia się również w oświadczeniu aud (odbiorców) wystawionego tokenu. |
struna |
ManagedIdentityUserAssignedIdentities
Nazwa | Opis | Wartość |
---|
Lista ACL sieci (NetworkACL)
Nazwa | Opis | Wartość |
---|---|---|
pozwolić | Dozwolone typy żądań. Wartość może być jedną lub większą częścią: ClientConnection, ServerConnection, RESTAPI. | Tablica ciągów zawierająca dowolną z: "ClientConnection" "RESTAPI" "ServerConnection" "Ślad" |
zaprzeczać | Niedozwolone typy żądań. Wartość może być jedną lub większą częścią: ClientConnection, ServerConnection, RESTAPI. | Tablica ciągów zawierająca dowolną z: "ClientConnection" "RESTAPI" "ServerConnection" "Ślad" |
PrivateEndpointACL
Nazwa | Opis | Wartość |
---|---|---|
pozwolić | Dozwolone typy żądań. Wartość może być jedną lub większą częścią: ClientConnection, ServerConnection, RESTAPI. | Tablica ciągów zawierająca dowolną z: "ClientConnection" "RESTAPI" "ServerConnection" "Ślad" |
zaprzeczać | Niedozwolone typy żądań. Wartość może być jedną lub większą częścią: ClientConnection, ServerConnection, RESTAPI. | Tablica ciągów zawierająca dowolną z: "ClientConnection" "RESTAPI" "ServerConnection" "Ślad" |
nazwa | Nazwa połączenia prywatnego punktu końcowego | ciąg (wymagany) |
Kategoria ResourceLogCategory
Nazwa | Opis | Wartość |
---|---|---|
Włączone | Wskazuje, czy kategoria dziennika zasobów jest włączona. Dostępne wartości: true, false. Bez uwzględniania wielkości liter. |
struna |
nazwa | Pobiera lub ustawia nazwę kategorii dziennika zasobów. Dostępne wartości: ConnectivityLogs, MessagingLogs. Bez uwzględniania wielkości liter. |
struna |
Konfiguracja dziennika zasobów
Nazwa | Opis | Wartość |
---|---|---|
Kategorie | Pobiera lub ustawia listę konfiguracji kategorii. | Kategoria Dziennika Zasobów[] |
Jednostka SKU zasobów
Nazwa | Opis | Wartość |
---|---|---|
pojemność | Opcjonalnie, liczba całkowita. Liczba jednostek zasobu. 1 dla Free_F1/Standard_S1/Premium_P1, 100 dla Premium_P2 domyślnie. Jeśli są obecne, dozwolone są następujące wartości: 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 |
nazwa | Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1, Premium_P1, Premium_P2 |
ciąg (wymagany) |
kondygnacja | Opcjonalna warstwa tej konkretnej jednostki SKU. "Standardowa" lub "Bezpłatna". Basic jest przestarzały, zamiast tego użyj Standard . |
"Podstawowa" "Bezpłatna" "Premium" "Standardowa" |
Ustawienia trasy
Nazwa | Opis | Wartość |
---|---|---|
connectionBalanceWeight (Waga) | Pobiera lub ustawia wagę równoważenia połączenia. Wyższa wartość oznacza większą równowagę połączeń klientów między różnymi połączeniami serwera. Wartość 0 rozdziela połączenia losowo, podczas gdy wartość 255 zapewnia maksymalne równoważenie. Wartość domyślna to 255. Zalecany 255 we wszystkich przypadkach. |
Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 255 |
opóźnienieWaga | Pobiera lub ustawia wagę routingu opartego na opóźnieniach. Wyższa wartość zwiększa wpływ routingu opartego na opóźnieniach. Wartość 0 całkowicie wyłącza routing oparty na opóźnieniach, podczas gdy wartość 255 umożliwia go w pełni. Wartość domyślna to 0. Zalecane 255 dla replik lub serwerów aplikacji w różnych regionach na potrzeby odzyskiwania po awarii. |
Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 255 |
serverBalanceWeight (waga serwera) | Pobiera lub ustawia wagę balansu serwera. Wyższa wartość oznacza większą równowagę połączeń klientów między różnymi wystąpieniami serwera aplikacji. Wartość 0 rozdziela połączenia losowo, podczas gdy wartość 255 zapewnia maksymalne równoważenie. Wartość domyślna to 255. Zalecane 255 dla wielu serwerów aplikacji w tym samym rozmiarze. |
Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 255 |
Ustawienia bezserwerowe
Nazwa | Opis | Wartość |
---|---|---|
connectionTimeoutInSeconds (Limit czasupołączenia w sekundach) | Pobiera lub ustawia limit czasu połączenia klienta. Opcjonalnie do ustawienia. Wartość w sekundach. Wartość domyślna to 30 sekund. Klient powinien ustawić limit czasu na krótszy okres, jeśli komunikaty mają być wysyłane w krótszych odstępach czasu, i chcesz, aby klient szybciej rozłączył się po wysłaniu ostatniej wiadomości. Limit czasu można ustawić na dłuższy okres, jeśli komunikaty mają być wysyłane w dłuższych odstępach czasu, i chcą zachować to samo połączenie klienta w trakcie tej sesji. Usługa uwzględnia rozłączenie klienta, jeśli nie odebrano komunikatu (w tym zachowania aktywności) w tym interwale. |
Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 120 |
keepAliveIntervalInSeconds | Pobiera lub ustawia interwał Keep-Alive. Opcjonalnie, aby ustawić. Wartość jest wyrażona w sekundach. Wartość domyślna to 15 sekund. Klienci powinni ustawić tę wartość na krótszy okres, jeśli chcą, aby usługa wysyłała komunikaty o zachowaniu aktywności częściej, zapewnienie terminowego sprawdzania stanu połączenia. Z drugiej strony klienci mogą ustawić tę wartość na dłuższy okres, jeśli chcą, aby usługa wysyłała komunikaty o zachowaniu aktywności rzadziej, zmniejszenie ruchu sieciowego, ale należy pamiętać, że wykrycie rozłączenia może potrwać dłużej. Ten interwał gwarantuje, że połączenie jest utrzymywane przez wysyłanie okresowych komunikatów o zachowaniu aktywności do klienta. |
Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 120 |
ServerlessUpstreamSettings
Nazwa | Opis | Wartość |
---|---|---|
Szablony | Pobiera lub ustawia listę nadrzędnych szablonów adresów URL. Kolejność ma znaczenie, a pierwszy pasujący szablon przyjmuje efekty. | Szablon nadrzędny[] |
SignalRCorsSettings
Nazwa | Opis | Wartość |
---|---|---|
allowedOrigins (dozwolone źródła) | Pobiera lub ustawia listę źródeł, które powinny być dozwolone do tworzenia wywołań między źródłami (na przykład: http://example.com:12345 ). Użyj ciągu "*", aby zezwolić na wszystkie. Jeśli pominięto, zezwól na wszystkie domyślnie. |
ciąg znakowy[] |
SignalRFeature
Nazwa | Opis | Wartość |
---|---|---|
flaga | FeatureFlags to obsługiwane funkcje usługi Azure SignalR. - ServiceMode: flaga serwera zaplecza dla usługi SignalR. Dozwolone wartości: "Default": have your own backend server; "Bezserwerowe": aplikacja nie ma serwera zaplecza; "Klasyczny": w celu zapewnienia zgodności z poprzednimi wersjami. Obsługa trybu domyślnego i bezserwerowego, ale nie jest zalecana; "PredefinedOnly": do użytku w przyszłości. - EnableConnectivityLogs: "true"/"false", aby włączyć/wyłączyć odpowiednio kategorię dziennika łączności. - EnableMessagingLogs: "true"/"false", aby włączyć/wyłączyć odpowiednio kategorię dziennika łączności. - EnableLiveTrace: Funkcja śledzenia na żywo pozwala wiedzieć, co dzieje się w usłudze Azure SignalR Service, zapewni ona śledzenie na żywo w czasie rzeczywistym, będzie pomocne podczas tworzenia własnej aplikacji internetowej opartej na usłudze Azure SignalR lub samodzielnego rozwiązywania niektórych problemów. Należy pamiętać, że ślady na żywo są liczone jako komunikaty wychodzące, które zostaną naliczone. Dozwolone wartości: "true"/"false", aby włączyć/wyłączyć funkcję śledzenia na żywo. |
"EnableConnectivityLogs" "EnableLiveTrace" "EnableMessagingLogs" "ServiceMode" (wymagane) |
Właściwości | Opcjonalne właściwości związane z tą funkcją. | Właściwości SignalRFeature |
wartość | Wartość flagi funkcji. Aby uzyskać dozwolone wartości, zobacz dokument usługi Azure SignalR Service /azure/azure-signalr/. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 128 (wymagana) |
Właściwości SignalRFeature
Nazwa | Opis | Wartość |
---|
SignalRNetworkACLs
Nazwa | Opis | Wartość |
---|---|---|
defaultAction (akcja domyślna) | Akcja listy ACL sieci platformy Azure. | "Zezwalaj" "Odmów" |
Reguły ip | Reguły adresów IP do filtrowania ruchu publicznego | IPRule [] |
prywatne punkty końcowe | Listy ACL dla żądań z prywatnych punktów końcowych | privateEndpointACL[] |
publicNetwork (sieć publiczna) | Lista ACL sieci | Lista ACL sieci (NetworkACL) |
SignalRProperties
Nazwa | Opis | Wartość |
---|---|---|
applicationZapora sieciowa | Ustawienia zapory aplikacji dla zasobu | ApplicationFirewallSettings (Ustawienia zapory aplikacji) |
CORS (Współdzielenie zasobów między źródłami) | Ustawienia współużytkowania zasobów między źródłami (CORS). | SignalRCorsSettings |
wyłączyćAadAuth | Wyłącz uwierzytelnianie lokalne Włączanie lub wyłączanie uwierzytelniania usługi aad Po ustawieniu wartości true połączenie z parametrem AuthType=aad nie będzie działać. |
Bool |
disableLocalAuth (wyłącz uwierzytelnianie lokalne) | Wyłącz uwierzytelnianie lokalne Włączanie lub wyłączanie lokalnego uwierzytelniania za pomocą AccessKey Po ustawieniu wartości true połączenie z wartością AccessKey=xxx nie będzie działać. |
Bool |
Funkcje | Lista funkcjiFlags. FunkcjeFlags, które nie są uwzględnione w parametrach operacji aktualizacji, nie zostaną zmodyfikowane. Odpowiedź będzie zawierać tylko funkcjeFlags, które są jawnie ustawione. Jeśli funkcjaFlag nie jest jawnie ustawiona, zostanie użyta jej globalnie domyślna wartość Należy jednak pamiętać, że wartość domyślna nie oznacza wartości "false". Różni się w zależności od różnych funkcjiFlags. |
SygnałRFeature[] |
Konfiguracja liveTrace | Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService. | |
networkACL (listy ACL sieci) | Listy ACL sieci dla zasobu | SignalRNetworkACLs |
dostęp do sieci publicznej | Włączanie lub wyłączanie dostępu do sieci publicznej. Wartość domyślna to "Włączone". Po włączeniu listy ACL sieci nadal mają zastosowanie. Po wyłączeniu dostęp do sieci publicznej jest zawsze wyłączony niezależnie od tego, co zostało ustawione w listach ACL sieci. |
struna |
regionEndpointEnabled (Włączony punkt końcowy) | Włącz lub wyłącz regionalny punkt końcowy. Wartość domyślna to "Włączone". Po wyłączeniu nowe połączenia nie będą kierowane do tego punktu końcowego, ale istniejące połączenia nie będą miały wpływu. Ta właściwość jest specyficzna dla repliki. Wyłącz regionalny punkt końcowy bez dozwolonej repliki. |
struna |
resourceLogConfiguration (konfiguracja dziennika zasobów) | Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService. | Konfiguracja dziennika zasobów |
resourceZatrzymany | Zatrzymaj lub uruchom zasób. Wartość domyślna to "False". Gdy to prawda, płaszczyzna danych zasobu zostanie zamknięta. Gdy jest to fałsz, płaszczyzna danych zasobu jest uruchamiana. |
struna |
routeSettings (ustawienia trasy) | Ustawienia marszruty dla zasobu | Ustawienia trasy |
bezserwerowy | Ustawienia bezserwerowe. | Ustawienia bezserwerowe |
Protokół TLS | Ustawienia protokołu TLS dla zasobu | SignalRTlsSettings |
Nadrzędnego | Ustawienia nadrzędne, gdy usługa jest w trybie bezserwerowym. | ServerlessUpstreamSettings |
SignalRTlsSettings
Nazwa | Opis | Wartość |
---|---|---|
clientCertEnabled (klient CertWłączone) | Zażądaj certyfikatu klienta podczas uzgadniania protokołu TLS, jeśli jest włączona. Nieobsługiwane w warstwie Bezpłatna. Wszystkie dane wejściowe będą ignorowane dla warstwy Bezpłatna. | Bool |
ThrottleByJwtCustomClaimRule
Nazwa | Opis | Wartość |
---|---|---|
claimName (nazwa roszczenia) | Nazwa oświadczenia w tokenie JWT. Połączenie klienta z tą samą wartością oświadczenia zostanie zagregowane. Jeśli oświadczenie nie zostanie znalezione w tokenie, połączenie będzie dozwolone. | ciąg (wymagany) |
maxCount (maksymalna liczba) | Maksymalna dozwolona liczba połączeń dla tej samej wartości oświadczenia Jwt. Klienci z tym samym oświadczeniem Jwt zostaną odrzuceni, jeśli liczba połączeń przekroczy tę wartość. Wartość domyślna to 20. | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 2147483647 |
typ | "ThrottleByJwtCustomClaimRule" (wymagane) |
ThrottleByJwtSignatureRule
Nazwa | Opis | Wartość |
---|---|---|
maxCount (maksymalna liczba) | Maksymalna dozwolona liczba połączeń dla tego samego podpisu JWT. Klienci z tym samym podpisem JWT zostaną odrzuceni, jeśli liczba połączeń przekroczy tę wartość. Wartość domyślna to 20. | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 2147483647 |
typ | "ThrottleByJwtSignatureRule" (wymagane) |
ThrottleByUserIdRule
Nazwa | Opis | Wartość |
---|---|---|
maxCount (maksymalna liczba) | Maksymalna dozwolona liczba połączeń dla tego samego identyfikatora użytkownika. Klienci o tym samym identyfikatorze użytkownika zostaną odrzuceni, jeśli liczba połączeń przekroczy tę wartość. Wartość domyślna to 20. | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 2147483647 |
typ | "ThrottleByUserIdRule" (wymagane) |
Śledzone tagi zasobów
Nazwa | Opis | Wartość |
---|
TrafficThrottleByJwtCustomClaimRule
Nazwa | Opis | Wartość |
---|---|---|
aggregationWindowInSeconds | Okno agregacji dla bajtów komunikatów. Bajty komunikatów zostaną zagregowane w tym oknie i zostaną zresetowane po oknie. Wartość domyślna to 60 sekund. | Int Ograniczenia: Minimalna wartość = 10 Wartość maksymalna = 3600 |
claimName (nazwa roszczenia) | Nazwa oświadczenia w tokenie JWT. Bajty komunikatów o tej samej wartości oświadczenia zostaną zagregowane. Jeśli oświadczenie nie zostanie znalezione w tokenie, reguła zostanie pominięta. | ciąg (wymagany) |
maxInboundMessageBytes (Bajty maksymalnych wiadomości) | Maksymalna liczba skumulowanych bajtów komunikatów przychodzących dozwolonych dla tego samego podpisu JWT w przedziale czasu. Klienci z tym samym oświadczeniem JWT zostaną rozłączeni, jeśli bajty komunikatów przekraczają tę wartość. Wartość domyślna to 1 GB. | Int Ograniczenia: Minimalna wartość = 0 |
typ | "TrafficThrottleByJwtCustomClaimRule" (wymagane) |
TrafficThrottleByJwtSignatureRule
Nazwa | Opis | Wartość |
---|---|---|
aggregationWindowInSeconds | Okno agregacji dla bajtów komunikatów. Bajty komunikatów zostaną zagregowane w tym oknie i zostaną zresetowane po oknie. Wartość domyślna to 60 sekund. | Int Ograniczenia: Minimalna wartość = 10 Wartość maksymalna = 3600 |
maxInboundMessageBytes (Bajty maksymalnych wiadomości) | Maksymalna liczba skumulowanych bajtów komunikatów przychodzących dozwolonych dla tego samego podpisu JWT w przedziale czasu. Klienci z tym samym podpisem JWT zostaną rozłączani, jeśli bajty komunikatu przekraczają tę wartość. Wartość domyślna to 1 GB. | Int Ograniczenia: Minimalna wartość = 0 |
typ | "TrafficThrottleByJwtSignatureRule" (wymagane) |
TrafficThrottleByUserIdRule
Nazwa | Opis | Wartość |
---|---|---|
aggregationWindowInSeconds | Okno agregacji dla bajtów komunikatów. Bajty komunikatów zostaną zagregowane w tym oknie i zostaną zresetowane po oknie. Wartość domyślna to 60 sekund. | Int Ograniczenia: Minimalna wartość = 10 Wartość maksymalna = 3600 |
maxInboundMessageBytes (Bajty maksymalnych wiadomości) | Maksymalna liczba skumulowanych bajtów komunikatów przychodzących dozwolonych dla tego samego identyfikatora użytkownika w przedziale czasu. Klienci z tym samym identyfikatorem użytkownika zostaną rozłączone, jeśli bajty komunikatu przekraczają tę wartość. Wartość domyślna to 1 GB. | Int Ograniczenia: Minimalna wartość = 0 |
typ | "TrafficThrottleByUserIdRule" (wymagane) |
Ustawienia uwierzytelniania nadrzędnego
Nazwa | Opis | Wartość |
---|---|---|
managedIdentity (tożsamość zarządzana) | Ustawienia tożsamości zarządzanej dla nadrzędnego elementu. | ManagedIdentitySettings |
typ | Wyliczenie typu uwierzytelniania nadrzędnego. | "ManagedIdentity" "Brak" |
UpstreamTemplate (Szablon nadrzędny)
Nazwa | Opis | Wartość |
---|---|---|
Auth | Ustawienia uwierzytelniania nadrzędnego. Jeśli nie zostanie ustawiona, dla komunikatów nadrzędnych nie jest używane żadne uwierzytelnianie. | Ustawienia uwierzytelniania nadrzędnego |
categoryWzorzec | Pobiera lub ustawia pasujący wzorzec dla nazw kategorii. Jeśli nie zostanie ustawiona, pasuje do dowolnej kategorii. Obsługiwane są 3 rodzaje wzorców: 1. "*", aby pasować do dowolnej nazwy kategorii. 2. Połącz wiele kategorii z ",", na przykład "połączenia,komunikaty", pasuje do kategorii "connections" i "messages". 3. Nazwa pojedynczej kategorii, na przykład "connections", pasuje do kategorii "connections". |
struna |
eventPattern (wzorzec zdarzenia) | Pobiera lub ustawia pasujący wzorzec nazw zdarzeń. Jeśli nie zostanie ustawiona, pasuje do dowolnego zdarzenia. Obsługiwane są 3 rodzaje wzorców: 1. "*", aby pasować do dowolnej nazwy zdarzenia. 2. Połącz wiele zdarzeń z ",", na przykład "połącz,rozłącz", pasuje do zdarzenia "connect" i "disconnect". 3. Pojedyncza nazwa zdarzenia, na przykład "connect", pasuje do "connect". |
struna |
hubPattern (wzorzec piasty) | Pobiera lub ustawia pasujący wzorzec dla nazw centrów. Jeśli nie zostanie ustawiona, pasuje do dowolnego koncentratora. Obsługiwane są 3 rodzaje wzorców: 1. "*", aby pasować do dowolnej nazwy centrum. 2. Połącz wiele koncentratorów z ",", na przykład "hub1,hub2", pasuje do "hub1" i "hub2". 3. Nazwa pojedynczego centrum, na przykład "hub1", pasuje do "hub1". |
struna |
Szablon url | Pobiera lub ustawia szablon nadrzędny adres URL. W szablonie można użyć 3 wstępnie zdefiniowanych parametrów {hub}, {category} {event}. Wartość adresu URL nadrzędnego jest obliczana dynamicznie, gdy pojawia się żądanie klienta. Jeśli na przykład adres URLTemplate jest http://example.com/{hub}/api/{event} , z żądaniem klienta z centrum chat nawiązuje połączenie, najpierw post do tego adresu URL: http://example.com/chat/api/connect . |
ciąg (wymagany) |
UserAssignedIdentityProperty (Właściwość użytkownika)
Nazwa | Opis | Wartość |
---|
Przykłady użycia
Szablony szybkiego startu platformy Azure
Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.
Szablon | Opis |
---|---|
wdrażanie usługi Azure SignalR Service wdrażanie |
Ten szablon tworzy usługę Azure SignalR Service przy użyciu szablonu. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu signalR można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.SignalRService/signalR, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SignalRService/signalR@2025-01-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
properties = {
applicationFirewall = {
clientConnectionCountRules = [
{
type = "string"
// For remaining properties, see ClientConnectionCountRule objects
}
]
clientTrafficControlRules = [
{
type = "string"
// For remaining properties, see ClientTrafficControlRule objects
}
]
maxClientConnectionLifetimeInSeconds = int
}
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"
routeSettings = {
connectionBalanceWeight = int
latencyWeight = int
serverBalanceWeight = int
}
serverless = {
connectionTimeoutInSeconds = int
keepAliveIntervalInSeconds = 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"
}
}
}
Obiekty ClientTrafficControlRule
Ustaw właściwość , aby określić typ obiektu.
W przypadku TrafficThrottleByJwtCustomClaimRuleużyj:
{
aggregationWindowInSeconds = int
claimName = "string"
maxInboundMessageBytes = int
type = "TrafficThrottleByJwtCustomClaimRule"
}
W przypadku TrafficThrottleByJwtSignatureRuleużyj:
{
aggregationWindowInSeconds = int
maxInboundMessageBytes = int
type = "TrafficThrottleByJwtSignatureRule"
}
W przypadku TrafficThrottleByUserIdRuleużyj:
{
aggregationWindowInSeconds = int
maxInboundMessageBytes = int
type = "TrafficThrottleByUserIdRule"
}
Obiekty ClientConnectionCountRule
Ustaw właściwość , aby określić typ obiektu.
W przypadku throttleByJwtCustomClaimRuleużyj:
{
claimName = "string"
maxCount = int
type = "ThrottleByJwtCustomClaimRule"
}
W przypadku ThrottleByJwtSignatureRuleużyj:
{
maxCount = int
type = "ThrottleByJwtSignatureRule"
}
W przypadku throttleByUserIdRuleużyj:
{
maxCount = int
type = "ThrottleByUserIdRule"
}
Wartości właściwości
Microsoft.SignalRService/signalR
Nazwa | Opis | Wartość |
---|---|---|
tożsamość | Klasa reprezentuje tożsamości zarządzane używane do żądania i odpowiedzi | Identyfikator zarządzany |
rodzaj | Rodzaj usługi | "RawWebSockets" "SignalR" |
lokalizacja | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 3 Maksymalna długość = 63 Wzorzec = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (wymagane) |
Właściwości | Klasa opisując właściwości zasobu | SignalRProperties |
Numer jednostki magazynowej | Informacje o rozliczeniach zasobu. | Jednostka SKU zasobów |
Tagi | Tagi zasobów | Słownik nazw tagów i wartości. |
typ | Typ zasobu | "Microsoft.SignalRService/signalR@2025-01-01-preview" |
ApplicationFirewallSettings (Ustawienia zapory aplikacji)
Nazwa | Opis | Wartość |
---|---|---|
clientConnectionCountRules (Reguły licznika) | Reguły kontrolowania liczby połączeń klienta | Reguła ClientConnectionCount[] |
clientTrafficControlRules (reguły) | Reguły kontrolowania ruchu klienta | Reguła ClientTrafficControl[] |
maxClientConnectionLifetimeInSeconds | Konfiguracja do kontrolowania żywotności połączenia klienta w ciągu kilku sekund, można ustawić na 0, aby wyłączyć konfigurację | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 604800 |
Reguła ClientConnectionCountRule
Nazwa | Opis | Wartość |
---|---|---|
typ | Ustaw wartość "ThrottleByJwtCustomClaimRule" dla typu ThrottleByJwtCustomClaimRule. Ustaw wartość "ThrottleByJwtSignatureRule" dla typu ThrottleByJwtSignatureRule. Ustaw wartość "ThrottleByUserIdRule" dla typu ThrottleByUserIdRule. | "ThrottleByJwtCustomClaimRule" "ThrottleByJwtSignatureRule" "ThrottleByUserIdRule" (wymagane) |
Reguła ClientTrafficControlRule
Nazwa | Opis | Wartość |
---|---|---|
typ | Ustaw wartość "TrafficThrottleByJwtCustomClaimRule" dla typu TrafficThrottleByJwtCustomClaimRule. Ustaw wartość "TrafficThrottleByJwtSignatureRule" dla typu TrafficThrottleByJwtSignatureRule. Ustaw wartość "TrafficThrottleByUserIdRule" dla typu TrafficThrottleByUserIdRule. | "TrafficThrottleByJwtCustomClaimRule" "TrafficThrottleByJwtSignatureRule" "TrafficThrottleByUserIdRule" (wymagane) |
Adres IPRule
Nazwa | Opis | Wartość |
---|---|---|
akcja | Akcja listy ACL sieci platformy Azure. | "Zezwalaj" "Odmów" |
wartość | Adres IP lub ciDR lub serviceTag | struna |
Kategoria LiveTrace
Nazwa | Opis | Wartość |
---|---|---|
Włączone | Wskazuje, czy kategoria śledzenia na żywo jest włączona. Dostępne wartości: true, false. Bez uwzględniania wielkości liter. |
struna |
nazwa | Pobiera lub ustawia nazwę kategorii śledzenia na żywo. Dostępne wartości: ConnectivityLogs, MessagingLogs. Bez uwzględniania wielkości liter. |
struna |
Konfiguracja LiveTrace
Nazwa | Opis | Wartość |
---|---|---|
Kategorie | Pobiera lub ustawia listę konfiguracji kategorii. | Kategoria LiveTrace[] |
Włączone | Wskazuje, czy włączono śledzenie na żywo. Po ustawieniu wartości true klient śledzenia na żywo może nawiązać połączenie z usługą. W przeciwnym razie klient śledzenia na żywo nie może nawiązać połączenia z usługą, aby nie można było odebrać żadnego dziennika, niezależnie od tego, co skonfigurowaliśmy w "kategoriach". Dostępne wartości: true, false. Bez uwzględniania wielkości liter. |
struna |
Identyfikator zarządzany
Nazwa | Opis | Wartość |
---|---|---|
typ | Reprezentuje typ tożsamości: systemAssigned, userAssigned, None | "Brak" "SystemAssigned" "UserAssigned" |
tożsamości przypisane użytkownikom | Pobieranie lub ustawianie tożsamości przypisanych przez użytkownika | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
Nazwa | Opis | Wartość |
---|---|---|
zasób | Zasób wskazujący identyfikator URI identyfikatora aplikacji zasobu docelowego. Pojawia się również w oświadczeniu aud (odbiorców) wystawionego tokenu. |
struna |
ManagedIdentityUserAssignedIdentities
Nazwa | Opis | Wartość |
---|
Lista ACL sieci (NetworkACL)
Nazwa | Opis | Wartość |
---|---|---|
pozwolić | Dozwolone typy żądań. Wartość może być jedną lub większą częścią: ClientConnection, ServerConnection, RESTAPI. | Tablica ciągów zawierająca dowolną z: "ClientConnection" "RESTAPI" "ServerConnection" "Ślad" |
zaprzeczać | Niedozwolone typy żądań. Wartość może być jedną lub większą częścią: ClientConnection, ServerConnection, RESTAPI. | Tablica ciągów zawierająca dowolną z: "ClientConnection" "RESTAPI" "ServerConnection" "Ślad" |
PrivateEndpointACL
Nazwa | Opis | Wartość |
---|---|---|
pozwolić | Dozwolone typy żądań. Wartość może być jedną lub większą częścią: ClientConnection, ServerConnection, RESTAPI. | Tablica ciągów zawierająca dowolną z: "ClientConnection" "RESTAPI" "ServerConnection" "Ślad" |
zaprzeczać | Niedozwolone typy żądań. Wartość może być jedną lub większą częścią: ClientConnection, ServerConnection, RESTAPI. | Tablica ciągów zawierająca dowolną z: "ClientConnection" "RESTAPI" "ServerConnection" "Ślad" |
nazwa | Nazwa połączenia prywatnego punktu końcowego | ciąg (wymagany) |
Kategoria ResourceLogCategory
Nazwa | Opis | Wartość |
---|---|---|
Włączone | Wskazuje, czy kategoria dziennika zasobów jest włączona. Dostępne wartości: true, false. Bez uwzględniania wielkości liter. |
struna |
nazwa | Pobiera lub ustawia nazwę kategorii dziennika zasobów. Dostępne wartości: ConnectivityLogs, MessagingLogs. Bez uwzględniania wielkości liter. |
struna |
Konfiguracja dziennika zasobów
Nazwa | Opis | Wartość |
---|---|---|
Kategorie | Pobiera lub ustawia listę konfiguracji kategorii. | Kategoria Dziennika Zasobów[] |
Jednostka SKU zasobów
Nazwa | Opis | Wartość |
---|---|---|
pojemność | Opcjonalnie, liczba całkowita. Liczba jednostek zasobu. 1 dla Free_F1/Standard_S1/Premium_P1, 100 dla Premium_P2 domyślnie. Jeśli są obecne, dozwolone są następujące wartości: 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 |
nazwa | Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1, Premium_P1, Premium_P2 |
ciąg (wymagany) |
kondygnacja | Opcjonalna warstwa tej konkretnej jednostki SKU. "Standardowa" lub "Bezpłatna". Basic jest przestarzały, zamiast tego użyj Standard . |
"Podstawowa" "Bezpłatna" "Premium" "Standardowa" |
Ustawienia trasy
Nazwa | Opis | Wartość |
---|---|---|
connectionBalanceWeight (Waga) | Pobiera lub ustawia wagę równoważenia połączenia. Wyższa wartość oznacza większą równowagę połączeń klientów między różnymi połączeniami serwera. Wartość 0 rozdziela połączenia losowo, podczas gdy wartość 255 zapewnia maksymalne równoważenie. Wartość domyślna to 255. Zalecany 255 we wszystkich przypadkach. |
Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 255 |
opóźnienieWaga | Pobiera lub ustawia wagę routingu opartego na opóźnieniach. Wyższa wartość zwiększa wpływ routingu opartego na opóźnieniach. Wartość 0 całkowicie wyłącza routing oparty na opóźnieniach, podczas gdy wartość 255 umożliwia go w pełni. Wartość domyślna to 0. Zalecane 255 dla replik lub serwerów aplikacji w różnych regionach na potrzeby odzyskiwania po awarii. |
Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 255 |
serverBalanceWeight (waga serwera) | Pobiera lub ustawia wagę balansu serwera. Wyższa wartość oznacza większą równowagę połączeń klientów między różnymi wystąpieniami serwera aplikacji. Wartość 0 rozdziela połączenia losowo, podczas gdy wartość 255 zapewnia maksymalne równoważenie. Wartość domyślna to 255. Zalecane 255 dla wielu serwerów aplikacji w tym samym rozmiarze. |
Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 255 |
Ustawienia bezserwerowe
Nazwa | Opis | Wartość |
---|---|---|
connectionTimeoutInSeconds (Limit czasupołączenia w sekundach) | Pobiera lub ustawia limit czasu połączenia klienta. Opcjonalnie do ustawienia. Wartość w sekundach. Wartość domyślna to 30 sekund. Klient powinien ustawić limit czasu na krótszy okres, jeśli komunikaty mają być wysyłane w krótszych odstępach czasu, i chcesz, aby klient szybciej rozłączył się po wysłaniu ostatniej wiadomości. Limit czasu można ustawić na dłuższy okres, jeśli komunikaty mają być wysyłane w dłuższych odstępach czasu, i chcą zachować to samo połączenie klienta w trakcie tej sesji. Usługa uwzględnia rozłączenie klienta, jeśli nie odebrano komunikatu (w tym zachowania aktywności) w tym interwale. |
Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 120 |
keepAliveIntervalInSeconds | Pobiera lub ustawia interwał Keep-Alive. Opcjonalnie, aby ustawić. Wartość jest wyrażona w sekundach. Wartość domyślna to 15 sekund. Klienci powinni ustawić tę wartość na krótszy okres, jeśli chcą, aby usługa wysyłała komunikaty o zachowaniu aktywności częściej, zapewnienie terminowego sprawdzania stanu połączenia. Z drugiej strony klienci mogą ustawić tę wartość na dłuższy okres, jeśli chcą, aby usługa wysyłała komunikaty o zachowaniu aktywności rzadziej, zmniejszenie ruchu sieciowego, ale należy pamiętać, że wykrycie rozłączenia może potrwać dłużej. Ten interwał gwarantuje, że połączenie jest utrzymywane przez wysyłanie okresowych komunikatów o zachowaniu aktywności do klienta. |
Int Ograniczenia: Minimalna wartość = 1 Wartość maksymalna = 120 |
ServerlessUpstreamSettings
Nazwa | Opis | Wartość |
---|---|---|
Szablony | Pobiera lub ustawia listę nadrzędnych szablonów adresów URL. Kolejność ma znaczenie, a pierwszy pasujący szablon przyjmuje efekty. | Szablon nadrzędny[] |
SignalRCorsSettings
Nazwa | Opis | Wartość |
---|---|---|
allowedOrigins (dozwolone źródła) | Pobiera lub ustawia listę źródeł, które powinny być dozwolone do tworzenia wywołań między źródłami (na przykład: http://example.com:12345 ). Użyj ciągu "*", aby zezwolić na wszystkie. Jeśli pominięto, zezwól na wszystkie domyślnie. |
ciąg znakowy[] |
SignalRFeature
Nazwa | Opis | Wartość |
---|---|---|
flaga | FeatureFlags to obsługiwane funkcje usługi Azure SignalR. - ServiceMode: flaga serwera zaplecza dla usługi SignalR. Dozwolone wartości: "Default": have your own backend server; "Bezserwerowe": aplikacja nie ma serwera zaplecza; "Klasyczny": w celu zapewnienia zgodności z poprzednimi wersjami. Obsługa trybu domyślnego i bezserwerowego, ale nie jest zalecana; "PredefinedOnly": do użytku w przyszłości. - EnableConnectivityLogs: "true"/"false", aby włączyć/wyłączyć odpowiednio kategorię dziennika łączności. - EnableMessagingLogs: "true"/"false", aby włączyć/wyłączyć odpowiednio kategorię dziennika łączności. - EnableLiveTrace: Funkcja śledzenia na żywo pozwala wiedzieć, co dzieje się w usłudze Azure SignalR Service, zapewni ona śledzenie na żywo w czasie rzeczywistym, będzie pomocne podczas tworzenia własnej aplikacji internetowej opartej na usłudze Azure SignalR lub samodzielnego rozwiązywania niektórych problemów. Należy pamiętać, że ślady na żywo są liczone jako komunikaty wychodzące, które zostaną naliczone. Dozwolone wartości: "true"/"false", aby włączyć/wyłączyć funkcję śledzenia na żywo. |
"EnableConnectivityLogs" "EnableLiveTrace" "EnableMessagingLogs" "ServiceMode" (wymagane) |
Właściwości | Opcjonalne właściwości związane z tą funkcją. | Właściwości SignalRFeature |
wartość | Wartość flagi funkcji. Aby uzyskać dozwolone wartości, zobacz dokument usługi Azure SignalR Service /azure/azure-signalr/. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 128 (wymagana) |
Właściwości SignalRFeature
Nazwa | Opis | Wartość |
---|
SignalRNetworkACLs
Nazwa | Opis | Wartość |
---|---|---|
defaultAction (akcja domyślna) | Akcja listy ACL sieci platformy Azure. | "Zezwalaj" "Odmów" |
Reguły ip | Reguły adresów IP do filtrowania ruchu publicznego | IPRule [] |
prywatne punkty końcowe | Listy ACL dla żądań z prywatnych punktów końcowych | privateEndpointACL[] |
publicNetwork (sieć publiczna) | Lista ACL sieci | Lista ACL sieci (NetworkACL) |
SignalRProperties
Nazwa | Opis | Wartość |
---|---|---|
applicationZapora sieciowa | Ustawienia zapory aplikacji dla zasobu | ApplicationFirewallSettings (Ustawienia zapory aplikacji) |
CORS (Współdzielenie zasobów między źródłami) | Ustawienia współużytkowania zasobów między źródłami (CORS). | SignalRCorsSettings |
wyłączyćAadAuth | Wyłącz uwierzytelnianie lokalne Włączanie lub wyłączanie uwierzytelniania usługi aad Po ustawieniu wartości true połączenie z parametrem AuthType=aad nie będzie działać. |
Bool |
disableLocalAuth (wyłącz uwierzytelnianie lokalne) | Wyłącz uwierzytelnianie lokalne Włączanie lub wyłączanie lokalnego uwierzytelniania za pomocą AccessKey Po ustawieniu wartości true połączenie z wartością AccessKey=xxx nie będzie działać. |
Bool |
Funkcje | Lista funkcjiFlags. FunkcjeFlags, które nie są uwzględnione w parametrach operacji aktualizacji, nie zostaną zmodyfikowane. Odpowiedź będzie zawierać tylko funkcjeFlags, które są jawnie ustawione. Jeśli funkcjaFlag nie jest jawnie ustawiona, zostanie użyta jej globalnie domyślna wartość Należy jednak pamiętać, że wartość domyślna nie oznacza wartości "false". Różni się w zależności od różnych funkcjiFlags. |
SygnałRFeature[] |
Konfiguracja liveTrace | Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService. | |
networkACL (listy ACL sieci) | Listy ACL sieci dla zasobu | SignalRNetworkACLs |
dostęp do sieci publicznej | Włączanie lub wyłączanie dostępu do sieci publicznej. Wartość domyślna to "Włączone". Po włączeniu listy ACL sieci nadal mają zastosowanie. Po wyłączeniu dostęp do sieci publicznej jest zawsze wyłączony niezależnie od tego, co zostało ustawione w listach ACL sieci. |
struna |
regionEndpointEnabled (Włączony punkt końcowy) | Włącz lub wyłącz regionalny punkt końcowy. Wartość domyślna to "Włączone". Po wyłączeniu nowe połączenia nie będą kierowane do tego punktu końcowego, ale istniejące połączenia nie będą miały wpływu. Ta właściwość jest specyficzna dla repliki. Wyłącz regionalny punkt końcowy bez dozwolonej repliki. |
struna |
resourceLogConfiguration (konfiguracja dziennika zasobów) | Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService. | Konfiguracja dziennika zasobów |
resourceZatrzymany | Zatrzymaj lub uruchom zasób. Wartość domyślna to "False". Gdy to prawda, płaszczyzna danych zasobu zostanie zamknięta. Gdy jest to fałsz, płaszczyzna danych zasobu jest uruchamiana. |
struna |
routeSettings (ustawienia trasy) | Ustawienia marszruty dla zasobu | Ustawienia trasy |
bezserwerowy | Ustawienia bezserwerowe. | Ustawienia bezserwerowe |
Protokół TLS | Ustawienia protokołu TLS dla zasobu | SignalRTlsSettings |
Nadrzędnego | Ustawienia nadrzędne, gdy usługa jest w trybie bezserwerowym. | ServerlessUpstreamSettings |
SignalRTlsSettings
Nazwa | Opis | Wartość |
---|---|---|
clientCertEnabled (klient CertWłączone) | Zażądaj certyfikatu klienta podczas uzgadniania protokołu TLS, jeśli jest włączona. Nieobsługiwane w warstwie Bezpłatna. Wszystkie dane wejściowe będą ignorowane dla warstwy Bezpłatna. | Bool |
ThrottleByJwtCustomClaimRule
Nazwa | Opis | Wartość |
---|---|---|
claimName (nazwa roszczenia) | Nazwa oświadczenia w tokenie JWT. Połączenie klienta z tą samą wartością oświadczenia zostanie zagregowane. Jeśli oświadczenie nie zostanie znalezione w tokenie, połączenie będzie dozwolone. | ciąg (wymagany) |
maxCount (maksymalna liczba) | Maksymalna dozwolona liczba połączeń dla tej samej wartości oświadczenia Jwt. Klienci z tym samym oświadczeniem Jwt zostaną odrzuceni, jeśli liczba połączeń przekroczy tę wartość. Wartość domyślna to 20. | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 2147483647 |
typ | "ThrottleByJwtCustomClaimRule" (wymagane) |
ThrottleByJwtSignatureRule
Nazwa | Opis | Wartość |
---|---|---|
maxCount (maksymalna liczba) | Maksymalna dozwolona liczba połączeń dla tego samego podpisu JWT. Klienci z tym samym podpisem JWT zostaną odrzuceni, jeśli liczba połączeń przekroczy tę wartość. Wartość domyślna to 20. | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 2147483647 |
typ | "ThrottleByJwtSignatureRule" (wymagane) |
ThrottleByUserIdRule
Nazwa | Opis | Wartość |
---|---|---|
maxCount (maksymalna liczba) | Maksymalna dozwolona liczba połączeń dla tego samego identyfikatora użytkownika. Klienci o tym samym identyfikatorze użytkownika zostaną odrzuceni, jeśli liczba połączeń przekroczy tę wartość. Wartość domyślna to 20. | Int Ograniczenia: Minimalna wartość = 0 Wartość maksymalna = 2147483647 |
typ | "ThrottleByUserIdRule" (wymagane) |
Śledzone tagi zasobów
Nazwa | Opis | Wartość |
---|
TrafficThrottleByJwtCustomClaimRule
Nazwa | Opis | Wartość |
---|---|---|
aggregationWindowInSeconds | Okno agregacji dla bajtów komunikatów. Bajty komunikatów zostaną zagregowane w tym oknie i zostaną zresetowane po oknie. Wartość domyślna to 60 sekund. | Int Ograniczenia: Minimalna wartość = 10 Wartość maksymalna = 3600 |
claimName (nazwa roszczenia) | Nazwa oświadczenia w tokenie JWT. Bajty komunikatów o tej samej wartości oświadczenia zostaną zagregowane. Jeśli oświadczenie nie zostanie znalezione w tokenie, reguła zostanie pominięta. | ciąg (wymagany) |
maxInboundMessageBytes (Bajty maksymalnych wiadomości) | Maksymalna liczba skumulowanych bajtów komunikatów przychodzących dozwolonych dla tego samego podpisu JWT w przedziale czasu. Klienci z tym samym oświadczeniem JWT zostaną rozłączeni, jeśli bajty komunikatów przekraczają tę wartość. Wartość domyślna to 1 GB. | Int Ograniczenia: Minimalna wartość = 0 |
typ | "TrafficThrottleByJwtCustomClaimRule" (wymagane) |
TrafficThrottleByJwtSignatureRule
Nazwa | Opis | Wartość |
---|---|---|
aggregationWindowInSeconds | Okno agregacji dla bajtów komunikatów. Bajty komunikatów zostaną zagregowane w tym oknie i zostaną zresetowane po oknie. Wartość domyślna to 60 sekund. | Int Ograniczenia: Minimalna wartość = 10 Wartość maksymalna = 3600 |
maxInboundMessageBytes (Bajty maksymalnych wiadomości) | Maksymalna liczba skumulowanych bajtów komunikatów przychodzących dozwolonych dla tego samego podpisu JWT w przedziale czasu. Klienci z tym samym podpisem JWT zostaną rozłączani, jeśli bajty komunikatu przekraczają tę wartość. Wartość domyślna to 1 GB. | Int Ograniczenia: Minimalna wartość = 0 |
typ | "TrafficThrottleByJwtSignatureRule" (wymagane) |
TrafficThrottleByUserIdRule
Nazwa | Opis | Wartość |
---|---|---|
aggregationWindowInSeconds | Okno agregacji dla bajtów komunikatów. Bajty komunikatów zostaną zagregowane w tym oknie i zostaną zresetowane po oknie. Wartość domyślna to 60 sekund. | Int Ograniczenia: Minimalna wartość = 10 Wartość maksymalna = 3600 |
maxInboundMessageBytes (Bajty maksymalnych wiadomości) | Maksymalna liczba skumulowanych bajtów komunikatów przychodzących dozwolonych dla tego samego identyfikatora użytkownika w przedziale czasu. Klienci z tym samym identyfikatorem użytkownika zostaną rozłączone, jeśli bajty komunikatu przekraczają tę wartość. Wartość domyślna to 1 GB. | Int Ograniczenia: Minimalna wartość = 0 |
typ | "TrafficThrottleByUserIdRule" (wymagane) |
Ustawienia uwierzytelniania nadrzędnego
Nazwa | Opis | Wartość |
---|---|---|
managedIdentity (tożsamość zarządzana) | Ustawienia tożsamości zarządzanej dla nadrzędnego elementu. | ManagedIdentitySettings |
typ | Wyliczenie typu uwierzytelniania nadrzędnego. | "ManagedIdentity" "Brak" |
UpstreamTemplate (Szablon nadrzędny)
Nazwa | Opis | Wartość |
---|---|---|
Auth | Ustawienia uwierzytelniania nadrzędnego. Jeśli nie zostanie ustawiona, dla komunikatów nadrzędnych nie jest używane żadne uwierzytelnianie. | Ustawienia uwierzytelniania nadrzędnego |
categoryWzorzec | Pobiera lub ustawia pasujący wzorzec dla nazw kategorii. Jeśli nie zostanie ustawiona, pasuje do dowolnej kategorii. Obsługiwane są 3 rodzaje wzorców: 1. "*", aby pasować do dowolnej nazwy kategorii. 2. Połącz wiele kategorii z ",", na przykład "połączenia,komunikaty", pasuje do kategorii "connections" i "messages". 3. Nazwa pojedynczej kategorii, na przykład "connections", pasuje do kategorii "connections". |
struna |
eventPattern (wzorzec zdarzenia) | Pobiera lub ustawia pasujący wzorzec nazw zdarzeń. Jeśli nie zostanie ustawiona, pasuje do dowolnego zdarzenia. Obsługiwane są 3 rodzaje wzorców: 1. "*", aby pasować do dowolnej nazwy zdarzenia. 2. Połącz wiele zdarzeń z ",", na przykład "połącz,rozłącz", pasuje do zdarzenia "connect" i "disconnect". 3. Pojedyncza nazwa zdarzenia, na przykład "connect", pasuje do "connect". |
struna |
hubPattern (wzorzec piasty) | Pobiera lub ustawia pasujący wzorzec dla nazw centrów. Jeśli nie zostanie ustawiona, pasuje do dowolnego koncentratora. Obsługiwane są 3 rodzaje wzorców: 1. "*", aby pasować do dowolnej nazwy centrum. 2. Połącz wiele koncentratorów z ",", na przykład "hub1,hub2", pasuje do "hub1" i "hub2". 3. Nazwa pojedynczego centrum, na przykład "hub1", pasuje do "hub1". |
struna |
Szablon url | Pobiera lub ustawia szablon nadrzędny adres URL. W szablonie można użyć 3 wstępnie zdefiniowanych parametrów {hub}, {category} {event}. Wartość adresu URL nadrzędnego jest obliczana dynamicznie, gdy pojawia się żądanie klienta. Jeśli na przykład adres URLTemplate jest http://example.com/{hub}/api/{event} , z żądaniem klienta z centrum chat nawiązuje połączenie, najpierw post do tego adresu URL: http://example.com/chat/api/connect . |
ciąg (wymagany) |
UserAssignedIdentityProperty (Właściwość użytkownika)
Nazwa | Opis | Wartość |
---|