Udostępnij za pośrednictwem

Microsoft.SignalRService signalR 2021-10-01

  • Artykuł

Definicja zasobu Bicep

Typ zasobu signalR można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.SignalRService/signalR, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.SignalRService/signalR@2021-10-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    disableAadAuth: bool
    disableLocalAuth: bool
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    networkACLs: {
      defaultAction: 'string'
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
    }
    tls: {
      clientCertEnabled: bool
    }
    upstream: {
      templates: [
        {
          auth: {
            managedIdentity: {
              resource: 'string'
            }
            type: 'string'
          }
          categoryPattern: 'string'
          eventPattern: 'string'
          hubPattern: 'string'
          urlTemplate: 'string'
        }
      ]
    }
  }
}

Wartości właściwości

Signalr

Nazwa Opis Wartość
name Nazwa zasobu ciąg (wymagany)

Limit znaków: 3–63

Prawidłowe znaki:
Alfanumeryczne i łączniki.

Zacznij od litery. Koniec literą lub cyfrą.

Nazwa zasobu musi być unikatowa na platformie Azure.
location Lokalizacja GEOGRAFICZNa zasobu. np. Zachodnie stany USA, Wschodnie stany USA, Północno-środkowe stany USA, Południowo-środkowe stany USA. ciąg
tags Tagi usługi, która jest listą par klucz-wartość, które opisują zasób. Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
sku Informacje dotyczące rozliczeń zasobu. ZasóbSku
Rodzaju Rodzaj usługi, może to być SignalR lub RawWebSockets "RawWebSockets"
"SignalR"
identity Klasa reprezentuje tożsamości zarządzane używane do obsługi żądań i odpowiedzi ManagedIdentity
properties Klasa opisując właściwości zasobu SignalRProperties

ManagedIdentity

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

ManagedIdentityUserAssignedIdentities

Nazwa Opis Wartość
{niestandardowa właściwość} UserAssignedIdentityProperty

UserAssignedIdentityProperty

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

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ą klawisza AccessKey
Po ustawieniu wartości true połączenie z parametrem AccessKey=xxx nie będzie działać.		 bool
funkcje Lista funkcjiFlags.

FeatureFlags, 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 zostanie jawnie ustawiona, zostanie użyta jej globalnie domyślna wartość
Należy jednak pamiętać, że wartość domyślna nie oznacza "false". Różni się w zależności od różnych funkcjiFlags.		 SignalRFeature[]
networkACLs Listy ACL sieci dla zasobu SignalRNetworkACLs
publicNetworkAccess Włącz lub wyłącz dostęp 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.		 ciąg
resourceLogConfiguration Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService. ResourceLogConfiguration
Tls Ustawienia protokołu TLS dla zasobu SignalRTlsSettings
połączenie nadrzędne Ustawienia nadrzędne, gdy usługa jest w trybie bezserwerowym. ServerlessUpstreamSettings

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, zezwalaj na wszystkie domyślnie. ciąg[]

SignalRFeature

Nazwa Opis Wartość
flag 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: Śledzenie na żywo pozwala wiedzieć, co dzieje się w usłudze Azure SignalR Service, daje ślady na żywo w czasie rzeczywistym. Pomocne będzie tworzenie własnej aplikacji internetowej opartej na usłudze Azure SignalR lub samodzielne rozwiązywanie niektórych problemów. Pamiętaj, ż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)
properties Opcjonalne właściwości związane z tą funkcją. SignalRFeatureProperties
wartość Wartość flagi funkcji. Aby uzyskać dozwolone wartości, zobacz dokument https://docs.microsoft.com/azure/azure-signalr/ usługi Azure SignalR Service. ciąg (wymagany)

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 128

SignalRFeatureProperties

Nazwa Opis Wartość
{niestandardowa właściwość} ciąg

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

PrivateEndpointACL

