Microsoft.SignalRService signalR 2020-07-01-preview
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 dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.SignalRService/signalR, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.SignalRService/signalR@2020-07-01-preview' = {
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'
]
}
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'
}
]
}
}
}
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. Zakończ literą lub cyfrą. Nazwa zasobu musi być unikatowa na platformie Azure. |
location | Lokalizacja GEO 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ści opisujących zasób. | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
sku | Informacje dotyczące rozliczeń zasobu. (np. Bezpłatna, Standardowa) | ResourceSku |
Rodzaju | Rodzaj usługi — np. "SignalR" dla "Microsoft.SignalRService/SignalR" | "RawWebSockets" "SignalR" |
identity | Odpowiedź tożsamości zarządzanej | ManagedIdentity |
properties | Ustawienia używane do aprowizowania lub konfigurowania 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 |
funkcje | Lista funkcji usługi SignalRFlags. np. ServiceMode. 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. Gdy funkcjaFlag nie jest jawnie ustawiona, usługa SignalR będzie używać jej globalnej wartości domyślnej. 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 | SignalRNetworkACLs |
Tls | Ustawienia protokołu TLS. | SignalRTlsSettings |
połączenie nadrzędne | Ustawienia nadrzędne, gdy usługa Azure SignalR 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. |
"EnableConnectivityLogs" "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 domyślna, 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 |
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" |
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" |
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" |
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" |
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 | Pobiera lub ustawia ustawienia uwierzytelniania nadrzędnego. 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 | 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" |
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 usługi SignalR. 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" |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
Template | Opis |
---|---|
Wdrażanie usługi Azure SignalR Service |
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:
- 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 dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.SignalRService/signalR, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2020-07-01-preview",
"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" ]
},
"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"
}
]
}
}
}
Wartości właściwości
Signalr
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ zasobu | "Microsoft.SignalRService/signalR" |
apiVersion | Wersja interfejsu API zasobów | "2020-07-01-preview" |
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. (np. Bezpłatna, Standardowa) | ZasóbSku |
Rodzaju | Rodzaj usługi — np. "SignalR" dla "Microsoft.SignalRService/SignalR" | "RawWebSockets" "SignalR" |
identity | Odpowiedź tożsamości zarządzanej | ManagedIdentity |
properties | Ustawienia używane do aprowizowania lub konfigurowania zasobu | SignalRProperties |
ManagedIdentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Reprezentacja typu 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 |
funkcje | Lista funkcji usługi SignalRFlags. np. ServiceMode. 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, usługa SignalR będzie używać jej globalnej wartości domyślnej. 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 | SignalRNetworkACLs |
Tls | Ustawienia protokołu TLS. | SignalRTlsSettings |
połączenie nadrzędne | Ustawienia nadrzędne, gdy usługa Azure SignalR 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. |
"EnableConnectivityLogs" "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 | 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 |
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" |
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" |
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" |
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" |
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 | 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 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 | 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. Opcja Brak lub Identyfikator zarządzany jest teraz obsługiwana. | "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 usługi SignalR. 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 |
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@2020-07-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
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"
}
kind = "string"
})
}
Wartości właściwości
Signalr
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ zasobu | "Microsoft.SignalRService/signalR@2020-07-01-preview" |
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. (np. Bezpłatna, Standardowa) | ZasóbSku |
Rodzaju | Rodzaj usługi — np. "SignalR" dla "Microsoft.SignalRService/SignalR" | "RawWebSockets" "SignalR" |
identity | Odpowiedź tożsamości zarządzanej | ManagedIdentity |
properties | Ustawienia używane do aprowizowania lub konfigurowania zasobu | SignalRProperties |
ManagedIdentity
Nazwa | Opis | Wartość |
---|---|---|
typ | Reprezentacja typu 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 |
funkcje | Lista funkcji usługi SignalRFlags. np. ServiceMode. 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, usługa SignalR będzie używać jej globalnej wartości domyślnej. 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 | SignalRNetworkACLs |
Tls | Ustawienia protokołu TLS. | SignalRTlsSettings |
połączenie nadrzędne | Ustawienia nadrzędne, gdy usługa Azure SignalR 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. |
"EnableConnectivityLogs" "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 | 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 |
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" |
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" |
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" |
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" |
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 | 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 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 | 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. Opcja Brak lub Identyfikator zarządzany jest teraz obsługiwana. | "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 usługi SignalR. 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" |