Udostępnij za pośrednictwem

Microsoft.SignalRService signalR 2023-02-01

  • Artykuł

Definicja zasobu Bicep

Typ zasobu signalR można wdrożyć przy użyciu operacji docelowych:

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@2023-02-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    disableAadAuth: bool
    disableLocalAuth: bool
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    liveTraceConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
      enabled: 'string'
    }
    networkACLs: {
      defaultAction: 'string'
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
    }
    serverless: {
      connectionTimeoutInSeconds: int
    }
    tls: {
      clientCertEnabled: bool
    }
    upstream: {
      templates: [
        {
          auth: {
            managedIdentity: {
              resource: 'string'
            }
            type: 'string'
          }
          categoryPattern: 'string'
          eventPattern: 'string'
          hubPattern: 'string'
          urlTemplate: 'string'
        }
      ]
    }
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

LiveTraceCategory

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

LiveTraceConfiguration

Nazwa Opis Wartość
Kategorie Pobiera lub ustawia listę konfiguracji kategorii. LiveTraceCategory[]
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"
userAssignedIdentities 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ść

Microsoft.SignalRService/signalR

Nazwa Opis Wartość
tożsamość Klasa reprezentuje tożsamości zarządzane używane do żądania i odpowiedzi ManagedIdentity
rodzaj Rodzaj usługi, może to być SignalR lub RawWebSockets "RawWebSockets"
"SignalR"
lokalizacja Lokalizacja GEOGRAFICZNa zasobu. np. Zachodnie stany USA East US Północno-środkowe stany USA Południowo-środkowe stany USA. struna
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Klasa opisując właściwości zasobu SignalRProperties
Numer jednostki magazynowej Informacje o rozliczeniach zasobu. ResourceSku
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

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)

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

ResourceLogConfiguration

Nazwa Opis Wartość
Kategorie Pobiera lub ustawia listę konfiguracji kategorii. ResourceLogCategory[]

ResourceSku

Nazwa Opis Wartość
pojemność Opcjonalnie, liczba całkowita. Liczba jednostek zasobu. Domyślnie 1.

Jeśli są obecne, dozwolone są następujące wartości:
Bezpłatna: 1;
Standardowa: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;		 Int
nazwa Nazwa jednostki SKU. Wymagane.

Dozwolone wartości: Standard_S1, Free_F1, Premium_P1		 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 bezserwerowe

Nazwa Opis Wartość
connectionTimeoutInSeconds 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

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. UpstreamTemplate[]

SignalRCorsSettings

Nazwa Opis Wartość
allowedOrigins 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. string[]

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ą. SignalRFeatureProperties
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ść = 1 (wymagana)

SignalRFeatureProperties

Nazwa Opis Wartość

SignalRNetworkACLs

Nazwa Opis Wartość
defaultAction Akcja listy ACL sieci platformy Azure. "Zezwalaj"
"Odmów"
privateEndpoints Listy ACL dla żądań z prywatnych punktów końcowych privateEndpointACL[]
publicNetwork Lista ACL sieci NetworkACL

SignalRProperties

Nazwa Opis Wartość
cors Ustawienia współużytkowania zasobów między źródłami (CORS). SignalRCorsSettings
disableAadAuth DisableLocalAuth
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 DisableLocalAuth
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.		 SignalRFeature[]
liveTraceConfiguration Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService. LiveTraceConfiguration
networkACLs Listy ACL sieci dla zasobu SignalRNetworkACLs
publicNetworkAccess 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
resourceLogConfiguration Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService. ResourceLogConfiguration
bezserwerowy Ustawienia bezserwerowe. ServerlessSettings
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 Żądanie certyfikatu klienta podczas uzgadniania protokołu TLS, jeśli jest włączone Bool

TrackedResourceTags

Nazwa Opis Wartość

UpstreamAuthSettings

Nazwa Opis Wartość
managedIdentity Ustawienia tożsamości zarządzanej dla nadrzędnego elementu. ManagedIdentitySettings
typ Wyliczenie typu uwierzytelniania nadrzędnego. "ManagedIdentity"
"Brak"

UpstreamTemplate

Nazwa Opis Wartość
Auth Ustawienia uwierzytelniania nadrzędnego. Jeśli nie zostanie ustawiona, dla komunikatów nadrzędnych nie jest używane żadne uwierzytelnianie. UpstreamAuthSettings
categoryPattern 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 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 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
urlTemplate 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