Nazwa Opis Wartość
Umożliwić swobodne otworzenie Dozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI. Tablica ciągów zawierająca dowolną z:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Ślad"
Odmów Odrzucone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI. Tablica ciągów zawierająca dowolną z:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Ślad"
name Nazwa połączenia prywatnego punktu końcowego ciąg (wymagany)

NetworkACL

Nazwa Opis Wartość
Umożliwić swobodne otworzenie Dozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI. Tablica ciągów zawierająca dowolną z:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Ślad"
Odmów Niedozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI. Tablica ciągów zawierająca dowolną z:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Ślad"

ResourceLogConfiguration

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

ResourceLogCategory

Nazwa Opis Wartość
enabled Wskazuje, czy kategoria dziennika zasobów jest włączona.
Dostępne wartości: true, false.
Bez uwzględniania wielkości liter.		 ciąg
name Pobiera lub ustawia nazwę kategorii dziennika zasobów.
Dostępne wartości: ConnectivityLogs, MessagingLogs.
Bez uwzględniania wielkości liter.
 ciąg

SignalRTlsSettings

Nazwa Opis Wartość
clientCertEnabled Żądanie certyfikatu klienta podczas uzgadniania protokołu TLS, jeśli jest włączone bool

ServerlessUpstreamSettings

Nazwa Opis Wartość
szablonów Pobiera lub ustawia listę nadrzędnych szablonów adresów URL. Kolejność ma znaczenie, a pierwszy pasujący szablon ma efekty. UpstreamTemplate[]

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 nazw kategorii. Jeśli nie zostanie ustawiona, pasuje do dowolnej kategorii.
Obsługiwane są 3 rodzaje wzorców:
1. "*", dopasuje 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 "połączenia", pasuje do kategorii "połączenia"		 ciąg
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. "*", dopasuje dowolną nazwę zdarzenia
2. Połącz wiele zdarzeń z ",", na przykład "połącz,rozłącz", pasuje do zdarzenia "connect" i "disconnect"
3. Nazwa pojedynczego zdarzenia, na przykład "connect", pasuje do "connect"		 ciąg
hubPattern Pobiera lub ustawia pasujący wzorzec nazw centrów. Jeśli nie zostanie ustawiona, pasuje do dowolnego koncentratora.
Obsługiwane są 3 rodzaje wzorców:
1. "*", dopasuje dowolną nazwę 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"		 ciąg
urlTemplate Pobiera lub ustawia szablon nadrzędny adres URL. W szablonie można użyć 3 wstępnie zdefiniowanych parametrów {hub}, {category} {event}, a wartość nadrzędnego adresu URL jest obliczana dynamicznie po wejściu żądania klienta.
Jeśli na przykład adres URLTemplate to http://example.com/{hub}/api/{event}, z żądaniem klienta z centrum chat łączy się, najpierw post do tego adresu URL: http://example.com/chat/api/connect.
 ciąg (wymagany)

UpstreamAuthSettings

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

ManagedIdentitySettings

Nazwa Opis Wartość
zasób Zasób wskazujący identyfikator URI identyfikatora aplikacji zasobu docelowego.
Pojawia się również w aud (odbiorcy) oświadczenia wystawionego tokenu.
 ciąg

ZasóbSku

Nazwa Opis Wartość
capacity 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,5,10,20,50,100		 int
name Nazwa jednostki SKU. Wymagane.

Dozwolone wartości: Standard_S1, Free_F1		 ciąg (wymagany)
tier Opcjonalna warstwa tej konkretnej jednostki SKU. "Standardowa" lub "Bezpłatna".

Basic jest przestarzały, zamiast tego użyj polecenia Standard .
 "Podstawowa"
"Za darmo"
"Premium"
"Standardowa"

Szablony szybkiego startu

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

Template Opis
Wdrażanie usługi Azure SignalR

Wdróż na platformie Azure		 Ten szablon tworzy Azure SignalR Service przy użyciu szablonu.

Definicja zasobu szablonu usługi ARM

