Partilhar via

Microsoft.SignalRService signalR

  • Artigo

Definição de recurso do Bicep

O tipo de recurso signalR pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.SignalRService/signalR, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.SignalRService/signalR@2023-08-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    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
    }
    tls: {
      clientCertEnabled: bool
    }
    upstream: {
      templates: [
        {
          auth: {
            managedIdentity: {
              resource: 'string'
            }
            type: 'string'
          }
          categoryPattern: 'string'
          eventPattern: 'string'
          hubPattern: 'string'
          urlTemplate: 'string'
        }
      ]
    }
  }
}

Valores de propriedade

signalR

Nome Descrição Valor
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 3-63

Carateres válidos:
Alfanuméricos e hífenes.

Comece com a letra. Terminar com letra ou número.

O nome do recurso tem de ser exclusivo em todo o Azure.
localização A localização geográfica onde reside o recurso cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
sku As informações de faturação do recurso. ResourceSku
tipo O tipo de serviço 'RawWebSockets'
"SignalR"
identidade Uma classe representa identidades geridas utilizadas para pedido e resposta ManagedIdentity
propriedades Uma classe que descreve as propriedades do recurso SignalRProperties

ManagedIdentity

Nome Descrição Valor
tipo Representa o tipo de identidade: systemAssigned, userAssigned, None "Nenhum"
"SystemAssigned"
"UserAssigned"
userAssignedIdentities Obter ou definir as identidades atribuídas pelo utilizador ManagedIdentityUserAssignedIdentities

ManagedIdentityUserAssignedIdentities

Nome Descrição Valor
{customized property} UserAssignedIdentityProperty

UserAssignedIdentityProperty

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

SignalRProperties

Nome Descrição Valor
cors Definições de Partilha de Recursos transversais à Origem (CORS). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Ativar ou desativar a autenticação do aad
Quando definido como verdadeiro, a ligação com AuthType=aad não funcionará.		 bool
disableLocalAuth DisableLocalAuth
Ativar ou desativar a autenticação local com AccessKey
Quando definido como verdadeiro, a ligação com AccessKey=xxx não funcionará.		 bool
funcionalidades 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.
Além disso, a resposta incluirá apenas featureFlags que estão explicitamente definidos.
Quando uma featureFlag não está explicitamente definida, será utilizado o respetivo valor predefinido globalmente
No entanto, tenha em atenção que o valor predefinido não significa "falso". Varia em termos de FeatureFlags diferentes.		 SignalRFeature[]
liveTraceConfiguration Configuração de rastreio em direto de um recurso Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACLs de rede para o recurso SignalRNetworkACLs
publicNetworkAccess Ativar ou desativar o acesso à rede pública. A predefinição é "Ativado".
Quando estiver Ativado, as ACLs de rede continuam a ser aplicadas.
Quando está Desativado, o acesso à rede pública é sempre desativado independentemente do que definir nas ACLs de rede.		 string
regionEndpointEnabled Ativar ou desativar o ponto final regional. A predefinição é "Ativado".
Quando estiver Desativado, as novas ligações não serão encaminhadas para este ponto final, no entanto, as ligações existentes não serão afetadas.
Esta propriedade é específica da réplica. Não é permitido desativar o ponto final regional sem réplica.		 string
resourceLogConfiguration Configuração do registo de recursos de um recurso Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Pare ou inicie o recurso. Predefinição é "Falso".
Quando é verdade, o plano de dados do recurso é encerrado.
Quando for falso, o plano de dados do recurso é iniciado.		 string
sem servidor Definições sem servidor. ServerlessSettings
tls Definições de TLS para o recurso SignalRTlsSettings
a montante As definições para o Upstream quando o serviço está no modo sem servidor. ServerlessUpstreamSettings

SignalRCorsSettings