Nazwa Opis Wartość

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ 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:

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": "2023-02-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "disableAadAuth": "bool",
    "disableLocalAuth": "bool",
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "liveTraceConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ],
      "enabled": "string"
    },
    "networkACLs": {
      "defaultAction": "string",
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "resourceLogConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ]
    },
    "serverless": {
      "connectionTimeoutInSeconds": "int"
    },
    "tls": {
      "clientCertEnabled": "bool"
    },
    "upstream": {
      "templates": [
        {
          "auth": {
            "managedIdentity": {
              "resource": "string"
            },
            "type": "string"
          },
          "categoryPattern": "string",
          "eventPattern": "string",
          "hubPattern": "string",
          "urlTemplate": "string"
        }
      ]
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

LiveTraceCategory

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

LiveTraceConfiguration

Nazwa Opis Wartość
Kategorie Pobiera lub ustawia listę konfiguracji kategorii. LiveTraceCategory[]
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"
userAssignedIdentities 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ść

Microsoft.SignalRService/signalR

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2023-02-01'
tożsamość Klasa reprezentuje tożsamości zarządzane używane do żądania i odpowiedzi ManagedIdentity
rodzaj Rodzaj usługi, może to być SignalR lub RawWebSockets "RawWebSockets"
"SignalR"
lokalizacja Lokalizacja GEOGRAFICZNa zasobu. np. Zachodnie stany USA East US Północno-środkowe stany USA Południowo-środkowe stany USA. struna
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Klasa opisując właściwości zasobu SignalRProperties
Numer jednostki magazynowej Informacje o rozliczeniach zasobu. ResourceSku
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.SignalRService/signalR"

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)

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

ResourceLogConfiguration

Nazwa Opis Wartość
Kategorie Pobiera lub ustawia listę konfiguracji kategorii. ResourceLogCategory[]

ResourceSku

Nazwa Opis Wartość
pojemność Opcjonalnie, liczba całkowita. Liczba jednostek zasobu. Domyślnie 1.

Jeśli są obecne, dozwolone są następujące wartości:
Bezpłatna: 1;
Standardowa: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;		 Int
nazwa Nazwa jednostki SKU. Wymagane.

Dozwolone wartości: Standard_S1, Free_F1, Premium_P1		 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 bezserwerowe

Nazwa Opis Wartość
connectionTimeoutInSeconds 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

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. UpstreamTemplate[]

SignalRCorsSettings

Nazwa Opis Wartość
allowedOrigins 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. string[]

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ą. SignalRFeatureProperties
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ść = 1 (wymagana)

SignalRFeatureProperties

Nazwa Opis Wartość

SignalRNetworkACLs

Nazwa Opis Wartość
defaultAction Akcja listy ACL sieci platformy Azure. "Zezwalaj"
"Odmów"
privateEndpoints Listy ACL dla żądań z prywatnych punktów końcowych privateEndpointACL[]
publicNetwork Lista ACL sieci NetworkACL

SignalRProperties

Nazwa Opis Wartość
cors Ustawienia współużytkowania zasobów między źródłami (CORS). SignalRCorsSettings
disableAadAuth DisableLocalAuth
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 DisableLocalAuth
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.		 SignalRFeature[]
liveTraceConfiguration Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService. LiveTraceConfiguration
networkACLs Listy ACL sieci dla zasobu SignalRNetworkACLs
publicNetworkAccess 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
resourceLogConfiguration Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService. ResourceLogConfiguration
bezserwerowy Ustawienia bezserwerowe. ServerlessSettings
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 Żądanie certyfikatu klienta podczas uzgadniania protokołu TLS, jeśli jest włączone Bool

TrackedResourceTags

Nazwa Opis Wartość

UpstreamAuthSettings

Nazwa Opis Wartość
managedIdentity Ustawienia tożsamości zarządzanej dla nadrzędnego elementu. ManagedIdentitySettings
typ Wyliczenie typu uwierzytelniania nadrzędnego. "ManagedIdentity"
"Brak"

UpstreamTemplate

Nazwa Opis Wartość
Auth Ustawienia uwierzytelniania nadrzędnego. Jeśli nie zostanie ustawiona, dla komunikatów nadrzędnych nie jest używane żadne uwierzytelnianie. UpstreamAuthSettings
categoryPattern 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 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 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
urlTemplate 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

Nazwa Opis Wartość

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
wdrażanie usługi Azure SignalR Service