Typ zasobu signalR można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.SignalRService/signalR, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2021-10-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "disableAadAuth": "bool",
    "disableLocalAuth": "bool",
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "networkACLs": {
      "defaultAction": "string",
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "resourceLogConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ]
    },
    "tls": {
      "clientCertEnabled": "bool"
    },
    "upstream": {
      "templates": [
        {
          "auth": {
            "managedIdentity": {
              "resource": "string"
            },
            "type": "string"
          },
          "categoryPattern": "string",
          "eventPattern": "string",
          "hubPattern": "string",
          "urlTemplate": "string"
        }
      ]
    }
  }
}

Wartości właściwości

Signalr

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.SignalRService/signalR"
apiVersion Wersja interfejsu API zasobów '2021-10-01'
name Nazwa zasobu ciąg (wymagany)

Limit znaków: 3–63

Prawidłowe znaki:
Alfanumeryczne i łączniki.

Zacznij od litery. Koniec literą lub cyfrą.

Nazwa zasobu musi być unikatowa na platformie Azure.
location Lokalizacja GEOGRAFICZNa zasobu. np. Zachodnie stany USA, Wschodnie stany USA, Północno-środkowe stany USA, Południowo-środkowe stany USA. ciąg
tags Tagi usługi, która jest listą par klucz-wartość, które opisują zasób. Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
sku Informacje dotyczące rozliczeń zasobu. ZasóbSku
Rodzaju Rodzaj usługi, może to być SignalR lub RawWebSockets "RawWebSockets"
"SignalR"
identity Klasa reprezentuje tożsamości zarządzane używane do obsługi żądań i odpowiedzi ManagedIdentity
properties Klasa opisując właściwości zasobu SignalRProperties

ManagedIdentity

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

ManagedIdentityUserAssignedIdentities

Nazwa Opis Wartość
{niestandardowa właściwość} UserAssignedIdentityProperty

UserAssignedIdentityProperty

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

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ą klawisza AccessKey
Po ustawieniu wartości true połączenie z parametrem 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 zostanie 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ę on pod względem różnych funkcjiFlags.		 SignalRFeature[]
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.		 ciąg
resourceLogConfiguration Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService. ResourceLogConfiguration
Tls Ustawienia protokołu TLS dla zasobu SignalRTlsSettings
połączenie nadrzędne Ustawienia nadrzędne, gdy usługa jest w trybie bezserwerowym. ServerlessUpstreamSettings

SignalRCorsSettings

Nazwa Opis Wartość
allowedOrigins Pobiera lub ustawia listę źródeł, które powinny być dozwolone do wywołań między źródłami (na przykład: http://example.com:12345). Użyj "*", aby zezwolić na wszystkie. Jeśli pominięto, domyślnie zezwalaj na wszystkie. ciąg[]

SignalRFeature

Nazwa Opis Wartość
flag 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, zapewni śledzenie na żywo w czasie rzeczywistym. Pomocne będzie tworzenie własnej aplikacji internetowej opartej na usłudze Azure SignalR lub samodzielne rozwiązywanie 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)
properties Opcjonalne właściwości związane z tą funkcją. SignalRFeatureProperties
wartość Wartość flagi funkcji. Aby uzyskać informacje o dozwolonych wartościach, zobacz dokument https://docs.microsoft.com/azure/azure-signalr/ dotyczący usługi Azure SignalR Service. ciąg (wymagany)

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 128

SignalRFeatureProperties

Nazwa Opis Wartość
{niestandardowa właściwość} ciąg

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

PrivateEndpointACL

Nazwa Opis Wartość
Umożliwić swobodne otworzenie Dozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI. Tablica ciągów zawierająca dowolną z:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Ślad"
Odmów Niedozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI. Tablica ciągów zawierająca dowolną z:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Ślad"
name Nazwa połączenia prywatnego punktu końcowego ciąg (wymagany)

NetworkACL

Nazwa Opis Wartość
Umożliwić swobodne otworzenie Dozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI. Tablica ciągów zawierająca dowolną z:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Ślad"
Odmów Niedozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI. Tablica ciągów zawierająca dowolną z:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Ślad"

