Compartilhar via

Microsoft.SignalRService signalR 2024-01-01-preview

  • Artigo

Definição de recurso do Bicep

O tipo de recurso signalR pode ser implantado com operações de destino:

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

Formato de recurso

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

resource symbolicname 'Microsoft.SignalRService/signalR@2024-01-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

IPRule

Nome Descrição Valor
ação Ação acl de rede do Azure. 'Permitir'
'Negar'
valor Um IP ou CIDR ou ServiceTag corda

LiveTraceCategory

Nome Descrição Valor
Habilitado Indica se ou a categoria de rastreamento dinâmico está habilitada.
Valores disponíveis: true, false.
Não diferencia maiúsculas de minúsculas.		 corda
nome Obtém ou define o nome da categoria de rastreamento ao vivo.
Valores disponíveis: ConnectivityLogs, MessagingLogs.
Não diferencia maiúsculas de minúsculas.		 corda

LiveTraceConfiguration

Nome Descrição Valor
Categorias Obtém ou define a lista de configurações de categoria. LiveTraceCategory []
Habilitado Indica se habilitar ou não o rastreamento dinâmico.
Quando ele é definido como true, o cliente de rastreamento dinâmico pode se conectar ao serviço.
Caso contrário, o cliente de rastreamento dinâmico não poderá se conectar ao serviço, de modo que você não possa receber nenhum log, independentemente do que você configurar em "categorias".
Valores disponíveis: true, false.
Não diferencia maiúsculas de minúsculas.		 corda

ManagedIdentity

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

ManagedIdentitySettings

Nome Descrição Valor
recurso O recurso que indica o URI da ID do aplicativo do recurso de destino.
Ele também aparece na declaração aud (audience) do token emitido.		 corda

ManagedIdentityUserAssignedIdentities

Nome Descrição Valor

Microsoft.SignalRService/signalR

Nome Descrição Valor
identidade Uma classe representa identidades gerenciadas usadas para solicitação e resposta ManagedIdentity
tipo O tipo do serviço 'RawWebSockets'
'SignalR'
localização A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 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 cobrança do recurso. do ResourceSku
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

NetworkACL

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

PrivateEndpointACL

Nome Descrição Valor
permitir Tipos de solicitação permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeia de caracteres que contém qualquer um dos:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
negar Tipos de solicitação negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeia de caracteres que contém qualquer um dos:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nome Nome da conexão de ponto de extremidade privado cadeia de caracteres (obrigatório)

ResourceLogCategory

Nome Descrição Valor
Habilitado Indica se ou a categoria de log de recursos está habilitada.
Valores disponíveis: true, false.
Não diferencia maiúsculas de minúsculas.		 corda
nome Obtém ou define o nome da categoria do log de recursos.
Valores disponíveis: ConnectivityLogs, MessagingLogs.
Não diferencia maiúsculas de minúsculas.		 corda

ResourceLogConfiguration

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

ResourceSku

Nome Descrição Valor
capacidade Opcional, inteiro. A contagem de unidades do recurso.
1 para Free_F1/Standard_S1/Premium_P1, 100 para Premium_P2 por padrão.

Se estiverem presentes, os seguintes valores serão permitidos:
Free_F1: 1;
Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90.100;
Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90.100;
Premium_P2: 100.200.300.400.500.600.700.800.900.1000;		 int
nome O nome da SKU. Necessário.

Valores permitidos: Standard_S1, Free_F1, Premium_P1 Premium_P2		 cadeia de caracteres (obrigatório)
camada Camada opcional deste SKU específico. 'Standard' ou 'Free'.

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

ServerlessSettings

Nome Descrição Valor
connectionTimeoutInSeconds Obtém ou define o tempo limite de conexão do cliente. Opcional a ser definido.
Valor em segundos.
O valor padrão é 30 segundos.
O cliente deve definir o tempo limite para um período mais curto se as mensagens forem enviadas em intervalos mais curtos,
e deseja que o cliente se desconecte mais rapidamente após o envio da última mensagem.
Você pode definir o tempo limite para um período mais longo se espera-se que as mensagens sejam enviadas em intervalos mais longos,
e eles querem manter a mesma conexão de cliente ativa durante esta sessão.
O serviço considerará o cliente desconectado se ele não tiver recebido uma mensagem (incluindo manter-se ativo) nesse intervalo.		 int

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

ServerlessUpstreamSettings

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

SignalRCorsSettings

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

