Microsoft.SignalRService signalR 2018-10-01
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@2018-10-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
{customized property}: 'string'
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
properties: {
cors: {
allowedOrigins: [
'string'
]
}
features: [
{
flag: 'string'
properties: {
{customized property}: 'string'
}
value: 'string'
}
]
hostNamePrefix: '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 | 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 itp. Region geograficzny zasobu nigdy nie zmienia się po jego utworzeniu. |
ciąg (wymagany) |
| tags | Lista 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. podstawowa a standardowa) | ResourceSku |
| properties | Ustawienia używane do aprowizowania lub konfigurowania zasobu | SignalRCreateOrUpdatePropertiesOrSignalRProperties |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| 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[] |
| hostNamePrefix | Prefiks nazwy hosta usługi SignalR. Zachowywane do użytku w przyszłości. Nazwa hosta będzie mieć format: <hostNamePrefix.service.signalr.net>. |
ciąg |
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" "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 |
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 |
| rodzina | Ciąg opcjonalny. Do użytku w przyszłości. | ciąg |
| name | Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1 |
ciąg (wymagany) |
| size | Ciąg opcjonalny. Do użytku w przyszłości. | ciąg |
| 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ć 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 JSON do szablonu.
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2018-10-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"{customized property}": "string"
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"properties": {
"cors": {
"allowedOrigins": [ "string" ]
},
"features": [
{
"flag": "string",
"properties": {
"{customized property}": "string"
},
"value": "string"
}
],
"hostNamePrefix": "string"
}
}
Wartości właściwości
Signalr
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.SignalRService/signalR" |
| apiVersion | Wersja interfejsu API zasobów | '2018-10-01' |
| 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 | 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 itp. Region geograficzny zasobu nigdy nie zmienia się po jego utworzeniu. |
ciąg (wymagany) |
| tags | Lista 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. podstawowa a standardowa) | ResourceSku |
| properties | Ustawienia używane do aprowizowania lub konfigurowania zasobu | SignalRCreateOrUpdatePropertiesOrSignalRProperties |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| 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[] |
| hostNamePrefix | Prefiks nazwy hosta usługi SignalR. Zachowywane do użytku w przyszłości. Nazwa hosta będzie mieć format: <hostNamePrefix.service.signalr.net>. |
ciąg |
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" "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 |
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 |
| rodzina | Ciąg opcjonalny. Do użytku w przyszłości. | ciąg |
| name | Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1 |
ciąg (wymagany) |
| size | Ciąg opcjonalny. Do użytku w przyszłości. | ciąg |
| 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 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 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@2018-10-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
{customized property} = "string"
body = jsonencode({
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"
}
})
}
Wartości właściwości
Signalr
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.SignalRService/signalR@2018-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 | 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 itp. Region geograficzny zasobu nigdy nie zmienia się po jego utworzeniu. |
ciąg (wymagany) |
| parent_id | Aby przeprowadzić wdrożenie w grupie zasobów, użyj identyfikatora tej grupy zasobów. | ciąg (wymagany) |
| tags | Lista par klucz-wartość, które opisują zasób. | Słownik nazw tagów i wartości. |
| sku | Informacje dotyczące rozliczeń zasobu. (np. podstawowa a standardowa) | ZasóbSku |
| properties | Ustawienia używane do aprowizowania lub konfigurowania zasobu | SignalRCreateOrUpdatePropertiesOrSignalRProperties |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| 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[] |
| hostNamePrefix | Prefiks nazwy hosta usługi SignalR. Zachowywane do użytku w przyszłości. Nazwa hosta będzie mieć format hostNamePrefix.service.signalr.net<>. |
ciąg |
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" "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 |
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 |
| rodzina | Ciąg opcjonalny. Do użytku w przyszłości. | ciąg |
| name | Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1 |
ciąg (wymagany) |
| size | Ciąg opcjonalny. Do użytku w przyszłości. | ciąg |
| 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" |