ResourceLogConfiguration

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

ResourceLogCategory

Nazwa Opis Wartość
enabled Wskazuje, czy kategoria dziennika zasobów jest włączona.
Dostępne wartości: true, false.
Bez uwzględniania wielkości liter.		 ciąg
name Pobiera lub ustawia nazwę kategorii dziennika zasobów.
Dostępne wartości: ConnectivityLogs, MessagingLogs.
Bez uwzględniania wielkości liter.
 ciąg

SignalRTlsSettings

Nazwa Opis Wartość
clientCertEnabled Żądanie certyfikatu klienta podczas uzgadniania protokołu TLS, jeśli jest włączone bool

ServerlessUpstreamSettings

Nazwa Opis Wartość
szablonów Pobiera lub ustawia listę nadrzędnych szablonów adresów URL. Kolejność ma znaczenie, a pierwszy pasujący szablon ma efekty. UpstreamTemplate[]

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 nazw kategorii. Jeśli nie zostanie ustawiona, pasuje do dowolnej kategorii.
Obsługiwane są 3 rodzaje wzorców:
1. "*", dopasuje 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 "połączenia", pasuje do kategorii "połączenia"		 ciąg
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. "*", dopasuje dowolną nazwę zdarzenia
2. Połącz wiele zdarzeń z ",", na przykład "połącz,rozłącz", pasuje do zdarzenia "connect" i "disconnect"
3. Nazwa pojedynczego zdarzenia, na przykład "connect", pasuje do "connect"		 ciąg
hubPattern Pobiera lub ustawia pasujący wzorzec nazw centrów. Jeśli nie zostanie ustawiona, pasuje do dowolnego koncentratora.
Obsługiwane są 3 rodzaje wzorców:
1. "*", dopasuje dowolną nazwę 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"		 ciąg
urlTemplate Pobiera lub ustawia szablon nadrzędny adres URL. W szablonie można użyć 3 wstępnie zdefiniowanych parametrów {hub}, {category} {event}, a wartość nadrzędnego adresu URL jest obliczana dynamicznie po wejściu żądania klienta.
Jeśli na przykład adres URLTemplate to http://example.com/{hub}/api/{event}, z żądaniem klienta z centrum chat łączy się, najpierw post do tego adresu URL: http://example.com/chat/api/connect.
 ciąg (wymagany)

UpstreamAuthSettings

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

ManagedIdentitySettings

Nazwa Opis Wartość
zasób Zasób wskazujący identyfikator URI identyfikatora aplikacji zasobu docelowego.
Pojawia się również w aud (odbiorcy) oświadczenia wystawionego tokenu.
 ciąg

ZasóbSku

Nazwa Opis Wartość
capacity 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,5,10,20,50,100		 int
name Nazwa jednostki SKU. Wymagane.

Dozwolone wartości: Standard_S1, Free_F1		 ciąg (wymagany)
tier Opcjonalna warstwa tej konkretnej jednostki SKU. "Standardowa" lub "Bezpłatna".

Basic jest przestarzały, zamiast tego użyj polecenia Standard .
 "Podstawowa"
"Za darmo"
"Premium"
"Standardowa"

Szablony szybkiego startu

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

Template Opis
Wdrażanie usługi Azure SignalR

Wdróż na platformie Azure		 Ten szablon tworzy Azure SignalR Service przy użyciu szablonu.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu signalR można wdrożyć z operacjami docelowymi:

  • Grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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@2021-10-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      disableAadAuth = bool
      disableLocalAuth = bool
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      networkACLs = {
        defaultAction = "string"
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      resourceLogConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
      }
      tls = {
        clientCertEnabled = bool
      }
      upstream = {
        templates = [
          {
            auth = {
              managedIdentity = {
                resource = "string"
              }
              type = "string"
            }
            categoryPattern = "string"
            eventPattern = "string"
            hubPattern = "string"
            urlTemplate = "string"
          }
        ]
      }
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
    kind = "string"
  })
}

Wartości właściwości