SignalRFeature

Nome Descrição Valor
bandeira FeatureFlags são os recursos com suporte do serviço do Azure SignalR.
- ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Padrão": tenha seu próprio servidor de back-end; "Sem servidor": seu aplicativo não tem um servidor de back-end; "Clássico": para compatibilidade com versões anteriores. Suporte ao modo padrão e sem servidor, mas não recomendado; "PredefinedOnly": para uso futuro.
- EnableConnectivityLogs: "true"/"false", para habilitar/desabilitar a categoria de log de conectividade, respectivamente.
- EnableMessagingLogs: "true"/"false", para habilitar/desabilitar a categoria de log de conectividade, respectivamente.
- EnableLiveTrace: Live Trace permite que você saiba o que está acontecendo dentro do serviço do Azure SignalR, ele fornecerá rastreamentos dinâmicos em tempo real, será útil ao desenvolver seu próprio aplicativo Web baseado no Azure SignalR ou solucionar alguns problemas. Observe que os rastreamentos dinâmicos são contados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para habilitar/desabilitar o recurso de rastreamento dinâmico.		 'EnableConnectivityLogs'
'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 valores permitidos. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)

SignalRFeatureProperties

Nome Descrição Valor

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 []
privateEndpoints ACLs para solicitações de pontos de extremidade privados PrivateEndpointACL []
publicNetwork ACL de rede NetworkACL

SignalRProperties

Nome Descrição Valor
cors Configurações de CORS (Compartilhamento de Recursos entre Origens). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Habilitar ou desabilitar a autenticação do aad
Quando definido como true, a conexão com AuthType=aad não funcionará.		 Bool
disableLocalAuth DisableLocalAuth
Habilitar ou desabilitar a autenticação local com o AccessKey
Quando definido como true, a conexão com AccessKey=xxx não funcionará.		 Bool
Características Lista de featureFlags.

FeatureFlags que não estão incluídos nos parâmetros da operação de atualização não serão modificados.
E a resposta incluirá apenas featureFlags definidos explicitamente.
Quando um featureFlag não for definido explicitamente, seu valor padrão global será usado
Mas tenha em mente que o valor padrão não significa "false". Ele varia em termos de FeatureFlags diferentes.		 SignalRFeature []
liveTraceConfiguration Configuração de rastreamento ao vivo de um recurso Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACLs de rede para o recurso SignalRNetworkACLs
publicNetworkAccess Habilitar ou desabilitar o acesso à rede pública. Padrão como "Habilitado".
Quando está habilitado, as ACLs de rede ainda se aplicam.
Quando estiver desabilitado, o acesso à rede pública sempre será desabilitado, independentemente do que você definir nas ACLs de rede.		 corda
regionEndpointEnabled Habilite ou desabilite o ponto de extremidade regional. Padrão como "Habilitado".
Quando estiver desabilitado, novas conexões não serão roteadas para esse ponto de extremidade, no entanto, as conexões existentes não serão afetadas.
Essa propriedade é específica da réplica. Não é permitido desabilitar o ponto de extremidade regional sem réplica.		 corda
resourceLogConfiguration Configuração de log de recursos de um recurso Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Pare ou inicie o recurso. Padrão para "False".
Quando for true, o plano de dados do recurso será desligado.
Quando for falso, o plano de dados do recurso será iniciado.		 corda
sem servidor Configurações sem servidor. ServerlessSettings
tls Configurações de TLS para o recurso SignalRTlsSettings
montante As configurações para o Upstream quando o serviço está no modo sem servidor. ServerlessUpstreamSettings

SignalRTlsSettings

Nome Descrição Valor
clientCertEnabled Solicite o certificado do cliente durante o handshake do TLS, se habilitado. Não há suporte para a camada gratuita. Qualquer entrada será ignorada para a camada gratuita. Bool

TrackedResourceTags

Nome Descrição Valor

UpstreamAuthSettings

Nome Descrição Valor
managedIdentity Configurações de identidade gerenciada para upstream. ManagedIdentitySettings
tipo Enumeração de tipo de autenticação upstream. 'ManagedIdentity'
'None'

UpstreamTemplate

