Compartir a través de

SignalRService de Microsoft.SignalR

  • Artículo

Definición de recursos de Bicep

El tipo de recurso signalR se puede implementar con operaciones destinadas a:

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@2024-10-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    applicationFirewall: {
      clientConnectionCountRules: [
        {
          type: 'string'
          // For remaining properties, see ClientConnectionCountRule objects
        }
      ]
      clientTrafficControlRules: [
        {
          type: 'string'
          // For remaining properties, see ClientTrafficControlRule objects
        }
      ]
    }
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    disableAadAuth: bool
    disableLocalAuth: bool
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    liveTraceConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
      enabled: 'string'
    }
    networkACLs: {
      defaultAction: 'string'
      ipRules: [
        {
          action: 'string'
          value: 'string'
        }
      ]
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    regionEndpointEnabled: 'string'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: 'string'
        }
      ]
    }
    resourceStopped: 'string'
    serverless: {
      connectionTimeoutInSeconds: int
      keepAliveIntervalInSeconds: int
    }
    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'
  }
}

Objetos ClientTrafficControlRule

Establezca el tipo propiedad para especificar el tipo de objeto.

Para TrafficThrottleByJwtCustomClaimRule, use:

{
  aggregationWindowInSeconds: int
  claimName: 'string'
  maxInboundMessageBytes: int
  type: 'TrafficThrottleByJwtCustomClaimRule'
}

Para TrafficThrottleByJwtSignatureRule, use:

{
  aggregationWindowInSeconds: int
  maxInboundMessageBytes: int
  type: 'TrafficThrottleByJwtSignatureRule'
}

Para TrafficThrottleByUserIdRule, use:

{
  aggregationWindowInSeconds: int
  maxInboundMessageBytes: int
  type: 'TrafficThrottleByUserIdRule'
}

Objetos ClientConnectionCountRule

Establezca el tipo propiedad para especificar el tipo de objeto.

Para ThrottleByJwtCustomClaimRule, use:

{
  claimName: 'string'
  maxCount: int
  type: 'ThrottleByJwtCustomClaimRule'
}

Para ThrottleByJwtSignatureRule, use:

{
  maxCount: int
  type: 'ThrottleByJwtSignatureRule'
}

Para ThrottleByUserIdRule, use:

{
  maxCount: int
  type: 'ThrottleByUserIdRule'
}

Valores de propiedad

ApplicationFirewallSettings

Nombre Descripción Valor
clientConnectionCountRules Reglas para controlar el recuento de conexiones de cliente ClientConnectionCountRule []
clientTrafficControlRules Reglas para controlar el tráfico del cliente ClientTrafficControlRule []

ClientConnectionCountRule

Nombre Descripción Valor
tipo Establezca en "ThrottleByJwtCustomClaimRule" para el tipo ThrottleByJwtCustomClaimRule. Establezca en "ThrottleByJwtSignatureRule" para el tipo ThrottleByJwtSignatureRule. Establezca en "ThrottleByUserIdRule" para el tipo ThrottleByUserIdRule. 'ThrottleByJwtCustomClaimRule'
'ThrottleByJwtSignatureRule'
'ThrottleByUserIdRule' (obligatorio)

ClientTrafficControlRule

Nombre Descripción Valor
tipo Establezca en "TrafficThrottleByJwtCustomClaimRule" para el tipo TrafficThrottleByJwtCustomClaimRule. Establezca en "TrafficThrottleByJwtSignatureRule" para el tipo TrafficThrottleByJwtSignatureRule. Establezca en "TrafficThrottleByUserIdRule" para el tipo TrafficThrottleByUserIdRule. 'TrafficThrottleByJwtCustomClaimRule'
'TrafficThrottleByJwtSignatureRule'
'TrafficThrottleByUserIdRule' (obligatorio)

IPRule

Nombre Descripción Valor
acción Acción de ACL de redes de Azure. 'Permitir'
'Denegar'
valor Ip o CIDR o ServiceTag cuerda

LiveTraceCategory

Nombre Descripción Valor
Habilitado Indica si o la categoría de seguimiento activo está habilitada.
Valores disponibles: true, false.
No distingue mayúsculas de minúsculas.		 cuerda
nombre Obtiene o establece el nombre de la categoría de seguimiento activo.
Valores disponibles: ConnectivityLogs, MessagingLogs.
No distingue mayúsculas de minúsculas.		 cuerda

LiveTraceConfiguration

Nombre Descripción Valor
Categorías Obtiene o establece la lista de configuraciones de categoría. LiveTraceCategory []
Habilitado Indica si habilita o no el seguimiento activo.
Cuando se establece en true, el cliente de seguimiento activo puede conectarse al servicio.
De lo contrario, el cliente de seguimiento activo no puede conectarse al servicio, de modo que no pueda recibir ningún registro, independientemente de lo que configure en "categorías".
Valores disponibles: true, false.
No distingue mayúsculas de minúsculas.		 cuerda

ManagedIdentity

Nombre Descripción Valor
tipo Representa el tipo de identidad: systemAssigned, userAssigned, None 'Ninguno'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Obtener o establecer las identidades asignadas por el usuario ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Nombre Descripción Valor
recurso Recurso que indica el URI del identificador de aplicación del recurso de destino.
También aparece en la notificación aud (audiencia) del token emitido.		 cuerda

ManagedIdentityUserAssignedIdentities

Nombre Descripción Valor

Microsoft.SignalRService/signalR

Nombre Descripción Valor
identidad Una clase representa las identidades administradas usadas para la solicitud y la respuesta. managedIdentity
amable El tipo de servicio 'RawWebSockets'
'SignalR'
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 3
Longitud máxima = 3
Patrón = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obligatorio)
Propiedades Clase que describe las propiedades del recurso SignalRProperties
Sku Información de facturación del recurso. ResourceSku de
Etiquetas Etiquetas del recurso Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

NetworkACL

Nombre Descripción Valor
conceder Tipos de solicitud permitidos. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadenas que contiene cualquiera de:
'ClientConnection'
'RESTAPI'
"ServerConnection"
'Trace'
negar Tipos de solicitud denegados. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadenas que contiene cualquiera de:
'ClientConnection'
'RESTAPI'
"ServerConnection"
'Trace'

PrivateEndpointACL

Nombre Descripción Valor
conceder Tipos de solicitud permitidos. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadenas que contiene cualquiera de:
'ClientConnection'
'RESTAPI'
"ServerConnection"
'Trace'
negar Tipos de solicitud denegados. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadenas que contiene cualquiera de:
'ClientConnection'
'RESTAPI'
"ServerConnection"
'Trace'
nombre Nombre de la conexión de punto de conexión privado string (obligatorio)

ResourceLogCategory

Nombre Descripción Valor
Habilitado Indica si o la categoría de registro de recursos está habilitada.
Valores disponibles: true, false.
No distingue mayúsculas de minúsculas.		 cuerda
nombre Obtiene o establece el nombre de la categoría del registro de recursos.
Valores disponibles: ConnectivityLogs, MessagingLogs.
No distingue mayúsculas de minúsculas.		 cuerda

ResourceLogConfiguration

Nombre Descripción Valor
Categorías Obtiene o establece la lista de configuraciones de categoría. resourceLogCategory[]

ResourceSku

