Microsoft.SignalRService signalR 2020-05-01
- última
- 2024-10-01-preview
- 2024-08-01-preview
- 2024-04-01-preview
- 2024-03-01
- 2024-01-01-preview
- 2023-08-01-preview
- 2023-06-01-preview
- 2023-03-01-preview
- 2023-02-01
- 2022-08-01-preview
- 2022-02-01
- 2021-10-01
- 2021-09-01-preview
- 2021-06-01-preview
- 2021-04-01-preview
- 2020-07-01-preview
- 2020-05-01
- 2018-10-01
- 2018-03-01-preview
Definição de recurso do Bicep
O tipo de recurso signalR pode ser implantado com operações de destino:
- Grupos de recursos - Consulte comandos de implantação do grupo 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 Bicep a seguir ao seu modelo.
resource symbolicname 'Microsoft.SignalRService/signalR@2020-05-01' = {
kind: 'string'
location: 'string'
name: 'string'
properties: {
cors: {
allowedOrigins: [
'string'
]
}
features: [
{
flag: 'string'
properties: {
{customized property}: 'string'
}
value: 'string'
}
]
networkACLs: {
defaultAction: 'string'
privateEndpoints: [
{
allow: [
'string'
]
deny: [
'string'
]
name: 'string'
}
]
publicNetwork: {
allow: [
'string'
]
deny: [
'string'
]
}
}
upstream: {
templates: [
{
categoryPattern: 'string'
eventPattern: 'string'
hubPattern: 'string'
urlTemplate: 'string'
}
]
}
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Valores de propriedade
Microsoft.SignalRService/signalR
Nome | Descrição | Valor | |||
---|---|---|---|---|---|
tipo | O tipo do serviço - por exemplo, "SignalR" ou "RawWebSockets" para "Microsoft.SignalRService/SignalR" | 'RawWebSockets' 'SignalR' |
|||
localização | A localização GEO do serviço SignalR. Por exemplo, Oeste dos EUA | Leste dos EUA | Centro-Norte dos EUA | Centro-Sul dos EUA. | corda |
nome | O nome do recurso | cadeia de caracteres (obrigatório) | |||
Propriedades | Configurações usadas para provisionar ou configurar o recurso | SignalRProperties | |||
Sku | As informações de cobrança do recurso. (por exemplo, Gratuito, Standard) | do |
|||
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) |
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 |
nome | O nome da SKU. Necessário. Valores permitidos: Standard_S1, Free_F1 |
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' |
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. |
'EnableConnectivityLogs' 'EnableMessagingLogs' 'ServiceMode' (obrigatório) |
Propriedades | Propriedades opcionais relacionadas a esse recurso. | |
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
SignalRProperties
TrackedResourceTags
Nome | Descrição | Valor |
---|
UpstreamTemplate
Nome | Descrição | Valor |
---|---|---|
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. Combinar 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. Combinar 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) |
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:
- Grupos de recursos - Consulte comandos de implantação do grupo 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 JSON a seguir ao seu modelo.
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2020-05-01",
"name": "string",
"kind": "string",
"location": "string",
"properties": {
"cors": {
"allowedOrigins": [ "string" ]
},
"features": [
{
"flag": "string",
"properties": {
"{customized property}": "string"
},
"value": "string"
}
],
"networkACLs": {
"defaultAction": "string",
"privateEndpoints": [
{
"allow": [ "string" ],
"deny": [ "string" ],
"name": "string"
}
],
"publicNetwork": {
"allow": [ "string" ],
"deny": [ "string" ]
}
},
"upstream": {
"templates": [
{
"categoryPattern": "string",
"eventPattern": "string",
"hubPattern": "string",
"urlTemplate": "string"
}
]
}
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Valores de propriedade
Microsoft.SignalRService/signalR
Nome | Descrição | Valor | |||
---|---|---|---|---|---|
apiVersion | A versão da API | '2020-05-01' | |||
tipo | O tipo do serviço - por exemplo, "SignalR" ou "RawWebSockets" para "Microsoft.SignalRService/SignalR" | 'RawWebSockets' 'SignalR' |
|||
localização | A localização GEO do serviço SignalR. Por exemplo, Oeste dos EUA | Leste dos EUA | Centro-Norte dos EUA | Centro-Sul dos EUA. | corda |
nome | O nome do recurso | cadeia de caracteres (obrigatório) | |||
Propriedades | Configurações usadas para provisionar ou configurar o recurso | SignalRProperties | |||
Sku | As informações de cobrança do recurso. (por exemplo, Gratuito, Standard) | do |
|||
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) |
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 |
nome | O nome da SKU. Necessário. Valores permitidos: Standard_S1, Free_F1 |
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' |
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. |
'EnableConnectivityLogs' 'EnableMessagingLogs' 'ServiceMode' (obrigatório) |
Propriedades | Propriedades opcionais relacionadas a esse recurso. | |
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
SignalRProperties
TrackedResourceTags
Nome | Descrição | Valor |
---|
UpstreamTemplate
Nome | Descrição | Valor |
---|---|---|
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. Combinar 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. Combinar 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) |
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 |
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@2020-05-01"
name = "string"
kind = "string"
location = "string"
sku = {
capacity = int
name = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
cors = {
allowedOrigins = [
"string"
]
}
features = [
{
flag = "string"
properties = {
{customized property} = "string"
}
value = "string"
}
]
networkACLs = {
defaultAction = "string"
privateEndpoints = [
{
allow = [
"string"
]
deny = [
"string"
]
name = "string"
}
]
publicNetwork = {
allow = [
"string"
]
deny = [
"string"
]
}
}
upstream = {
templates = [
{
categoryPattern = "string"
eventPattern = "string"
hubPattern = "string"
urlTemplate = "string"
}
]
}
}
})
}
Valores de propriedade
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) |
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 |
nome | O nome da SKU. Necessário. Valores permitidos: Standard_S1, Free_F1 |
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' |
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. |
'EnableConnectivityLogs' 'EnableMessagingLogs' 'ServiceMode' (obrigatório) |
Propriedades | Propriedades opcionais relacionadas a esse recurso. | |
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
SignalRProperties
TrackedResourceTags
Nome | Descrição | Valor |
---|
UpstreamTemplate
Nome | Descrição | Valor |
---|---|---|
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. Combinar 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. Combinar 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) |