Signalr

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.SignalRService/signalR@2021-10-01"
name Nazwa zasobu ciąg (wymagany)

Limit znaków: 3–63

Prawidłowe znaki:
Alfanumeryczne i łączniki.

Zacznij od litery. Koniec literą lub cyfrą.

Nazwa zasobu musi być unikatowa na platformie Azure.
location Lokalizacja GEOGRAFICZNa zasobu. np. Zachodnie stany USA, Wschodnie stany USA, Północno-środkowe stany USA, Południowo-środkowe stany USA. ciąg
parent_id Aby przeprowadzić wdrożenie w grupie zasobów, użyj identyfikatora tej grupy zasobów. ciąg (wymagany)
tags Tagi usługi, która jest listą par klucz-wartość, które opisują zasób. Słownik nazw tagów i wartości.
sku Informacje dotyczące rozliczeń zasobu. ZasóbSku
Rodzaju Rodzaj usługi, może to być SignalR lub RawWebSockets "RawWebSockets"
"SignalR"
identity Klasa reprezentuje tożsamości zarządzane używane do obsługi żądań i odpowiedzi ManagedIdentity
properties Klasa opisując właściwości zasobu SignalRProperties

ManagedIdentity

Nazwa Opis Wartość
typ Reprezentuje typ tożsamości: systemAssigned, userAssigned, None "SystemAssigned"
"UserAssigned"
identity_ids Pobieranie lub ustawianie tożsamości przypisanych przez użytkownika Tablica identyfikatorów tożsamości użytkowników.

ManagedIdentityUserAssignedIdentities

Nazwa Opis Wartość
{niestandardowa właściwość} UserAssignedIdentityProperty

UserAssignedIdentityProperty

Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.

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ą klawisza AccessKey
Po ustawieniu wartości true połączenie z parametrem 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 zostanie 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ę on pod względem różnych funkcjiFlags.		 SignalRFeature[]
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.		 ciąg
resourceLogConfiguration Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService. ResourceLogConfiguration
Tls Ustawienia protokołu TLS dla zasobu SignalRTlsSettings
połączenie nadrzędne Ustawienia nadrzędne, gdy usługa jest w trybie bezserwerowym. ServerlessUpstreamSettings

SignalRCorsSettings