Nombre Descripción Valor
capacidad Opcional, entero. Recuento de unidades del recurso.
1 para Free_F1/Standard_S1/Premium_P1, 100 para Premium_P2 de forma predeterminada.

Si está presente, se permiten los siguientes valores:
Free_F1: 1;
Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P2: 100.200.300.400.500.600.700.800.900.1000;		 Int
nombre Nombre de la SKU. Obligatorio.

Valores permitidos: Standard_S1, Free_F1, Premium_P1, Premium_P2		 string (obligatorio)
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'

ServerlessSettings

Nombre Descripción Valor
connectionTimeoutInSeconds Obtiene o establece tiempo de espera de conexión de cliente. Opcional para establecer.
Valor en segundos.
El valor predeterminado es de 30 segundos.
El cliente debe establecer el tiempo de espera en un período más corto si se espera que los mensajes se envíen en intervalos más cortos,
y quiere que el cliente se desconecte más rápidamente después de enviar el último mensaje.
Puede establecer el tiempo de espera en un período más largo si se espera que los mensajes se envíen en intervalos más largos,
y quieren mantener activa la misma conexión de cliente durante esta sesión.
El servicio considera que el cliente está desconectado si no ha recibido un mensaje (incluido keep-alive) en este intervalo.		 Int

Restricciones:
Valor mínimo = 1
Valor máximo = 120
keepAliveIntervalInSeconds Obtiene o establece el intervalo de Keep-Alive. Opcional para establecer.
El valor es en segundos.
El valor predeterminado es 15 segundos.
Los clientes deben establecer este valor en un período más corto si quieren que el servicio envíe mensajes de mantenimiento con más frecuencia,
garantizando comprobaciones oportunas del estado de conexión.
Por el contrario, los clientes pueden establecer este valor en un período más largo si quieren que el servicio envíe mensajes de mantenimiento activo con menos frecuencia,
Reducir el tráfico de red, pero tenga en cuenta que puede tardar más tiempo en detectar una desconexión.
Este intervalo garantiza que la conexión se mantenga enviando mensajes periódicos de mantenimiento al cliente.		 Int

Restricciones:
Valor mínimo = 1
Valor máximo = 120

ServerlessUpstreamSettings

Nombre Descripción Valor
Plantillas Obtiene o establece la lista de plantillas de dirección URL ascendentes. El orden es importante y la primera plantilla coincidente tiene efectos. UpstreamTemplate []

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[]

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.
- EnableMessagingLogs: "true"/"false", para habilitar o deshabilitar la categoría del registro de conectividad respectivamente.
- EnableLiveTrace: Live Trace le permite saber lo que sucede dentro del servicio Azure SignalR, le proporcionará seguimientos en vivo en tiempo real, será útil al desarrollar su propia aplicación web basada en Azure SignalR o solucionar algunos problemas. Tenga en cuenta que los seguimientos en directo se cuentan como mensajes salientes que se cobrarán. Valores permitidos: "true"/"false", para habilitar o deshabilitar la característica de seguimiento activo.		 'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'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

SignalRNetworkACLs

Nombre Descripción Valor
defaultAction Acción de ACL de redes de Azure. 'Permitir'
'Denegar'
ipRules Reglas ip para filtrar el tráfico público IPRule []
privateEndpoints ACL para solicitudes de puntos de conexión privados PrivateEndpointACL []
publicNetwork ACL de red NetworkACL

SignalRProperties

Nombre Descripción Valor
applicationFirewall Configuración del firewall de aplicaciones para el recurso applicationFirewallSettings
cors Configuración de uso compartido de recursos entre orígenes (CORS). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Habilitación o deshabilitación de la autenticación de aad
Cuando se establece como true, la conexión con AuthType=aad no funcionará.		 Bool
disableLocalAuth DisableLocalAuth
Habilitación o deshabilitación de la autenticación local con AccessKey
Cuando se establece como true, la conexión con AccessKey=xxx no funcionará.		 Bool
Funciones Lista de featureFlags.

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 un featureFlag no se establece explícitamente, se 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[]
liveTraceConfiguration Configuración de seguimiento activo de un recurso Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACL de red para el recurso SignalRNetworkACLs
publicNetworkAccess Habilite o deshabilite el acceso a la red pública. El valor predeterminado es "Habilitado".
Cuando está habilitado, las ACL de red se siguen aplicando.
Cuando está deshabilitado, el acceso a la red pública siempre está deshabilitado independientemente de lo que establezca en las ACL de red.		 cuerda
regionEndpointEnabled Habilite o deshabilite el punto de conexión regional. El valor predeterminado es "Habilitado".
Cuando está deshabilitado, las nuevas conexiones no se enrutarán a este punto de conexión, pero las conexiones existentes no se verán afectadas.
Esta propiedad es específica de la réplica. No se permite deshabilitar el punto de conexión regional sin réplica.		 cuerda
resourceLogConfiguration Configuración del registro de recursos de un recurso Microsoft.SignalRService. resourceLogConfiguration
resourceStopped Detenga o inicie el recurso. El valor predeterminado es "False".
Cuando se cumple, el plano de datos del recurso se apaga.
Cuando es false, se inicia el plano de datos del recurso.		 cuerda
sin servidor Configuración sin servidor. ServerlessSettings
tls Configuración de TLS para el recurso SignalRTlsSettings
río arriba La configuración de upstream cuando el servicio está en modo sin servidor. ServerlessUpstreamSettings

SignalRTlsSettings

Nombre Descripción Valor
clientCertEnabled Solicite el certificado de cliente durante el protocolo de enlace TLS si está habilitado. No se admite para el nivel gratis. Cualquier entrada se omitirá para el nivel gratis. Bool

ThrottleByJwtCustomClaimRule

Nombre Descripción Valor
claimName Nombre de la notificación en el token JWT. La conexión de cliente con el mismo valor de notificación se agregará. Si la notificación no se encuentra en el token, se permitirá la conexión. string (obligatorio)
maxCount Número máximo de conexiones permitido para el mismo valor de notificación Jwt. Los clientes con la misma notificación Jwt se rechazarán si el recuento de conexiones supera este valor. El valor predeterminado es 20. Int

Restricciones:
Valor mínimo = 0
Valor máximo = 2147483647
tipo 'ThrottleByJwtCustomClaimRule' (obligatorio)

ThrottleByJwtSignatureRule

Nombre Descripción Valor
maxCount Número máximo de conexiones permitido para la misma firma JWT. Los clientes con la misma firma JWT se rechazarán si el recuento de conexiones supera este valor. El valor predeterminado es 20. Int

Restricciones:
Valor mínimo = 0
Valor máximo = 2147483647
tipo 'ThrottleByJwtSignatureRule' (obligatorio)

ThrottleByUserIdRule

Nombre Descripción Valor
maxCount Número máximo de conexiones permitido para el mismo identificador de usuario. Los clientes con el mismo identificador de usuario se rechazarán si el recuento de conexiones supera este valor. El valor predeterminado es 20. Int

Restricciones:
Valor mínimo = 0
Valor máximo = 2147483647
tipo 'ThrottleByUserIdRule' (obligatorio)

TrackedResourceTags

Nombre Descripción Valor

TrafficThrottleByJwtCustomClaimRule

Nombre Descripción Valor
aggregationWindowInSeconds Ventana de agregación para los bytes del mensaje. Los bytes del mensaje se agregarán en esta ventana y se restablecerán después de la ventana. El valor predeterminado es de 60 segundos. Int