Nome Descrição Valor
Auth Configurações de autenticação upstream. Se não estiver definido, 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 for definido, ele corresponderá a qualquer categoria.
Há três tipos de padrões com suporte:
1. "*", ele 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 da categoria única, por exemplo, "conexões", corresponde à categoria "conexões".		 corda
eventPattern Obtém ou define o padrão de correspondência para nomes de eventos. Se não estiver definido, ele corresponderá a qualquer evento.
Há três tipos de padrões com suporte:
1. "*", ele corresponde a qualquer nome de evento.
2. Combine vários eventos com "", por exemplo, "conectar,desconectar", ele corresponde ao evento "connect" e "disconnect".
3. O nome do evento único, por exemplo, "connect", corresponde a "connect".		 corda
hubPattern Obtém ou define o padrão de correspondência para nomes de hub. Se não estiver definido, ele corresponderá a qualquer hub.
Há três tipos de padrões com suporte:
1. "*", ele 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 do hub único, por exemplo, "hub1", corresponde a "hub1".		 corda
urlTemplate Obtém ou define o modelo de URL upstream. Você pode usar três parâmetros predefinidos {hub}, {category} {event} dentro do modelo, o valor da URL upstream é calculado dinamicamente quando a solicitação do cliente entra.
Por exemplo, se o urlTemplate for http://example.com/{hub}/api/{event}, com uma solicitação de cliente do hub chat se conectar, ele primeiro postará esta URL: http://example.com/chat/api/connect.		 cadeia de caracteres (obrigatório)

UserAssignedIdentityProperty

Nome 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 Esse modelo cria um Serviço do Azure SignalR usando um modelo.

Definição de recurso de modelo do ARM

O tipo de recurso signalR pode ser implantado com operações de destino:

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

Formato de recurso

Para criar um recurso Microsoft.SignalRService/signalR, adicione o JSON a seguir ao seu modelo.

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2024-01-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

IPRule

Nome Descrição Valor
ação Ação acl de rede do Azure. 'Permitir'
'Negar'
valor Um IP ou CIDR ou ServiceTag corda

LiveTraceCategory

Nome Descrição Valor
Habilitado Indica se ou a categoria de rastreamento dinâmico está habilitada.
Valores disponíveis: true, false.
Não diferencia maiúsculas de minúsculas.		 corda
nome Obtém ou define o nome da categoria de rastreamento ao vivo.
Valores disponíveis: ConnectivityLogs, MessagingLogs.
Não diferencia maiúsculas de minúsculas.		 corda

LiveTraceConfiguration

Nome Descrição Valor
Categorias Obtém ou define a lista de configurações de categoria. LiveTraceCategory []
Habilitado Indica se habilitar ou não o rastreamento dinâmico.
Quando ele é definido como true, o cliente de rastreamento dinâmico pode se conectar ao serviço.
Caso contrário, o cliente de rastreamento dinâmico não poderá se conectar ao serviço, de modo que você não possa receber nenhum log, independentemente do que você configurar em "categorias".
Valores disponíveis: true, false.
Não diferencia maiúsculas de minúsculas.		 corda

ManagedIdentity

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

ManagedIdentitySettings

Nome Descrição Valor
recurso O recurso que indica o URI da ID do aplicativo do recurso de destino.
Ele também aparece na declaração aud (audience) do token emitido.		 corda

ManagedIdentityUserAssignedIdentities

Nome Descrição Valor

Microsoft.SignalRService/signalR

Nome Descrição Valor
apiVersion A versão da API '2024-01-01-preview'
identidade Uma classe representa identidades gerenciadas usadas para solicitação e resposta ManagedIdentity
tipo O tipo do serviço 'RawWebSockets'
'SignalR'
localização A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 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 cobrança do recurso. do ResourceSku
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.SignalRService/signalR'

NetworkACL

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

PrivateEndpointACL

Nome Descrição Valor
permitir Tipos de solicitação permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeia de caracteres que contém qualquer um dos:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
negar Tipos de solicitação negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeia de caracteres que contém qualquer um dos:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nome Nome da conexão de ponto de extremidade privado cadeia de caracteres (obrigatório)

ResourceLogCategory

Nome Descrição Valor
Habilitado Indica se ou a categoria de log de recursos está habilitada.
Valores disponíveis: true, false.
Não diferencia maiúsculas de minúsculas.		 corda
nome Obtém ou define o nome da categoria do log de recursos.
Valores disponíveis: ConnectivityLogs, MessagingLogs.
Não diferencia maiúsculas de minúsculas.		 corda

ResourceLogConfiguration

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

ResourceSku

