Partilhar via


Microsoft.SignalRService signalR 2018-10-01

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@2018-10-01' = {
  location: 'string'
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    hostNamePrefix: 'string'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

Microsoft.SignalRService/signalR

Designação Descrição Valor
Localização Região do Azure GEO: por exemplo, Oeste dos EUA Leste dos EUA Centro-Norte dos EUA Centro-Sul dos EUA Europa Ocidental Norte da Europa Ásia Oriental Sudeste Asiático Etc.
A região geográfica de um recurso nunca muda depois de ser criado.
string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades Configurações usadas para provisionar ou configurar o recurso SignalRCreateOrUpdatePropertiesOrSignalRProperties
SKU As informações de faturamento do recurso. (por exemplo, básico vs. padrão) ResourceSku
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

ResourceSku

Designação Descrição Valor
capacidade Opcional, inteiro. A contagem de unidades do recurso SignalR. 1 por defeito.

Se presentes, são permitidos os seguintes valores:
Grátis: 1
Padrão: 1,2,5,10,20,50,100
Int
Família Cadeia de caracteres opcional. Para uso futuro. string
Designação O nome do SKU. Necessário.

Valores permitidos: Standard_S1, Free_F1
string (obrigatório)
tamanho Cadeia de caracteres opcional. Para uso futuro. string
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'

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[]

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Designação Descrição Valor
CORS Configurações de compartilhamento de recursos entre origens (CORS). SignalRCorsSettings
caraterísticas Lista de featureFlags do SignalR. por exemplo, ServiceMode.

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, o serviço SignalR usará seu valor padrão global.
Mas lembre-se, o valor padrão não significa "falso". Ele varia em termos de diferentes FeatureFlags.
SignalRFeature[]
hostNamePrefix Prefixo para o hostName do serviço SignalR. Retido para uso futuro.
O nome do host será de formato: <hostNamePrefix>.service.signalr.net.
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.
'EnableConnectivityLogs'
'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

SignalRUpdateParametersTags

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": "2018-10-01",
  "name": "string",
  "location": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "hostNamePrefix": "string"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

Microsoft.SignalRService/signalR

Designação Descrição Valor
apiVersion A versão api '2018-10-01'
Localização Região do Azure GEO: por exemplo, Oeste dos EUA Leste dos EUA Centro-Norte dos EUA Centro-Sul dos EUA Europa Ocidental Norte da Europa Ásia Oriental Sudeste Asiático Etc.
A região geográfica de um recurso nunca muda depois de ser criado.
string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades Configurações usadas para provisionar ou configurar o recurso SignalRCreateOrUpdatePropertiesOrSignalRProperties
SKU As informações de faturamento do recurso. (por exemplo, básico vs. padrão) 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'

ResourceSku

Designação Descrição Valor
capacidade Opcional, inteiro. A contagem de unidades do recurso SignalR. 1 por defeito.

Se presentes, são permitidos os seguintes valores:
Grátis: 1
Padrão: 1,2,5,10,20,50,100
Int
Família Cadeia de caracteres opcional. Para uso futuro. string
Designação O nome do SKU. Necessário.

Valores permitidos: Standard_S1, Free_F1
string (obrigatório)
tamanho Cadeia de caracteres opcional. Para uso futuro. string
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'

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[]

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Designação Descrição Valor
CORS Configurações de compartilhamento de recursos entre origens (CORS). SignalRCorsSettings
caraterísticas Lista de featureFlags do SignalR. por exemplo, ServiceMode.

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, o serviço SignalR usará seu valor padrão global.
Mas lembre-se, o valor padrão não significa "falso". Ele varia em termos de diferentes FeatureFlags.
SignalRFeature[]
hostNamePrefix Prefixo para o hostName do serviço SignalR. Retido para uso futuro.
O nome do host será de formato: <hostNamePrefix>.service.signalr.net.
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.
'EnableConnectivityLogs'
'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

SignalRUpdateParametersTags

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@2018-10-01"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      hostNamePrefix = "string"
    }
  })
}

Valores de propriedade

Microsoft.SignalRService/signalR

Designação Descrição Valor
Localização Região do Azure GEO: por exemplo, Oeste dos EUA Leste dos EUA Centro-Norte dos EUA Centro-Sul dos EUA Europa Ocidental Norte da Europa Ásia Oriental Sudeste Asiático Etc.
A região geográfica de um recurso nunca muda depois de ser criado.
string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades Configurações usadas para provisionar ou configurar o recurso SignalRCreateOrUpdatePropertiesOrSignalRProperties
SKU As informações de faturamento do recurso. (por exemplo, básico vs. padrão) ResourceSku
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.SignalRService/signalR@2018-10-01"

ResourceSku

Designação Descrição Valor
capacidade Opcional, inteiro. A contagem de unidades do recurso SignalR. 1 por defeito.

Se presentes, são permitidos os seguintes valores:
Grátis: 1
Padrão: 1,2,5,10,20,50,100
Int
Família Cadeia de caracteres opcional. Para uso futuro. string
Designação O nome do SKU. Necessário.

Valores permitidos: Standard_S1, Free_F1
string (obrigatório)
tamanho Cadeia de caracteres opcional. Para uso futuro. string
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'

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[]

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Designação Descrição Valor
CORS Configurações de compartilhamento de recursos entre origens (CORS). SignalRCorsSettings
caraterísticas Lista de featureFlags do SignalR. por exemplo, ServiceMode.

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, o serviço SignalR usará seu valor padrão global.
Mas lembre-se, o valor padrão não significa "falso". Ele varia em termos de diferentes FeatureFlags.
SignalRFeature[]
hostNamePrefix Prefixo para o hostName do serviço SignalR. Retido para uso futuro.
O nome do host será de formato: <hostNamePrefix>.service.signalr.net.
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.
'EnableConnectivityLogs'
'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

SignalRUpdateParametersTags

Designação Descrição Valor