Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
- última
- 2025-01-01-visualização
- 2024-10-01-visualização
- 2024-08-01-visualização
- 2024-04-01-prévia
- 2024-03-01
- 2024-01-01-visualização
- 2023-08-01-prévia
- 2023-06-01-prévia
- 2023-03-01-visualização
- 2023-02-01
- 2022-08-01-visualização
- 2022-02-01
- 2021-10-01
- 2021-09-01-visualização
- 2021-06-01-visualização
- 2021-04-01-visualização
- 2020-07-01-visualização
- 2020-05-01
- 2018-10-01
- 2018-03-01-visualização
Definição de recurso do Bicep
O tipo de recurso signalR pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.SignalRService/signalR, adicione o Bicep a seguir ao seu modelo.
resource symbolicname 'Microsoft.SignalRService/signalR@2025-01-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
}
]
maxClientConnectionLifetimeInSeconds: int
}
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'
routeSettings: {
connectionBalanceWeight: int
latencyWeight: int
serverBalanceWeight: int
}
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
Defina a propriedade tipo para especificar o 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
Defina a propriedade tipo para especificar o 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 propriedade
Microsoft.SignalRService/signalR
Nome | Descrição | Valor |
---|---|---|
identidade | Uma classe representa identidades gerenciadas usadas para solicitação e resposta | Identidade gerenciada |
tipo | O tipo do serviço | 'RawWebSockets' 'SignalR' |
localização | A localização geográfica onde o recurso reside | cadeia de caracteres (obrigatório) |
nome | O nome do recurso | corda Restrições: Comprimento mínimo = 3 Comprimento máximo = 63 Padrão = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obrigatório) |
Propriedades | Uma classe que descreve as propriedades do recurso | SignalRProperties |
Sku | As informações de cobrança do recurso. | do |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
ApplicationFirewallSettings
Nome | Descrição | Valor |
---|---|---|
clientConnectionCountRules | Regras para controlar a contagem de conexões do cliente | ClientConnectionCountRule[] |
clientTrafficControlRules | Regras para controlar o tráfego do cliente | ClientTrafficControlRule [] |
maxClientConnectionLifetimeInSeconds | Configuração para controlar o tempo de vida da conexão do cliente em segundos, pode ser definido como 0 para desabilitar a configuração | int Restrições: Valor mínimo = 0 Valor máximo = 604800 |
Regra de contagem de conexões de cliente
Nome | Descrição | Valor |
---|---|---|
tipo | Defina como 'ThrottleByJwtCustomClaimRule' para o tipo ThrottleByJwtCustomClaimRule. Defina como 'ThrottleByJwtSignatureRule' para o tipo ThrottleByJwtSignatureRule. Defina como 'ThrottleByUserIdRule' para o tipo ThrottleByUserIdRule. | 'ThrottleByJwtCustomClaimRule' 'ThrottleByJwtSignatureRule' 'ThrottleByUserIdRule' (obrigatório) |
ClientTrafficControlRule
Nome | Descrição | Valor |
---|---|---|
tipo | Defina como 'TrafficThrottleByJwtCustomClaimRule' para o tipo TrafficThrottleByJwtCustomClaimRule. Defina como 'TrafficThrottleByJwtSignatureRule' para o tipo TrafficThrottleByJwtSignatureRule. Defina como 'TrafficThrottleByUserIdRule' para o tipo TrafficThrottleByUserIdRule. | 'TrafficThrottleByJwtCustomClaimRule' 'TrafficThrottleByJwtSignatureRule' 'TrafficThrottleByUserIdRule' (obrigatório) |
IPRule
Nome | Descrição | Valor |
---|---|---|
ação | Ação acl de rede do Azure. | 'Permitir' 'Negar' |
valor | Um IP ou CIDR ou ServiceTag | corda |
LiveTraceCategory
Nome | Descrição | Valor |
---|---|---|
Habilitado | Indica se ou a categoria de rastreamento dinâmico está habilitada. Valores disponíveis: true, false. Não diferencia maiúsculas de minúsculas. |
corda |
nome | Obtém ou define o nome da categoria de rastreamento ao vivo. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não diferencia maiúsculas de minúsculas. |
corda |
LiveTraceConfiguration
Nome | Descrição | Valor |
---|---|---|
Categorias | Obtém ou define a lista de configurações de categoria. | |
Habilitado | Indica se habilitar ou não o rastreamento dinâmico. Quando ele é definido como true, o cliente de rastreamento dinâmico pode se conectar ao serviço. Caso contrário, o cliente de rastreamento dinâmico não poderá se conectar ao serviço, de modo que você não possa receber nenhum log, independentemente do que você configurar em "categorias". Valores disponíveis: true, false. Não diferencia maiúsculas de minúsculas. |
corda |
Identidade gerenciada
Nome | Descrição | Valor |
---|---|---|
tipo | Representa o tipo de identidade: systemAssigned, userAssigned, None | 'Nenhum' 'SystemAssigned' 'UserAssigned' |
Identidades Atribuídas pelo Usuário | Obter ou definir as identidades atribuídas pelo usuário | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
Nome | Descrição | Valor |
---|---|---|
recurso | O recurso que indica o URI da ID do aplicativo do recurso de destino. Ele também aparece na declaração aud (audience) do token emitido. |
corda |
ManagedIdentityUserAssignedIdentities
Nome | Descrição | Valor |
---|
ACL de rede
Nome | Descrição | Valor |
---|---|---|
permitir | Tipos de solicitação permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. | Matriz de cadeia de caracteres que contém qualquer um dos: 'Conexão de cliente' 'RESTAPI' 'Conexão de servidor' 'Traço' |
negar | Tipos de solicitação negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. | Matriz de cadeia de caracteres que contém qualquer um dos: 'Conexão de cliente' 'RESTAPI' 'Conexão de servidor' 'Traço' |
PrivateEndpointACL
Nome | Descrição | Valor |
---|---|---|
permitir | Tipos de solicitação permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. | Matriz de cadeia de caracteres que contém qualquer um dos: 'Conexão de cliente' 'RESTAPI' 'Conexão de servidor' 'Traço' |
negar | Tipos de solicitação negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. | Matriz de cadeia de caracteres que contém qualquer um dos: 'Conexão de cliente' 'RESTAPI' 'Conexão de servidor' 'Traço' |
nome | Nome da conexão de ponto de extremidade privado | cadeia de caracteres (obrigatório) |
ResourceLogCategory
Nome | Descrição | Valor |
---|---|---|
Habilitado | Indica se ou a categoria de log de recursos está habilitada. Valores disponíveis: true, false. Não diferencia maiúsculas de minúsculas. |
corda |
nome | Obtém ou define o nome da categoria do log de recursos. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não diferencia maiúsculas de minúsculas. |
corda |
Configuração do ResourceLog
Nome | Descrição | Valor |
---|---|---|
Categorias | Obtém ou define a lista de configurações de categoria. | ResourceLogCategory [] |
ResourceSku
Nome | Descrição | Valor |
---|---|---|
capacidade | Opcional, inteiro. A contagem de unidades do recurso. 1 para Free_F1/Standard_S1/Premium_P1, 100 para Premium_P2 por padrão. Se estiverem presentes, os seguintes valores serão permitidos: 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 |
nome | O nome da SKU. Necessário. Valores permitidos: Standard_S1, Free_F1, Premium_P1 Premium_P2 |
cadeia de caracteres (obrigatório) |
camada | Camada opcional deste SKU específico. 'Standard' ou 'Free'. Basic foi preterido, use Standard em vez disso. |
'Básico' 'Gratuito' 'Prêmio' 'Padrão' |
Configurações de rota
Nome | Descrição | Valor |
---|---|---|
connectionBalanceWeight | Obtém ou define o peso do equilíbrio da conexão. Um valor mais alto significa um maior equilíbrio de conexões de cliente em diferentes conexões de servidor. Um valor de 0 distribui conexões aleatoriamente, enquanto um valor de 255 garante o balanceamento máximo. O valor padrão é 255. Recomendado 255 para todos os casos. |
int Restrições: Valor mínimo = 0 Valor máximo = 255 |
latencyWeight | Obtém ou define o peso para roteamento baseado em latência. Um valor mais alto aumenta a influência do roteamento baseado em latência. Um valor de 0 desabilita totalmente o roteamento baseado em latência, enquanto um valor de 255 o habilita totalmente. O valor padrão é 0. Recomendado 255 para réplicas ou servidores de aplicativos em diferentes regiões para recuperação de desastre. |
int Restrições: Valor mínimo = 0 Valor máximo = 255 |
serverBalanceWeight | Obtém ou define o peso do saldo do servidor. Um valor mais alto significa um maior equilíbrio de conexões de cliente em diferentes instâncias do servidor de aplicativos. Um valor de 0 distribui conexões aleatoriamente, enquanto um valor de 255 garante o balanceamento máximo. O valor padrão é 255. Recomendado 255 para vários servidores de aplicativos no mesmo tamanho. |
int Restrições: Valor mínimo = 0 Valor máximo = 255 |
Configurações sem servidor
Nome | Descrição | Valor |
---|---|---|
connectionTimeoutInSeconds | Obtém ou define o tempo limite de conexão do cliente. Opcional a ser definido. Valor em segundos. O valor padrão é 30 segundos. O cliente deve definir o tempo limite para um período mais curto se as mensagens forem enviadas em intervalos mais curtos, e deseja que o cliente se desconecte mais rapidamente após o envio da última mensagem. Você pode definir o tempo limite para um período mais longo se espera-se que as mensagens sejam enviadas em intervalos mais longos, e eles querem manter a mesma conexão de cliente ativa durante esta sessão. O serviço considerará o cliente desconectado se ele não tiver recebido uma mensagem (incluindo manter-se ativo) nesse intervalo. |
int Restrições: Valor mínimo = 1 Valor máximo = 120 |
manterAliveIntervalInSeconds | Obtém ou define o intervalo de Keep-Alive. Opcional para definir. O valor é em segundos. O valor padrão é 15 segundos. Os clientes devem definir esse valor como um período mais curto se quiserem que o serviço envie mensagens de manutenção com mais frequência, garantindo verificações oportunas do status da conexão. Por outro lado, os clientes podem definir esse valor para um período mais longo se quiserem que o serviço envie mensagens keep-alive com menos frequência, reduzindo o tráfego de rede, mas observe que pode levar mais tempo para detectar uma desconexão. Esse intervalo garante que a conexão seja mantida enviando mensagens de manutenção periódicas para o cliente. |
int Restrições: Valor mínimo = 1 Valor máximo = 120 |
Configurações de upstream sem servidor
Nome | Descrição | Valor |
---|---|---|
Modelos | Obtém ou define a lista de modelos de URL upstream. A ordem é importante e o primeiro modelo de correspondência tem efeitos. | UpstreamTemplate [] |
SignalRCorsSettings
Nome | Descrição | Valor |
---|---|---|
allowedOrigins | Obtém ou define a lista de origens que devem ter permissão para fazer chamadas entre origens (por exemplo: http://example.com:12345 ). Use "*" para permitir tudo. Se omitido, permita tudo por padrão. |
cadeia de caracteres[] |
SinalRFeature
Nome | Descrição | Valor |
---|---|---|
bandeira | FeatureFlags são os recursos com suporte do serviço do Azure SignalR. - ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Padrão": tenha seu próprio servidor de back-end; "Sem servidor": seu aplicativo não tem um servidor de back-end; "Clássico": para compatibilidade com versões anteriores. Suporte ao modo padrão e sem servidor, mas não recomendado; "PredefinedOnly": para uso futuro. - EnableConnectivityLogs: "true"/"false", para habilitar/desabilitar a categoria de log de conectividade, respectivamente. - EnableMessagingLogs: "true"/"false", para habilitar/desabilitar a categoria de log de conectividade, respectivamente. - EnableLiveTrace: Live Trace permite que você saiba o que está acontecendo dentro do serviço do Azure SignalR, ele fornecerá rastreamentos dinâmicos em tempo real, será útil ao desenvolver seu próprio aplicativo Web baseado no Azure SignalR ou solucionar alguns problemas. Observe que os rastreamentos dinâmicos são contados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para habilitar/desabilitar o recurso de rastreamento dinâmico. |
'EnableConnectivityLogs' 'Ativar LiveTrace' 'EnableMessagingLogs' 'ServiceMode' (obrigatório) |
Propriedades | Propriedades opcionais relacionadas a esse recurso. | |
valor | Valor do sinalizador de recurso. Consulte o documento de serviço do Azure SignalR /azure/azure-signalr/ para obter valores permitidos. | corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 128 (obrigatório) |
Propriedades do SignalRF
Nome | Descrição | Valor |
---|
ACLs de sinalização
SignalRProperties
Nome | Descrição | Valor |
---|---|---|
applicationFirewall | Configurações de firewall do aplicativo para o recurso | applicationFirewallSettings |
corpete | Configurações de CORS (Compartilhamento de Recursos entre Origens). | SignalRCorsSettings |
disableAadAuth | DisableLocalAuth Habilitar ou desabilitar a autenticação do aad Quando definido como true, a conexão com AuthType=aad não funcionará. |
Bool |
disableLocalAuth | DisableLocalAuth Habilitar ou desabilitar a autenticação local com o AccessKey Quando definido como true, a conexão com AccessKey=xxx não funcionará. |
Bool |
Características | Lista de featureFlags. FeatureFlags que não estão incluídos nos parâmetros da operação de atualização não serão modificados. E a resposta incluirá apenas featureFlags definidos explicitamente. Quando um featureFlag não for definido explicitamente, seu valor padrão global será usado Mas tenha em mente que o valor padrão não significa "false". Ele varia em termos de FeatureFlags diferentes. |
SignalRFeature [] |
liveTraceConfiguration | Configuração de rastreamento ao vivo de um recurso Microsoft.SignalRService. | |
ACLs de rede | ACLs de rede para o recurso | SignalRNetworkACLs |
públicoAcessoRedeAcesso | Habilitar ou desabilitar o acesso à rede pública. Padrão como "Habilitado". Quando está habilitado, as ACLs de rede ainda se aplicam. Quando estiver desabilitado, o acesso à rede pública sempre será desabilitado, independentemente do que você definir nas ACLs de rede. |
corda |
regionEndpointEnabled | Habilite ou desabilite o ponto de extremidade regional. Padrão como "Habilitado". Quando estiver desabilitado, novas conexões não serão roteadas para esse ponto de extremidade, no entanto, as conexões existentes não serão afetadas. Essa propriedade é específica da réplica. Não é permitido desabilitar o ponto de extremidade regional sem réplica. |
corda |
resourceLogConfiguration | Configuração de log de recursos de um recurso Microsoft.SignalRService. | ResourceLogConfiguration |
recursoParado | Pare ou inicie o recurso. Padrão para "False". Quando for true, o plano de dados do recurso será desligado. Quando for falso, o plano de dados do recurso será iniciado. |
corda |
routeSettings | Configurações de rota para o recurso | Configurações de rota |
sem servidor | Configurações sem servidor. | ServerlessSettings |
TLS | Configurações de TLS para o recurso | SignalRTlsSettings |
montante | As configurações para o Upstream quando o serviço está no modo sem servidor. | ServerlessUpstreamSettings |
SignalRTlsSettings
Nome | Descrição | Valor |
---|---|---|
clientCertEnabled | Solicite o certificado do cliente durante o handshake do TLS, se habilitado. Não há suporte para a camada gratuita. Qualquer entrada será ignorada para a camada gratuita. | Bool |
ThrottleByJwtCustomClaimRule
Nome | Descrição | Valor |
---|---|---|
nome da reivindicação | O nome da declaração no token JWT. A conexão do cliente com o mesmo valor de declaração será agregada. Se a declaração não for encontrada no token, a conexão será permitida. | cadeia de caracteres (obrigatório) |
maxCount | Contagem máxima de conexões permitida para o mesmo valor de declaração Jwt. Os clientes com a mesma declaração Jwt serão rejeitados se a contagem de conexões exceder esse valor. O valor padrão é 20. | int Restrições: Valor mínimo = 0 Valor máximo = 2147483647 |
tipo | 'ThrottleByJwtCustomClaimRule' (obrigatório) |
ThrottleByJwtSignatureRule
Nome | Descrição | Valor |
---|---|---|
maxCount | Contagem máxima de conexões permitida para a mesma assinatura JWT. Os clientes com a mesma assinatura JWT serão rejeitados se a contagem de conexões exceder esse valor. O valor padrão é 20. | int Restrições: Valor mínimo = 0 Valor máximo = 2147483647 |
tipo | 'ThrottleByJwtSignatureRule' (obrigatório) |
ThrottleByUserIdRule
Nome | Descrição | Valor |
---|---|---|
maxCount | Contagem máxima de conexões permitida para a mesma ID de usuário. Os clientes com a mesma ID de usuário serão rejeitados se a contagem de conexões exceder esse valor. O valor padrão é 20. | int Restrições: Valor mínimo = 0 Valor máximo = 2147483647 |
tipo | 'ThrottleByUserIdRule' (obrigatório) |
TrackedResourceTags
Nome | Descrição | Valor |
---|
TrafficThrottleByJwtCustomClaimRule
Nome | Descrição | Valor |
---|---|---|
aggregationWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes da mensagem serão agregados nesta janela e serão redefinidos após a janela. O valor padrão é 60 segundos. | int Restrições: Valor mínimo = 10 Valor máximo = 3600 |
nome da reivindicação | O nome da declaração no token JWT. Os bytes de mensagem com o mesmo valor de declaração serão agregados. Se a declaração não for encontrada no token, a regra será ignorada. | cadeia de caracteres (obrigatório) |
maxInboundMessageBytes | Máximo de bytes de mensagem de entrada acumulados permitidos para a mesma assinatura JWT em uma janela de tempo. Os clientes com a mesma declaração JWT serão desconectados se os bytes da mensagem excederem esse valor. O valor padrão é 1 GB. | int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByJwtCustomClaimRule' (obrigatório) |
Regra de Assinatura TrafficThrottleByJwt
Nome | Descrição | Valor |
---|---|---|
aggregationWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes da mensagem serão agregados nesta janela e serão redefinidos após a janela. O valor padrão é 60 segundos. | int Restrições: Valor mínimo = 10 Valor máximo = 3600 |
maxInboundMessageBytes | Máximo de bytes de mensagem de entrada acumulados permitidos para a mesma assinatura JWT em uma janela de tempo. Os clientes com a mesma assinatura JWT serão desconectados se os bytes da mensagem excederem esse valor. O valor padrão é 1 GB. | int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByJwtSignatureRule' (obrigatório) |
Regra de TrafficThrottleByUserIdRule
Nome | Descrição | Valor |
---|---|---|
aggregationWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes da mensagem serão agregados nesta janela e serão redefinidos após a janela. O valor padrão é 60 segundos. | int Restrições: Valor mínimo = 10 Valor máximo = 3600 |
maxInboundMessageBytes | Máximo de bytes de mensagem de entrada acumulados permitidos para a mesma ID de usuário em uma janela de tempo. Os clientes com a mesma ID de usuário serão desconectados se os bytes da mensagem excederem esse valor. O valor padrão é 1 GB. | int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByUserIdRule' (obrigatório) |
UpstreamAuthSettings
Nome | Descrição | Valor |
---|---|---|
Identidade gerenciada | Configurações de identidade gerenciada para upstream. | |
tipo | Enumeração de tipo de autenticação upstream. | 'ManagedIdentity' 'Nenhum' |
Modelo a montante
UserAssignedIdentityProperty
Nome | Descrição | Valor |
---|
Exemplos de uso
Módulos verificados do Azure
O módulos verificados do Azure a seguir pode ser usado para implantar esse tipo de recurso.
Exemplos de Início Rápido do Azure
Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar esse tipo de recurso.
Arquivo Bicep | Descrição |
---|---|
implantar um serviço do Azure SignalR | Esse modelo cria um Serviço do Azure SignalR usando um modelo. |
Definição de recurso de modelo do ARM
O tipo de recurso signalR pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.SignalRService/signalR, adicione o JSON a seguir ao seu modelo.
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2025-01-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
} ],
"maxClientConnectionLifetimeInSeconds": "int"
},
"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",
"routeSettings": {
"connectionBalanceWeight": "int",
"latencyWeight": "int",
"serverBalanceWeight": "int"
},
"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
Defina a propriedade tipo para especificar o 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
Defina a propriedade tipo para especificar o 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 propriedade
Microsoft.SignalRService/signalR
Nome | Descrição | Valor |
---|---|---|
apiVersion | A versão da API | '2025-01-01-preview' |
identidade | Uma classe representa identidades gerenciadas usadas para solicitação e resposta | Identidade gerenciada |
tipo | O tipo do serviço | 'RawWebSockets' 'SignalR' |
localização | A localização geográfica onde o recurso reside | cadeia de caracteres (obrigatório) |
nome | O nome do recurso | corda Restrições: Comprimento mínimo = 3 Comprimento máximo = 63 Padrão = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obrigatório) |
Propriedades | Uma classe que descreve as propriedades do recurso | SignalRProperties |
Sku | As informações de cobrança do recurso. | do |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
tipo | O tipo de recurso | 'Microsoft.SignalRService/signalR' |
ApplicationFirewallSettings
Nome | Descrição | Valor |
---|---|---|
clientConnectionCountRules | Regras para controlar a contagem de conexões do cliente | ClientConnectionCountRule[] |
clientTrafficControlRules | Regras para controlar o tráfego do cliente | ClientTrafficControlRule [] |
maxClientConnectionLifetimeInSeconds | Configuração para controlar o tempo de vida da conexão do cliente em segundos, pode ser definido como 0 para desabilitar a configuração | int Restrições: Valor mínimo = 0 Valor máximo = 604800 |
Regra de contagem de conexões de cliente
Nome | Descrição | Valor |
---|---|---|
tipo | Defina como 'ThrottleByJwtCustomClaimRule' para o tipo ThrottleByJwtCustomClaimRule. Defina como 'ThrottleByJwtSignatureRule' para o tipo ThrottleByJwtSignatureRule. Defina como 'ThrottleByUserIdRule' para o tipo ThrottleByUserIdRule. | 'ThrottleByJwtCustomClaimRule' 'ThrottleByJwtSignatureRule' 'ThrottleByUserIdRule' (obrigatório) |
ClientTrafficControlRule
Nome | Descrição | Valor |
---|---|---|
tipo | Defina como 'TrafficThrottleByJwtCustomClaimRule' para o tipo TrafficThrottleByJwtCustomClaimRule. Defina como 'TrafficThrottleByJwtSignatureRule' para o tipo TrafficThrottleByJwtSignatureRule. Defina como 'TrafficThrottleByUserIdRule' para o tipo TrafficThrottleByUserIdRule. | 'TrafficThrottleByJwtCustomClaimRule' 'TrafficThrottleByJwtSignatureRule' 'TrafficThrottleByUserIdRule' (obrigatório) |
IPRule
Nome | Descrição | Valor |
---|---|---|
ação | Ação acl de rede do Azure. | 'Permitir' 'Negar' |
valor | Um IP ou CIDR ou ServiceTag | corda |
LiveTraceCategory
Nome | Descrição | Valor |
---|---|---|
Habilitado | Indica se ou a categoria de rastreamento dinâmico está habilitada. Valores disponíveis: true, false. Não diferencia maiúsculas de minúsculas. |
corda |
nome | Obtém ou define o nome da categoria de rastreamento ao vivo. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não diferencia maiúsculas de minúsculas. |
corda |
LiveTraceConfiguration
Nome | Descrição | Valor |
---|---|---|
Categorias | Obtém ou define a lista de configurações de categoria. | |
Habilitado | Indica se habilitar ou não o rastreamento dinâmico. Quando ele é definido como true, o cliente de rastreamento dinâmico pode se conectar ao serviço. Caso contrário, o cliente de rastreamento dinâmico não poderá se conectar ao serviço, de modo que você não possa receber nenhum log, independentemente do que você configurar em "categorias". Valores disponíveis: true, false. Não diferencia maiúsculas de minúsculas. |
corda |
Identidade gerenciada
Nome | Descrição | Valor |
---|---|---|
tipo | Representa o tipo de identidade: systemAssigned, userAssigned, None | 'Nenhum' 'SystemAssigned' 'UserAssigned' |
Identidades Atribuídas pelo Usuário | Obter ou definir as identidades atribuídas pelo usuário | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
Nome | Descrição | Valor |
---|---|---|
recurso | O recurso que indica o URI da ID do aplicativo do recurso de destino. Ele também aparece na declaração aud (audience) do token emitido. |
corda |
ManagedIdentityUserAssignedIdentities
Nome | Descrição | Valor |
---|
ACL de rede
Nome | Descrição | Valor |
---|---|---|
permitir | Tipos de solicitação permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. | Matriz de cadeia de caracteres que contém qualquer um dos: 'Conexão de cliente' 'RESTAPI' 'Conexão de servidor' 'Traço' |
negar | Tipos de solicitação negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. | Matriz de cadeia de caracteres que contém qualquer um dos: 'Conexão de cliente' 'RESTAPI' 'Conexão de servidor' 'Traço' |
PrivateEndpointACL
Nome | Descrição | Valor |
---|---|---|
permitir | Tipos de solicitação permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. | Matriz de cadeia de caracteres que contém qualquer um dos: 'Conexão de cliente' 'RESTAPI' 'Conexão de servidor' 'Traço' |
negar | Tipos de solicitação negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. | Matriz de cadeia de caracteres que contém qualquer um dos: 'Conexão de cliente' 'RESTAPI' 'Conexão de servidor' 'Traço' |
nome | Nome da conexão de ponto de extremidade privado | cadeia de caracteres (obrigatório) |
ResourceLogCategory
Nome | Descrição | Valor |
---|---|---|
Habilitado | Indica se ou a categoria de log de recursos está habilitada. Valores disponíveis: true, false. Não diferencia maiúsculas de minúsculas. |
corda |
nome | Obtém ou define o nome da categoria do log de recursos. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não diferencia maiúsculas de minúsculas. |
corda |
Configuração do ResourceLog
Nome | Descrição | Valor |
---|---|---|
Categorias | Obtém ou define a lista de configurações de categoria. | ResourceLogCategory [] |
ResourceSku
Nome | Descrição | Valor |
---|---|---|
capacidade | Opcional, inteiro. A contagem de unidades do recurso. 1 para Free_F1/Standard_S1/Premium_P1, 100 para Premium_P2 por padrão. Se estiverem presentes, os seguintes valores serão permitidos: 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 |
nome | O nome da SKU. Necessário. Valores permitidos: Standard_S1, Free_F1, Premium_P1 Premium_P2 |
cadeia de caracteres (obrigatório) |
camada | Camada opcional deste SKU específico. 'Standard' ou 'Free'. Basic foi preterido, use Standard em vez disso. |
'Básico' 'Gratuito' 'Prêmio' 'Padrão' |
Configurações de rota
Nome | Descrição | Valor |
---|---|---|
connectionBalanceWeight | Obtém ou define o peso do equilíbrio da conexão. Um valor mais alto significa um maior equilíbrio de conexões de cliente em diferentes conexões de servidor. Um valor de 0 distribui conexões aleatoriamente, enquanto um valor de 255 garante o balanceamento máximo. O valor padrão é 255. Recomendado 255 para todos os casos. |
int Restrições: Valor mínimo = 0 Valor máximo = 255 |
latencyWeight | Obtém ou define o peso para roteamento baseado em latência. Um valor mais alto aumenta a influência do roteamento baseado em latência. Um valor de 0 desabilita totalmente o roteamento baseado em latência, enquanto um valor de 255 o habilita totalmente. O valor padrão é 0. Recomendado 255 para réplicas ou servidores de aplicativos em diferentes regiões para recuperação de desastre. |
int Restrições: Valor mínimo = 0 Valor máximo = 255 |
serverBalanceWeight | Obtém ou define o peso do saldo do servidor. Um valor mais alto significa um maior equilíbrio de conexões de cliente em diferentes instâncias do servidor de aplicativos. Um valor de 0 distribui conexões aleatoriamente, enquanto um valor de 255 garante o balanceamento máximo. O valor padrão é 255. Recomendado 255 para vários servidores de aplicativos no mesmo tamanho. |
int Restrições: Valor mínimo = 0 Valor máximo = 255 |
Configurações sem servidor
Nome | Descrição | Valor |
---|---|---|
connectionTimeoutInSeconds | Obtém ou define o tempo limite de conexão do cliente. Opcional a ser definido. Valor em segundos. O valor padrão é 30 segundos. O cliente deve definir o tempo limite para um período mais curto se as mensagens forem enviadas em intervalos mais curtos, e deseja que o cliente se desconecte mais rapidamente após o envio da última mensagem. Você pode definir o tempo limite para um período mais longo se espera-se que as mensagens sejam enviadas em intervalos mais longos, e eles querem manter a mesma conexão de cliente ativa durante esta sessão. O serviço considerará o cliente desconectado se ele não tiver recebido uma mensagem (incluindo manter-se ativo) nesse intervalo. |
int Restrições: Valor mínimo = 1 Valor máximo = 120 |
manterAliveIntervalInSeconds | Obtém ou define o intervalo de Keep-Alive. Opcional para definir. O valor é em segundos. O valor padrão é 15 segundos. Os clientes devem definir esse valor como um período mais curto se quiserem que o serviço envie mensagens de manutenção com mais frequência, garantindo verificações oportunas do status da conexão. Por outro lado, os clientes podem definir esse valor para um período mais longo se quiserem que o serviço envie mensagens keep-alive com menos frequência, reduzindo o tráfego de rede, mas observe que pode levar mais tempo para detectar uma desconexão. Esse intervalo garante que a conexão seja mantida enviando mensagens de manutenção periódicas para o cliente. |
int Restrições: Valor mínimo = 1 Valor máximo = 120 |
Configurações de upstream sem servidor
Nome | Descrição | Valor |
---|---|---|
Modelos | Obtém ou define a lista de modelos de URL upstream. A ordem é importante e o primeiro modelo de correspondência tem efeitos. | UpstreamTemplate [] |
SignalRCorsSettings
Nome | Descrição | Valor |
---|---|---|
allowedOrigins | Obtém ou define a lista de origens que devem ter permissão para fazer chamadas entre origens (por exemplo: http://example.com:12345 ). Use "*" para permitir tudo. Se omitido, permita tudo por padrão. |
cadeia de caracteres[] |
SinalRFeature
Nome | Descrição | Valor |
---|---|---|
bandeira | FeatureFlags são os recursos com suporte do serviço do Azure SignalR. - ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Padrão": tenha seu próprio servidor de back-end; "Sem servidor": seu aplicativo não tem um servidor de back-end; "Clássico": para compatibilidade com versões anteriores. Suporte ao modo padrão e sem servidor, mas não recomendado; "PredefinedOnly": para uso futuro. - EnableConnectivityLogs: "true"/"false", para habilitar/desabilitar a categoria de log de conectividade, respectivamente. - EnableMessagingLogs: "true"/"false", para habilitar/desabilitar a categoria de log de conectividade, respectivamente. - EnableLiveTrace: Live Trace permite que você saiba o que está acontecendo dentro do serviço do Azure SignalR, ele fornecerá rastreamentos dinâmicos em tempo real, será útil ao desenvolver seu próprio aplicativo Web baseado no Azure SignalR ou solucionar alguns problemas. Observe que os rastreamentos dinâmicos são contados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para habilitar/desabilitar o recurso de rastreamento dinâmico. |
'EnableConnectivityLogs' 'Ativar LiveTrace' 'EnableMessagingLogs' 'ServiceMode' (obrigatório) |
Propriedades | Propriedades opcionais relacionadas a esse recurso. | |
valor | Valor do sinalizador de recurso. Consulte o documento de serviço do Azure SignalR /azure/azure-signalr/ para obter valores permitidos. | corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 128 (obrigatório) |
Propriedades do SignalRF
Nome | Descrição | Valor |
---|
ACLs de sinalização
SignalRProperties
Nome | Descrição | Valor |
---|---|---|
applicationFirewall | Configurações de firewall do aplicativo para o recurso | applicationFirewallSettings |
corpete | Configurações de CORS (Compartilhamento de Recursos entre Origens). | SignalRCorsSettings |
disableAadAuth | DisableLocalAuth Habilitar ou desabilitar a autenticação do aad Quando definido como true, a conexão com AuthType=aad não funcionará. |
Bool |
disableLocalAuth | DisableLocalAuth Habilitar ou desabilitar a autenticação local com o AccessKey Quando definido como true, a conexão com AccessKey=xxx não funcionará. |
Bool |
Características | Lista de featureFlags. FeatureFlags que não estão incluídos nos parâmetros da operação de atualização não serão modificados. E a resposta incluirá apenas featureFlags definidos explicitamente. Quando um featureFlag não for definido explicitamente, seu valor padrão global será usado Mas tenha em mente que o valor padrão não significa "false". Ele varia em termos de FeatureFlags diferentes. |
SignalRFeature [] |
liveTraceConfiguration | Configuração de rastreamento ao vivo de um recurso Microsoft.SignalRService. | |
ACLs de rede | ACLs de rede para o recurso | SignalRNetworkACLs |
públicoAcessoRedeAcesso | Habilitar ou desabilitar o acesso à rede pública. Padrão como "Habilitado". Quando está habilitado, as ACLs de rede ainda se aplicam. Quando estiver desabilitado, o acesso à rede pública sempre será desabilitado, independentemente do que você definir nas ACLs de rede. |
corda |
regionEndpointEnabled | Habilite ou desabilite o ponto de extremidade regional. Padrão como "Habilitado". Quando estiver desabilitado, novas conexões não serão roteadas para esse ponto de extremidade, no entanto, as conexões existentes não serão afetadas. Essa propriedade é específica da réplica. Não é permitido desabilitar o ponto de extremidade regional sem réplica. |
corda |
resourceLogConfiguration | Configuração de log de recursos de um recurso Microsoft.SignalRService. | ResourceLogConfiguration |
recursoParado | Pare ou inicie o recurso. Padrão para "False". Quando for true, o plano de dados do recurso será desligado. Quando for falso, o plano de dados do recurso será iniciado. |
corda |
routeSettings | Configurações de rota para o recurso | Configurações de rota |
sem servidor | Configurações sem servidor. | ServerlessSettings |
TLS | Configurações de TLS para o recurso | SignalRTlsSettings |
montante | As configurações para o Upstream quando o serviço está no modo sem servidor. | ServerlessUpstreamSettings |
SignalRTlsSettings
Nome | Descrição | Valor |
---|---|---|
clientCertEnabled | Solicite o certificado do cliente durante o handshake do TLS, se habilitado. Não há suporte para a camada gratuita. Qualquer entrada será ignorada para a camada gratuita. | Bool |
ThrottleByJwtCustomClaimRule
Nome | Descrição | Valor |
---|---|---|
nome da reivindicação | O nome da declaração no token JWT. A conexão do cliente com o mesmo valor de declaração será agregada. Se a declaração não for encontrada no token, a conexão será permitida. | cadeia de caracteres (obrigatório) |
maxCount | Contagem máxima de conexões permitida para o mesmo valor de declaração Jwt. Os clientes com a mesma declaração Jwt serão rejeitados se a contagem de conexões exceder esse valor. O valor padrão é 20. | int Restrições: Valor mínimo = 0 Valor máximo = 2147483647 |
tipo | 'ThrottleByJwtCustomClaimRule' (obrigatório) |
ThrottleByJwtSignatureRule
Nome | Descrição | Valor |
---|---|---|
maxCount | Contagem máxima de conexões permitida para a mesma assinatura JWT. Os clientes com a mesma assinatura JWT serão rejeitados se a contagem de conexões exceder esse valor. O valor padrão é 20. | int Restrições: Valor mínimo = 0 Valor máximo = 2147483647 |
tipo | 'ThrottleByJwtSignatureRule' (obrigatório) |
ThrottleByUserIdRule
Nome | Descrição | Valor |
---|---|---|
maxCount | Contagem máxima de conexões permitida para a mesma ID de usuário. Os clientes com a mesma ID de usuário serão rejeitados se a contagem de conexões exceder esse valor. O valor padrão é 20. | int Restrições: Valor mínimo = 0 Valor máximo = 2147483647 |
tipo | 'ThrottleByUserIdRule' (obrigatório) |
TrackedResourceTags
Nome | Descrição | Valor |
---|
TrafficThrottleByJwtCustomClaimRule
Nome | Descrição | Valor |
---|---|---|
aggregationWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes da mensagem serão agregados nesta janela e serão redefinidos após a janela. O valor padrão é 60 segundos. | int Restrições: Valor mínimo = 10 Valor máximo = 3600 |
nome da reivindicação | O nome da declaração no token JWT. Os bytes de mensagem com o mesmo valor de declaração serão agregados. Se a declaração não for encontrada no token, a regra será ignorada. | cadeia de caracteres (obrigatório) |
maxInboundMessageBytes | Máximo de bytes de mensagem de entrada acumulados permitidos para a mesma assinatura JWT em uma janela de tempo. Os clientes com a mesma declaração JWT serão desconectados se os bytes da mensagem excederem esse valor. O valor padrão é 1 GB. | int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByJwtCustomClaimRule' (obrigatório) |
Regra de Assinatura TrafficThrottleByJwt
Nome | Descrição | Valor |
---|---|---|
aggregationWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes da mensagem serão agregados nesta janela e serão redefinidos após a janela. O valor padrão é 60 segundos. | int Restrições: Valor mínimo = 10 Valor máximo = 3600 |
maxInboundMessageBytes | Máximo de bytes de mensagem de entrada acumulados permitidos para a mesma assinatura JWT em uma janela de tempo. Os clientes com a mesma assinatura JWT serão desconectados se os bytes da mensagem excederem esse valor. O valor padrão é 1 GB. | int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByJwtSignatureRule' (obrigatório) |
Regra de TrafficThrottleByUserIdRule
Nome | Descrição | Valor |
---|---|---|
aggregationWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes da mensagem serão agregados nesta janela e serão redefinidos após a janela. O valor padrão é 60 segundos. | int Restrições: Valor mínimo = 10 Valor máximo = 3600 |
maxInboundMessageBytes | Máximo de bytes de mensagem de entrada acumulados permitidos para a mesma ID de usuário em uma janela de tempo. Os clientes com a mesma ID de usuário serão desconectados se os bytes da mensagem excederem esse valor. O valor padrão é 1 GB. | int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByUserIdRule' (obrigatório) |
UpstreamAuthSettings
Nome | Descrição | Valor |
---|---|---|
Identidade gerenciada | Configurações de identidade gerenciada para upstream. | |
tipo | Enumeração de tipo de autenticação upstream. | 'ManagedIdentity' 'Nenhum' |
Modelo a montante
UserAssignedIdentityProperty
Nome | Descrição | Valor |
---|
Exemplos de uso
Modelos de Início Rápido do Azure
Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.
Modelo | Descrição |
---|---|
implantar um serviço do Azure SignalR |
Esse modelo cria um Serviço do Azure SignalR usando um modelo. |
Definição de recurso do Terraform (provedor de AzAPI)
O tipo de recurso signalR pode ser implantado com operações de destino:
- grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Formato de recurso
Para criar um recurso Microsoft.SignalRService/signalR, adicione o Terraform a seguir ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SignalRService/signalR@2025-01-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
properties = {
applicationFirewall = {
clientConnectionCountRules = [
{
type = "string"
// For remaining properties, see ClientConnectionCountRule objects
}
]
clientTrafficControlRules = [
{
type = "string"
// For remaining properties, see ClientTrafficControlRule objects
}
]
maxClientConnectionLifetimeInSeconds = int
}
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"
routeSettings = {
connectionBalanceWeight = int
latencyWeight = int
serverBalanceWeight = int
}
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"
}
}
}
Objetos ClientTrafficControlRule
Defina a propriedade tipo para especificar o 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
Defina a propriedade tipo para especificar o 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 propriedade
Microsoft.SignalRService/signalR
Nome | Descrição | Valor |
---|---|---|
identidade | Uma classe representa identidades gerenciadas usadas para solicitação e resposta | Identidade gerenciada |
tipo | O tipo do serviço | 'RawWebSockets' 'SignalR' |
localização | A localização geográfica onde o recurso reside | cadeia de caracteres (obrigatório) |
nome | O nome do recurso | corda Restrições: Comprimento mínimo = 3 Comprimento máximo = 63 Padrão = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (obrigatório) |
Propriedades | Uma classe que descreve as propriedades do recurso | SignalRProperties |
Sku | As informações de cobrança do recurso. | do |
Tags | Marcas de recurso | Dicionário de nomes e valores de marca. |
tipo | O tipo de recurso | "Microsoft.SignalRService/signalR@2025-01-01-preview" |
ApplicationFirewallSettings
Nome | Descrição | Valor |
---|---|---|
clientConnectionCountRules | Regras para controlar a contagem de conexões do cliente | ClientConnectionCountRule[] |
clientTrafficControlRules | Regras para controlar o tráfego do cliente | ClientTrafficControlRule [] |
maxClientConnectionLifetimeInSeconds | Configuração para controlar o tempo de vida da conexão do cliente em segundos, pode ser definido como 0 para desabilitar a configuração | int Restrições: Valor mínimo = 0 Valor máximo = 604800 |
Regra de contagem de conexões de cliente
Nome | Descrição | Valor |
---|---|---|
tipo | Defina como 'ThrottleByJwtCustomClaimRule' para o tipo ThrottleByJwtCustomClaimRule. Defina como 'ThrottleByJwtSignatureRule' para o tipo ThrottleByJwtSignatureRule. Defina como 'ThrottleByUserIdRule' para o tipo ThrottleByUserIdRule. | 'ThrottleByJwtCustomClaimRule' 'ThrottleByJwtSignatureRule' 'ThrottleByUserIdRule' (obrigatório) |
ClientTrafficControlRule
Nome | Descrição | Valor |
---|---|---|
tipo | Defina como 'TrafficThrottleByJwtCustomClaimRule' para o tipo TrafficThrottleByJwtCustomClaimRule. Defina como 'TrafficThrottleByJwtSignatureRule' para o tipo TrafficThrottleByJwtSignatureRule. Defina como 'TrafficThrottleByUserIdRule' para o tipo TrafficThrottleByUserIdRule. | 'TrafficThrottleByJwtCustomClaimRule' 'TrafficThrottleByJwtSignatureRule' 'TrafficThrottleByUserIdRule' (obrigatório) |
IPRule
Nome | Descrição | Valor |
---|---|---|
ação | Ação acl de rede do Azure. | 'Permitir' 'Negar' |
valor | Um IP ou CIDR ou ServiceTag | corda |
LiveTraceCategory
Nome | Descrição | Valor |
---|---|---|
Habilitado | Indica se ou a categoria de rastreamento dinâmico está habilitada. Valores disponíveis: true, false. Não diferencia maiúsculas de minúsculas. |
corda |
nome | Obtém ou define o nome da categoria de rastreamento ao vivo. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não diferencia maiúsculas de minúsculas. |
corda |
LiveTraceConfiguration
Nome | Descrição | Valor |
---|---|---|
Categorias | Obtém ou define a lista de configurações de categoria. | |
Habilitado | Indica se habilitar ou não o rastreamento dinâmico. Quando ele é definido como true, o cliente de rastreamento dinâmico pode se conectar ao serviço. Caso contrário, o cliente de rastreamento dinâmico não poderá se conectar ao serviço, de modo que você não possa receber nenhum log, independentemente do que você configurar em "categorias". Valores disponíveis: true, false. Não diferencia maiúsculas de minúsculas. |
corda |
Identidade gerenciada
Nome | Descrição | Valor |
---|---|---|
tipo | Representa o tipo de identidade: systemAssigned, userAssigned, None | 'Nenhum' 'SystemAssigned' 'UserAssigned' |
Identidades Atribuídas pelo Usuário | Obter ou definir as identidades atribuídas pelo usuário | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
Nome | Descrição | Valor |
---|---|---|
recurso | O recurso que indica o URI da ID do aplicativo do recurso de destino. Ele também aparece na declaração aud (audience) do token emitido. |
corda |
ManagedIdentityUserAssignedIdentities
Nome | Descrição | Valor |
---|
ACL de rede
Nome | Descrição | Valor |
---|---|---|
permitir | Tipos de solicitação permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. | Matriz de cadeia de caracteres que contém qualquer um dos: 'Conexão de cliente' 'RESTAPI' 'Conexão de servidor' 'Traço' |
negar | Tipos de solicitação negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. | Matriz de cadeia de caracteres que contém qualquer um dos: 'Conexão de cliente' 'RESTAPI' 'Conexão de servidor' 'Traço' |
PrivateEndpointACL
Nome | Descrição | Valor |
---|---|---|
permitir | Tipos de solicitação permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. | Matriz de cadeia de caracteres que contém qualquer um dos: 'Conexão de cliente' 'RESTAPI' 'Conexão de servidor' 'Traço' |
negar | Tipos de solicitação negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. | Matriz de cadeia de caracteres que contém qualquer um dos: 'Conexão de cliente' 'RESTAPI' 'Conexão de servidor' 'Traço' |
nome | Nome da conexão de ponto de extremidade privado | cadeia de caracteres (obrigatório) |
ResourceLogCategory
Nome | Descrição | Valor |
---|---|---|
Habilitado | Indica se ou a categoria de log de recursos está habilitada. Valores disponíveis: true, false. Não diferencia maiúsculas de minúsculas. |
corda |
nome | Obtém ou define o nome da categoria do log de recursos. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não diferencia maiúsculas de minúsculas. |
corda |
Configuração do ResourceLog
Nome | Descrição | Valor |
---|---|---|
Categorias | Obtém ou define a lista de configurações de categoria. | ResourceLogCategory [] |
ResourceSku
Nome | Descrição | Valor |
---|---|---|
capacidade | Opcional, inteiro. A contagem de unidades do recurso. 1 para Free_F1/Standard_S1/Premium_P1, 100 para Premium_P2 por padrão. Se estiverem presentes, os seguintes valores serão permitidos: 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 |
nome | O nome da SKU. Necessário. Valores permitidos: Standard_S1, Free_F1, Premium_P1 Premium_P2 |
cadeia de caracteres (obrigatório) |
camada | Camada opcional deste SKU específico. 'Standard' ou 'Free'. Basic foi preterido, use Standard em vez disso. |
'Básico' 'Gratuito' 'Prêmio' 'Padrão' |
Configurações de rota
Nome | Descrição | Valor |
---|---|---|
connectionBalanceWeight | Obtém ou define o peso do equilíbrio da conexão. Um valor mais alto significa um maior equilíbrio de conexões de cliente em diferentes conexões de servidor. Um valor de 0 distribui conexões aleatoriamente, enquanto um valor de 255 garante o balanceamento máximo. O valor padrão é 255. Recomendado 255 para todos os casos. |
int Restrições: Valor mínimo = 0 Valor máximo = 255 |
latencyWeight | Obtém ou define o peso para roteamento baseado em latência. Um valor mais alto aumenta a influência do roteamento baseado em latência. Um valor de 0 desabilita totalmente o roteamento baseado em latência, enquanto um valor de 255 o habilita totalmente. O valor padrão é 0. Recomendado 255 para réplicas ou servidores de aplicativos em diferentes regiões para recuperação de desastre. |
int Restrições: Valor mínimo = 0 Valor máximo = 255 |
serverBalanceWeight | Obtém ou define o peso do saldo do servidor. Um valor mais alto significa um maior equilíbrio de conexões de cliente em diferentes instâncias do servidor de aplicativos. Um valor de 0 distribui conexões aleatoriamente, enquanto um valor de 255 garante o balanceamento máximo. O valor padrão é 255. Recomendado 255 para vários servidores de aplicativos no mesmo tamanho. |
int Restrições: Valor mínimo = 0 Valor máximo = 255 |
Configurações sem servidor
Nome | Descrição | Valor |
---|---|---|
connectionTimeoutInSeconds | Obtém ou define o tempo limite de conexão do cliente. Opcional a ser definido. Valor em segundos. O valor padrão é 30 segundos. O cliente deve definir o tempo limite para um período mais curto se as mensagens forem enviadas em intervalos mais curtos, e deseja que o cliente se desconecte mais rapidamente após o envio da última mensagem. Você pode definir o tempo limite para um período mais longo se espera-se que as mensagens sejam enviadas em intervalos mais longos, e eles querem manter a mesma conexão de cliente ativa durante esta sessão. O serviço considerará o cliente desconectado se ele não tiver recebido uma mensagem (incluindo manter-se ativo) nesse intervalo. |
int Restrições: Valor mínimo = 1 Valor máximo = 120 |
manterAliveIntervalInSeconds | Obtém ou define o intervalo de Keep-Alive. Opcional para definir. O valor é em segundos. O valor padrão é 15 segundos. Os clientes devem definir esse valor como um período mais curto se quiserem que o serviço envie mensagens de manutenção com mais frequência, garantindo verificações oportunas do status da conexão. Por outro lado, os clientes podem definir esse valor para um período mais longo se quiserem que o serviço envie mensagens keep-alive com menos frequência, reduzindo o tráfego de rede, mas observe que pode levar mais tempo para detectar uma desconexão. Esse intervalo garante que a conexão seja mantida enviando mensagens de manutenção periódicas para o cliente. |
int Restrições: Valor mínimo = 1 Valor máximo = 120 |
Configurações de upstream sem servidor
Nome | Descrição | Valor |
---|---|---|
Modelos | Obtém ou define a lista de modelos de URL upstream. A ordem é importante e o primeiro modelo de correspondência tem efeitos. | UpstreamTemplate [] |
SignalRCorsSettings
Nome | Descrição | Valor |
---|---|---|
allowedOrigins | Obtém ou define a lista de origens que devem ter permissão para fazer chamadas entre origens (por exemplo: http://example.com:12345 ). Use "*" para permitir tudo. Se omitido, permita tudo por padrão. |
cadeia de caracteres[] |
SinalRFeature
Nome | Descrição | Valor |
---|---|---|
bandeira | FeatureFlags são os recursos com suporte do serviço do Azure SignalR. - ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Padrão": tenha seu próprio servidor de back-end; "Sem servidor": seu aplicativo não tem um servidor de back-end; "Clássico": para compatibilidade com versões anteriores. Suporte ao modo padrão e sem servidor, mas não recomendado; "PredefinedOnly": para uso futuro. - EnableConnectivityLogs: "true"/"false", para habilitar/desabilitar a categoria de log de conectividade, respectivamente. - EnableMessagingLogs: "true"/"false", para habilitar/desabilitar a categoria de log de conectividade, respectivamente. - EnableLiveTrace: Live Trace permite que você saiba o que está acontecendo dentro do serviço do Azure SignalR, ele fornecerá rastreamentos dinâmicos em tempo real, será útil ao desenvolver seu próprio aplicativo Web baseado no Azure SignalR ou solucionar alguns problemas. Observe que os rastreamentos dinâmicos são contados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para habilitar/desabilitar o recurso de rastreamento dinâmico. |
'EnableConnectivityLogs' 'Ativar LiveTrace' 'EnableMessagingLogs' 'ServiceMode' (obrigatório) |
Propriedades | Propriedades opcionais relacionadas a esse recurso. | |
valor | Valor do sinalizador de recurso. Consulte o documento de serviço do Azure SignalR /azure/azure-signalr/ para obter valores permitidos. | corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 128 (obrigatório) |
Propriedades do SignalRF
Nome | Descrição | Valor |
---|
ACLs de sinalização
SignalRProperties
Nome | Descrição | Valor |
---|---|---|
applicationFirewall | Configurações de firewall do aplicativo para o recurso | applicationFirewallSettings |
corpete | Configurações de CORS (Compartilhamento de Recursos entre Origens). | SignalRCorsSettings |
disableAadAuth | DisableLocalAuth Habilitar ou desabilitar a autenticação do aad Quando definido como true, a conexão com AuthType=aad não funcionará. |
Bool |
disableLocalAuth | DisableLocalAuth Habilitar ou desabilitar a autenticação local com o AccessKey Quando definido como true, a conexão com AccessKey=xxx não funcionará. |
Bool |
Características | Lista de featureFlags. FeatureFlags que não estão incluídos nos parâmetros da operação de atualização não serão modificados. E a resposta incluirá apenas featureFlags definidos explicitamente. Quando um featureFlag não for definido explicitamente, seu valor padrão global será usado Mas tenha em mente que o valor padrão não significa "false". Ele varia em termos de FeatureFlags diferentes. |
SignalRFeature [] |
liveTraceConfiguration | Configuração de rastreamento ao vivo de um recurso Microsoft.SignalRService. | |
ACLs de rede | ACLs de rede para o recurso | SignalRNetworkACLs |
públicoAcessoRedeAcesso | Habilitar ou desabilitar o acesso à rede pública. Padrão como "Habilitado". Quando está habilitado, as ACLs de rede ainda se aplicam. Quando estiver desabilitado, o acesso à rede pública sempre será desabilitado, independentemente do que você definir nas ACLs de rede. |
corda |
regionEndpointEnabled | Habilite ou desabilite o ponto de extremidade regional. Padrão como "Habilitado". Quando estiver desabilitado, novas conexões não serão roteadas para esse ponto de extremidade, no entanto, as conexões existentes não serão afetadas. Essa propriedade é específica da réplica. Não é permitido desabilitar o ponto de extremidade regional sem réplica. |
corda |
resourceLogConfiguration | Configuração de log de recursos de um recurso Microsoft.SignalRService. | ResourceLogConfiguration |
recursoParado | Pare ou inicie o recurso. Padrão para "False". Quando for true, o plano de dados do recurso será desligado. Quando for falso, o plano de dados do recurso será iniciado. |
corda |
routeSettings | Configurações de rota para o recurso | Configurações de rota |
sem servidor | Configurações sem servidor. | ServerlessSettings |
TLS | Configurações de TLS para o recurso | SignalRTlsSettings |
montante | As configurações para o Upstream quando o serviço está no modo sem servidor. | ServerlessUpstreamSettings |
SignalRTlsSettings
Nome | Descrição | Valor |
---|---|---|
clientCertEnabled | Solicite o certificado do cliente durante o handshake do TLS, se habilitado. Não há suporte para a camada gratuita. Qualquer entrada será ignorada para a camada gratuita. | Bool |
ThrottleByJwtCustomClaimRule
Nome | Descrição | Valor |
---|---|---|
nome da reivindicação | O nome da declaração no token JWT. A conexão do cliente com o mesmo valor de declaração será agregada. Se a declaração não for encontrada no token, a conexão será permitida. | cadeia de caracteres (obrigatório) |
maxCount | Contagem máxima de conexões permitida para o mesmo valor de declaração Jwt. Os clientes com a mesma declaração Jwt serão rejeitados se a contagem de conexões exceder esse valor. O valor padrão é 20. | int Restrições: Valor mínimo = 0 Valor máximo = 2147483647 |
tipo | 'ThrottleByJwtCustomClaimRule' (obrigatório) |
ThrottleByJwtSignatureRule
Nome | Descrição | Valor |
---|---|---|
maxCount | Contagem máxima de conexões permitida para a mesma assinatura JWT. Os clientes com a mesma assinatura JWT serão rejeitados se a contagem de conexões exceder esse valor. O valor padrão é 20. | int Restrições: Valor mínimo = 0 Valor máximo = 2147483647 |
tipo | 'ThrottleByJwtSignatureRule' (obrigatório) |
ThrottleByUserIdRule
Nome | Descrição | Valor |
---|---|---|
maxCount | Contagem máxima de conexões permitida para a mesma ID de usuário. Os clientes com a mesma ID de usuário serão rejeitados se a contagem de conexões exceder esse valor. O valor padrão é 20. | int Restrições: Valor mínimo = 0 Valor máximo = 2147483647 |
tipo | 'ThrottleByUserIdRule' (obrigatório) |
TrackedResourceTags
Nome | Descrição | Valor |
---|
TrafficThrottleByJwtCustomClaimRule
Nome | Descrição | Valor |
---|---|---|
aggregationWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes da mensagem serão agregados nesta janela e serão redefinidos após a janela. O valor padrão é 60 segundos. | int Restrições: Valor mínimo = 10 Valor máximo = 3600 |
nome da reivindicação | O nome da declaração no token JWT. Os bytes de mensagem com o mesmo valor de declaração serão agregados. Se a declaração não for encontrada no token, a regra será ignorada. | cadeia de caracteres (obrigatório) |
maxInboundMessageBytes | Máximo de bytes de mensagem de entrada acumulados permitidos para a mesma assinatura JWT em uma janela de tempo. Os clientes com a mesma declaração JWT serão desconectados se os bytes da mensagem excederem esse valor. O valor padrão é 1 GB. | int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByJwtCustomClaimRule' (obrigatório) |
Regra de Assinatura TrafficThrottleByJwt
Nome | Descrição | Valor |
---|---|---|
aggregationWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes da mensagem serão agregados nesta janela e serão redefinidos após a janela. O valor padrão é 60 segundos. | int Restrições: Valor mínimo = 10 Valor máximo = 3600 |
maxInboundMessageBytes | Máximo de bytes de mensagem de entrada acumulados permitidos para a mesma assinatura JWT em uma janela de tempo. Os clientes com a mesma assinatura JWT serão desconectados se os bytes da mensagem excederem esse valor. O valor padrão é 1 GB. | int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByJwtSignatureRule' (obrigatório) |
Regra de TrafficThrottleByUserIdRule
Nome | Descrição | Valor |
---|---|---|
aggregationWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes da mensagem serão agregados nesta janela e serão redefinidos após a janela. O valor padrão é 60 segundos. | int Restrições: Valor mínimo = 10 Valor máximo = 3600 |
maxInboundMessageBytes | Máximo de bytes de mensagem de entrada acumulados permitidos para a mesma ID de usuário em uma janela de tempo. Os clientes com a mesma ID de usuário serão desconectados se os bytes da mensagem excederem esse valor. O valor padrão é 1 GB. | int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByUserIdRule' (obrigatório) |
UpstreamAuthSettings
Nome | Descrição | Valor |
---|---|---|
Identidade gerenciada | Configurações de identidade gerenciada para upstream. | |
tipo | Enumeração de tipo de autenticação upstream. | 'ManagedIdentity' 'Nenhum' |
Modelo a montante
UserAssignedIdentityProperty
Nome | Descrição | Valor |
---|