Nome Descrição Valor
capacidade Opcional, inteiro. A contagem de unidades do recurso.
1 para Free_F1/Standard_S1/Premium_P1, 100 para Premium_P2 por padrão.

Se estiverem presentes, os seguintes valores serão permitidos:
Free_F1: 1;
Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90.100;
Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90.100;
Premium_P2: 100.200.300.400.500.600.700.800.900.1000;		 int
nome O nome da SKU. Necessário.

Valores permitidos: Standard_S1, Free_F1, Premium_P1 Premium_P2		 cadeia de caracteres (obrigatório)
camada Camada opcional deste SKU específico. 'Standard' ou 'Free'.

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

ServerlessSettings

Nome Descrição Valor
connectionTimeoutInSeconds Obtém ou define o tempo limite de conexão do cliente. Opcional a ser definido.
Valor em segundos.
O valor padrão é 30 segundos.
O cliente deve definir o tempo limite para um período mais curto se as mensagens forem enviadas em intervalos mais curtos,
e deseja que o cliente se desconecte mais rapidamente após o envio da última mensagem.
Você pode definir o tempo limite para um período mais longo se espera-se que as mensagens sejam enviadas em intervalos mais longos,
e eles querem manter a mesma conexão de cliente ativa durante esta sessão.
O serviço considerará o cliente desconectado se ele não tiver recebido uma mensagem (incluindo manter-se ativo) nesse intervalo.		 int

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

ServerlessUpstreamSettings

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

SignalRCorsSettings

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

SignalRFeature

Nome Descrição Valor
bandeira FeatureFlags são os recursos com suporte do serviço do Azure SignalR.
- ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Padrão": tenha seu próprio servidor de back-end; "Sem servidor": seu aplicativo não tem um servidor de back-end; "Clássico": para compatibilidade com versões anteriores. Suporte ao modo padrão e sem servidor, mas não recomendado; "PredefinedOnly": para uso futuro.
- EnableConnectivityLogs: "true"/"false", para habilitar/desabilitar a categoria de log de conectividade, respectivamente.
- EnableMessagingLogs: "true"/"false", para habilitar/desabilitar a categoria de log de conectividade, respectivamente.
- EnableLiveTrace: Live Trace permite que você saiba o que está acontecendo dentro do serviço do Azure SignalR, ele fornecerá rastreamentos dinâmicos em tempo real, será útil ao desenvolver seu próprio aplicativo Web baseado no Azure SignalR ou solucionar alguns problemas. Observe que os rastreamentos dinâmicos são contados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para habilitar/desabilitar o recurso de rastreamento dinâmico.		 'EnableConnectivityLogs'
'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 valores permitidos. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)

SignalRFeatureProperties

Nome Descrição Valor

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 []
privateEndpoints ACLs para solicitações de pontos de extremidade privados PrivateEndpointACL []
publicNetwork ACL de rede NetworkACL

SignalRProperties

Nome Descrição Valor
cors Configurações de CORS (Compartilhamento de Recursos entre Origens). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Habilitar ou desabilitar a autenticação do aad
Quando definido como true, a conexão com AuthType=aad não funcionará.		 Bool
disableLocalAuth DisableLocalAuth
Habilitar ou desabilitar a autenticação local com o AccessKey
Quando definido como true, a conexão com AccessKey=xxx não funcionará.		 Bool
Características Lista de featureFlags.

FeatureFlags que não estão incluídos nos parâmetros da operação de atualização não serão modificados.
E a resposta incluirá apenas featureFlags definidos explicitamente.
Quando um featureFlag não for definido explicitamente, seu valor padrão global será usado
Mas tenha em mente que o valor padrão não significa "false". Ele varia em termos de FeatureFlags diferentes.		 SignalRFeature []
liveTraceConfiguration Configuração de rastreamento ao vivo de um recurso Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACLs de rede para o recurso SignalRNetworkACLs
publicNetworkAccess Habilitar ou desabilitar o acesso à rede pública. Padrão como "Habilitado".
Quando está habilitado, as ACLs de rede ainda se aplicam.
Quando estiver desabilitado, o acesso à rede pública sempre será desabilitado, independentemente do que você definir nas ACLs de rede.		 corda
regionEndpointEnabled Habilite ou desabilite o ponto de extremidade regional. Padrão como "Habilitado".
Quando estiver desabilitado, novas conexões não serão roteadas para esse ponto de extremidade, no entanto, as conexões existentes não serão afetadas.
Essa propriedade é específica da réplica. Não é permitido desabilitar o ponto de extremidade regional sem réplica.		 corda
resourceLogConfiguration Configuração de log de recursos de um recurso Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Pare ou inicie o recurso. Padrão para "False".
Quando for true, o plano de dados do recurso será desligado.
Quando for falso, o plano de dados do recurso será iniciado.		 corda
sem servidor Configurações sem servidor. ServerlessSettings
tls Configurações de TLS para o recurso SignalRTlsSettings
montante As configurações para o Upstream quando o serviço está no modo sem servidor. ServerlessUpstreamSettings