Restricciones:
Valor mínimo = 10
Valor máximo = 3600
claimName Nombre de la notificación en el token JWT. Se agregarán los bytes del mensaje con el mismo valor de notificación. Si no se encuentra la notificación en el token, se omitirá la regla. string (obligatorio)
maxInboundMessageBytes Número máximo de bytes de mensajes entrantes acumulados permitidos para la misma firma JWT dentro de un período de tiempo. Los clientes con la misma notificación JWT se desconectarán si los bytes del mensaje superan este valor. El valor predeterminado es de 1 GB. Int

Restricciones:
Valor mínimo = 0
tipo 'TrafficThrottleByJwtCustomClaimRule' (obligatorio)

TrafficThrottleByJwtSignatureRule

Nombre Descripción Valor
aggregationWindowInSeconds Ventana de agregación para los bytes del mensaje. Los bytes del mensaje se agregarán en esta ventana y se restablecerán después de la ventana. El valor predeterminado es de 60 segundos. Int

Restricciones:
Valor mínimo = 10
Valor máximo = 3600
maxInboundMessageBytes Número máximo de bytes de mensajes entrantes acumulados permitidos para la misma firma JWT dentro de un período de tiempo. Los clientes con la misma firma JWT se desconectarán si los bytes del mensaje superan este valor. El valor predeterminado es de 1 GB. Int

Restricciones:
Valor mínimo = 0
tipo 'TrafficThrottleByJwtSignatureRule' (obligatorio)

TrafficThrottleByUserIdRule

Nombre Descripción Valor
aggregationWindowInSeconds Ventana de agregación para los bytes del mensaje. Los bytes del mensaje se agregarán en esta ventana y se restablecerán después de la ventana. El valor predeterminado es de 60 segundos. Int

Restricciones:
Valor mínimo = 10
Valor máximo = 3600
maxInboundMessageBytes Número máximo de bytes de mensajes entrantes acumulados permitidos para el mismo identificador de usuario dentro de un período de tiempo. Los clientes con el mismo identificador de usuario se desconectarán si los bytes del mensaje superan este valor. El valor predeterminado es de 1 GB. Int

Restricciones:
Valor mínimo = 0
tipo 'TrafficThrottleByUserIdRule' (obligatorio)

UpstreamAuthSettings

Nombre Descripción Valor
managedIdentity Configuración de identidad administrada para ascendente. managedIdentitySettings
tipo Enumeración de tipo de autenticación ascendente. 'ManagedIdentity'
'Ninguno'

UpstreamTemplate

Nombre Descripción Valor
Auth Configuración de autenticación ascendente. Si no se establece, no se usa ninguna autenticación para los mensajes ascendentes. upstreamAuthSettings
categoryPattern Obtiene o establece el patrón coincidente para los nombres de categoría. Si no se establece, coincide con cualquier categoría.
Hay 3 tipos de patrones admitidos:
1. "*", coincide con cualquier nombre de categoría.
2. Combine varias categorías con ",", por ejemplo "conexiones, mensajes", coincide con la categoría "connections" y "messages".
3. El nombre de categoría único, por ejemplo, "connections", coincide con la categoría "connections".		 cuerda
eventPattern Obtiene o establece el patrón coincidente para los nombres de evento. Si no se establece, coincide con cualquier evento.
Hay 3 tipos de patrones admitidos:
1. "*", coincide con cualquier nombre de evento.
2. Combine varios eventos con ",", por ejemplo "connect,disconnect", coincide con el evento "connect" y "disconnect".
3. El nombre de evento único, por ejemplo, "connect", coincide con "connect".		 cuerda
hubPattern Obtiene o establece el patrón coincidente para los nombres del centro. Si no se establece, coincide con cualquier centro.
Hay 3 tipos de patrones admitidos:
1. "*", para que coincida con cualquier nombre del centro.
2. Combine varios concentradores con ",", por ejemplo "hub1,hub2", coincide con "hub1" y "hub2".
3. El nombre del concentrador único, por ejemplo, "hub1", coincide con "hub1".		 cuerda
urlTemplate Obtiene o establece la plantilla dirección URL ascendente. Puede usar 3 parámetros predefinidos {hub}, {category} {event} dentro de la plantilla, el valor de la dirección URL ascendente se calcula dinámicamente cuando entra en la solicitud de cliente.
Por ejemplo, si la dirección URLTemplate es http://example.com/{hub}/api/{event}, con una solicitud de cliente del centro de conectividad chat se conecta, primero enviará POST a esta dirección URL: http://example.com/chat/api/connect.		 string (obligatorio)

UserAssignedIdentityProperty

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:

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": "2024-10-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "applicationFirewall": {
      "clientConnectionCountRules": [ {
        "type": "string"
        // For remaining properties, see ClientConnectionCountRule objects
      } ],
      "clientTrafficControlRules": [ {
        "type": "string"
        // For remaining properties, see ClientTrafficControlRule objects
      } ]
    },
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "disableAadAuth": "bool",
    "disableLocalAuth": "bool",
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "liveTraceConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ],
      "enabled": "string"
    },
    "networkACLs": {
      "defaultAction": "string",
      "ipRules": [
        {
          "action": "string",
          "value": "string"
        }
      ],
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "regionEndpointEnabled": "string",
    "resourceLogConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "string"
        }
      ]
    },
    "resourceStopped": "string",
    "serverless": {
      "connectionTimeoutInSeconds": "int",
      "keepAliveIntervalInSeconds": "int"
    },
    "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"
  }
}

Objetos ClientTrafficControlRule

Establezca el tipo propiedad para especificar el tipo de objeto.

Para TrafficThrottleByJwtCustomClaimRule, use:

{
  "aggregationWindowInSeconds": "int",
  "claimName": "string",
  "maxInboundMessageBytes": "int",
  "type": "TrafficThrottleByJwtCustomClaimRule"
}

Para TrafficThrottleByJwtSignatureRule, use:

{
  "aggregationWindowInSeconds": "int",
  "maxInboundMessageBytes": "int",
  "type": "TrafficThrottleByJwtSignatureRule"
}

Para TrafficThrottleByUserIdRule, use:

{
  "aggregationWindowInSeconds": "int",
  "maxInboundMessageBytes": "int",
  "type": "TrafficThrottleByUserIdRule"
}

Objetos ClientConnectionCountRule

Establezca el tipo propiedad para especificar el tipo de objeto.

Para ThrottleByJwtCustomClaimRule, use:

{
  "claimName": "string",
  "maxCount": "int",
  "type": "ThrottleByJwtCustomClaimRule"
}

Para ThrottleByJwtSignatureRule, use:

{
  "maxCount": "int",
  "type": "ThrottleByJwtSignatureRule"
}

Para ThrottleByUserIdRule, use:

{
  "maxCount": "int",
  "type": "ThrottleByUserIdRule"
}

Valores de propiedad

ApplicationFirewallSettings

Nombre Descripción Valor
clientConnectionCountRules Reglas para controlar el recuento de conexiones de cliente ClientConnectionCountRule []
clientTrafficControlRules Reglas para controlar el tráfico del cliente ClientTrafficControlRule []

ClientConnectionCountRule

