Microsoft.SignalRService signalR
- Últimas
- 2024-10-01-preview
- 2024-08-01-preview
- 2024-04-01-preview
- 2024-03-01
- 2024-01-01-preview
- 2023-08-01-PREVIEW
- 2023-06-01-preview
- 2023-03-01-preview
- 2023-02-01
- 2022-08-01-preview
- 2022-02-01
- 2021-10-01
- 2021-09-01-preview
- 2021-06-01-preview
- 2021-04-01-preview
- 2020-07-01-preview
- 2020-05-01
- 2018-10-01
- 2018-03-01-preview
Definição de recursos do bíceps
O tipo de recurso signalR pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.SignalRService/signalR, adicione o seguinte Bíceps ao seu modelo.
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
Defina a propriedade type 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 type 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
ApplicationFirewallSettings
Designação | 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[] |
ClientConnectionCountRule
Designação | 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
Designação | 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
Designação | Descrição | Valor |
---|---|---|
ação | Ação da ACL de rede do Azure. | 'Permitir' 'Negar' |
valor | Um IP ou CIDR ou ServiceTag | string |
LiveTraceCategory
Designação | Descrição | Valor |
---|---|---|
ativado | Indica se ou a categoria de rastreamento dinâmico está habilitada. Valores disponíveis: true, false. Insensível a maiúsculas e minúsculas. |
string |
Designação | Obtém ou define o nome da categoria de rastreamento dinâmico. Valores disponíveis: ConnectivityLogs, MessagingLogs. Insensível a maiúsculas e minúsculas. |
string |
LiveTraceConfiguration
Designação | Descrição | Valor |
---|---|---|
Categorias | Obtém ou define a lista de configurações de categoria. | LiveTraceCategory[] |
ativado | Indica se habilita ou não o rastreamento em tempo real. Quando estiver definido como true, o cliente de rastreamento dinâmico poderá se conectar ao serviço. Caso contrário, o cliente de rastreamento ao vivo não poderá se conectar ao serviço, de modo que você não poderá receber nenhum log, independentemente do que você configurar em "categorias". Valores disponíveis: true, false. Insensível a maiúsculas e minúsculas. |
string |
Identidade gerenciada
ManagedIdentitySettings
Designação | Descrição | Valor |
---|---|---|
recurso | O Recurso que indica o URI da ID do Aplicativo do recurso de destino. Também aparece na declaração aud (audiência) do token emitido. |
string |
ManagedIdentityUserAssignedIdentities
Designação | Descrição | Valor |
---|
Microsoft.SignalRService/signalR
Designação | Descrição | Valor |
---|---|---|
identidade | Uma classe representa identidades gerenciadas usadas para solicitação e resposta | ManagedIdentity |
tipo | O tipo de serviço | 'RawWebSockets' 'SignalR' |
Localização | A geolocalização onde o recurso vive | string (obrigatório) |
Designação | O nome do recurso | string Restrições: Comprimento mínimo = 3 Comprimento máximo = 3 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 faturamento do recurso. | ResourceSku |
Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
RedeACL
Designação | 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 contendo qualquer uma das: 'ClientConnection' '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 contendo qualquer uma das: 'ClientConnection' 'RESTAPI' 'Conexão de servidor' 'Traço' |
PrivateEndpointACL
Designação | 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 contendo qualquer uma das: 'ClientConnection' '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 contendo qualquer uma das: 'ClientConnection' 'RESTAPI' 'Conexão de servidor' 'Traço' |
Designação | Nome da conexão de ponto de extremidade privado | string (obrigatório) |
ResourceLogCategory
Designação | Descrição | Valor |
---|---|---|
ativado | Indica se ou a categoria do log de recursos está habilitada. Valores disponíveis: true, false. Insensível a maiúsculas e minúsculas. |
string |
Designação | Obtém ou define o nome da categoria do log de recursos. Valores disponíveis: ConnectivityLogs, MessagingLogs. Insensível a maiúsculas e minúsculas. |
string |
ResourceLogConfiguration
Designação | Descrição | Valor |
---|---|---|
Categorias | Obtém ou define a lista de configurações de categoria. | ResourceLogCategory [] |
ResourceSku
Designação | 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 presentes, são permitidos os seguintes 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 |
Designação | O nome do SKU. Necessário. Valores permitidos: Standard_S1, Free_F1, Premium_P1 Premium_P2 |
string (obrigatório) |
nível | Camada opcional desta SKU específica. 'Padrão' ou 'Livre'. Basic for preterido, use-Standard em vez disso. |
'Básico' 'Grátis' 'Premium' 'Padrão' |
ServerlessSettings
Designação | Descrição | Valor |
---|---|---|
connectionTimeoutInSeconds | Obtém ou define o Tempo Limite de Conexão do Cliente. Opcional a definir. Valor em segundos. O valor padrão é 30 segundos. O cliente deve definir o tempo limite para um período mais curto se se espera que as mensagens sejam 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 se espera que as mensagens sejam enviadas em intervalos maiores, e eles querem manter a mesma conexão de cliente viva durante esta sessão. O serviço considera o cliente desconectado se ele não tiver recebido uma mensagem (incluindo keep-alive) nesse intervalo. |
Int Restrições: Valor mínimo = 1 Valor máximo = 120 |
keepAliveIntervalInSeconds | Obtém ou define o Keep-Alive Intervalo. Opcional para definir. O valor é em segundos. O valor padrão é 15 segundos. Os clientes devem definir esse valor para um período mais curto se quiserem que o serviço envie mensagens keep-alive com mais frequência, assegurar a verificação atempada do estado da ligaçã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 detetar uma desconexão. Esse intervalo garante que a conexão seja mantida enviando mensagens periódicas de keep-alive para o cliente. |
Int Restrições: Valor mínimo = 1 Valor máximo = 120 |
ServerlessUpstreamSettings
Designação | 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 produz efeitos. | UpstreamTemplate[] |
SignalRCorsSettings
Designação | Descrição | Valor |
---|---|---|
allowedOrigens | 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. | string[] |
SignalRFeature
Designação | Descrição | Valor |
---|---|---|
bandeira | FeatureFlags são os recursos suportados do serviço Azure SignalR. - ServiceMode: Sinalizador para servidor back-end para serviço SignalR. Valores permitidos: "Padrão": ter seu próprio servidor back-end; "Sem servidor": seu aplicativo não tem um servidor back-end; "Clássico": para compatibilidade com versões anteriores. Suporta o modo padrão e sem servidor, mas não recomendado; "PredefinedOnly": para uso futuro. - EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de log de conectividade, respectivamente. - EnableMessagingLogs: "true"/"false", para ativar/desativar a categoria de log de conectividade, respectivamente. - EnableLiveTrace: O Live Trace permite que você saiba o que está acontecendo dentro do serviço Azure SignalR, ele lhe dará rastreamentos ao vivo em tempo real, será útil quando você desenvolver seu próprio aplicativo Web baseado no Azure SignalR ou solucionar alguns problemas. Por favor, note que os rastreamentos em tempo real são contados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para ativar/desativar o recurso de rastreamento ao vivo. |
'EnableConnectivityLogs' 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' (obrigatório) |
propriedades | Propriedades opcionais relacionadas a esse recurso. | SignalRFeatureProperties |
valor | Valor do sinalizador de recurso. Consulte o documento de serviço do Azure SignalR /azure/azure-signalr/ para obter os valores permitidos. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 (obrigatório) |
SignalRFeatureProperties
Designação | Descrição | Valor |
---|
SignalRNetworkACLs
Designação | Descrição | Valor |
---|---|---|
defaultAction | Ação da ACL de rede do Azure. | 'Permitir' 'Negar' |
ipRegras | Regras de IP para filtrar o tráfego público | IPRule[] |
privateEndpoints | ACLs para solicitações de pontos de extremidade privados | PrivateEndpointACL [] |
rede pública | ACL de rede | NetworkACL |
SignalRProperties
Designação | Descrição | Valor |
---|---|---|
applicationFirewall | Configurações do firewall do aplicativo para o recurso | ApplicationFirewallSettings |
CORS | Configurações de compartilhamento de recursos entre origens (CORS). | SignalRCorsSettings |
desativarAadAuth | DisableLocalAuth Ativar ou desativar aad auth Quando definido como true, a conexão com AuthType=aad não funcionará. |
Bool |
disableLocalAuth | DisableLocalAuth Ativar ou desativar autenticação local com AccessKey Quando definido como true, a conexão com AccessKey=xxx não funcionará. |
Bool |
caraterísticas | Lista dos featureFlags. FeatureFlags que não estão incluídos nos parâmetros para a operação de atualização não serão modificados. E a resposta incluirá apenas featureFlags que estão explicitamente definidos. Quando um featureFlag não é definido explicitamente, seu valor padrão global será usado Mas lembre-se, o valor padrão não significa "falso". Ele varia em termos de diferentes FeatureFlags. |
SignalRFeature[] |
liveTraceConfiguration | Configuração de rastreamento em tempo real de um recurso Microsoft.SignalRService. | LiveTraceConfiguration |
ACLs de rede | ACLs de rede para o recurso | SignalRNetworkACLs |
publicNetworkAccess | Habilite ou desabilite o acesso à rede pública. O padrão é "Ativado". Quando está habilitado, as ACLs de rede ainda se aplicam. Quando está Desativado, o acesso à rede pública é sempre desativado, independentemente do que você definir nas ACLs de rede. |
string |
regionEndpointEnabled | Habilite ou desabilite o ponto de extremidade regional. O padrão é "Ativado". Quando estiver desativado, novas conexões não serão roteadas para esse ponto de extremidade, no entanto, as conexões existentes não serão afetadas. Esta propriedade é específica da réplica. Não é permitido desativar o ponto de extremidade regional sem réplica. |
string |
resourceLogConfiguration | Configuração do log de recursos de um recurso Microsoft.SignalRService. | ResourceLogConfiguration |
resourceStopped | Pare ou inicie o recurso. O padrão é "False". Quando é verdadeiro, o plano de dados do recurso é desligado. Quando é falso, o plano de dados do recurso é iniciado. |
string |
sem servidor | Configurações sem servidor. | ServerlessSettings |
TLS | Configurações de TLS para o recurso | SignalRTlsSettings |
a montante | As configurações para o Upstream quando o serviço está no modo sem servidor. | ServerlessUpstreamSettings |
SignalRTlsSettings
Designação | Descrição | Valor |
---|---|---|
clientCertEnabled | Solicite o certificado do cliente durante o handshake TLS, se habilitado. Não suportado para o nível gratuito. Qualquer entrada será ignorada para o nível gratuito. | Bool |
ThrottleByJwtCustomClaimRule
Designação | Descrição | Valor |
---|---|---|
claimName | O nome da declaração no token JWT. A conexão do cliente com o mesmo valor de sinistro será agregada. Se a declaração não for encontrada no token, a conexão será permitida. | string (obrigatório) |
maxContagem | Contagem máxima de conexão permitida para o mesmo valor de declaração Jwt. 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
Designação | Descrição | Valor |
---|---|---|
maxContagem | Contagem máxima de conexão permitida para a mesma assinatura JWT. 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
Designação | Descrição | Valor |
---|---|---|
maxContagem | Contagem máxima de conexões permitida para o mesmo ID de usuário. Clientes com o mesmo 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
Designação | Descrição | Valor |
---|
TrafficThrottleByJwtCustomClaimRule
Designação | Descrição | Valor |
---|---|---|
agregaçãoWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes de 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 |
claimName | 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. | string (obrigatório) |
maxInboundMessageBytes | Máximo acumulado de bytes de mensagens de entrada permitidos para a mesma assinatura JWT dentro de 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 é 1GB. | Int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByJwtCustomClaimRule' (obrigatório) |
TrafficThrottleByJwtSignatureRule
Designação | Descrição | Valor |
---|---|---|
agregaçãoWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes de 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 acumulado de bytes de mensagens de entrada permitidos para a mesma assinatura JWT dentro de 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 é 1GB. | Int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByJwtSignatureRule' (obrigatório) |
TrafficThrottleByUserIdRule
Designação | Descrição | Valor |
---|---|---|
agregaçãoWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes de 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 acumulado de bytes de mensagens de entrada permitidos para o mesmo ID de usuário dentro de uma janela de tempo. Os clientes com o mesmo ID de usuário serão desconectados se os bytes da mensagem excederem esse valor. O valor padrão é 1GB. | Int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByUserIdRule' (obrigatório) |
UpstreamAuthSettings
Designação | Descrição | Valor |
---|---|---|
managedIdentity | Configurações de identidade gerenciadas para upstream. | ManagedIdentitySettings |
tipo | Auta a montante tipo enum. | 'Identidade gerenciada' 'Nenhuma' |
UpstreamTemplate
Designação | Descrição | Valor |
---|---|---|
auth | Configurações de autenticação upstream. Se não estiver definida, nenhuma autenticação será usada para mensagens upstream. | UpstreamAuthSettings |
categoryPattern | Obtém ou define o padrão de correspondência para nomes de categoria. Se não estiver definido, corresponde a qualquer categoria. Existem 3 tipos de padrões suportados: 1. "*", corresponde a qualquer nome de categoria. 2. Combine várias categorias com ",", por exemplo "conexões, mensagens", ele corresponde à categoria "conexões" e "mensagens". 3. O nome de uma única categoria, por exemplo, "conexões", corresponde à categoria "conexões". |
string |
eventPattern | Obtém ou define o padrão de correspondência para nomes de eventos. Se não estiver definido, corresponde a qualquer evento. Existem 3 tipos de padrões suportados: 1. "*", corresponde a qualquer nome de evento. 2. Combine vários eventos com ",", por exemplo "connect,disconnect", ele corresponde ao evento "connect" e "disconnect". 3. O nome de um único evento, por exemplo, "connect", corresponde a "connect". |
string |
hubPattern | Obtém ou define o padrão de correspondência para nomes de hub. Se não estiver definido, corresponde a qualquer hub. Existem 3 tipos de padrões suportados: 1. "*", corresponde a qualquer nome de hub. 2. Combine vários hubs com ",", por exemplo "hub1,hub2", ele corresponde a "hub1" e "hub2". 3. O nome de hub único, por exemplo, "hub1", corresponde a "hub1". |
string |
urlTemplate | Obtém ou define o modelo de URL Upstream. Você pode usar 3 parâmetros predefinidos {hub}, {category} {event} dentro do modelo, o valor da URL Upstream é calculado dinamicamente quando a solicitação do cliente chega. Por exemplo, se o urlTemplate estiver http://example.com/{hub}/api/{event} , com uma solicitação de cliente do hub chat se conectar, ele primeiro POST para esta URL: http://example.com/chat/api/connect . |
string (obrigatório) |
UserAssignedIdentityProperty
Designação | Descrição | Valor |
---|
Exemplos de início rápido
Os exemplos de início rápido a seguir implantam esse tipo de recurso.
Arquivo Bicep | Descrição |
---|---|
Implantar um serviço do Azure SignalR | Este modelo cria um Serviço Azure SignalR usando um modelo. |
Definição de recurso de modelo ARM
O tipo de recurso signalR pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.SignalRService/signalR, adicione o seguinte JSON ao seu modelo.
{
"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
Defina a propriedade type 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 type 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
ApplicationFirewallSettings
Designação | 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[] |
ClientConnectionCountRule
Designação | 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
Designação | 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
Designação | Descrição | Valor |
---|---|---|
ação | Ação da ACL de rede do Azure. | 'Permitir' 'Negar' |
valor | Um IP ou CIDR ou ServiceTag | string |
LiveTraceCategory
Designação | Descrição | Valor |
---|---|---|
ativado | Indica se ou a categoria de rastreamento dinâmico está habilitada. Valores disponíveis: true, false. Insensível a maiúsculas e minúsculas. |
string |
Designação | Obtém ou define o nome da categoria de rastreamento dinâmico. Valores disponíveis: ConnectivityLogs, MessagingLogs. Insensível a maiúsculas e minúsculas. |
string |
LiveTraceConfiguration
Designação | Descrição | Valor |
---|---|---|
Categorias | Obtém ou define a lista de configurações de categoria. | LiveTraceCategory[] |
ativado | Indica se habilita ou não o rastreamento em tempo real. Quando estiver definido como true, o cliente de rastreamento dinâmico poderá se conectar ao serviço. Caso contrário, o cliente de rastreamento ao vivo não poderá se conectar ao serviço, de modo que você não poderá receber nenhum log, independentemente do que você configurar em "categorias". Valores disponíveis: true, false. Insensível a maiúsculas e minúsculas. |
string |
Identidade gerenciada
ManagedIdentitySettings
Designação | Descrição | Valor |
---|---|---|
recurso | O Recurso que indica o URI da ID do Aplicativo do recurso de destino. Também aparece na declaração aud (audiência) do token emitido. |
string |
ManagedIdentityUserAssignedIdentities
Designação | Descrição | Valor |
---|
Microsoft.SignalRService/signalR
Designação | Descrição | Valor |
---|---|---|
apiVersion | A versão api | '2024-10-01-pré-visualização' |
identidade | Uma classe representa identidades gerenciadas usadas para solicitação e resposta | ManagedIdentity |
tipo | O tipo de serviço | 'RawWebSockets' 'SignalR' |
Localização | A geolocalização onde o recurso vive | string (obrigatório) |
Designação | O nome do recurso | string Restrições: Comprimento mínimo = 3 Comprimento máximo = 3 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 faturamento do recurso. | ResourceSku |
Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
tipo | O tipo de recurso | 'Microsoft.SignalRService/signalR' |
RedeACL
Designação | 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 contendo qualquer uma das: 'ClientConnection' '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 contendo qualquer uma das: 'ClientConnection' 'RESTAPI' 'Conexão de servidor' 'Traço' |
PrivateEndpointACL
Designação | 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 contendo qualquer uma das: 'ClientConnection' '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 contendo qualquer uma das: 'ClientConnection' 'RESTAPI' 'Conexão de servidor' 'Traço' |
Designação | Nome da conexão de ponto de extremidade privado | string (obrigatório) |
ResourceLogCategory
Designação | Descrição | Valor |
---|---|---|
ativado | Indica se ou a categoria do log de recursos está habilitada. Valores disponíveis: true, false. Insensível a maiúsculas e minúsculas. |
string |
Designação | Obtém ou define o nome da categoria do log de recursos. Valores disponíveis: ConnectivityLogs, MessagingLogs. Insensível a maiúsculas e minúsculas. |
string |
ResourceLogConfiguration
Designação | Descrição | Valor |
---|---|---|
Categorias | Obtém ou define a lista de configurações de categoria. | ResourceLogCategory [] |
ResourceSku
Designação | 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 presentes, são permitidos os seguintes 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 |
Designação | O nome do SKU. Necessário. Valores permitidos: Standard_S1, Free_F1, Premium_P1 Premium_P2 |
string (obrigatório) |
nível | Camada opcional desta SKU específica. 'Padrão' ou 'Livre'. Basic for preterido, use-Standard em vez disso. |
'Básico' 'Grátis' 'Premium' 'Padrão' |
ServerlessSettings
Designação | Descrição | Valor |
---|---|---|
connectionTimeoutInSeconds | Obtém ou define o Tempo Limite de Conexão do Cliente. Opcional a definir. Valor em segundos. O valor padrão é 30 segundos. O cliente deve definir o tempo limite para um período mais curto se se espera que as mensagens sejam 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 se espera que as mensagens sejam enviadas em intervalos maiores, e eles querem manter a mesma conexão de cliente viva durante esta sessão. O serviço considera o cliente desconectado se ele não tiver recebido uma mensagem (incluindo keep-alive) nesse intervalo. |
Int Restrições: Valor mínimo = 1 Valor máximo = 120 |
keepAliveIntervalInSeconds | Obtém ou define o Keep-Alive Intervalo. Opcional para definir. O valor é em segundos. O valor padrão é 15 segundos. Os clientes devem definir esse valor para um período mais curto se quiserem que o serviço envie mensagens keep-alive com mais frequência, assegurar a verificação atempada do estado da ligaçã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 detetar uma desconexão. Esse intervalo garante que a conexão seja mantida enviando mensagens periódicas de keep-alive para o cliente. |
Int Restrições: Valor mínimo = 1 Valor máximo = 120 |
ServerlessUpstreamSettings
Designação | 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 produz efeitos. | UpstreamTemplate[] |
SignalRCorsSettings
Designação | Descrição | Valor |
---|---|---|
allowedOrigens | 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. | string[] |
SignalRFeature
Designação | Descrição | Valor |
---|---|---|
bandeira | FeatureFlags são os recursos suportados do serviço Azure SignalR. - ServiceMode: Sinalizador para servidor back-end para serviço SignalR. Valores permitidos: "Padrão": ter seu próprio servidor back-end; "Sem servidor": seu aplicativo não tem um servidor back-end; "Clássico": para compatibilidade com versões anteriores. Suporta o modo padrão e sem servidor, mas não recomendado; "PredefinedOnly": para uso futuro. - EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de log de conectividade, respectivamente. - EnableMessagingLogs: "true"/"false", para ativar/desativar a categoria de log de conectividade, respectivamente. - EnableLiveTrace: O Live Trace permite que você saiba o que está acontecendo dentro do serviço Azure SignalR, ele lhe dará rastreamentos ao vivo em tempo real, será útil quando você desenvolver seu próprio aplicativo Web baseado no Azure SignalR ou solucionar alguns problemas. Por favor, note que os rastreamentos em tempo real são contados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para ativar/desativar o recurso de rastreamento ao vivo. |
'EnableConnectivityLogs' 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' (obrigatório) |
propriedades | Propriedades opcionais relacionadas a esse recurso. | SignalRFeatureProperties |
valor | Valor do sinalizador de recurso. Consulte o documento de serviço do Azure SignalR /azure/azure-signalr/ para obter os valores permitidos. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 (obrigatório) |
SignalRFeatureProperties
Designação | Descrição | Valor |
---|
SignalRNetworkACLs
Designação | Descrição | Valor |
---|---|---|
defaultAction | Ação da ACL de rede do Azure. | 'Permitir' 'Negar' |
ipRegras | Regras de IP para filtrar o tráfego público | IPRule[] |
privateEndpoints | ACLs para solicitações de pontos de extremidade privados | PrivateEndpointACL [] |
rede pública | ACL de rede | NetworkACL |
SignalRProperties
Designação | Descrição | Valor |
---|---|---|
applicationFirewall | Configurações do firewall do aplicativo para o recurso | ApplicationFirewallSettings |
CORS | Configurações de compartilhamento de recursos entre origens (CORS). | SignalRCorsSettings |
desativarAadAuth | DisableLocalAuth Ativar ou desativar aad auth Quando definido como true, a conexão com AuthType=aad não funcionará. |
Bool |
disableLocalAuth | DisableLocalAuth Ativar ou desativar autenticação local com AccessKey Quando definido como true, a conexão com AccessKey=xxx não funcionará. |
Bool |
caraterísticas | Lista dos featureFlags. FeatureFlags que não estão incluídos nos parâmetros para a operação de atualização não serão modificados. E a resposta incluirá apenas featureFlags que estão explicitamente definidos. Quando um featureFlag não é definido explicitamente, seu valor padrão global será usado Mas lembre-se, o valor padrão não significa "falso". Ele varia em termos de diferentes FeatureFlags. |
SignalRFeature[] |
liveTraceConfiguration | Configuração de rastreamento em tempo real de um recurso Microsoft.SignalRService. | LiveTraceConfiguration |
ACLs de rede | ACLs de rede para o recurso | SignalRNetworkACLs |
publicNetworkAccess | Habilite ou desabilite o acesso à rede pública. O padrão é "Ativado". Quando está habilitado, as ACLs de rede ainda se aplicam. Quando está Desativado, o acesso à rede pública é sempre desativado, independentemente do que você definir nas ACLs de rede. |
string |
regionEndpointEnabled | Habilite ou desabilite o ponto de extremidade regional. O padrão é "Ativado". Quando estiver desativado, novas conexões não serão roteadas para esse ponto de extremidade, no entanto, as conexões existentes não serão afetadas. Esta propriedade é específica da réplica. Não é permitido desativar o ponto de extremidade regional sem réplica. |
string |
resourceLogConfiguration | Configuração do log de recursos de um recurso Microsoft.SignalRService. | ResourceLogConfiguration |
resourceStopped | Pare ou inicie o recurso. O padrão é "False". Quando é verdadeiro, o plano de dados do recurso é desligado. Quando é falso, o plano de dados do recurso é iniciado. |
string |
sem servidor | Configurações sem servidor. | ServerlessSettings |
TLS | Configurações de TLS para o recurso | SignalRTlsSettings |
a montante | As configurações para o Upstream quando o serviço está no modo sem servidor. | ServerlessUpstreamSettings |
SignalRTlsSettings
Designação | Descrição | Valor |
---|---|---|
clientCertEnabled | Solicite o certificado do cliente durante o handshake TLS, se habilitado. Não suportado para o nível gratuito. Qualquer entrada será ignorada para o nível gratuito. | Bool |
ThrottleByJwtCustomClaimRule
Designação | Descrição | Valor |
---|---|---|
claimName | O nome da declaração no token JWT. A conexão do cliente com o mesmo valor de sinistro será agregada. Se a declaração não for encontrada no token, a conexão será permitida. | string (obrigatório) |
maxContagem | Contagem máxima de conexão permitida para o mesmo valor de declaração Jwt. 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
Designação | Descrição | Valor |
---|---|---|
maxContagem | Contagem máxima de conexão permitida para a mesma assinatura JWT. 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
Designação | Descrição | Valor |
---|---|---|
maxContagem | Contagem máxima de conexões permitida para o mesmo ID de usuário. Clientes com o mesmo 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
Designação | Descrição | Valor |
---|
TrafficThrottleByJwtCustomClaimRule
Designação | Descrição | Valor |
---|---|---|
agregaçãoWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes de 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 |
claimName | 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. | string (obrigatório) |
maxInboundMessageBytes | Máximo acumulado de bytes de mensagens de entrada permitidos para a mesma assinatura JWT dentro de 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 é 1GB. | Int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByJwtCustomClaimRule' (obrigatório) |
TrafficThrottleByJwtSignatureRule
Designação | Descrição | Valor |
---|---|---|
agregaçãoWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes de 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 acumulado de bytes de mensagens de entrada permitidos para a mesma assinatura JWT dentro de 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 é 1GB. | Int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByJwtSignatureRule' (obrigatório) |
TrafficThrottleByUserIdRule
Designação | Descrição | Valor |
---|---|---|
agregaçãoWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes de 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 acumulado de bytes de mensagens de entrada permitidos para o mesmo ID de usuário dentro de uma janela de tempo. Os clientes com o mesmo ID de usuário serão desconectados se os bytes da mensagem excederem esse valor. O valor padrão é 1GB. | Int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByUserIdRule' (obrigatório) |
UpstreamAuthSettings
Designação | Descrição | Valor |
---|---|---|
managedIdentity | Configurações de identidade gerenciadas para upstream. | ManagedIdentitySettings |
tipo | Auta a montante tipo enum. | 'Identidade gerenciada' 'Nenhuma' |
UpstreamTemplate
Designação | Descrição | Valor |
---|---|---|
auth | Configurações de autenticação upstream. Se não estiver definida, nenhuma autenticação será usada para mensagens upstream. | UpstreamAuthSettings |
categoryPattern | Obtém ou define o padrão de correspondência para nomes de categoria. Se não estiver definido, corresponde a qualquer categoria. Existem 3 tipos de padrões suportados: 1. "*", corresponde a qualquer nome de categoria. 2. Combine várias categorias com ",", por exemplo "conexões, mensagens", ele corresponde à categoria "conexões" e "mensagens". 3. O nome de uma única categoria, por exemplo, "conexões", corresponde à categoria "conexões". |
string |
eventPattern | Obtém ou define o padrão de correspondência para nomes de eventos. Se não estiver definido, corresponde a qualquer evento. Existem 3 tipos de padrões suportados: 1. "*", corresponde a qualquer nome de evento. 2. Combine vários eventos com ",", por exemplo "connect,disconnect", ele corresponde ao evento "connect" e "disconnect". 3. O nome de um único evento, por exemplo, "connect", corresponde a "connect". |
string |
hubPattern | Obtém ou define o padrão de correspondência para nomes de hub. Se não estiver definido, corresponde a qualquer hub. Existem 3 tipos de padrões suportados: 1. "*", corresponde a qualquer nome de hub. 2. Combine vários hubs com ",", por exemplo "hub1,hub2", ele corresponde a "hub1" e "hub2". 3. O nome de hub único, por exemplo, "hub1", corresponde a "hub1". |
string |
urlTemplate | Obtém ou define o modelo de URL Upstream. Você pode usar 3 parâmetros predefinidos {hub}, {category} {event} dentro do modelo, o valor da URL Upstream é calculado dinamicamente quando a solicitação do cliente chega. Por exemplo, se o urlTemplate estiver http://example.com/{hub}/api/{event} , com uma solicitação de cliente do hub chat se conectar, ele primeiro POST para esta URL: http://example.com/chat/api/connect . |
string (obrigatório) |
UserAssignedIdentityProperty
Designação | Descrição | Valor |
---|
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
Modelo | Descrição |
---|---|
Implantar um serviço do Azure SignalR |
Este modelo cria um Serviço Azure SignalR usando um modelo. |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso signalR pode ser implantado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.SignalRService/signalR, adicione o seguinte Terraform ao seu modelo.
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
Defina a propriedade type 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 type 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
ApplicationFirewallSettings
Designação | 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[] |
ClientConnectionCountRule
Designação | 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
Designação | 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
Designação | Descrição | Valor |
---|---|---|
ação | Ação da ACL de rede do Azure. | 'Permitir' 'Negar' |
valor | Um IP ou CIDR ou ServiceTag | string |
LiveTraceCategory
Designação | Descrição | Valor |
---|---|---|
ativado | Indica se ou a categoria de rastreamento dinâmico está habilitada. Valores disponíveis: true, false. Insensível a maiúsculas e minúsculas. |
string |
Designação | Obtém ou define o nome da categoria de rastreamento dinâmico. Valores disponíveis: ConnectivityLogs, MessagingLogs. Insensível a maiúsculas e minúsculas. |
string |
LiveTraceConfiguration
Designação | Descrição | Valor |
---|---|---|
Categorias | Obtém ou define a lista de configurações de categoria. | LiveTraceCategory[] |
ativado | Indica se habilita ou não o rastreamento em tempo real. Quando estiver definido como true, o cliente de rastreamento dinâmico poderá se conectar ao serviço. Caso contrário, o cliente de rastreamento ao vivo não poderá se conectar ao serviço, de modo que você não poderá receber nenhum log, independentemente do que você configurar em "categorias". Valores disponíveis: true, false. Insensível a maiúsculas e minúsculas. |
string |
Identidade gerenciada
ManagedIdentitySettings
Designação | Descrição | Valor |
---|---|---|
recurso | O Recurso que indica o URI da ID do Aplicativo do recurso de destino. Também aparece na declaração aud (audiência) do token emitido. |
string |
ManagedIdentityUserAssignedIdentities
Designação | Descrição | Valor |
---|
Microsoft.SignalRService/signalR
Designação | Descrição | Valor |
---|---|---|
identidade | Uma classe representa identidades gerenciadas usadas para solicitação e resposta | ManagedIdentity |
tipo | O tipo de serviço | 'RawWebSockets' 'SignalR' |
Localização | A geolocalização onde o recurso vive | string (obrigatório) |
Designação | O nome do recurso | string Restrições: Comprimento mínimo = 3 Comprimento máximo = 3 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 faturamento do recurso. | ResourceSku |
Etiquetas | Tags de recursos | Dicionário de nomes e valores de tags. |
tipo | O tipo de recurso | "Microsoft.SignalRService/signalR@2024-10-01-preview" |
RedeACL
Designação | 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 contendo qualquer uma das: 'ClientConnection' '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 contendo qualquer uma das: 'ClientConnection' 'RESTAPI' 'Conexão de servidor' 'Traço' |
PrivateEndpointACL
Designação | 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 contendo qualquer uma das: 'ClientConnection' '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 contendo qualquer uma das: 'ClientConnection' 'RESTAPI' 'Conexão de servidor' 'Traço' |
Designação | Nome da conexão de ponto de extremidade privado | string (obrigatório) |
ResourceLogCategory
Designação | Descrição | Valor |
---|---|---|
ativado | Indica se ou a categoria do log de recursos está habilitada. Valores disponíveis: true, false. Insensível a maiúsculas e minúsculas. |
string |
Designação | Obtém ou define o nome da categoria do log de recursos. Valores disponíveis: ConnectivityLogs, MessagingLogs. Insensível a maiúsculas e minúsculas. |
string |
ResourceLogConfiguration
Designação | Descrição | Valor |
---|---|---|
Categorias | Obtém ou define a lista de configurações de categoria. | ResourceLogCategory [] |
ResourceSku
Designação | 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 presentes, são permitidos os seguintes 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 |
Designação | O nome do SKU. Necessário. Valores permitidos: Standard_S1, Free_F1, Premium_P1 Premium_P2 |
string (obrigatório) |
nível | Camada opcional desta SKU específica. 'Padrão' ou 'Livre'. Basic for preterido, use-Standard em vez disso. |
'Básico' 'Grátis' 'Premium' 'Padrão' |
ServerlessSettings
Designação | Descrição | Valor |
---|---|---|
connectionTimeoutInSeconds | Obtém ou define o Tempo Limite de Conexão do Cliente. Opcional a definir. Valor em segundos. O valor padrão é 30 segundos. O cliente deve definir o tempo limite para um período mais curto se se espera que as mensagens sejam 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 se espera que as mensagens sejam enviadas em intervalos maiores, e eles querem manter a mesma conexão de cliente viva durante esta sessão. O serviço considera o cliente desconectado se ele não tiver recebido uma mensagem (incluindo keep-alive) nesse intervalo. |
Int Restrições: Valor mínimo = 1 Valor máximo = 120 |
keepAliveIntervalInSeconds | Obtém ou define o Keep-Alive Intervalo. Opcional para definir. O valor é em segundos. O valor padrão é 15 segundos. Os clientes devem definir esse valor para um período mais curto se quiserem que o serviço envie mensagens keep-alive com mais frequência, assegurar a verificação atempada do estado da ligaçã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 detetar uma desconexão. Esse intervalo garante que a conexão seja mantida enviando mensagens periódicas de keep-alive para o cliente. |
Int Restrições: Valor mínimo = 1 Valor máximo = 120 |
ServerlessUpstreamSettings
Designação | 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 produz efeitos. | UpstreamTemplate[] |
SignalRCorsSettings
Designação | Descrição | Valor |
---|---|---|
allowedOrigens | 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. | string[] |
SignalRFeature
Designação | Descrição | Valor |
---|---|---|
bandeira | FeatureFlags são os recursos suportados do serviço Azure SignalR. - ServiceMode: Sinalizador para servidor back-end para serviço SignalR. Valores permitidos: "Padrão": ter seu próprio servidor back-end; "Sem servidor": seu aplicativo não tem um servidor back-end; "Clássico": para compatibilidade com versões anteriores. Suporta o modo padrão e sem servidor, mas não recomendado; "PredefinedOnly": para uso futuro. - EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de log de conectividade, respectivamente. - EnableMessagingLogs: "true"/"false", para ativar/desativar a categoria de log de conectividade, respectivamente. - EnableLiveTrace: O Live Trace permite que você saiba o que está acontecendo dentro do serviço Azure SignalR, ele lhe dará rastreamentos ao vivo em tempo real, será útil quando você desenvolver seu próprio aplicativo Web baseado no Azure SignalR ou solucionar alguns problemas. Por favor, note que os rastreamentos em tempo real são contados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para ativar/desativar o recurso de rastreamento ao vivo. |
'EnableConnectivityLogs' 'EnableLiveTrace' 'EnableMessagingLogs' 'ServiceMode' (obrigatório) |
propriedades | Propriedades opcionais relacionadas a esse recurso. | SignalRFeatureProperties |
valor | Valor do sinalizador de recurso. Consulte o documento de serviço do Azure SignalR /azure/azure-signalr/ para obter os valores permitidos. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 1 (obrigatório) |
SignalRFeatureProperties
Designação | Descrição | Valor |
---|
SignalRNetworkACLs
Designação | Descrição | Valor |
---|---|---|
defaultAction | Ação da ACL de rede do Azure. | 'Permitir' 'Negar' |
ipRegras | Regras de IP para filtrar o tráfego público | IPRule[] |
privateEndpoints | ACLs para solicitações de pontos de extremidade privados | PrivateEndpointACL [] |
rede pública | ACL de rede | NetworkACL |
SignalRProperties
Designação | Descrição | Valor |
---|---|---|
applicationFirewall | Configurações do firewall do aplicativo para o recurso | ApplicationFirewallSettings |
CORS | Configurações de compartilhamento de recursos entre origens (CORS). | SignalRCorsSettings |
desativarAadAuth | DisableLocalAuth Ativar ou desativar aad auth Quando definido como true, a conexão com AuthType=aad não funcionará. |
Bool |
disableLocalAuth | DisableLocalAuth Ativar ou desativar autenticação local com AccessKey Quando definido como true, a conexão com AccessKey=xxx não funcionará. |
Bool |
caraterísticas | Lista dos featureFlags. FeatureFlags que não estão incluídos nos parâmetros para a operação de atualização não serão modificados. E a resposta incluirá apenas featureFlags que estão explicitamente definidos. Quando um featureFlag não é definido explicitamente, seu valor padrão global será usado Mas lembre-se, o valor padrão não significa "falso". Ele varia em termos de diferentes FeatureFlags. |
SignalRFeature[] |
liveTraceConfiguration | Configuração de rastreamento em tempo real de um recurso Microsoft.SignalRService. | LiveTraceConfiguration |
ACLs de rede | ACLs de rede para o recurso | SignalRNetworkACLs |
publicNetworkAccess | Habilite ou desabilite o acesso à rede pública. O padrão é "Ativado". Quando está habilitado, as ACLs de rede ainda se aplicam. Quando está Desativado, o acesso à rede pública é sempre desativado, independentemente do que você definir nas ACLs de rede. |
string |
regionEndpointEnabled | Habilite ou desabilite o ponto de extremidade regional. O padrão é "Ativado". Quando estiver desativado, novas conexões não serão roteadas para esse ponto de extremidade, no entanto, as conexões existentes não serão afetadas. Esta propriedade é específica da réplica. Não é permitido desativar o ponto de extremidade regional sem réplica. |
string |
resourceLogConfiguration | Configuração do log de recursos de um recurso Microsoft.SignalRService. | ResourceLogConfiguration |
resourceStopped | Pare ou inicie o recurso. O padrão é "False". Quando é verdadeiro, o plano de dados do recurso é desligado. Quando é falso, o plano de dados do recurso é iniciado. |
string |
sem servidor | Configurações sem servidor. | ServerlessSettings |
TLS | Configurações de TLS para o recurso | SignalRTlsSettings |
a montante | As configurações para o Upstream quando o serviço está no modo sem servidor. | ServerlessUpstreamSettings |
SignalRTlsSettings
Designação | Descrição | Valor |
---|---|---|
clientCertEnabled | Solicite o certificado do cliente durante o handshake TLS, se habilitado. Não suportado para o nível gratuito. Qualquer entrada será ignorada para o nível gratuito. | Bool |
ThrottleByJwtCustomClaimRule
Designação | Descrição | Valor |
---|---|---|
claimName | O nome da declaração no token JWT. A conexão do cliente com o mesmo valor de sinistro será agregada. Se a declaração não for encontrada no token, a conexão será permitida. | string (obrigatório) |
maxContagem | Contagem máxima de conexão permitida para o mesmo valor de declaração Jwt. 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
Designação | Descrição | Valor |
---|---|---|
maxContagem | Contagem máxima de conexão permitida para a mesma assinatura JWT. 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
Designação | Descrição | Valor |
---|---|---|
maxContagem | Contagem máxima de conexões permitida para o mesmo ID de usuário. Clientes com o mesmo 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
Designação | Descrição | Valor |
---|
TrafficThrottleByJwtCustomClaimRule
Designação | Descrição | Valor |
---|---|---|
agregaçãoWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes de 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 |
claimName | 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. | string (obrigatório) |
maxInboundMessageBytes | Máximo acumulado de bytes de mensagens de entrada permitidos para a mesma assinatura JWT dentro de 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 é 1GB. | Int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByJwtCustomClaimRule' (obrigatório) |
TrafficThrottleByJwtSignatureRule
Designação | Descrição | Valor |
---|---|---|
agregaçãoWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes de 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 acumulado de bytes de mensagens de entrada permitidos para a mesma assinatura JWT dentro de 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 é 1GB. | Int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByJwtSignatureRule' (obrigatório) |
TrafficThrottleByUserIdRule
Designação | Descrição | Valor |
---|---|---|
agregaçãoWindowInSeconds | A janela de agregação para os bytes de mensagem. Os bytes de 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 acumulado de bytes de mensagens de entrada permitidos para o mesmo ID de usuário dentro de uma janela de tempo. Os clientes com o mesmo ID de usuário serão desconectados se os bytes da mensagem excederem esse valor. O valor padrão é 1GB. | Int Restrições: Valor mínimo = 0 |
tipo | 'TrafficThrottleByUserIdRule' (obrigatório) |
UpstreamAuthSettings
Designação | Descrição | Valor |
---|---|---|
managedIdentity | Configurações de identidade gerenciadas para upstream. | ManagedIdentitySettings |
tipo | Auta a montante tipo enum. | 'Identidade gerenciada' 'Nenhuma' |
UpstreamTemplate
Designação | Descrição | Valor |
---|---|---|
auth | Configurações de autenticação upstream. Se não estiver definida, nenhuma autenticação será usada para mensagens upstream. | UpstreamAuthSettings |
categoryPattern | Obtém ou define o padrão de correspondência para nomes de categoria. Se não estiver definido, corresponde a qualquer categoria. Existem 3 tipos de padrões suportados: 1. "*", corresponde a qualquer nome de categoria. 2. Combine várias categorias com ",", por exemplo "conexões, mensagens", ele corresponde à categoria "conexões" e "mensagens". 3. O nome de uma única categoria, por exemplo, "conexões", corresponde à categoria "conexões". |
string |
eventPattern | Obtém ou define o padrão de correspondência para nomes de eventos. Se não estiver definido, corresponde a qualquer evento. Existem 3 tipos de padrões suportados: 1. "*", corresponde a qualquer nome de evento. 2. Combine vários eventos com ",", por exemplo "connect,disconnect", ele corresponde ao evento "connect" e "disconnect". 3. O nome de um único evento, por exemplo, "connect", corresponde a "connect". |
string |
hubPattern | Obtém ou define o padrão de correspondência para nomes de hub. Se não estiver definido, corresponde a qualquer hub. Existem 3 tipos de padrões suportados: 1. "*", corresponde a qualquer nome de hub. 2. Combine vários hubs com ",", por exemplo "hub1,hub2", ele corresponde a "hub1" e "hub2". 3. O nome de hub único, por exemplo, "hub1", corresponde a "hub1". |
string |
urlTemplate | Obtém ou define o modelo de URL Upstream. Você pode usar 3 parâmetros predefinidos {hub}, {category} {event} dentro do modelo, o valor da URL Upstream é calculado dinamicamente quando a solicitação do cliente chega. Por exemplo, se o urlTemplate estiver http://example.com/{hub}/api/{event} , com uma solicitação de cliente do hub chat se conectar, ele primeiro POST para esta URL: http://example.com/chat/api/connect . |
string (obrigatório) |
UserAssignedIdentityProperty
Designação | Descrição | Valor |
---|