Microsoft.SignalRService signalR 2021-04-01-preview

Artykuł
10/26/2024

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@2021-04-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    networkACLs: {
      defaultAction: 'string'
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          '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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

Identyfikator zarządzany

Nazwa	Opis	Wartość
typ	Reprezentują 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ść	Odpowiedź tożsamości zarządzanej	ManagedIdentity
rodzaj	Rodzaj usługi — np. "SignalR" dla "Microsoft.SignalRService/SignalR"	"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	Ustawienia używane do aprowizowania lub konfigurowania zasobu	SignalRProperties
Numer jednostki magazynowej	Informacje o rozliczeniach zasobu. (np. Bezpłatna, Standardowa)	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)

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,5,10,20,50,100	Int
nazwa	Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1	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"

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	Domyślna akcja, gdy żadna inna reguła nie jest zgodna	"Zezwalaj" "Odmów"
privateEndpoints	Listy ACL dla żądań z prywatnych punktów końcowych	privateEndpointACL[]
publicNetwork	Lista ACL żądań z sieci publicznej	NetworkACL

SignalRProperties

Nazwa	Opis	Wartość
cors	Ustawienia współużytkowania zasobów między źródłami (CORS).	SignalRCorsSettings
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[]
networkACLs	Listy ACL sieci	SignalRNetworkACLs
tls	Ustawienia protokołu TLS.	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	Pobiera lub ustawia ustawienia tożsamości zarządzanej. Jest to wymagane, jeśli typ uwierzytelniania jest ustawiony na Wartość ManagedIdentity.	ManagedIdentitySettings
typ	Pobiera lub ustawia typ uwierzytelniania. Brak lub tożsamość zarządzana jest teraz obsługiwana.	"ManagedIdentity" "Brak"

UpstreamTemplate

Nazwa	Opis	Wartość
Auth	Pobiera lub ustawia 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. Łączenie wielu 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"	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 dopasować dowolną nazwę 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:

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": "2021-04-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "networkACLs": {
      "defaultAction": "string",
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

Identyfikator zarządzany

Nazwa	Opis	Wartość
typ	Reprezentują 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	"2021-04-01-preview"
tożsamość	Odpowiedź tożsamości zarządzanej	ManagedIdentity
rodzaj	Rodzaj usługi — np. "SignalR" dla "Microsoft.SignalRService/SignalR"	"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	Ustawienia używane do aprowizowania lub konfigurowania zasobu	SignalRProperties
Numer jednostki magazynowej	Informacje o rozliczeniach zasobu. (np. Bezpłatna, Standardowa)	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)

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,5,10,20,50,100	Int
nazwa	Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1	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"

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	Domyślna akcja, gdy żadna inna reguła nie jest zgodna	"Zezwalaj" "Odmów"
privateEndpoints	Listy ACL dla żądań z prywatnych punktów końcowych	privateEndpointACL[]
publicNetwork	Lista ACL żądań z sieci publicznej	NetworkACL

SignalRProperties

Nazwa	Opis	Wartość
cors	Ustawienia współużytkowania zasobów między źródłami (CORS).	SignalRCorsSettings
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[]
networkACLs	Listy ACL sieci	SignalRNetworkACLs
tls	Ustawienia protokołu TLS.	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	Pobiera lub ustawia ustawienia tożsamości zarządzanej. Jest to wymagane, jeśli typ uwierzytelniania jest ustawiony na Wartość ManagedIdentity.	ManagedIdentitySettings
typ	Pobiera lub ustawia typ uwierzytelniania. Brak lub tożsamość zarządzana jest teraz obsługiwana.	"ManagedIdentity" "Brak"

UpstreamTemplate

Nazwa	Opis	Wartość
Auth	Pobiera lub ustawia 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. Łączenie wielu 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"	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 dopasować dowolną nazwę 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	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@2021-04-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      networkACLs = {
        defaultAction = "string"
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "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"
  }
  tags = {
    {customized property} = "string"
  }
}