Nombre Descripción Valor
tipo Establezca en "ThrottleByJwtCustomClaimRule" para el tipo ThrottleByJwtCustomClaimRule. Establezca en "ThrottleByJwtSignatureRule" para el tipo ThrottleByJwtSignatureRule. Establezca en "ThrottleByUserIdRule" para el tipo ThrottleByUserIdRule. 'ThrottleByJwtCustomClaimRule'
'ThrottleByJwtSignatureRule'
'ThrottleByUserIdRule' (obligatorio)

ClientTrafficControlRule

Nombre Descripción Valor
tipo Establezca en "TrafficThrottleByJwtCustomClaimRule" para el tipo TrafficThrottleByJwtCustomClaimRule. Establezca en "TrafficThrottleByJwtSignatureRule" para el tipo TrafficThrottleByJwtSignatureRule. Establezca en "TrafficThrottleByUserIdRule" para el tipo TrafficThrottleByUserIdRule. 'TrafficThrottleByJwtCustomClaimRule'
'TrafficThrottleByJwtSignatureRule'
'TrafficThrottleByUserIdRule' (obligatorio)

IPRule

Nombre Descripción Valor
acción Acción de ACL de redes de Azure. 'Permitir'
'Denegar'
valor Ip o CIDR o ServiceTag cuerda

LiveTraceCategory

Nombre Descripción Valor
Habilitado Indica si o la categoría de seguimiento activo está habilitada.
Valores disponibles: true, false.
No distingue mayúsculas de minúsculas.		 cuerda
nombre Obtiene o establece el nombre de la categoría de seguimiento activo.
Valores disponibles: ConnectivityLogs, MessagingLogs.
No distingue mayúsculas de minúsculas.		 cuerda

LiveTraceConfiguration

Nombre Descripción Valor
Categorías Obtiene o establece la lista de configuraciones de categoría. LiveTraceCategory []
Habilitado Indica si habilita o no el seguimiento activo.
Cuando se establece en true, el cliente de seguimiento activo puede conectarse al servicio.
De lo contrario, el cliente de seguimiento activo no puede conectarse al servicio, de modo que no pueda recibir ningún registro, independientemente de lo que configure en "categorías".
Valores disponibles: true, false.
No distingue mayúsculas de minúsculas.		 cuerda

ManagedIdentity

Nombre Descripción Valor
tipo Representa el tipo de identidad: systemAssigned, userAssigned, None 'Ninguno'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Obtener o establecer las identidades asignadas por el usuario ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Nombre Descripción Valor
recurso Recurso que indica el URI del identificador de aplicación del recurso de destino.
También aparece en la notificación aud (audiencia) del token emitido.		 cuerda

ManagedIdentityUserAssignedIdentities

Nombre Descripción Valor

Microsoft.SignalRService/signalR

Nombre Descripción Valor
apiVersion La versión de api '2024-10-01-preview'
identidad Una clase representa las identidades administradas usadas para la solicitud y la respuesta. managedIdentity
amable El tipo de servicio 'RawWebSockets'
'SignalR'
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 3
Longitud máxima = 3
Patrón = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obligatorio)
Propiedades Clase que describe las propiedades del recurso SignalRProperties
Sku Información de facturación del recurso. ResourceSku de
Etiquetas Etiquetas del recurso Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo El tipo de recurso 'Microsoft.SignalRService/signalR'

NetworkACL

Nombre Descripción Valor
conceder Tipos de solicitud permitidos. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadenas que contiene cualquiera de:
'ClientConnection'
'RESTAPI'
"ServerConnection"
'Trace'
negar Tipos de solicitud denegados. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadenas que contiene cualquiera de:
'ClientConnection'
'RESTAPI'
"ServerConnection"
'Trace'

PrivateEndpointACL

Nombre Descripción Valor
conceder Tipos de solicitud permitidos. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadenas que contiene cualquiera de:
'ClientConnection'
'RESTAPI'
"ServerConnection"
'Trace'
negar Tipos de solicitud denegados. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadenas que contiene cualquiera de:
'ClientConnection'
'RESTAPI'
"ServerConnection"
'Trace'
nombre Nombre de la conexión de punto de conexión privado string (obligatorio)

ResourceLogCategory

Nombre Descripción Valor
Habilitado Indica si o la categoría de registro de recursos está habilitada.
Valores disponibles: true, false.
No distingue mayúsculas de minúsculas.		 cuerda
nombre Obtiene o establece el nombre de la categoría del registro de recursos.
Valores disponibles: ConnectivityLogs, MessagingLogs.
No distingue mayúsculas de minúsculas.		 cuerda

ResourceLogConfiguration

Nombre Descripción Valor
Categorías Obtiene o establece la lista de configuraciones de categoría. resourceLogCategory[]

ResourceSku

Nombre Descripción Valor
capacidad Opcional, entero. Recuento de unidades del recurso.
1 para Free_F1/Standard_S1/Premium_P1, 100 para Premium_P2 de forma predeterminada.

Si está presente, se permiten los siguientes valores:
Free_F1: 1;
Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P2: 100.200.300.400.500.600.700.800.900.1000;		 Int
nombre Nombre de la SKU. Obligatorio.

Valores permitidos: Standard_S1, Free_F1, Premium_P1, Premium_P2		 string (obligatorio)
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'

ServerlessSettings

Nombre Descripción Valor
connectionTimeoutInSeconds Obtiene o establece tiempo de espera de conexión de cliente. Opcional para establecer.
Valor en segundos.
El valor predeterminado es de 30 segundos.
El cliente debe establecer el tiempo de espera en un período más corto si se espera que los mensajes se envíen en intervalos más cortos,
y quiere que el cliente se desconecte más rápidamente después de enviar el último mensaje.
Puede establecer el tiempo de espera en un período más largo si se espera que los mensajes se envíen en intervalos más largos,
y quieren mantener activa la misma conexión de cliente durante esta sesión.
El servicio considera que el cliente está desconectado si no ha recibido un mensaje (incluido keep-alive) en este intervalo.		 Int

Restricciones:
Valor mínimo = 1
Valor máximo = 120
keepAliveIntervalInSeconds Obtiene o establece el intervalo de Keep-Alive. Opcional para establecer.
El valor es en segundos.
El valor predeterminado es 15 segundos.
Los clientes deben establecer este valor en un período más corto si quieren que el servicio envíe mensajes de mantenimiento con más frecuencia,
garantizando comprobaciones oportunas del estado de conexión.
Por el contrario, los clientes pueden establecer este valor en un período más largo si quieren que el servicio envíe mensajes de mantenimiento activo con menos frecuencia,
Reducir el tráfico de red, pero tenga en cuenta que puede tardar más tiempo en detectar una desconexión.
Este intervalo garantiza que la conexión se mantenga enviando mensajes periódicos de mantenimiento al cliente.		 Int

Restricciones:
Valor mínimo = 1
Valor máximo = 120

ServerlessUpstreamSettings

Nombre Descripción Valor
Plantillas Obtiene o establece la lista de plantillas de dirección URL ascendentes. El orden es importante y la primera plantilla coincidente tiene efectos. UpstreamTemplate []

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[]

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.
- EnableMessagingLogs: "true"/"false", para habilitar o deshabilitar la categoría del registro de conectividad respectivamente.
- EnableLiveTrace: Live Trace le permite saber lo que sucede dentro del servicio Azure SignalR, le proporcionará seguimientos en vivo en tiempo real, será útil al desarrollar su propia aplicación web basada en Azure SignalR o solucionar algunos problemas. Tenga en cuenta que los seguimientos en directo se cuentan como mensajes salientes que se cobrarán. Valores permitidos: "true"/"false", para habilitar o deshabilitar la característica de seguimiento activo.		 'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'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

