Partilhar via

Microsoft.SignalRService signalR 2023-02-01

  • Artigo

Definição de recursos do bíceps

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

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@2023-02-01' = {
  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'
      privateEndpoints: [
        {
          allow: [
            'string'
          ]
          deny: [
            'string'
          ]
          name: 'string'
        }
      ]
      publicNetwork: {
        allow: [
          'string'
        ]
        deny: [
          'string'
        ]
      }
    }
    publicNetworkAccess: 'string'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'string'
          name: '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

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

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

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, pode ser SignalR ou RawWebSockets 'RawWebSockets'
'SignalR'
Localização A localização GEO do recurso. por exemplo, Oeste dos EUA Leste dos EUA Centro-Norte dos EUA Centro-Sul dos EUA. string
Designação O nome do recurso string (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 por defeito.

Se presentes, são permitidos os seguintes valores:
Grátis: 1;
Padrão: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Prémio: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;		 Int
Designação O nome do SKU. Necessário.

Valores permitidos: Standard_S1, Free_F1 Premium_P1		 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

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

SignalRProperties

Designação Descrição Valor
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
resourceLogConfiguration Configuração do log de recursos de um recurso Microsoft.SignalRService. ResourceLogConfiguration
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 Solicitar certificado de cliente durante o handshake TLS, se habilitado Bool

TrackedResourceTags

Designação Descrição Valor

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:

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": "2023-02-01",
  "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",
      "privateEndpoints": [
        {
          "allow": [ "string" ],
          "deny": [ "string" ],
          "name": "string"
        }
      ],
      "publicNetwork": {
        "allow": [ "string" ],
        "deny": [ "string" ]
      }
    },
    "publicNetworkAccess": "string",
    "resourceLogConfiguration": {
      "categories": [
        {
          "enabled": "string",
          "name": "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

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

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

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 '2023-02-01'
identidade Uma classe representa identidades gerenciadas usadas para solicitação e resposta ManagedIdentity
tipo O tipo de serviço, pode ser SignalR ou RawWebSockets 'RawWebSockets'
'SignalR'
Localização A localização GEO do recurso. por exemplo, Oeste dos EUA Leste dos EUA Centro-Norte dos EUA Centro-Sul dos EUA. string
Designação O nome do recurso string (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 por defeito.

Se presentes, são permitidos os seguintes valores:
Grátis: 1;
Padrão: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Prémio: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;		 Int
Designação O nome do SKU. Necessário.

Valores permitidos: Standard_S1, Free_F1 Premium_P1		 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

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

SignalRProperties

Designação Descrição Valor
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
resourceLogConfiguration Configuração do log de recursos de um recurso Microsoft.SignalRService. ResourceLogConfiguration
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 Solicitar certificado de cliente durante o handshake TLS, se habilitado Bool

TrackedResourceTags

Designação Descrição Valor

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

Implantar no Azure 		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@2023-02-01"
  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"
        privateEndpoints = [
          {
            allow = [
              "string"
            ]
            deny = [
              "string"
            ]
            name = "string"
          }
        ]
        publicNetwork = {
          allow = [
            "string"
          ]
          deny = [
            "string"
          ]
        }
      }
      publicNetworkAccess = "string"
      resourceLogConfiguration = {
        categories = [
          {
            enabled = "string"
            name = "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

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

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

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, pode ser SignalR ou RawWebSockets 'RawWebSockets'
'SignalR'
Localização A localização GEO do recurso. por exemplo, Oeste dos EUA Leste dos EUA Centro-Norte dos EUA Centro-Sul dos EUA. string
Designação O nome do recurso string (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@2023-02-01"

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 por defeito.

Se presentes, são permitidos os seguintes valores:
Grátis: 1;
Padrão: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
Prémio: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;		 Int
Designação O nome do SKU. Necessário.

Valores permitidos: Standard_S1, Free_F1 Premium_P1		 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

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

SignalRProperties

Designação Descrição Valor
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
resourceLogConfiguration Configuração do log de recursos de um recurso Microsoft.SignalRService. ResourceLogConfiguration
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 Solicitar certificado de cliente durante o handshake TLS, se habilitado Bool

TrackedResourceTags

Designação Descrição Valor

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