Nome Descrição Valor
allowedOrigins Obtém ou define a lista de origens que devem ser autorizadas a fazer chamadas entre origens (por exemplo: http://example.com:12345). Utilize "*" para permitir todos. Se for omitido, permita tudo por predefinição. string[]

SignalRFeature

Nome Descrição Valor
flag FeatureFlags são as funcionalidades suportadas do serviço Azure SignalR.
- ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Predefinição": tenha o seu próprio servidor de back-end; "Sem servidor": a aplicação não tem um servidor de back-end; "Clássico": para retrocompatibilidade. Suporte para o modo Predefinido e Sem Servidor, mas não recomendado; "PredefinedOnly": para utilização futura.
- EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente.
- EnableMessagingLogs: "true"/"false", para ativar/desativar a categoria do registo de conectividade, respetivamente.
- EnableLiveTrace: o Rastreio Em Direto permite-lhe saber o que está a acontecer dentro do serviço Azure SignalR, irá dar-lhe rastreios em tempo real, será útil quando desenvolver a sua própria aplicação Web baseada no Azure SignalR ou resolver automaticamente alguns problemas. Tenha em atenção que os rastreios dinâmicos são contabilizados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para ativar/desativar a funcionalidade de rastreio dinâmico.		 "EnableConnectivityLogs"
"EnableLiveTrace"
"EnableMessagingLogs"
"ServiceMode" (obrigatório)
propriedades Propriedades opcionais relacionadas com esta funcionalidade. SignalRFeatureProperties
valor Valor do sinalizador de funcionalidade. Veja o documento https://docs.microsoft.com/azure/azure-signalr/ do serviço Azure SignalR para obter os valores permitidos. cadeia (obrigatório)

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 128

SignalRFeatureProperties

Nome Descrição Valor
{customized property} string

LiveTraceConfiguration

Nome Descrição Valor
categories Obtém ou define a lista de configurações de categorias. LiveTraceCategory[]
ativado Indica se ativa ou não o rastreio em direto.
Quando estiver definido como verdadeiro, o cliente de rastreio em direto pode ligar-se ao serviço.
Caso contrário, o cliente de rastreio dinâmico não consegue ligar-se ao serviço, pelo que não pode receber qualquer registo, independentemente do que configurar em "categorias".
Valores disponíveis: true, false.
Não sensível a maiúsculas e minúsculas
 string

LiveTraceCategory

Nome Descrição Valor
ativado Indica se ou a categoria de rastreio dinâmico está ativada.
Valores disponíveis: verdadeiro, falso.
Não sensível a maiúsculas e minúsculas		 string
name Obtém ou define o nome da categoria de rastreio dinâmico.
Valores disponíveis: ConnectivityLogs, MessagingLogs.
Não sensível a maiúsculas e minúsculas
 string

SignalRNetworkACLs

Nome Descrição Valor
defaultAction Ação ACL de Rede do Azure. "Permitir"
'Negar'
ipRules Regras de IP para filtrar o tráfego público IPRule[]

Restrições:
Comprimento máximo = 30
privateEndpoints ACLs para pedidos de pontos finais privados PrivateEndpointACL[]
publicNetwork ACL de Rede RedeACL

IPRule

Nome Descrição Valor
action Ação ACL de Rede do Azure. "Permitir"
'Negar'
valor Um IP, CIDR ou ServiceTag string

PrivateEndpointACL

Nome Descrição Valor
permitir Tipos de pedido permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeias que contém qualquer um dos seguintes:
"ClientConnection"
"RESTAPI"
"ServerConnection"
'Trace'
negar Tipos de pedido negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeias que contém qualquer um dos seguintes:
"ClientConnection"
"RESTAPI"
"ServerConnection"
'Trace'
name Nome da ligação de ponto final privado cadeia (obrigatório)

RedeACL

Nome Descrição Valor
permitir Tipos de pedido permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeias que contém qualquer um dos seguintes:
"ClientConnection"
"RESTAPI"
"ServerConnection"
'Trace'
negar Tipos de pedido negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeias que contém qualquer um dos seguintes:
"ClientConnection"
"RESTAPI"
"ServerConnection"
'Trace'

ResourceLogConfiguration

Nome Descrição Valor
categories Obtém ou define a lista de configurações de categorias. ResourceLogCategory[]

ResourceLogCategory

Nome Descrição Valor
ativado Indica se ou a categoria de registo de recursos está ativada.
Valores disponíveis: verdadeiro, falso.
Não sensível a maiúsculas e minúsculas		 string
name Obtém ou define o nome da categoria de registo de recursos.
Valores disponíveis: ConnectivityLogs, MessagingLogs.
Não sensível a maiúsculas e minúsculas
 string

ServerlessSettings

Nome Descrição Valor
connectionTimeoutInSeconds Obtém ou define o Tempo Limite da Ligação do Cliente. Opcional para ser definido.
Valor em segundos.
O valor predefinido é de 30 segundos.
O cliente deve definir o tempo limite para um período mais curto se se esperar que as mensagens sejam enviadas em intervalos mais curtos,
e quer que o cliente desligue mais rapidamente após o envio da última mensagem.
Pode definir o tempo limite para um período mais longo se se esperar que as mensagens sejam enviadas em intervalos mais longos,
e querem manter viva a mesma ligação de cliente durante esta sessão.
O serviço considera o cliente desligado se não tiver recebido uma mensagem (incluindo keep-alive) neste intervalo.
 int

Restrições:
Valor mínimo = 1
Valor máximo = 120

SignalRTlsSettings

Nome Descrição Valor
clientCertEnabled Peça o certificado de cliente durante o handshake do TLS, se estiver ativado. Não suportado para o escalão gratuito. Qualquer entrada será ignorada para o escalão gratuito. bool

ServerlessUpstreamSettings

Nome Descrição Valor
modelos Obtém ou define a lista de modelos de URL a Montante. A ordem é importante e o primeiro modelo correspondente tem efeitos. UpstreamTemplate[]

UpstreamTemplate

Nome Descrição Valor
autenticação Definições de autenticação a montante. Se não estiver definido, nenhuma autenticação é utilizada para mensagens a montante. UpstreamAuthSettings
categoryPattern Obtém ou define o padrão correspondente para nomes de categorias. Se não estiver definido, corresponde a qualquer categoria.
Existem três tipos de padrões suportados:
1. "*", corresponde a qualquer nome de categoria.
2. Combine várias categorias com "", por exemplo "ligações, mensagens", corresponde à categoria "ligações" e "mensagens".
3. O nome de categoria única, por exemplo, "ligações", corresponde à categoria "ligações".		 string
eventPattern Obtém ou define o padrão correspondente para nomes de eventos. Se não estiver definido, corresponde a qualquer evento.
Existem três tipos de padrões suportados:
1. "*", corresponde a qualquer nome de evento.
2. Combine vários eventos com "", por exemplo "ligar,desligar", corresponde ao evento "ligar" e "desligar".
3. O nome de evento único, por exemplo, "ligar", corresponde a "ligar".		 string
hubPattern Obtém ou define o padrão correspondente para os nomes dos hubs. Se não estiver definido, corresponde a qualquer hub.
Existem três tipos de padrões suportados:
1. "*", corresponde a qualquer nome do hub.
2. Combine vários hubs com "", por exemplo "hub1,hub2", corresponde a "hub1" e "hub2".
3. O nome do hub único, por exemplo, "hub1", corresponde a "hub1".		 string
urlTemplate Obtém ou define o modelo de URL a Montante. Pode utilizar 3 parâmetros predefinidos {hub}, {category} {event} dentro do modelo, o valor do URL a Montante é calculado dinamicamente quando o pedido de cliente entra.
Por exemplo, se o urlTemplate for http://example.com/{hub}/api/{event}, com um pedido de cliente do hub chat ligado, será primeiro POST para este URL: http://example.com/chat/api/connect.
 cadeia (obrigatório)

UpstreamAuthSettings

Nome Descrição Valor
managedIdentity Definições de identidade geridas para a montante. ManagedIdentitySettings
tipo Enum tipo de autenticação a montante. "ManagedIdentity"
"Nenhum"

ManagedIdentitySettings

Nome Descrição Valor
recurso O Recurso que indica o URI do ID da Aplicação do recurso de destino.
Também aparece na afirmação aud (audiência) do token emitido.
 string

ResourceSku

Nome Descrição Valor
capacidade Opcional, número inteiro. A contagem de unidades do recurso. 1 por predefinição.

Se estiverem presentes, são permitidos os seguintes valores:
Gratuito: 1;
Padrão: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;		 int
name O nome do SKU. Obrigatório.

Valores permitidos: Standard_S1, Free_F1, Premium_P1		 cadeia (obrigatório)
tier Camada opcional deste SKU específico. "Standard" ou "Gratuito".

Basic foi preterido, utilize Standard em vez disso.
 "Básico"
'Gratuito'
"Premium"
'Standard'

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Implementar um serviço Azure SignalR

Implementar no Azure		 Este modelo cria uma Azure SignalR Service com um modelo.

Definição de recurso do modelo arm

O tipo de recurso signalR pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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": "2023-08-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "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"
    },
    "tls": {
      "clientCertEnabled": "bool"
    },
    "upstream": {
      "templates": [
        {
          "auth": {
            "managedIdentity": {
              "resource": "string"
            },
            "type": "string"
          },
          "categoryPattern": "string",
          "eventPattern": "string",
          "hubPattern": "string",
          "urlTemplate": "string"
        }
      ]
    }
  }
}