wdrażanie w usłudze Azure		 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@2023-02-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      disableAadAuth = bool
      disableLocalAuth = bool
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      liveTraceConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
        enabled = "string"
      }
      networkACLs = {
        defaultAction = "string"
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      resourceLogConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
      }
      serverless = {
        connectionTimeoutInSeconds = int
      }
      tls = {
        clientCertEnabled = bool
      }
      upstream = {
        templates = [
          {
            auth = {
              managedIdentity = {
                resource = "string"
              }
              type = "string"
            }
            categoryPattern = "string"
            eventPattern = "string"
            hubPattern = "string"
            urlTemplate = "string"
          }
        ]
      }
    }
  })
  sku = {
    capacity = int
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

Wartości właściwości

LiveTraceCategory

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

LiveTraceConfiguration

Nazwa Opis Wartość
Kategorie Pobiera lub ustawia listę konfiguracji kategorii. LiveTraceCategory[]
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"
userAssignedIdentities 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ść

Microsoft.SignalRService/signalR

Nazwa Opis Wartość
tożsamość Klasa reprezentuje tożsamości zarządzane używane do żądania i odpowiedzi ManagedIdentity
rodzaj Rodzaj usługi, może to być SignalR lub RawWebSockets "RawWebSockets"
"SignalR"
lokalizacja Lokalizacja GEOGRAFICZNa zasobu. np. Zachodnie stany USA East US Północno-środkowe stany USA Południowo-środkowe stany USA. struna
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Klasa opisując właściwości zasobu SignalRProperties
Numer jednostki magazynowej Informacje o rozliczeniach zasobu. ResourceSku
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.SignalRService/signalR@2023-02-01"

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)

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

ResourceLogConfiguration

Nazwa Opis Wartość
Kategorie Pobiera lub ustawia listę konfiguracji kategorii. ResourceLogCategory[]

ResourceSku

Nazwa Opis Wartość
pojemność Opcjonalnie, liczba całkowita. Liczba jednostek zasobu. Domyślnie 1.

Jeśli są obecne, dozwolone są następujące wartości:
Bezpłatna: 1;
Standardowa: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;		 Int
nazwa Nazwa jednostki SKU. Wymagane.

Dozwolone wartości: Standard_S1, Free_F1, Premium_P1		 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 bezserwerowe

Nazwa Opis Wartość
connectionTimeoutInSeconds 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

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. UpstreamTemplate[]

SignalRCorsSettings

Nazwa Opis Wartość
allowedOrigins 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. string[]

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ą. SignalRFeatureProperties
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ść = 1 (wymagana)

SignalRFeatureProperties

Nazwa Opis Wartość

SignalRNetworkACLs

Nazwa Opis Wartość
defaultAction Akcja listy ACL sieci platformy Azure. "Zezwalaj"
"Odmów"
privateEndpoints Listy ACL dla żądań z prywatnych punktów końcowych privateEndpointACL[]
publicNetwork Lista ACL sieci NetworkACL

SignalRProperties

Nazwa Opis Wartość
cors Ustawienia współużytkowania zasobów między źródłami (CORS). SignalRCorsSettings
disableAadAuth DisableLocalAuth
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 DisableLocalAuth
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.		 SignalRFeature[]
liveTraceConfiguration Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService. LiveTraceConfiguration
networkACLs Listy ACL sieci dla zasobu SignalRNetworkACLs
publicNetworkAccess 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
resourceLogConfiguration Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService. ResourceLogConfiguration
bezserwerowy Ustawienia bezserwerowe. ServerlessSettings
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 Żądanie certyfikatu klienta podczas uzgadniania protokołu TLS, jeśli jest włączone Bool

TrackedResourceTags

Nazwa Opis Wartość

UpstreamAuthSettings

Nazwa Opis Wartość
managedIdentity Ustawienia tożsamości zarządzanej dla nadrzędnego elementu. ManagedIdentitySettings
typ Wyliczenie typu uwierzytelniania nadrzędnego. "ManagedIdentity"
"Brak"

UpstreamTemplate

Nazwa Opis Wartość
Auth Ustawienia uwierzytelniania nadrzędnego. Jeśli nie zostanie ustawiona, dla komunikatów nadrzędnych nie jest używane żadne uwierzytelnianie. UpstreamAuthSettings
categoryPattern 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 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 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
urlTemplate 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

Nazwa Opis Wartość