Nazwa Opis Wartość
allowedOrigins Pobiera lub ustawia listę źródeł, które powinny być dozwolone do wywołań między źródłami (na przykład: http://example.com:12345). Użyj "*", aby zezwolić na wszystkie. Jeśli pominięto, domyślnie zezwalaj na wszystkie. ciąg[]

SignalRFeature

Nazwa Opis Wartość
flag 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, zapewni śledzenie na żywo w czasie rzeczywistym. Pomocne będzie tworzenie własnej aplikacji internetowej opartej na usłudze Azure SignalR lub samodzielne rozwiązywanie 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" (wymagany)
properties Opcjonalne właściwości związane z tą funkcją. SignalRFeatureProperties
wartość Wartość flagi funkcji. Aby uzyskać informacje o dozwolonych wartościach, zobacz dokument https://docs.microsoft.com/azure/azure-signalr/ dotyczący usługi Azure SignalR Service. ciąg (wymagany)

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 128

SignalRFeatureProperties

Nazwa Opis Wartość
{niestandardowa właściwość} ciąg

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

PrivateEndpointACL

Nazwa Opis Wartość
Umożliwić swobodne otworzenie Dozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI. Tablica ciągów zawierająca dowolną z:
"ClientConnection"
"RESTAPI"
"SerwerPołączenie"
"Ślad"
Odmów Niedozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI. Tablica ciągów zawierająca dowolną z:
"ClientConnection"
"RESTAPI"
"SerwerPołączenie"
"Ślad"
name Nazwa połączenia prywatnego punktu końcowego ciąg (wymagany)

NetworkACL

Nazwa Opis Wartość
Umożliwić swobodne otworzenie Dozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI. Tablica ciągów zawierająca dowolną z:
"ClientConnection"
"RESTAPI"
"SerwerPołączenie"
"Ślad"
Odmów Niedozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI. Tablica ciągów zawierająca dowolną z:
"ClientConnection"
"RESTAPI"
"SerwerPołączenie"
"Ślad"

ResourceLogConfiguration

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

ResourceLogCategory

Nazwa Opis Wartość
enabled Wskazuje, czy kategoria dziennika zasobów jest włączona.
Dostępne wartości: true, false.
Bez uwzględniania wielkości liter.		 ciąg
name Pobiera lub ustawia nazwę kategorii dziennika zasobów.
Dostępne wartości: ConnectivityLogs, MessagingLogs.
Bez uwzględniania wielkości liter.
 ciąg

SignalRTlsSettings

Nazwa Opis Wartość
clientCertEnabled Żądanie certyfikatu klienta podczas uzgadniania protokołu TLS, jeśli jest włączone bool

ServerlessUpstreamSettings

Nazwa Opis Wartość
szablonów Pobiera lub ustawia listę nadrzędnych szablonów adresów URL. Kolejność ma znaczenie, a pierwszy pasujący szablon przyjmuje efekty. UpstreamTemplate[]

UpstreamTemplate

Nazwa Opis Wartość
Auth Ustawienia nadrzędnego uwierzytelniania. Jeśli nie zostanie ustawiona, dla komunikatów nadrzędnych nie jest używany żaden uwierzytelnianie. UpstreamAuthSettings
categoryPattern Pobiera lub ustawia pasujący wzorzec nazw kategorii. Jeśli nie zostanie ustawiona, będzie ona zgodna z dowolną kategorią.
Obsługiwane są 3 rodzaje wzorców:
1. "*", aby pasować do dowolnej nazwy kategorii
2. Łączenie wielu kategorii z ",", na przykład "połączenia,komunikaty", pasuje do kategorii "połączenia" i "komunikaty"
3. Nazwa pojedynczej kategorii, na przykład "połączenia", pasuje do kategorii "połączenia"		 ciąg
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"		 ciąg
hubPattern Pobiera lub ustawia pasujący wzorzec nazw centrów. Jeśli nie zostanie ustawiona, będzie ona zgodna z dowolnym koncentratorem.
Obsługiwane są 3 rodzaje wzorców:
1. "*", aby pasować do dowolnej nazwy centrum
2. Łączenie wielu koncentratorów z ",", na przykład "hub1,hub2", pasuje do "hub1" i "hub2"
3. Pojedyncza nazwa centrum, na przykład "hub1", pasuje do "hub1"		 ciąg
urlTemplate Pobiera lub konfiguruje szablon nadrzędnego adresu URL. W szablonie można użyć 3 wstępnie zdefiniowanych parametrów {hub}, {category} {event}, wartość adresu URL nadrzędnego jest dynamicznie obliczana, gdy pojawi się żądanie klienta.
Jeśli na przykład adres URLTemplate to http://example.com/{hub}/api/{event}, z żądaniem klienta z centrum chat łączy się, najpierw opublikuj adres POST pod tym adresem URL: http://example.com/chat/api/connect.
 ciąg (wymagany)

UpstreamAuthSettings

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

ManagedIdentitySettings

Nazwa Opis Wartość
zasób Zasób wskazujący identyfikator URI identyfikatora aplikacji zasobu docelowego.
Pojawia się również w oświadczeniu aud (odbiorcy) wystawionego tokenu.
 ciąg

ResourceSku

Nazwa Opis Wartość
capacity 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,5,10,20,50,100		 int
name Nazwa jednostki SKU. Wymagane.

Dozwolone wartości: Standard_S1, Free_F1		 ciąg (wymagany)
tier Opcjonalna warstwa tej konkretnej jednostki SKU. "Standardowa" lub "Bezpłatna".

Basic jest przestarzały, zamiast tego użyj polecenia Standard .
 "Podstawowa"
"Bezpłatna"
"Premium"
"Standardowa"