SignalRNetworkACLs

Nombre Descripción Valor
defaultAction Acción de ACL de redes de Azure. 'Permitir'
'Denegar'
ipRules Reglas ip para filtrar el tráfico público IPRule []
privateEndpoints ACL para solicitudes de puntos de conexión privados PrivateEndpointACL []
publicNetwork ACL de red NetworkACL

SignalRProperties

Nombre Descripción Valor
applicationFirewall Configuración del firewall de aplicaciones para el recurso applicationFirewallSettings
cors Configuración de uso compartido de recursos entre orígenes (CORS). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Habilitación o deshabilitación de la autenticación de aad
Cuando se establece como true, la conexión con AuthType=aad no funcionará.		 Bool
disableLocalAuth DisableLocalAuth
Habilitación o deshabilitación de la autenticación local con AccessKey
Cuando se establece como true, la conexión con AccessKey=xxx no funcionará.		 Bool
Funciones Lista de featureFlags.

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 un featureFlag no se establece explícitamente, se 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[]
liveTraceConfiguration Configuración de seguimiento activo de un recurso Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACL de red para el recurso SignalRNetworkACLs
publicNetworkAccess Habilite o deshabilite el acceso a la red pública. El valor predeterminado es "Habilitado".
Cuando está habilitado, las ACL de red se siguen aplicando.
Cuando está deshabilitado, el acceso a la red pública siempre está deshabilitado independientemente de lo que establezca en las ACL de red.		 cuerda
regionEndpointEnabled Habilite o deshabilite el punto de conexión regional. El valor predeterminado es "Habilitado".
Cuando está deshabilitado, las nuevas conexiones no se enrutarán a este punto de conexión, pero las conexiones existentes no se verán afectadas.
Esta propiedad es específica de la réplica. No se permite deshabilitar el punto de conexión regional sin réplica.		 cuerda
resourceLogConfiguration Configuración del registro de recursos de un recurso Microsoft.SignalRService. resourceLogConfiguration
resourceStopped Detenga o inicie el recurso. El valor predeterminado es "False".
Cuando se cumple, el plano de datos del recurso se apaga.
Cuando es false, se inicia el plano de datos del recurso.		 cuerda
sin servidor Configuración sin servidor. ServerlessSettings
tls Configuración de TLS para el recurso SignalRTlsSettings
río arriba La configuración de upstream cuando el servicio está en modo sin servidor. ServerlessUpstreamSettings

SignalRTlsSettings

Nombre Descripción Valor
clientCertEnabled Solicite el certificado de cliente durante el protocolo de enlace TLS si está habilitado. No se admite para el nivel gratis. Cualquier entrada se omitirá para el nivel gratis. Bool

ThrottleByJwtCustomClaimRule

Nombre Descripción Valor
claimName Nombre de la notificación en el token JWT. La conexión de cliente con el mismo valor de notificación se agregará. Si la notificación no se encuentra en el token, se permitirá la conexión. string (obligatorio)
maxCount Número máximo de conexiones permitido para el mismo valor de notificación Jwt. Los clientes con la misma notificación Jwt se rechazarán si el recuento de conexiones supera este valor. El valor predeterminado es 20. Int

Restricciones:
Valor mínimo = 0
Valor máximo = 2147483647
tipo 'ThrottleByJwtCustomClaimRule' (obligatorio)

ThrottleByJwtSignatureRule

Nombre Descripción Valor
maxCount Número máximo de conexiones permitido para la misma firma JWT. Los clientes con la misma firma JWT se rechazarán si el recuento de conexiones supera este valor. El valor predeterminado es 20. Int

Restricciones:
Valor mínimo = 0
Valor máximo = 2147483647
tipo 'ThrottleByJwtSignatureRule' (obligatorio)

ThrottleByUserIdRule

Nombre Descripción Valor
maxCount Número máximo de conexiones permitido para el mismo identificador de usuario. Los clientes con el mismo identificador de usuario se rechazarán si el recuento de conexiones supera este valor. El valor predeterminado es 20. Int

Restricciones:
Valor mínimo = 0
Valor máximo = 2147483647
tipo 'ThrottleByUserIdRule' (obligatorio)

TrackedResourceTags

Nombre Descripción Valor

TrafficThrottleByJwtCustomClaimRule

Nombre Descripción Valor
aggregationWindowInSeconds Ventana de agregación para los bytes del mensaje. Los bytes del mensaje se agregarán en esta ventana y se restablecerán después de la ventana. El valor predeterminado es de 60 segundos. Int

Restricciones:
Valor mínimo = 10
Valor máximo = 3600
claimName Nombre de la notificación en el token JWT. Se agregarán los bytes del mensaje con el mismo valor de notificación. Si no se encuentra la notificación en el token, se omitirá la regla. string (obligatorio)
maxInboundMessageBytes Número máximo de bytes de mensajes entrantes acumulados permitidos para la misma firma JWT dentro de un período de tiempo. Los clientes con la misma notificación JWT se desconectarán si los bytes del mensaje superan este valor. El valor predeterminado es de 1 GB. Int

Restricciones:
Valor mínimo = 0
tipo 'TrafficThrottleByJwtCustomClaimRule' (obligatorio)

TrafficThrottleByJwtSignatureRule

Nombre Descripción Valor
aggregationWindowInSeconds Ventana de agregación para los bytes del mensaje. Los bytes del mensaje se agregarán en esta ventana y se restablecerán después de la ventana. El valor predeterminado es de 60 segundos. Int

Restricciones:
Valor mínimo = 10
Valor máximo = 3600
maxInboundMessageBytes Número máximo de bytes de mensajes entrantes acumulados permitidos para la misma firma JWT dentro de un período de tiempo. Los clientes con la misma firma JWT se desconectarán si los bytes del mensaje superan este valor. El valor predeterminado es de 1 GB. Int

Restricciones:
Valor mínimo = 0
tipo 'TrafficThrottleByJwtSignatureRule' (obligatorio)

TrafficThrottleByUserIdRule

Nombre Descripción Valor
aggregationWindowInSeconds Ventana de agregación para los bytes del mensaje. Los bytes del mensaje se agregarán en esta ventana y se restablecerán después de la ventana. El valor predeterminado es de 60 segundos. Int

Restricciones:
Valor mínimo = 10
Valor máximo = 3600
maxInboundMessageBytes Número máximo de bytes de mensajes entrantes acumulados permitidos para el mismo identificador de usuario dentro de un período de tiempo. Los clientes con el mismo identificador de usuario se desconectarán si los bytes del mensaje superan este valor. El valor predeterminado es de 1 GB. Int

Restricciones:
Valor mínimo = 0
tipo 'TrafficThrottleByUserIdRule' (obligatorio)

UpstreamAuthSettings

Nombre Descripción Valor
managedIdentity Configuración de identidad administrada para ascendente. managedIdentitySettings
tipo Enumeración de tipo de autenticación ascendente. 'ManagedIdentity'
'Ninguno'