Valores de propriedade

signalR

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.SignalRService/signalR"
apiVersion A versão da API de recursos '2023-08-01-preview'
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 3-63

Carateres válidos:
Alfanuméricos e hífenes.

Comece com a letra. Terminar com letra ou número.

O nome do recurso tem de ser exclusivo em todo o Azure.
localização A localização geográfica onde reside o recurso cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
sku As informações de faturação do recurso. ResourceSku
tipo O tipo de serviço 'RawWebSockets'
"SignalR"
identidade Uma classe representa identidades geridas utilizadas para pedido e resposta ManagedIdentity
propriedades Uma classe que descreve as propriedades do recurso SignalRProperties

ManagedIdentity

Nome Descrição Valor
tipo Representa o tipo de identidade: systemAssigned, userAssigned, None "Nenhum"
"SystemAssigned"
"UserAssigned"
userAssignedIdentities Obter ou definir as identidades atribuídas pelo utilizador ManagedIdentityUserAssignedIdentities

ManagedIdentityUserAssignedIdentities

Nome Descrição Valor
{customized property} UserAssignedIdentityProperty

UserAssignedIdentityProperty

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

SignalRProperties

Nome Descrição Valor
cors Definições de Partilha de Recursos entre Origens (CORS). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Ativar ou desativar a autenticação do aad
Quando definido como verdadeiro, a ligação com AuthType=aad não funciona.		 bool
disableLocalAuth DisableLocalAuth
Ativar ou desativar a autenticação local com o AccessKey
Quando definido como verdadeiro, a ligação com AccessKey=xxx não funcionará.		 bool
funcionalidades Lista da funcionalidadeFlags.

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 que estão explicitamente definidos.
Quando uma funcionalidadeFlag não estiver explicitamente definida, será utilizado o respetivo valor predefinido globalmente
No entanto, tenha em atenção que o valor predefinido não significa "falso". Varia em termos de FeatureFlags diferentes.		 SignalRFeature[]
liveTraceConfiguration Configuração de rastreio dinâmico de um recurso Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACLs de rede para o recurso SignalRNetworkACLs
publicNetworkAccess Ativar ou desativar o acesso à rede pública. Predefinição para "Ativado".
Quando estiver Ativado, as ACLs de rede ainda se aplicam.
Quando está Desativado, o acesso à rede pública é sempre desativado independentemente do que definir em ACLs de rede.		 string
regionEndpointEnabled Ative ou desative o ponto final regional. Predefinição para "Ativado".
Quando estiver Desativado, as novas ligações não serão encaminhadas para este ponto final, no entanto, as ligações existentes não serão afetadas.
Esta propriedade é específica da réplica. Não é permitido desativar o ponto final regional sem réplica.		 string
resourceLogConfiguration Configuração do registo de recursos de um recurso Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Pare ou inicie o recurso. Predefinição para "Falso".
Quando é verdade, o plano de dados do recurso é encerrado.
Quando for falso, o plano de dados do recurso é iniciado.		 string
sem servidor Definições sem servidor. ServerlessSettings
tls Definições de TLS para o recurso SignalRTlsSettings
a montante As definições do Upstream quando o serviço está no modo sem servidor. ServerlessUpstreamSettings