SignalRTlsSettings

Nome Descrição Valor
clientCertEnabled Solicite o certificado do cliente durante o handshake do TLS, se habilitado. Não há suporte para a camada gratuita. Qualquer entrada será ignorada para a camada gratuita. Bool

TrackedResourceTags

Nome Descrição Valor

UpstreamAuthSettings

Nome Descrição Valor
managedIdentity Configurações de identidade gerenciada para upstream. ManagedIdentitySettings
tipo Enumeração de tipo de autenticação upstream. 'ManagedIdentity'
'None'

UpstreamTemplate

Nome Descrição Valor
Auth Configurações de autenticação upstream. Se não estiver definido, 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 for definido, ele corresponderá a qualquer categoria.
Há três tipos de padrões com suporte:
1. "*", ele 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 da categoria única, por exemplo, "conexões", corresponde à categoria "conexões".		 corda
eventPattern Obtém ou define o padrão de correspondência para nomes de eventos. Se não estiver definido, ele corresponderá a qualquer evento.
Há três tipos de padrões com suporte:
1. "*", ele corresponde a qualquer nome de evento.
2. Combine vários eventos com "", por exemplo, "conectar,desconectar", ele corresponde ao evento "connect" e "disconnect".
3. O nome do evento único, por exemplo, "connect", corresponde a "connect".		 corda
hubPattern Obtém ou define o padrão de correspondência para nomes de hub. Se não estiver definido, ele corresponderá a qualquer hub.
Há três tipos de padrões com suporte:
1. "*", ele 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 do hub único, por exemplo, "hub1", corresponde a "hub1".		 corda
urlTemplate Obtém ou define o modelo de URL upstream. Você pode usar três parâmetros predefinidos {hub}, {category} {event} dentro do modelo, o valor da URL upstream é calculado dinamicamente quando a solicitação do cliente entra.
Por exemplo, se o urlTemplate for http://example.com/{hub}/api/{event}, com uma solicitação de cliente do hub chat se conectar, ele primeiro postará esta URL: http://example.com/chat/api/connect.		 cadeia de caracteres (obrigatório)

UserAssignedIdentityProperty

Nome 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

Implantar no Azure 		Esse modelo cria um Serviço do Azure SignalR usando um modelo.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso signalR pode ser implantado com operações de destino:

  • grupos de recursos

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

Formato de recurso