UpstreamTemplate

Nombre Descripción Valor
Auth Configuración de autenticación ascendente. Si no se establece, no se usa ninguna autenticación para los mensajes ascendentes. upstreamAuthSettings
categoryPattern Obtiene o establece el patrón coincidente para los nombres de categoría. Si no se establece, coincide con cualquier categoría.
Hay 3 tipos de patrones admitidos:
1. "*", coincide con cualquier nombre de categoría.
2. Combine varias categorías con ",", por ejemplo "conexiones, mensajes", coincide con la categoría "connections" y "messages".
3. El nombre de categoría único, por ejemplo, "connections", coincide con la categoría "connections".		 cuerda
eventPattern Obtiene o establece el patrón coincidente para los nombres de evento. Si no se establece, coincide con cualquier evento.
Hay 3 tipos de patrones admitidos:
1. "*", coincide con cualquier nombre de evento.
2. Combine varios eventos con ",", por ejemplo "connect,disconnect", coincide con el evento "connect" y "disconnect".
3. El nombre de evento único, por ejemplo, "connect", coincide con "connect".		 cuerda
hubPattern Obtiene o establece el patrón coincidente para los nombres del centro. Si no se establece, coincide con cualquier centro.
Hay 3 tipos de patrones admitidos:
1. "*", para que coincida con cualquier nombre del centro.
2. Combine varios concentradores con ",", por ejemplo "hub1,hub2", coincide con "hub1" y "hub2".
3. El nombre del concentrador único, por ejemplo, "hub1", coincide con "hub1".		 cuerda
urlTemplate Obtiene o establece la plantilla dirección URL ascendente. Puede usar 3 parámetros predefinidos {hub}, {category} {event} dentro de la plantilla, el valor de la dirección URL ascendente se calcula dinámicamente cuando entra en la solicitud de cliente.
Por ejemplo, si la dirección URLTemplate es http://example.com/{hub}/api/{event}, con una solicitud de cliente del centro de conectividad chat se conecta, primero enviará POST a esta dirección URL: http://example.com/chat/api/connect.		 string (obligatorio)

UserAssignedIdentityProperty

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

Implementación en Azure 		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@2024-10-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      applicationFirewall = {
        clientConnectionCountRules = [
          {
            type = "string"
            // For remaining properties, see ClientConnectionCountRule objects
          }
        ]
        clientTrafficControlRules = [
          {
            type = "string"
            // For remaining properties, see ClientTrafficControlRule objects
          }
        ]
      }
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      disableAadAuth = bool
      disableLocalAuth = bool
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      liveTraceConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
        enabled = "string"
      }
      networkACLs = {
        defaultAction = "string"
        ipRules = [
          {
            action = "string"
            value = "string"
          }
        ]
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      regionEndpointEnabled = "string"
      resourceLogConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "string"
          }
        ]
      }
      resourceStopped = "string"
      serverless = {
        connectionTimeoutInSeconds = int
        keepAliveIntervalInSeconds = int
      }
      tls = {
        clientCertEnabled = bool
      }
      upstream = {
        templates = [
          {
            auth = {
              managedIdentity = {
                resource = "string"
              }
              type = "string"
            }
            categoryPattern = "string"
            eventPattern = "string"
            hubPattern = "string"
            urlTemplate = "string"
          }
        ]
      }
    }
  })
}

Objetos ClientTrafficControlRule

Establezca el tipo propiedad para especificar el tipo de objeto.

Para TrafficThrottleByJwtCustomClaimRule, use:

{
  aggregationWindowInSeconds = int
  claimName = "string"
  maxInboundMessageBytes = int
  type = "TrafficThrottleByJwtCustomClaimRule"
}

Para TrafficThrottleByJwtSignatureRule, use:

{
  aggregationWindowInSeconds = int
  maxInboundMessageBytes = int
  type = "TrafficThrottleByJwtSignatureRule"
}

Para TrafficThrottleByUserIdRule, use:

{
  aggregationWindowInSeconds = int
  maxInboundMessageBytes = int
  type = "TrafficThrottleByUserIdRule"
}

Objetos ClientConnectionCountRule

Establezca el tipo propiedad para especificar el tipo de objeto.

Para ThrottleByJwtCustomClaimRule, use:

{
  claimName = "string"
  maxCount = int
  type = "ThrottleByJwtCustomClaimRule"
}

Para ThrottleByJwtSignatureRule, use:

{
  maxCount = int
  type = "ThrottleByJwtSignatureRule"
}

Para ThrottleByUserIdRule, use:

{
  maxCount = int
  type = "ThrottleByUserIdRule"
}

Valores de propiedad

ApplicationFirewallSettings

Nombre Descripción Valor
clientConnectionCountRules Reglas para controlar el recuento de conexiones de cliente ClientConnectionCountRule []
clientTrafficControlRules Reglas para controlar el tráfico del cliente ClientTrafficControlRule []

ClientConnectionCountRule

Nombre Descripción Valor
tipo Establezca en "ThrottleByJwtCustomClaimRule" para el tipo ThrottleByJwtCustomClaimRule. Establezca en "ThrottleByJwtSignatureRule" para el tipo ThrottleByJwtSignatureRule. Establezca en "ThrottleByUserIdRule" para el tipo ThrottleByUserIdRule. 'ThrottleByJwtCustomClaimRule'
'ThrottleByJwtSignatureRule'
'ThrottleByUserIdRule' (obligatorio)

ClientTrafficControlRule

Nombre Descripción Valor
tipo Establezca en "TrafficThrottleByJwtCustomClaimRule" para el tipo TrafficThrottleByJwtCustomClaimRule. Establezca en "TrafficThrottleByJwtSignatureRule" para el tipo TrafficThrottleByJwtSignatureRule. Establezca en "TrafficThrottleByUserIdRule" para el tipo TrafficThrottleByUserIdRule. 'TrafficThrottleByJwtCustomClaimRule'
'TrafficThrottleByJwtSignatureRule'
'TrafficThrottleByUserIdRule' (obligatorio)

IPRule

Nombre Descripción Valor
acción Acción de ACL de redes de Azure. 'Permitir'
'Denegar'
valor Ip o CIDR o ServiceTag cuerda

LiveTraceCategory

Nombre Descripción Valor
Habilitado Indica si o la categoría de seguimiento activo está habilitada.
Valores disponibles: true, false.
No distingue mayúsculas de minúsculas.		 cuerda
nombre Obtiene o establece el nombre de la categoría de seguimiento activo.
Valores disponibles: ConnectivityLogs, MessagingLogs.
No distingue mayúsculas de minúsculas.		 cuerda

LiveTraceConfiguration

Nombre Descripción Valor
Categorías Obtiene o establece la lista de configuraciones de categoría. LiveTraceCategory []
Habilitado Indica si habilita o no el seguimiento activo.
Cuando se establece en true, el cliente de seguimiento activo puede conectarse al servicio.
De lo contrario, el cliente de seguimiento activo no puede conectarse al servicio, de modo que no pueda recibir ningún registro, independientemente de lo que configure en "categorías".
Valores disponibles: true, false.
No distingue mayúsculas de minúsculas.		 cuerda

ManagedIdentity

Nombre Descripción Valor
tipo Representa el tipo de identidad: systemAssigned, userAssigned, None 'Ninguno'
'SystemAssigned'
'UserAssigned'
userAssignedIdentities Obtener o establecer las identidades asignadas por el usuario ManagedIdentityUserAssignedIdentities

