Microsoft.SignalRService signalR 2018-10-01
- najnowsze
- 2024-10-01-preview
- 2024-08-01-preview
- 2024-04-01-preview
- 2024-03-01
- 2024-01-01-preview
-
2023-08-01-preview - 2023-06-01-preview
- 2023-03-01-preview
- 2023-02-01
- 2022-08-01-preview
- 2022-02-01
- 2021-10-01
- 2021-09-01-preview
- 2021-06-01-preview
- 2021-04-01-preview
- 2020-07-01-preview
- 2020-05-01
- 2018-10-01
- 2018-03-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 dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.SignalRService/signalR, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.SignalRService/signalR@2018-10-01' = {
location: 'string'
name: 'string'
properties: {
cors: {
allowedOrigins: [
'string'
]
}
features: [
{
flag: 'string'
properties: {
{customized property}: 'string'
}
value: 'string'
}
]
hostNamePrefix: 'string'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Wartości właściwości
Microsoft.SignalRService/signalR
| Nazwa | Opis | Wartość | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| lokalizacja | Region geograficzny platformy Azure: np. Zachodnie stany USA | Wschodnie stany USA | Północno-środkowe stany USA | Południowo-środkowe stany USA | Europa Zachodnia | Europa Północna | Azja Wschodnia | Azja Południowo-Wschodnia | itd. Region geograficzny zasobu nigdy nie zmienia się po jego utworzeniu. |
ciąg (wymagany) |
| nazwa | Nazwa zasobu | ciąg (wymagany) | ||||||||
| Właściwości | Ustawienia używane do aprowizowania lub konfigurowania zasobu | SignalRCreateOrUpdatePropertiesOrSignalRProperties | ||||||||
| Numer jednostki magazynowej | Informacje o rozliczeniach zasobu. (np. podstawowa a standardowa) | ResourceSku | ||||||||
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
ResourceSku
| Nazwa | Opis | Wartość |
|---|---|---|
| pojemność | 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 |
| rodzina | Ciąg opcjonalny. Do użytku w przyszłości. | struna |
| nazwa | Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1 |
ciąg (wymagany) |
| rozmiar | Ciąg opcjonalny. Do użytku w przyszłości. | struna |
| 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" |
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[] |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| cors | Ustawienia współużytkowania zasobów między źródłami (CORS). | SignalRCorsSettings |
| Funkcje | Lista funkcji 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ę w zależności od różnych funkcjiFlags. |
SignalRFeature[] |
| hostNamePrefix | Prefiks nazwy hosta usługi SignalR. Zachowano do użytku w przyszłości. Nazwa hosta będzie mieć format: <hostNamePrefix>.service.signalr.net. |
struna |
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. |
"EnableConnectivityLogs" "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ść = 128 (wymagana) |
SignalRFeatureProperties
| Nazwa | Opis | Wartość |
|---|
SignalRUpdateParametersTags
| 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": "2018-10-01",
"name": "string",
"location": "string",
"properties": {
"cors": {
"allowedOrigins": [ "string" ]
},
"features": [
{
"flag": "string",
"properties": {
"{customized property}": "string"
},
"value": "string"
}
],
"hostNamePrefix": "string"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Wartości właściwości
Microsoft.SignalRService/signalR
| Nazwa | Opis | Wartość | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| apiVersion | Wersja interfejsu API | '2018-10-01' | ||||||||
| lokalizacja | Region geograficzny platformy Azure: np. Zachodnie stany USA | Wschodnie stany USA | Północno-środkowe stany USA | Południowo-środkowe stany USA | Europa Zachodnia | Europa Północna | Azja Wschodnia | Azja Południowo-Wschodnia | itd. Region geograficzny zasobu nigdy nie zmienia się po jego utworzeniu. |
ciąg (wymagany) |
| nazwa | Nazwa zasobu | ciąg (wymagany) | ||||||||
| Właściwości | Ustawienia używane do aprowizowania lub konfigurowania zasobu | SignalRCreateOrUpdatePropertiesOrSignalRProperties | ||||||||
| Numer jednostki magazynowej | Informacje o rozliczeniach zasobu. (np. podstawowa a standardowa) | ResourceSku | ||||||||
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach | ||||||||
| typ | Typ zasobu | "Microsoft.SignalRService/signalR" |
ResourceSku
| Nazwa | Opis | Wartość |
|---|---|---|
| pojemność | 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 |
| rodzina | Ciąg opcjonalny. Do użytku w przyszłości. | struna |
| nazwa | Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1 |
ciąg (wymagany) |
| rozmiar | Ciąg opcjonalny. Do użytku w przyszłości. | struna |
| 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" |
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[] |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| cors | Ustawienia współużytkowania zasobów między źródłami (CORS). | SignalRCorsSettings |
| Funkcje | Lista funkcji 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ę w zależności od różnych funkcjiFlags. |
SignalRFeature[] |
| hostNamePrefix | Prefiks nazwy hosta usługi SignalR. Zachowano do użytku w przyszłości. Nazwa hosta będzie mieć format: <hostNamePrefix>.service.signalr.net. |
struna |
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. |
"EnableConnectivityLogs" "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ść = 128 (wymagana) |
SignalRFeatureProperties
| Nazwa | Opis | Wartość |
|---|
SignalRUpdateParametersTags
| 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@2018-10-01"
name = "string"
location = "string"
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
cors = {
allowedOrigins = [
"string"
]
}
features = [
{
flag = "string"
properties = {
{customized property} = "string"
}
value = "string"
}
]
hostNamePrefix = "string"
}
})
}
Wartości właściwości
Microsoft.SignalRService/signalR
| Nazwa | Opis | Wartość | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| lokalizacja | Region geograficzny platformy Azure: np. Zachodnie stany USA | Wschodnie stany USA | Północno-środkowe stany USA | Południowo-środkowe stany USA | Europa Zachodnia | Europa Północna | Azja Wschodnia | Azja Południowo-Wschodnia | itd. Region geograficzny zasobu nigdy nie zmienia się po jego utworzeniu. |
ciąg (wymagany) |
| nazwa | Nazwa zasobu | ciąg (wymagany) | ||||||||
| Właściwości | Ustawienia używane do aprowizowania lub konfigurowania zasobu | SignalRCreateOrUpdatePropertiesOrSignalRProperties | ||||||||
| Numer jednostki magazynowej | Informacje o rozliczeniach zasobu. (np. podstawowa a standardowa) | ResourceSku | ||||||||
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. | ||||||||
| typ | Typ zasobu | "Microsoft.SignalRService/signalR@2018-10-01" |
ResourceSku
| Nazwa | Opis | Wartość |
|---|---|---|
| pojemność | 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 |
| rodzina | Ciąg opcjonalny. Do użytku w przyszłości. | struna |
| nazwa | Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1 |
ciąg (wymagany) |
| rozmiar | Ciąg opcjonalny. Do użytku w przyszłości. | struna |
| 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" |
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[] |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| cors | Ustawienia współużytkowania zasobów między źródłami (CORS). | SignalRCorsSettings |
| Funkcje | Lista funkcji 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ę w zależności od różnych funkcjiFlags. |
SignalRFeature[] |
| hostNamePrefix | Prefiks nazwy hosta usługi SignalR. Zachowano do użytku w przyszłości. Nazwa hosta będzie mieć format: <hostNamePrefix>.service.signalr.net. |
struna |
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. |
"EnableConnectivityLogs" "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ść = 128 (wymagana) |
SignalRFeatureProperties
| Nazwa | Opis | Wartość |
|---|
SignalRUpdateParametersTags
| Nazwa | Opis | Wartość |
|---|