Compartilhar via


Microsoft.SignalRService signalR 2018-10-01

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@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

Nome Descrição Valor
localização Região GEOGRÁFICA do Azure: 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 é alterada depois que ele é criado.
cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Configurações usadas para provisionar ou configurar o recurso SignalRCreateOrUpdatePropertiesOrSignalRProperties
Sku As informações de cobrança do recurso. (por exemplo, básico versus padrão) do ResourceSku
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

ResourceSku

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

Se estiverem presentes, os seguintes valores serão permitidos:
Gratuito: 1
Padrão: 1,2,5,10,20,50.100
int
família Cadeia de caracteres opcional. Para uso futuro. corda
nome O nome da SKU. Necessário.

Valores permitidos: Standard_S1, Free_F1
cadeia de caracteres (obrigatório)
tamanho Cadeia de caracteres opcional. Para uso futuro. corda
camada Camada opcional deste SKU específico. 'Standard' ou 'Free'.

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

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

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Nome Descrição Valor
cors Configurações de CORS (Compartilhamento de Recursos entre Origens). SignalRCorsSettings
Características Lista de featureFlags do SignalR. Por exemplo, ServiceMode.

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, o serviço SignalR usará seu valor padrão globalmente.
Mas tenha em mente que o valor padrão não significa "false". Ele varia em termos de FeatureFlags diferentes.
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.
corda

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.
'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 valores permitidos. corda

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

SignalRFeatureProperties

Nome Descrição Valor

SignalRUpdateParametersTags

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": "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

Nome Descrição Valor
apiVersion A versão da API '2018-10-01'
localização Região GEOGRÁFICA do Azure: 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 é alterada depois que ele é criado.
cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Configurações usadas para provisionar ou configurar o recurso SignalRCreateOrUpdatePropertiesOrSignalRProperties
Sku As informações de cobrança do recurso. (por exemplo, básico versus padrão) 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'

ResourceSku

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

Se estiverem presentes, os seguintes valores serão permitidos:
Gratuito: 1
Padrão: 1,2,5,10,20,50.100
int
família Cadeia de caracteres opcional. Para uso futuro. corda
nome O nome da SKU. Necessário.

Valores permitidos: Standard_S1, Free_F1
cadeia de caracteres (obrigatório)
tamanho Cadeia de caracteres opcional. Para uso futuro. corda
camada Camada opcional deste SKU específico. 'Standard' ou 'Free'.

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

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

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Nome Descrição Valor
cors Configurações de CORS (Compartilhamento de Recursos entre Origens). SignalRCorsSettings
Características Lista de featureFlags do SignalR. Por exemplo, ServiceMode.

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, o serviço SignalR usará seu valor padrão globalmente.
Mas tenha em mente que o valor padrão não significa "false". Ele varia em termos de FeatureFlags diferentes.
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.
corda

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.
'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 valores permitidos. corda

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

SignalRFeatureProperties

Nome Descrição Valor

SignalRUpdateParametersTags

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@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

Nome Descrição Valor
localização Região GEOGRÁFICA do Azure: 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 é alterada depois que ele é criado.
cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Configurações usadas para provisionar ou configurar o recurso SignalRCreateOrUpdatePropertiesOrSignalRProperties
Sku As informações de cobrança do recurso. (por exemplo, básico versus padrão) do ResourceSku
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.SignalRService/signalR@2018-10-01"

ResourceSku

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

Se estiverem presentes, os seguintes valores serão permitidos:
Gratuito: 1
Padrão: 1,2,5,10,20,50.100
int
família Cadeia de caracteres opcional. Para uso futuro. corda
nome O nome da SKU. Necessário.

Valores permitidos: Standard_S1, Free_F1
cadeia de caracteres (obrigatório)
tamanho Cadeia de caracteres opcional. Para uso futuro. corda
camada Camada opcional deste SKU específico. 'Standard' ou 'Free'.

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

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

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Nome Descrição Valor
cors Configurações de CORS (Compartilhamento de Recursos entre Origens). SignalRCorsSettings
Características Lista de featureFlags do SignalR. Por exemplo, ServiceMode.

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, o serviço SignalR usará seu valor padrão globalmente.
Mas tenha em mente que o valor padrão não significa "false". Ele varia em termos de FeatureFlags diferentes.
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.
corda

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.
'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 valores permitidos. corda

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

SignalRFeatureProperties

Nome Descrição Valor

SignalRUpdateParametersTags

Nome Descrição Valor