Microsoft.SignalRService signalR 2018-10-01
- más reciente
- 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
Definición de recursos de Bicep
El tipo de recurso signalR se puede implementar con operaciones destinadas a:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de recurso
Para crear un recurso Microsoft.SignalRService/signalR, agregue lo siguiente a la plantilla de Bicep.
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'
}
}
Valores de propiedad
Microsoft.SignalRService/signalR
| Nombre | Descripción | Valor | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ubicación | Región geográfica de Azure: por ejemplo, Oeste de EE. UU. | Este de EE. UU. | Centro y norte de EE. UU. | Centro-sur de EE. UU. | Oeste de Europa | Norte de Europa | Asia Oriental | Sudeste Asiático | etcetera. La región geográfica de un recurso nunca cambia después de crearlo. |
string (obligatorio) |
| nombre | El nombre del recurso | string (obligatorio) | ||||||||
| Propiedades | Configuración que se usa para aprovisionar o configurar el recurso | SignalRCreateOrUpdatePropertiesOrSignalRProperties | ||||||||
| Sku | Información de facturación del recurso. (por ejemplo, básico frente a estándar) | ResourceSku de |
||||||||
| Etiquetas | Etiquetas de recursos | Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas |
ResourceSku
| Nombre | Descripción | Valor |
|---|---|---|
| capacidad | Opcional, entero. Recuento de unidades del recurso SignalR. 1 de forma predeterminada. Si está presente, se permiten los siguientes valores: Gratis: 1 Estándar: 1,2,5,10,20,50,100 |
Int |
| familia | Cadena opcional. Para su uso futuro. | cuerda |
| nombre | Nombre de la SKU. Obligatorio. Valores permitidos: Standard_S1, Free_F1 |
string (obligatorio) |
| tamaño | Cadena opcional. Para su uso futuro. | cuerda |
| nivel | Nivel opcional de esta SKU determinada. 'Estándar' o 'Gratis'. Basic está en desuso, use Standard en su lugar. |
"Básico" "Gratis" 'Premium' 'Estándar' |
SignalRCorsSettings
| Nombre | Descripción | Valor |
|---|---|---|
| allowedOrigins | Obtiene o establece la lista de orígenes que se deben permitir para realizar llamadas entre orígenes (por ejemplo: http://example.com:12345). Use "*" para permitir todo. Si se omite, permita todo de forma predeterminada. | string[] |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| Nombre | Descripción | Valor |
|---|---|---|
| cors | Configuración de uso compartido de recursos entre orígenes (CORS). | |
| Funciones | Lista de featureFlags de SignalR. Por ejemplo, ServiceMode. FeatureFlags que no se incluyen en los parámetros de la operación de actualización no se modificarán. Y la respuesta solo incluirá featureFlags que se establecen explícitamente. Cuando no se establece explícitamente featureFlag, signalR service usará su valor predeterminado global. Pero tenga en cuenta que el valor predeterminado no significa "false". Varía en términos de características diferentes. |
SignalRFeature[] |
| hostNamePrefix | Prefijo para el nombre de host del servicio SignalR. Se conserva para su uso futuro. El nombre de host tendrá el formato: <hostNamePrefix>.service.signalr.net. |
cuerda |
SignalRFeature
| Nombre | Descripción | Valor |
|---|---|---|
| bandera | FeatureFlags es las características admitidas del servicio Azure SignalR. - ServiceMode: marca para el servidor back-end para signalR service. Valores permitidos: "Valor predeterminado": tienen su propio servidor back-end; "Sin servidor": la aplicación no tiene un servidor back-end; "Clásico": para la compatibilidad con versiones anteriores. Admite tanto el modo predeterminado como el sin servidor, pero no se recomienda; "PredefinedOnly": para su uso futuro. - EnableConnectivityLogs: "true"/"false", para habilitar o deshabilitar la categoría del registro de conectividad respectivamente. |
'EnableConnectivityLogs' 'ServiceMode' (obligatorio) |
| Propiedades | Propiedades opcionales relacionadas con esta característica. | SignalRFeatureProperties |
| valor | Valor de la marca de característica. Consulte el documento de Azure SignalR Service /azure/azure-signalr/ para ver los valores permitidos. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio) |
SignalRFeatureProperties
| Nombre | Descripción | Valor |
|---|
SignalRUpdateParametersTags
| Nombre | Descripción | Valor |
|---|
Ejemplos de inicio rápido
En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.
| Archivo de Bicep | Descripción |
|---|---|
| Implementación de una de Azure SignalR Service | Esta plantilla crea una instancia de Azure SignalR Service mediante una plantilla. |
Definición de recursos de plantilla de ARM
El tipo de recurso signalR se puede implementar con operaciones destinadas a:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de recurso
Para crear un recurso Microsoft.SignalRService/signalR, agregue el siguiente JSON a la plantilla.
{
"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"
}
}
Valores de propiedad
Microsoft.SignalRService/signalR
| Nombre | Descripción | Valor | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| apiVersion | La versión de api | '2018-10-01' | ||||||||
| ubicación | Región geográfica de Azure: por ejemplo, Oeste de EE. UU. | Este de EE. UU. | Centro y norte de EE. UU. | Centro-sur de EE. UU. | Oeste de Europa | Norte de Europa | Asia Oriental | Sudeste Asiático | etcetera. La región geográfica de un recurso nunca cambia después de crearlo. |
string (obligatorio) |
| nombre | El nombre del recurso | string (obligatorio) | ||||||||
| Propiedades | Configuración que se usa para aprovisionar o configurar el recurso | SignalRCreateOrUpdatePropertiesOrSignalRProperties | ||||||||
| Sku | Información de facturación del recurso. (por ejemplo, básico frente a estándar) | ResourceSku de |
||||||||
| Etiquetas | Etiquetas de recursos | Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas | ||||||||
| tipo | El tipo de recurso | 'Microsoft.SignalRService/signalR' |
ResourceSku
| Nombre | Descripción | Valor |
|---|---|---|
| capacidad | Opcional, entero. Recuento de unidades del recurso SignalR. 1 de forma predeterminada. Si está presente, se permiten los siguientes valores: Gratis: 1 Estándar: 1,2,5,10,20,50,100 |
Int |
| familia | Cadena opcional. Para su uso futuro. | cuerda |
| nombre | Nombre de la SKU. Obligatorio. Valores permitidos: Standard_S1, Free_F1 |
string (obligatorio) |
| tamaño | Cadena opcional. Para su uso futuro. | cuerda |
| nivel | Nivel opcional de esta SKU determinada. 'Estándar' o 'Gratis'. Basic está en desuso, use Standard en su lugar. |
"Básico" "Gratis" 'Premium' 'Estándar' |
SignalRCorsSettings
| Nombre | Descripción | Valor |
|---|---|---|
| allowedOrigins | Obtiene o establece la lista de orígenes que se deben permitir para realizar llamadas entre orígenes (por ejemplo: http://example.com:12345). Use "*" para permitir todo. Si se omite, permita todo de forma predeterminada. | string[] |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| Nombre | Descripción | Valor |
|---|---|---|
| cors | Configuración de uso compartido de recursos entre orígenes (CORS). | |
| Funciones | Lista de featureFlags de SignalR. Por ejemplo, ServiceMode. FeatureFlags que no se incluyen en los parámetros de la operación de actualización no se modificarán. Y la respuesta solo incluirá featureFlags que se establecen explícitamente. Cuando no se establece explícitamente featureFlag, signalR service usará su valor predeterminado global. Pero tenga en cuenta que el valor predeterminado no significa "false". Varía en términos de características diferentes. |
SignalRFeature[] |
| hostNamePrefix | Prefijo para el nombre de host del servicio SignalR. Se conserva para su uso futuro. El nombre de host tendrá el formato: <hostNamePrefix>.service.signalr.net. |
cuerda |
SignalRFeature
| Nombre | Descripción | Valor |
|---|---|---|
| bandera | FeatureFlags es las características admitidas del servicio Azure SignalR. - ServiceMode: marca para el servidor back-end para signalR service. Valores permitidos: "Valor predeterminado": tienen su propio servidor back-end; "Sin servidor": la aplicación no tiene un servidor back-end; "Clásico": para la compatibilidad con versiones anteriores. Admite tanto el modo predeterminado como el sin servidor, pero no se recomienda; "PredefinedOnly": para su uso futuro. - EnableConnectivityLogs: "true"/"false", para habilitar o deshabilitar la categoría del registro de conectividad respectivamente. |
'EnableConnectivityLogs' 'ServiceMode' (obligatorio) |
| Propiedades | Propiedades opcionales relacionadas con esta característica. | SignalRFeatureProperties |
| valor | Valor de la marca de característica. Consulte el documento de Azure SignalR Service /azure/azure-signalr/ para ver los valores permitidos. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio) |
SignalRFeatureProperties
| Nombre | Descripción | Valor |
|---|
SignalRUpdateParametersTags
| Nombre | Descripción | Valor |
|---|
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
| Plantilla | Descripción |
|---|---|
Implementación de una de Azure SignalR Service
|
Esta plantilla crea una instancia de Azure SignalR Service mediante una plantilla. |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso signalR se puede implementar con operaciones destinadas a:
- grupos de recursos de
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de recurso
Para crear un recurso Microsoft.SignalRService/signalR, agregue el siguiente terraform a la plantilla.
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"
}
})
}
Valores de propiedad
Microsoft.SignalRService/signalR
| Nombre | Descripción | Valor | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ubicación | Región geográfica de Azure: por ejemplo, Oeste de EE. UU. | Este de EE. UU. | Centro y norte de EE. UU. | Centro-sur de EE. UU. | Oeste de Europa | Norte de Europa | Asia Oriental | Sudeste Asiático | etcetera. La región geográfica de un recurso nunca cambia después de crearlo. |
string (obligatorio) |
| nombre | El nombre del recurso | string (obligatorio) | ||||||||
| Propiedades | Configuración que se usa para aprovisionar o configurar el recurso | SignalRCreateOrUpdatePropertiesOrSignalRProperties | ||||||||
| Sku | Información de facturación del recurso. (por ejemplo, básico frente a estándar) | ResourceSku de |
||||||||
| Etiquetas | Etiquetas de recursos | Diccionario de nombres y valores de etiqueta. | ||||||||
| tipo | El tipo de recurso | "Microsoft.SignalRService/signalR@2018-10-01" |
ResourceSku
| Nombre | Descripción | Valor |
|---|---|---|
| capacidad | Opcional, entero. Recuento de unidades del recurso SignalR. 1 de forma predeterminada. Si está presente, se permiten los siguientes valores: Gratis: 1 Estándar: 1,2,5,10,20,50,100 |
Int |
| familia | Cadena opcional. Para su uso futuro. | cuerda |
| nombre | Nombre de la SKU. Obligatorio. Valores permitidos: Standard_S1, Free_F1 |
string (obligatorio) |
| tamaño | Cadena opcional. Para su uso futuro. | cuerda |
| nivel | Nivel opcional de esta SKU determinada. 'Estándar' o 'Gratis'. Basic está en desuso, use Standard en su lugar. |
"Básico" "Gratis" 'Premium' 'Estándar' |
SignalRCorsSettings
| Nombre | Descripción | Valor |
|---|---|---|
| allowedOrigins | Obtiene o establece la lista de orígenes que se deben permitir para realizar llamadas entre orígenes (por ejemplo: http://example.com:12345). Use "*" para permitir todo. Si se omite, permita todo de forma predeterminada. | string[] |
SignalRCreateOrUpdatePropertiesOrSignalRProperties
| Nombre | Descripción | Valor |
|---|---|---|
| cors | Configuración de uso compartido de recursos entre orígenes (CORS). | |
| Funciones | Lista de featureFlags de SignalR. Por ejemplo, ServiceMode. FeatureFlags que no se incluyen en los parámetros de la operación de actualización no se modificarán. Y la respuesta solo incluirá featureFlags que se establecen explícitamente. Cuando no se establece explícitamente featureFlag, signalR service usará su valor predeterminado global. Pero tenga en cuenta que el valor predeterminado no significa "false". Varía en términos de características diferentes. |
SignalRFeature[] |
| hostNamePrefix | Prefijo para el nombre de host del servicio SignalR. Se conserva para su uso futuro. El nombre de host tendrá el formato: <hostNamePrefix>.service.signalr.net. |
cuerda |
SignalRFeature
| Nombre | Descripción | Valor |
|---|---|---|
| bandera | FeatureFlags es las características admitidas del servicio Azure SignalR. - ServiceMode: marca para el servidor back-end para signalR service. Valores permitidos: "Valor predeterminado": tienen su propio servidor back-end; "Sin servidor": la aplicación no tiene un servidor back-end; "Clásico": para la compatibilidad con versiones anteriores. Admite tanto el modo predeterminado como el sin servidor, pero no se recomienda; "PredefinedOnly": para su uso futuro. - EnableConnectivityLogs: "true"/"false", para habilitar o deshabilitar la categoría del registro de conectividad respectivamente. |
'EnableConnectivityLogs' 'ServiceMode' (obligatorio) |
| Propiedades | Propiedades opcionales relacionadas con esta característica. | SignalRFeatureProperties |
| valor | Valor de la marca de característica. Consulte el documento de Azure SignalR Service /azure/azure-signalr/ para ver los valores permitidos. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio) |
SignalRFeatureProperties
| Nombre | Descripción | Valor |
|---|
SignalRUpdateParametersTags
| Nombre | Descripción | Valor |
|---|