Para criar um recurso Microsoft.SignalRService/signalR, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR@2024-01-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 = {
      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

IPRule

Nome Descrição Valor
ação Ação acl de rede do Azure. 'Permitir'
'Negar'
valor Um IP ou CIDR ou ServiceTag corda

LiveTraceCategory

Nome Descrição Valor
Habilitado Indica se ou a categoria de rastreamento dinâmico está habilitada.
Valores disponíveis: true, false.
Não diferencia maiúsculas de minúsculas.		 corda
nome Obtém ou define o nome da categoria de rastreamento ao vivo.
Valores disponíveis: ConnectivityLogs, MessagingLogs.
Não diferencia maiúsculas de minúsculas.		 corda

LiveTraceConfiguration

Nome Descrição Valor
Categorias Obtém ou define a lista de configurações de categoria. LiveTraceCategory []
Habilitado Indica se habilitar ou não o rastreamento dinâmico.
Quando ele é definido como true, o cliente de rastreamento dinâmico pode se conectar ao serviço.
Caso contrário, o cliente de rastreamento dinâmico não poderá se conectar ao serviço, de modo que você não possa receber nenhum log, independentemente do que você configurar em "categorias".
Valores disponíveis: true, false.
Não diferencia maiúsculas de minúsculas.		 corda

ManagedIdentity

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

ManagedIdentitySettings

Nome Descrição Valor
recurso O recurso que indica o URI da ID do aplicativo do recurso de destino.
Ele também aparece na declaração aud (audience) do token emitido.		 corda

ManagedIdentityUserAssignedIdentities

Nome Descrição Valor

Microsoft.SignalRService/signalR

Nome Descrição Valor
identidade Uma classe representa identidades gerenciadas usadas para solicitação e resposta ManagedIdentity
tipo O tipo do serviço 'RawWebSockets'
'SignalR'
localização A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 3
Comprimento máximo = 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 cobrança do recurso. do ResourceSku
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.SignalRService/signalR@2024-01-01-preview"

NetworkACL

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

PrivateEndpointACL

Nome Descrição Valor
permitir Tipos de solicitação permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeia de caracteres que contém qualquer um dos:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
negar Tipos de solicitação negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI. Matriz de cadeia de caracteres que contém qualquer um dos:
'ClientConnection'
'RESTAPI'
'ServerConnection'
'Trace'
nome Nome da conexão de ponto de extremidade privado cadeia de caracteres (obrigatório)

ResourceLogCategory

Nome Descrição Valor
Habilitado Indica se ou a categoria de log de recursos está habilitada.
Valores disponíveis: true, false.
Não diferencia maiúsculas de minúsculas.		 corda
nome Obtém ou define o nome da categoria do log de recursos.
Valores disponíveis: ConnectivityLogs, MessagingLogs.
Não diferencia maiúsculas de minúsculas.		 corda

ResourceLogConfiguration

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

ResourceSku

Nome Descrição Valor
capacidade Opcional, inteiro. A contagem de unidades do recurso.
1 para Free_F1/Standard_S1/Premium_P1, 100 para Premium_P2 por padrão.

Se estiverem presentes, os seguintes valores serão permitidos:
Free_F1: 1;
Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90.100;
Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90.100;
Premium_P2: 100.200.300.400.500.600.700.800.900.1000;		 int
nome O nome da SKU. Necessário.

Valores permitidos: Standard_S1, Free_F1, Premium_P1 Premium_P2		 cadeia de caracteres (obrigatório)
camada Camada opcional deste SKU específico. 'Standard' ou 'Free'.

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

ServerlessSettings

Nome Descrição Valor
connectionTimeoutInSeconds Obtém ou define o tempo limite de conexão do cliente. Opcional a ser definido.
Valor em segundos.
O valor padrão é 30 segundos.
O cliente deve definir o tempo limite para um período mais curto se as mensagens forem enviadas em intervalos mais curtos,
e deseja que o cliente se desconecte mais rapidamente após o envio da última mensagem.
Você pode definir o tempo limite para um período mais longo se espera-se que as mensagens sejam enviadas em intervalos mais longos,
e eles querem manter a mesma conexão de cliente ativa durante esta sessão.
O serviço considerará o cliente desconectado se ele não tiver recebido uma mensagem (incluindo manter-se ativo) nesse intervalo.		 int

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

ServerlessUpstreamSettings

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

SignalRCorsSettings

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

SignalRFeature

Nome Descrição Valor
bandeira FeatureFlags são os recursos com suporte do serviço do Azure SignalR.
- ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Padrão": tenha seu próprio servidor de back-end; "Sem servidor": seu aplicativo não tem um servidor de back-end; "Clássico": para compatibilidade com versões anteriores. Suporte ao modo padrão e sem servidor, mas não recomendado; "PredefinedOnly": para uso futuro.
- EnableConnectivityLogs: "true"/"false", para habilitar/desabilitar a categoria de log de conectividade, respectivamente.
- EnableMessagingLogs: "true"/"false", para habilitar/desabilitar a categoria de log de conectividade, respectivamente.
- EnableLiveTrace: Live Trace permite que você saiba o que está acontecendo dentro do serviço do Azure SignalR, ele fornecerá rastreamentos dinâmicos em tempo real, será útil ao desenvolver seu próprio aplicativo Web baseado no Azure SignalR ou solucionar alguns problemas. Observe que os rastreamentos dinâmicos são contados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para habilitar/desabilitar o recurso de rastreamento dinâmico.		 'EnableConnectivityLogs'
'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 valores permitidos. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)

SignalRFeatureProperties

Nome Descrição Valor

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 []
privateEndpoints ACLs para solicitações de pontos de extremidade privados PrivateEndpointACL []
publicNetwork ACL de rede NetworkACL

SignalRProperties

Nome Descrição Valor
cors Configurações de CORS (Compartilhamento de Recursos entre Origens). SignalRCorsSettings
disableAadAuth DisableLocalAuth
Habilitar ou desabilitar a autenticação do aad
Quando definido como true, a conexão com AuthType=aad não funcionará.		 Bool
disableLocalAuth DisableLocalAuth
Habilitar ou desabilitar a autenticação local com o AccessKey
Quando definido como true, a conexão com AccessKey=xxx não funcionará.		 Bool
Características Lista de featureFlags.

FeatureFlags que não estão incluídos nos parâmetros da operação de atualização não serão modificados.
E a resposta incluirá apenas featureFlags definidos explicitamente.
Quando um featureFlag não for definido explicitamente, seu valor padrão global será usado
Mas tenha em mente que o valor padrão não significa "false". Ele varia em termos de FeatureFlags diferentes.		 SignalRFeature []
liveTraceConfiguration Configuração de rastreamento ao vivo de um recurso Microsoft.SignalRService. LiveTraceConfiguration
networkACLs ACLs de rede para o recurso SignalRNetworkACLs
publicNetworkAccess Habilitar ou desabilitar o acesso à rede pública. Padrão como "Habilitado".
Quando está habilitado, as ACLs de rede ainda se aplicam.
Quando estiver desabilitado, o acesso à rede pública sempre será desabilitado, independentemente do que você definir nas ACLs de rede.		 corda
regionEndpointEnabled Habilite ou desabilite o ponto de extremidade regional. Padrão como "Habilitado".
Quando estiver desabilitado, novas conexões não serão roteadas para esse ponto de extremidade, no entanto, as conexões existentes não serão afetadas.
Essa propriedade é específica da réplica. Não é permitido desabilitar o ponto de extremidade regional sem réplica.		 corda
resourceLogConfiguration Configuração de log de recursos de um recurso Microsoft.SignalRService. ResourceLogConfiguration
resourceStopped Pare ou inicie o recurso. Padrão para "False".
Quando for true, o plano de dados do recurso será desligado.
Quando for falso, o plano de dados do recurso será iniciado.		 corda
sem servidor Configurações sem servidor. ServerlessSettings
tls Configurações de TLS para o recurso SignalRTlsSettings
montante As configurações para o Upstream quando o serviço está no modo sem servidor. ServerlessUpstreamSettings

SignalRTlsSettings

Nome Descrição Valor
clientCertEnabled Solicite o certificado do cliente durante o handshake do TLS, se habilitado. Não há suporte para a camada gratuita. Qualquer entrada será ignorada para a camada gratuita. Bool

TrackedResourceTags

Nome Descrição Valor

UpstreamAuthSettings

Nome Descrição Valor
managedIdentity Configurações de identidade gerenciada para upstream. ManagedIdentitySettings
tipo Enumeração de tipo de autenticação upstream. 'ManagedIdentity'
'None'

UpstreamTemplate

Nome Descrição Valor
Auth Configurações de autenticação upstream. Se não estiver definido, 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 for definido, ele corresponderá a qualquer categoria.
Há três tipos de padrões com suporte:
1. "*", ele 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 da categoria única, por exemplo, "conexões", corresponde à categoria "conexões".		 corda
eventPattern Obtém ou define o padrão de correspondência para nomes de eventos. Se não estiver definido, ele corresponderá a qualquer evento.
Há três tipos de padrões com suporte:
1. "*", ele corresponde a qualquer nome de evento.
2. Combine vários eventos com "", por exemplo, "conectar,desconectar", ele corresponde ao evento "connect" e "disconnect".
3. O nome do evento único, por exemplo, "connect", corresponde a "connect".		 corda
hubPattern Obtém ou define o padrão de correspondência para nomes de hub. Se não estiver definido, ele corresponderá a qualquer hub.
Há três tipos de padrões com suporte:
1. "*", ele 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 do hub único, por exemplo, "hub1", corresponde a "hub1".		 corda
urlTemplate Obtém ou define o modelo de URL upstream. Você pode usar três parâmetros predefinidos {hub}, {category} {event} dentro do modelo, o valor da URL upstream é calculado dinamicamente quando a solicitação do cliente entra.
Por exemplo, se o urlTemplate for http://example.com/{hub}/api/{event}, com uma solicitação de cliente do hub chat se conectar, ele primeiro postará esta URL: http://example.com/chat/api/connect.		 cadeia de caracteres (obrigatório)

UserAssignedIdentityProperty

Nome Descrição Valor