ManagedIdentitySettings

Nombre Descripción Valor
recurso Recurso que indica el URI del identificador de aplicación del recurso de destino.
También aparece en la notificación aud (audiencia) del token emitido.		 cuerda

ManagedIdentityUserAssignedIdentities

Nombre Descripción Valor

Microsoft.SignalRService/signalR

Nombre Descripción Valor
identidad Una clase representa las identidades administradas usadas para la solicitud y la respuesta. managedIdentity
amable El tipo de servicio 'RawWebSockets'
'SignalR'
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 3
Longitud máxima = 3
Patrón = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obligatorio)
Propiedades Clase que describe las propiedades del recurso SignalRProperties
Sku Información de facturación del recurso. ResourceSku de
Etiquetas Etiquetas del recurso Diccionario de nombres y valores de etiqueta.
tipo El tipo de recurso "Microsoft.SignalRService/signalR@2024-10-01-preview"

NetworkACL

Nombre Descripción Valor
conceder Tipos de solicitud permitidos. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadenas que contiene cualquiera de:
'ClientConnection'
'RESTAPI'
"ServerConnection"
'Trace'
negar Tipos de solicitud denegados. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadenas que contiene cualquiera de:
'ClientConnection'
'RESTAPI'
"ServerConnection"
'Trace'

PrivateEndpointACL

Nombre Descripción Valor
conceder Tipos de solicitud permitidos. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadenas que contiene cualquiera de:
'ClientConnection'
'RESTAPI'
"ServerConnection"
'Trace'
negar Tipos de solicitud denegados. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadenas que contiene cualquiera de:
'ClientConnection'
'RESTAPI'
"ServerConnection"
'Trace'
nombre Nombre de la conexión de punto de conexión privado string (obligatorio)

ResourceLogCategory

Nombre Descripción Valor
Habilitado Indica si o la categoría de registro de recursos está habilitada.
Valores disponibles: true, false.
No distingue mayúsculas de minúsculas.		 cuerda
nombre Obtiene o establece el nombre de la categoría del registro de recursos.
Valores disponibles: ConnectivityLogs, MessagingLogs.
No distingue mayúsculas de minúsculas.		 cuerda

ResourceLogConfiguration

Nombre Descripción Valor
Categorías Obtiene o establece la lista de configuraciones de categoría. resourceLogCategory[]

ResourceSku

Nombre Descripción Valor
capacidad Opcional, entero. Recuento de unidades del recurso.
1 para Free_F1/Standard_S1/Premium_P1, 100 para Premium_P2 de forma predeterminada.

Si está presente, se permiten los siguientes valores:
Free_F1: 1;
Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium_P2: 100.200.300.400.500.600.700.800.900.1000;		 Int
nombre Nombre de la SKU. Obligatorio.

Valores permitidos: Standard_S1, Free_F1, Premium_P1, Premium_P2		 string (obligatorio)
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'

ServerlessSettings

Nombre Descripción Valor
connectionTimeoutInSeconds Obtiene o establece tiempo de espera de conexión de cliente. Opcional para establecer.
Valor en segundos.
El valor predeterminado es de 30 segundos.
El cliente debe establecer el tiempo de espera en un período más corto si se espera que los mensajes se envíen en intervalos más cortos,
y quiere que el cliente se desconecte más rápidamente después de enviar el último mensaje.
Puede establecer el tiempo de espera en un período más largo si se espera que los mensajes se envíen en intervalos más largos,
y quieren mantener activa la misma conexión de cliente durante esta sesión.
El servicio considera que el cliente está desconectado si no ha recibido un mensaje (incluido keep-alive) en este intervalo.		 Int

Restricciones:
Valor mínimo = 1
Valor máximo = 120
keepAliveIntervalInSeconds Obtiene o establece el intervalo de Keep-Alive. Opcional para establecer.
El valor es en segundos.
El valor predeterminado es 15 segundos.
Los clientes deben establecer este valor en un período más corto si quieren que el servicio envíe mensajes de mantenimiento con más frecuencia,
garantizando comprobaciones oportunas del estado de conexión.
Por el contrario, los clientes pueden establecer este valor en un período más largo si quieren que el servicio envíe mensajes de mantenimiento activo con menos frecuencia,
Reducir el tráfico de red, pero tenga en cuenta que puede tardar más tiempo en detectar una desconexión.
Este intervalo garantiza que la conexión se mantenga enviando mensajes periódicos de mantenimiento al cliente.		 Int

Restricciones:
Valor mínimo = 1
Valor máximo = 120

ServerlessUpstreamSettings

Nombre Descripción Valor
Plantillas Obtiene o establece la lista de plantillas de dirección URL ascendentes. El orden es importante y la primera plantilla coincidente tiene efectos. UpstreamTemplate []

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[]

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.
- EnableMessagingLogs: "true"/"false", para habilitar o deshabilitar la categoría del registro de conectividad respectivamente.
- EnableLiveTrace: Live Trace le permite saber lo que sucede dentro del servicio Azure SignalR, le proporcionará seguimientos en vivo en tiempo real, será útil al desarrollar su propia aplicación web basada en Azure SignalR o solucionar algunos problemas. Tenga en cuenta que los seguimientos en directo se cuentan como mensajes salientes que se cobrarán. Valores permitidos: "true"/"false", para habilitar o deshabilitar la característica de seguimiento activo.		 'EnableConnectivityLogs'
'EnableLiveTrace'
'EnableMessagingLogs'
'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

SignalRNetworkACLs

Nombre Descripción Valor
defaultAction Acción de ACL de redes de Azure. 'Permitir'
'Denegar'
ipRules Reglas ip para filtrar el tráfico público IPRule []
privateEndpoints ACL para solicitudes de puntos de conexión privados PrivateEndpointACL []
publicNetwork ACL de red NetworkACL

SignalRProperties

Nombre Descripción Valor
applicationFirewall Configuración del firewall de aplicaciones para el recurso applicationFirewallSettings
cors Configuración de uso compartido de recursos entre orígenes (CORS). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Habilitación o deshabilitación de la autenticación de aad
Cuando se establece como true, la conexión con AuthType=aad no funcionará.		 Bool
disableLocalAuth DisableLocalAuth
Habilitación o deshabilitación de la autenticación local con AccessKey
Cuando se establece como true, la conexión con AccessKey=xxx no funcionará.		 Bool
Funciones Lista de featureFlags.

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 un featureFlag no se establece explícitamente, se 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[]
liveTraceConfiguration Configuración de seguimiento activo de un recurso Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACL de red para el recurso SignalRNetworkACLs
publicNetworkAccess Habilite o deshabilite el acceso a la red pública. El valor predeterminado es "Habilitado".
Cuando está habilitado, las ACL de red se siguen aplicando.
Cuando está deshabilitado, el acceso a la red pública siempre está deshabilitado independientemente de lo que establezca en las ACL de red.		 cuerda
regionEndpointEnabled Habilite o deshabilite el punto de conexión regional. El valor predeterminado es "Habilitado".
Cuando está deshabilitado, las nuevas conexiones no se enrutarán a este punto de conexión, pero las conexiones existentes no se verán afectadas.
Esta propiedad es específica de la réplica. No se permite deshabilitar el punto de conexión regional sin réplica.		 cuerda
resourceLogConfiguration Configuración del registro de recursos de un recurso Microsoft.SignalRService. resourceLogConfiguration
resourceStopped Detenga o inicie el recurso. El valor predeterminado es "False".
Cuando se cumple, el plano de datos del recurso se apaga.
Cuando es false, se inicia el plano de datos del recurso.		 cuerda
sin servidor Configuración sin servidor. ServerlessSettings
tls Configuración de TLS para el recurso SignalRTlsSettings
río arriba La configuración de upstream cuando el servicio está en modo sin servidor. ServerlessUpstreamSettings