SignalRCorsSettings

Nome Descrição Valor
allowedOrigins Obtém ou define a lista de origens que devem ser autorizadas a fazer chamadas entre origens (por exemplo: http://example.com:12345). Utilize "*" para permitir tudo. Se omitido, aguarde tudo por predefinição. cadeia[]

SignalRFeature

Nome Descrição Valor
flag FeatureFlags são as funcionalidades suportadas do serviço Azure SignalR.
- ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Predefinição": tenha o seu próprio servidor de back-end; "Sem servidor": a sua aplicação não tem um servidor de back-end; "Clássico": para retrocompatibilidade. Suporte para o modo Predefinido e Sem Servidor, mas não recomendado; "PredefinedOnly": para utilização futura.
- EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente.
- EnableMessagingLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente.
- EnableLiveTrace: o Rastreio Em Direto permite-lhe saber o que está a acontecer dentro do serviço Azure SignalR, irá fornecer-lhe rastreios dinâmicos em tempo real. Será útil ao desenvolver a sua própria aplicação Web baseada no Azure SignalR ou resolver automaticamente alguns problemas. Tenha em atenção que os rastreios em direto são contados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para ativar/desativar a funcionalidade de rastreio dinâmico.		 "EnableConnectivityLogs"
"EnableLiveTrace"
"EnableMessagingLogs"
"ServiceMode" (obrigatório)
propriedades Propriedades opcionais relacionadas com esta funcionalidade. SignalRFeatureProperties
valor Valor do sinalizador de funcionalidade. Veja o documento https://docs.microsoft.com/azure/azure-signalr/ do serviço Azure SignalR para obter os valores permitidos. cadeia (obrigatório)

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 128

SignalRFeatureProperties

Nome Descrição Valor
{customized property} string

LiveTraceConfiguration

Nome Descrição Valor
categories Obtém ou define a lista de configurações de categorias. LiveTraceCategory[]
ativado Indica se ativa ou não o rastreio em direto.
Quando estiver definido como verdadeiro, o cliente de rastreio dinâmico pode ligar-se ao serviço.
Caso contrário, o cliente de rastreio dinâmico não consegue ligar-se ao serviço, pelo que não pode receber qualquer registo, independentemente do que configurar em "categorias".
Valores disponíveis: verdadeiro, falso.
Não sensível a maiúsculas e minúsculas
 string

LiveTraceCategory

Nome Descrição Valor
ativado Indica se ou a categoria de rastreio dinâmico está ativada.
Valores disponíveis: verdadeiro, falso.
Não sensível a maiúsculas e minúsculas		 string
name Obtém ou define o nome da categoria de rastreio dinâmico.
Valores disponíveis: ConnectivityLogs, MessagingLogs.
Não sensível a maiúsculas e minúsculas
 string

SignalRNetworkACLs

Nome Descrição Valor
defaultAction Ação ACL de Rede do Azure. "Permitir"
'Negar'
ipRules Regras de IP para filtrar o tráfego público IPRule[]

Restrições:
Comprimento máximo = 30
privateEndpoints ACLs para pedidos de pontos finais privados PrivateEndpointACL[]
publicNetwork ACL de Rede RedeACL

IPRule

Nome Descrição Valor
action Ação ACL de Rede do Azure. "Permitir"
'Negar'
valor Um IP, CIDR ou ServiceTag string

PrivateEndpointACL

Nome Descrição Valor
permitir Tipos de pedido permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeias que contém qualquer um dos seguintes:
"ClientConnection"
"RESTAPI"
"ServerConnection"
'Trace'
negar Tipos de pedido negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeias que contém qualquer um dos seguintes:
"ClientConnection"
"RESTAPI"
"ServerConnection"
'Trace'
name Nome da ligação de ponto final privado cadeia (obrigatório)

RedeACL

Nome Descrição Valor
permitir Tipos de pedido permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeias que contém qualquer um dos seguintes:
"ClientConnection"
"RESTAPI"
"ServerConnection"
'Trace'
negar Tipos de pedido negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeias que contém qualquer um dos seguintes:
"ClientConnection"
"RESTAPI"
"ServerConnection"
'Trace'

ResourceLogConfiguration

Nome Descrição Valor
categories Obtém ou define a lista de configurações de categorias. ResourceLogCategory[]

ResourceLogCategory

Nome Descrição Valor
ativado Indica se ou a categoria de registo de recursos está ativada.
Valores disponíveis: true, false.
Não sensível a maiúsculas e minúsculas		 string
name Obtém ou define o nome da categoria de registo de recursos.
Valores disponíveis: ConnectivityLogs, MessagingLogs.
Não sensível a maiúsculas e minúsculas
 string

ServerlessSettings

Nome Descrição Valor
connectionTimeoutInSeconds Obtém ou define o Tempo Limite da Ligação do Cliente. Opcional a ser definido.
Valor em segundos.
O valor predefinido é 30 segundos.
O cliente deve definir o tempo limite para um período mais curto se se esperar que as mensagens sejam enviadas em intervalos mais curtos,
e quer que o cliente desligue mais rapidamente após o envio da última mensagem.
Pode definir o tempo limite para um período mais longo se se esperar que as mensagens sejam enviadas em intervalos mais longos,
e querem manter viva a mesma ligação de cliente durante esta sessão.
O serviço considera o cliente desligado se não tiver recebido uma mensagem (incluindo keep-alive) neste intervalo.
 int

Restrições:
Valor mínimo = 1
Valor máximo = 120

SignalRTlsSettings

Nome Descrição Valor
clientCertEnabled Peça o certificado de cliente durante o handshake TLS, se estiver ativado. Não suportado para o escalão gratuito. Qualquer entrada será ignorada para o escalão gratuito. bool

ServerlessUpstreamSettings

Nome Descrição Valor
modelos Obtém ou define a lista de modelos de URL a montante. A ordem é importante e o primeiro modelo correspondente tem efeitos. UpstreamTemplate[]

UpstreamTemplate

Nome Descrição Valor
autenticação Definições de autenticação a montante. Se não estiver definido, não será utilizada nenhuma autenticação para mensagens a montante. UpstreamAuthSettings
categoryPattern Obtém ou define o padrão correspondente para nomes de categorias. Se não estiver definido, corresponde a qualquer categoria.
Existem três tipos de padrões suportados:
1. "*", corresponde a qualquer nome de categoria.
2. Combine múltiplas categorias com "", por exemplo "ligações,mensagens", corresponde às categorias "ligações" e "mensagens".
3. O nome de categoria única, por exemplo, "ligações", corresponde à categoria "ligações".		 string
eventPattern Obtém ou define o padrão correspondente para nomes de eventos. Se não estiver definido, corresponde a qualquer evento.
Existem três tipos de padrões suportados:
1. "*", corresponde a qualquer nome de evento.
2. Combine vários eventos com ",", por exemplo "ligar,desligar", corresponde ao evento "ligar" e "desligar".
3. O nome do evento único, por exemplo, "ligar", corresponde a "ligar".		 string
hubPattern Obtém ou define o padrão correspondente para os nomes dos hubs. Se não estiver definido, corresponde a qualquer hub.
Existem três tipos de padrões suportados:
1. "*", corresponde a qualquer nome do hub.
2. Combine vários hubs com ",", por exemplo "hub1,hub2", corresponde a "hub1" e "hub2".
3. O nome do hub único, por exemplo, "hub1", corresponde a "hub1".		 string
urlTemplate Obtém ou define o modelo de URL a montante. Pode utilizar 3 parâmetros predefinidos {hub}, {category} {event} dentro do modelo. O valor do URL a Montante é calculado dinamicamente quando o pedido de cliente é recebido.
Por exemplo, se o urlTemplate for http://example.com/{hub}/api/{event}, com um pedido de cliente do hub chat ligado, será primeiro POST para este URL: http://example.com/chat/api/connect.
 cadeia (obrigatório)

UpstreamAuthSettings

Nome Descrição Valor
managedIdentity Definições de identidade gerida para o upstream. ManagedIdentitySettings
tipo Enumeração do tipo de autenticação a montante. 'ManagedIdentity'
"Nenhum"

ManagedIdentitySettings

Nome Descrição Valor
recurso O Recurso que indica o URI do ID da Aplicação do recurso de destino.
Também aparece na afirmação aud (audiência) do token emitido.
 string

ResourceSku

Nome Descrição Valor
capacidade Opcional, número inteiro. A contagem de unidades do recurso. 1 por predefinição.

Se estiverem presentes, são permitidos os seguintes valores:
Gratuito: 1;
Padrão: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;		 int
name O nome do SKU. Obrigatório.

Valores permitidos: Standard_S1, Free_F1, Premium_P1		 cadeia (obrigatório)
tier Camada opcional deste SKU específico. "Standard" ou "Gratuito".

Basic foi preterido, utilize Standard em vez disso.
 "Básico"
'Gratuito'
"Premium"
'Standard'

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Implementar um serviço Azure SignalR

Implementar no Azure		 Este modelo cria uma Azure SignalR Service com um modelo.

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso signalR pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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@2023-08-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      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
      }
      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"
    }
    kind = "string"
  })
}