Wartości właściwości

Identyfikator zarządzany

Nazwa	Opis	Wartość
typ	Reprezentują 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ść	Odpowiedź tożsamości zarządzanej	ManagedIdentity
rodzaj	Rodzaj usługi — np. "SignalR" dla "Microsoft.SignalRService/SignalR"	"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	Ustawienia używane do aprowizowania lub konfigurowania zasobu	SignalRProperties
Numer jednostki magazynowej	Informacje o rozliczeniach zasobu. (np. Bezpłatna, Standardowa)	ResourceSku
Tagi	Tagi zasobów	Słownik nazw tagów i wartości.
typ	Typ zasobu	"Microsoft.SignalRService/signalR@2021-04-01-preview"

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)

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,5,10,20,50,100	Int
nazwa	Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1	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"

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	Domyślna akcja, gdy żadna inna reguła nie jest zgodna	"Zezwalaj" "Odmów"
privateEndpoints	Listy ACL dla żądań z prywatnych punktów końcowych	privateEndpointACL[]
publicNetwork	Lista ACL żądań z sieci publicznej	NetworkACL

SignalRProperties

Nazwa	Opis	Wartość
cors	Ustawienia współużytkowania zasobów między źródłami (CORS).	SignalRCorsSettings
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[]
networkACLs	Listy ACL sieci	SignalRNetworkACLs
tls	Ustawienia protokołu TLS.	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	Pobiera lub ustawia ustawienia tożsamości zarządzanej. Jest to wymagane, jeśli typ uwierzytelniania jest ustawiony na Wartość ManagedIdentity.	ManagedIdentitySettings
typ	Pobiera lub ustawia typ uwierzytelniania. Brak lub tożsamość zarządzana jest teraz obsługiwana.	"ManagedIdentity" "Brak"

UpstreamTemplate

Nazwa	Opis	Wartość
Auth	Pobiera lub ustawia 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. Łączenie wielu 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"	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 dopasować dowolną nazwę 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ść

Udostępnij za pośrednictwem

Microsoft.SignalRService signalR 2021-04-01-preview

Definicja zasobu Bicep

Format zasobu

Wartości właściwości

Identyfikator zarządzany

ManagedIdentitySettings

ManagedIdentityUserAssignedIdentities

Microsoft.SignalRService/signalR

NetworkACL

PrivateEndpointACL

ResourceSku

ServerlessUpstreamSettings

SignalRCorsSettings

SignalRFeature

SignalRFeatureProperties

SignalRNetworkACLs

SignalRProperties

SignalRTlsSettings

TrackedResourceTags

UpstreamAuthSettings

UpstreamTemplate

UserAssignedIdentityProperty

Przykłady z przewodnika Szybki start

Definicja zasobu szablonu usługi ARM

Format zasobu

Wartości właściwości

Identyfikator zarządzany

ManagedIdentitySettings

ManagedIdentityUserAssignedIdentities

Microsoft.SignalRService/signalR

NetworkACL

PrivateEndpointACL

ResourceSku

ServerlessUpstreamSettings

SignalRCorsSettings

SignalRFeature

SignalRFeatureProperties

SignalRNetworkACLs

SignalRProperties

SignalRTlsSettings

TrackedResourceTags

UpstreamAuthSettings

UpstreamTemplate

UserAssignedIdentityProperty

Szablony szybkiego startu

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Format zasobu

Wartości właściwości

Identyfikator zarządzany

ManagedIdentitySettings

ManagedIdentityUserAssignedIdentities

Microsoft.SignalRService/signalR

NetworkACL

PrivateEndpointACL

ResourceSku

ServerlessUpstreamSettings

SignalRCorsSettings

SignalRFeature

SignalRFeatureProperties

SignalRNetworkACLs

SignalRProperties

SignalRTlsSettings

TrackedResourceTags

UpstreamAuthSettings

UpstreamTemplate

UserAssignedIdentityProperty

Opinia

Dodatkowe zasoby