SignalRTlsSettings

Nombre Descripción Valor
clientCertEnabled Solicite el certificado de cliente durante el protocolo de enlace TLS si está habilitado. No se admite para el nivel gratis. Cualquier entrada se omitirá para el nivel gratis. Bool

ThrottleByJwtCustomClaimRule

Nombre Descripción Valor
claimName Nombre de la notificación en el token JWT. La conexión de cliente con el mismo valor de notificación se agregará. Si la notificación no se encuentra en el token, se permitirá la conexión. string (obligatorio)
maxCount Número máximo de conexiones permitido para el mismo valor de notificación Jwt. Los clientes con la misma notificación Jwt se rechazarán si el recuento de conexiones supera este valor. El valor predeterminado es 20. Int

Restricciones:
Valor mínimo = 0
Valor máximo = 2147483647
tipo 'ThrottleByJwtCustomClaimRule' (obligatorio)

ThrottleByJwtSignatureRule

Nombre Descripción Valor
maxCount Número máximo de conexiones permitido para la misma firma JWT. Los clientes con la misma firma JWT se rechazarán si el recuento de conexiones supera este valor. El valor predeterminado es 20. Int

Restricciones:
Valor mínimo = 0
Valor máximo = 2147483647
tipo 'ThrottleByJwtSignatureRule' (obligatorio)

ThrottleByUserIdRule

Nombre Descripción Valor
maxCount Número máximo de conexiones permitido para el mismo identificador de usuario. Los clientes con el mismo identificador de usuario se rechazarán si el recuento de conexiones supera este valor. El valor predeterminado es 20. Int

Restricciones:
Valor mínimo = 0
Valor máximo = 2147483647
tipo 'ThrottleByUserIdRule' (obligatorio)

TrackedResourceTags

Nombre Descripción Valor

TrafficThrottleByJwtCustomClaimRule

Nombre Descripción Valor
aggregationWindowInSeconds Ventana de agregación para los bytes del mensaje. Los bytes del mensaje se agregarán en esta ventana y se restablecerán después de la ventana. El valor predeterminado es de 60 segundos. Int

Restricciones:
Valor mínimo = 10
Valor máximo = 3600
claimName Nombre de la notificación en el token JWT. Se agregarán los bytes del mensaje con el mismo valor de notificación. Si no se encuentra la notificación en el token, se omitirá la regla. string (obligatorio)
maxInboundMessageBytes Número máximo de bytes de mensajes entrantes acumulados permitidos para la misma firma JWT dentro de un período de tiempo. Los clientes con la misma notificación JWT se desconectarán si los bytes del mensaje superan este valor. El valor predeterminado es de 1 GB. Int

Restricciones:
Valor mínimo = 0
tipo 'TrafficThrottleByJwtCustomClaimRule' (obligatorio)

TrafficThrottleByJwtSignatureRule

Nombre Descripción Valor
aggregationWindowInSeconds Ventana de agregación para los bytes del mensaje. Los bytes del mensaje se agregarán en esta ventana y se restablecerán después de la ventana. El valor predeterminado es de 60 segundos. Int

Restricciones:
Valor mínimo = 10
Valor máximo = 3600
maxInboundMessageBytes Número máximo de bytes de mensajes entrantes acumulados permitidos para la misma firma JWT dentro de un período de tiempo. Los clientes con la misma firma JWT se desconectarán si los bytes del mensaje superan este valor. El valor predeterminado es de 1 GB. Int

Restricciones:
Valor mínimo = 0
tipo 'TrafficThrottleByJwtSignatureRule' (obligatorio)

TrafficThrottleByUserIdRule

Nombre Descripción Valor
aggregationWindowInSeconds Ventana de agregación para los bytes del mensaje. Los bytes del mensaje se agregarán en esta ventana y se restablecerán después de la ventana. El valor predeterminado es de 60 segundos. Int

Restricciones:
Valor mínimo = 10
Valor máximo = 3600
maxInboundMessageBytes Número máximo de bytes de mensajes entrantes acumulados permitidos para el mismo identificador de usuario dentro de un período de tiempo. Los clientes con el mismo identificador de usuario se desconectarán si los bytes del mensaje superan este valor. El valor predeterminado es de 1 GB. Int

Restricciones:
Valor mínimo = 0
tipo 'TrafficThrottleByUserIdRule' (obligatorio)

UpstreamAuthSettings

Nombre Descripción Valor
managedIdentity Configuración de identidad administrada para ascendente. managedIdentitySettings
tipo Enumeración de tipo de autenticación ascendente. 'ManagedIdentity'
'Ninguno'

UpstreamTemplate

Nombre Descripción Valor
Auth Configuración de autenticación ascendente. Si no se establece, no se usa ninguna autenticación para los mensajes ascendentes. upstreamAuthSettings
categoryPattern Obtiene o establece el patrón coincidente para los nombres de categoría. Si no se establece, coincide con cualquier categoría.
Hay 3 tipos de patrones admitidos:
1. "*", coincide con cualquier nombre de categoría.
2. Combine varias categorías con ",", por ejemplo "conexiones, mensajes", coincide con la categoría "connections" y "messages".
3. El nombre de categoría único, por ejemplo, "connections", coincide con la categoría "connections".		 cuerda
eventPattern Obtiene o establece el patrón coincidente para los nombres de evento. Si no se establece, coincide con cualquier evento.
Hay 3 tipos de patrones admitidos:
1. "*", coincide con cualquier nombre de evento.
2. Combine varios eventos con ",", por ejemplo "connect,disconnect", coincide con el evento "connect" y "disconnect".
3. El nombre de evento único, por ejemplo, "connect", coincide con "connect".		 cuerda
hubPattern Obtiene o establece el patrón coincidente para los nombres del centro. Si no se establece, coincide con cualquier centro.
Hay 3 tipos de patrones admitidos:
1. "*", para que coincida con cualquier nombre del centro.
2. Combine varios concentradores con ",", por ejemplo "hub1,hub2", coincide con "hub1" y "hub2".
3. El nombre del concentrador único, por ejemplo, "hub1", coincide con "hub1".		 cuerda
urlTemplate Obtiene o establece la plantilla dirección URL ascendente. Puede usar 3 parámetros predefinidos {hub}, {category} {event} dentro de la plantilla, el valor de la dirección URL ascendente se calcula dinámicamente cuando entra en la solicitud de cliente.
Por ejemplo, si la dirección URLTemplate es http://example.com/{hub}/api/{event}, con una solicitud de cliente del centro de conectividad chat se conecta, primero enviará POST a esta dirección URL: http://example.com/chat/api/connect.		 string (obligatorio)

UserAssignedIdentityProperty

Nombre Descripción Valor