Valores de propriedade

signalR

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.SignalRService/signalR@2023-08-01-preview"
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 3-63

Carateres válidos:
Alfanuméricos e hífenes.

Comece com a letra. Terminar com letra ou número.

O nome do recurso tem de ser exclusivo em todo o Azure.
localização A localização geográfica onde reside o recurso cadeia (obrigatório)
parent_id Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas.
sku As informações de faturação do recurso. ResourceSku
tipo O tipo de serviço "RawWebSockets"
"SignalR"
identidade Uma classe representa identidades geridas utilizadas para pedido e resposta ManagedIdentity
propriedades Uma classe que descreve as propriedades do recurso SignalRProperties

ManagedIdentity

Nome Descrição Valor
tipo Representa o tipo de identidade: systemAssigned, userAssigned, None "SystemAssigned"
"UserAssigned"
identity_ids Obter ou definir as identidades atribuídas pelo utilizador Matriz de IDs de identidade de utilizador.

ManagedIdentityUserAssignedIdentities

Nome Descrição Valor
{customized property} UserAssignedIdentityProperty

UserAssignedIdentityProperty

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

SignalRProperties

Nome Descrição Valor
cors Definições de Partilha de Recursos entre Origens (CORS). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Ativar ou desativar a autenticação do aad
Quando definido como verdadeiro, a ligação com AuthType=aad não funciona.		 bool
disableLocalAuth DisableLocalAuth
Ativar ou desativar a autenticação local com o AccessKey
Quando definido como verdadeiro, a ligação com AccessKey=xxx não funcionará.		 bool
funcionalidades Lista da funcionalidadeFlags.

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 que estão explicitamente definidos.
Quando uma funcionalidadeFlag não estiver explicitamente definida, será utilizado o respetivo valor predefinido globalmente
No entanto, tenha em atenção que o valor predefinido não significa "falso". Varia em termos de FeatureFlags diferentes.		 SignalRFeature[]
liveTraceConfiguration Configuração de rastreio dinâmico de um recurso Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACLs de rede para o recurso SignalRNetworkACLs
publicNetworkAccess Ativar ou desativar o acesso à rede pública. Predefinição para "Ativado".
Quando estiver Ativado, as ACLs de rede ainda se aplicam.
Quando está Desativado, o acesso à rede pública é sempre desativado independentemente do que definir em ACLs de rede.		 string
regionEndpointEnabled Ative ou desative o ponto final regional. Predefinição para "Ativado".
Quando estiver Desativado, as novas ligações não serão encaminhadas para este ponto final, no entanto, as ligações existentes não serão afetadas.
Esta propriedade é específica da réplica. Não é permitido desativar o ponto final regional sem réplica.		 string
resourceLogConfiguration Configuração do registo de recursos de um recurso Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Pare ou inicie o recurso. Predefinição para "Falso".
Quando é verdade, o plano de dados do recurso é encerrado.
Quando for falso, o plano de dados do recurso é iniciado.		 string
sem servidor Definições sem servidor. ServerlessSettings
tls Definições de TLS para o recurso SignalRTlsSettings
a montante As definições do Upstream quando o serviço está no modo sem servidor. ServerlessUpstreamSettings

SignalRCorsSettings

Nome Descrição Valor
allowedOrigins Obtém ou define a lista de origens que devem ser autorizadas a fazer chamadas entre origens (por exemplo: http://example.com:12345). Utilize "*" para permitir tudo. Se omitido, aguarde tudo por predefinição. cadeia[]

SignalRFeature

Nome Descrição Valor
flag FeatureFlags são as funcionalidades suportadas do serviço Azure SignalR.
- ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Predefinição": tenha o seu próprio servidor de back-end; "Sem servidor": a sua aplicação não tem um servidor de back-end; "Clássico": para retrocompatibilidade. Suporte para o modo Predefinido e Sem Servidor, mas não recomendado; "PredefinedOnly": para utilização futura.
- EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente.
- EnableMessagingLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente.
- EnableLiveTrace: o Rastreio Em Direto permite-lhe saber o que está a acontecer dentro do serviço Azure SignalR, irá fornecer-lhe rastreios dinâmicos em tempo real. Será útil ao desenvolver a sua própria aplicação Web baseada no Azure SignalR ou resolver automaticamente alguns problemas. Tenha em atenção que os rastreios em direto são contados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para ativar/desativar a funcionalidade de rastreio dinâmico.		 "EnableConnectivityLogs"
"EnableLiveTrace"
"EnableMessagingLogs"
"ServiceMode" (obrigatório)
propriedades Propriedades opcionais relacionadas com esta funcionalidade. SignalRFeatureProperties
valor Valor do sinalizador de funcionalidade. Veja o documento https://docs.microsoft.com/azure/azure-signalr/ do serviço Azure SignalR para obter os valores permitidos. cadeia (obrigatório)

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 128

SignalRFeatureProperties

Nome Descrição Valor
{customized property} string

LiveTraceConfiguration

Nome Descrição Valor
categories Obtém ou define a lista de configurações de categorias. LiveTraceCategory[]
ativado Indica se ativa ou não o rastreio em direto.
Quando estiver definido como verdadeiro, o cliente de rastreio em direto pode ligar-se ao serviço.
Caso contrário, o cliente de rastreio dinâmico não consegue ligar-se ao serviço, pelo que não pode receber qualquer registo, independentemente do que configurar em "categorias".
Valores disponíveis: true, false.
Não sensível a maiúsculas e minúsculas
 string

LiveTraceCategory

Nome Descrição Valor
ativado Indica se ou a categoria de rastreio dinâmico está ativada.
Valores disponíveis: true, false.
Não sensível a maiúsculas e minúsculas		 string
name Obtém ou define o nome da categoria de rastreio dinâmico.
Valores disponíveis: ConnectivityLogs, MessagingLogs.
Não sensível a maiúsculas e minúsculas
 string

SignalRNetworkACLs

Nome Descrição Valor
defaultAction Ação da ACL de Rede do Azure. "Permitir"
"Negar"
ipRules Regras de IP para filtrar o tráfego público IPRule[]

Restrições:
Comprimento máximo = 30
privateEndpoints ACLs para pedidos de pontos finais privados PrivateEndpointACL[]
publicNetwork ACL de Rede NetworkACL

IPRule

Nome Descrição Valor
action Ação da ACL de Rede do Azure. "Permitir"
"Negar"
valor Um IP, CIDR ou ServiceTag string

PrivateEndpointACL

Nome Descrição Valor
permitir Tipos de pedido permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeia que contém qualquer um dos seguintes:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Rastreio"
negar Tipos de pedido negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeia que contém qualquer um dos seguintes:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Rastreio"
name Nome da ligação de ponto final privado cadeia (obrigatório)

NetworkACL

Nome Descrição Valor
permitir Tipos de pedido permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeia que contém qualquer um dos seguintes:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Rastreio"
negar Tipos de pedido negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeia que contém qualquer um dos seguintes:
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Rastreio"

ResourceLogConfiguration

Nome Descrição Valor
categories Obtém ou define a lista de configurações de categorias. ResourceLogCategory[]

ResourceLogCategory

Nome Descrição Valor
ativado Indica se ou a categoria de registo de recursos está ativada.
Valores disponíveis: true, false.
Não sensível a maiúsculas e minúsculas		 string
name Obtém ou define o nome da categoria de registo de recursos.
Valores disponíveis: ConnectivityLogs, MessagingLogs.
Não sensível a maiúsculas e minúsculas
 string

ServerlessSettings

Nome Descrição Valor
connectionTimeoutInSeconds Obtém ou define o Tempo Limite da Ligação do Cliente. Opcional a ser definido.
Valor em segundos.
O valor predefinido é 30 segundos.
O cliente deve definir o tempo limite para um período mais curto se se esperar que as mensagens sejam enviadas em intervalos mais curtos,
e quer que o cliente desligue mais rapidamente após o envio da última mensagem.
Pode definir o tempo limite para um período mais longo se se esperar que as mensagens sejam enviadas em intervalos mais longos,
e querem manter viva a mesma ligação de cliente durante esta sessão.
O serviço considera o cliente desligado se não tiver recebido uma mensagem (incluindo keep-alive) neste intervalo.
 int

Restrições:
Valor mínimo = 1
Valor máximo = 120

SignalRTlsSettings

Nome Descrição Valor
clientCertEnabled Peça o certificado de cliente durante o handshake TLS, se estiver ativado. Não suportado para o escalão gratuito. Qualquer entrada será ignorada para o escalão gratuito. bool

ServerlessUpstreamSettings

Nome Descrição Valor
modelos Obtém ou define a lista de modelos de URL a montante. A ordem é importante e o primeiro modelo correspondente tem efeitos. UpstreamTemplate[]

UpstreamTemplate

Nome Descrição Valor
autenticação Definições de autenticação a montante. Se não estiver definido, não será utilizada nenhuma autenticação para mensagens a montante. UpstreamAuthSettings
categoryPattern Obtém ou define o padrão correspondente para nomes de categorias. Se não estiver definido, corresponde a qualquer categoria.
Existem três tipos de padrões suportados:
1. "*", corresponde a qualquer nome de categoria.
2. Combine múltiplas categorias com "", por exemplo "ligações,mensagens", corresponde às categorias "ligações" e "mensagens".
3. O nome de categoria única, por exemplo, "ligações", corresponde à categoria "ligações".		 string
eventPattern Obtém ou define o padrão correspondente para nomes de eventos. Se não estiver definido, corresponde a qualquer evento.
Existem três tipos de padrões suportados:
1. "*", corresponde a qualquer nome de evento.
2. Combine vários eventos com ",", por exemplo "ligar,desligar", corresponde ao evento "ligar" e "desligar".
3. O nome do evento único, por exemplo, "ligar", corresponde a "ligar".		 string
hubPattern Obtém ou define o padrão correspondente para os nomes dos hubs. Se não estiver definido, corresponde a qualquer hub.
Existem três tipos de padrões suportados:
1. "*", corresponde a qualquer nome do hub.
2. Combine vários hubs com "", por exemplo "hub1,hub2", corresponde a "hub1" e "hub2".
3. O nome do hub único, por exemplo, "hub1", corresponde a "hub1".		 string
urlTemplate Obtém ou define o modelo de URL a Montante. Pode utilizar 3 parâmetros predefinidos {hub}, {category} {event} dentro do modelo, o valor do URL a Montante é calculado dinamicamente quando o pedido de cliente entra.
Por exemplo, se o urlTemplate for http://example.com/{hub}/api/{event}, com um pedido de cliente do hub chat ligado, será primeiro POST para este URL: http://example.com/chat/api/connect.
 cadeia (obrigatório)

UpstreamAuthSettings

Nome Descrição Valor
managedIdentity Definições de identidade geridas para a montante. ManagedIdentitySettings
tipo Enum tipo de autenticação a montante. "ManagedIdentity"
"Nenhum"

ManagedIdentitySettings

Nome Descrição Valor
recurso O Recurso que indica o URI do ID da Aplicação do recurso de destino.
Também aparece na afirmação aud (audiência) do token emitido.
 string

ResourceSku

Nome Descrição Valor
capacidade Opcional, número inteiro. A contagem de unidades do recurso. 1 por predefinição.

Se estiverem presentes, são permitidos os seguintes valores:
Gratuito: 1;
Padrão: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;		 int
name O nome do SKU. Obrigatório.

Valores permitidos: Standard_S1, Free_F1, Premium_P1		 cadeia (obrigatório)
tier Camada opcional deste SKU específico. "Standard" ou "Gratuito".

Basic é preterido, utilize Standard em vez disso.
 "Básico"
"Gratuito"
"Premium"
"Standard"