SignalR - List By Resource Group

Lida com pedidos para listar todos os recursos de um grupo de recursos.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR?api-version=2020-05-01

Parâmetros do URI

Name In Required Type Description
resourceGroupName
path True
  • string

O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Gestor de Recursos Azure ou do portal.

subscriptionId
path True
  • string

Obtém id de subscrição que identifica exclusivamente a subscrição do Microsoft Azure. O ID de subscrição faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão Api do cliente.

Respostas

Name Type Description
200 OK

Com êxito. A resposta descreve a lista de serviços SignalR num Grupo de Recursos.

Other Status Codes

Ocorreu um erro inesperado durante a operação.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

SignalR_ListByResourceGroup

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/signalR?api-version=2020-05-01

Sample Response

{
  "value": [
    {
      "sku": {
        "name": "Standard_S1",
        "tier": "Standard",
        "size": "S1",
        "capacity": 1
      },
      "properties": {
        "provisioningState": "Succeeded",
        "externalIP": "10.0.0.1",
        "hostName": "mysignalrservice.service.signalr.net",
        "publicPort": 443,
        "serverPort": 443,
        "version": "1.0",
        "privateEndpointConnections": [
          {
            "properties": {
              "provisioningState": "Succeeded",
              "privateEndpoint": {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
              },
              "privateLinkServiceConnectionState": {
                "status": "Approved",
                "description": null,
                "actionsRequired": "None"
              }
            },
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
            "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
            "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections"
          }
        ],
        "hostNamePrefix": "mysignalrservice",
        "features": [
          {
            "flag": "ServiceMode",
            "value": "Serverless",
            "properties": {}
          },
          {
            "flag": "EnableConnectivityLogs",
            "value": "True",
            "properties": {}
          },
          {
            "flag": "EnableMessagingLogs",
            "value": "False",
            "properties": {}
          }
        ],
        "cors": {
          "allowedOrigins": [
            "https://foo.com",
            "https://bar.com"
          ]
        },
        "upstream": {
          "templates": [
            {
              "hubPattern": null,
              "eventPattern": null,
              "categoryPattern": null,
              "urlTemplate": "http://foo.com"
            }
          ]
        },
        "networkACLs": {
          "defaultAction": "Deny",
          "publicNetwork": {
            "allow": [
              "ClientConnection"
            ],
            "deny": null
          },
          "privateEndpoints": [
            {
              "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
              "allow": [
                "ServerConnection"
              ],
              "deny": null
            }
          ]
        }
      },
      "kind": "SignalR",
      "location": "eastus",
      "tags": {
        "key1": "value1"
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
      "name": "mySignalRService",
      "type": "Microsoft.SignalRService/SignalR"
    }
  ]
}

Definições

ACLAction

Ação padrão quando nenhuma outra regra corresponde

ErrorResponse

Contém informações sobre um erro da API.

ErrorResponseBody

Descreve um erro de API particular com um código de erro e uma mensagem.

FeatureFlags

FeatureFlags são as funcionalidades suportadas do serviço Azure SignalR.

  • ServiceMode: Bandeira para servidor de backend para o serviço SignalR. Valores permitidos: "Padrão": ter o seu próprio servidor backend; "Serverless": a sua aplicação não tem um servidor backend; "Clássico": para retrocompatibilidade. Suporte o modo Default e Serverless, mas não recomendado; "PredefinedOnly": para utilização futura.
  • EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respectivamente.
NetworkACL

Rede ACL

PrivateEndpoint

Ponto final privado

PrivateEndpointACL

ACL para um ponto final privado

PrivateEndpointConnection

Uma ligação privada ao ponto final ao recurso SignalR

PrivateLinkServiceConnectionState

Estado de ligação da ligação privada do ponto final

PrivateLinkServiceConnectionStatus

Indica se a ligação foi aprovada/rejeitada/removida pelo proprietário do serviço.

ProvisioningState

Provisionando o estado do recurso.

ResourceSku

A informação de faturação do recurso SignalR.

ServerlessUpstreamSettings

As definições para o Upstream quando o Azure SignalR está no modo sem servidor.

ServiceKind

O tipo de serviço - por exemplo, "SignalR", ou "RawWebSockets" para "Microsoft.SignalRService/SignalR"

SignalRCorsSettings

Definições de partilha de recursos de origem cruzada (CORS).

SignalRFeature

Característica de um recurso SignalR, que controla o comportamento de execução do SignalR.

SignalRNetworkACLs

ACLs de rede para SignalR

SignalRResource

Uma classe representa um recurso de serviço SignalR.

SignalRResourceList

Objeto que inclui uma série de serviços SignalR e uma possível ligação para o próximo conjunto.

SignalRSkuTier

Nível opcional deste SKU em particular. 'Standard' ou 'Free'.

Basic é depreciado, uso Standard em vez disso.

UpstreamTemplate

Definições de item do modelo a montante. Define o URL A montante dos pedidos de entrada. O modelo define o padrão do evento, o hub ou a categoria do pedido de entrada que corresponde ao modelo de URL atual.

ACLAction

Ação padrão quando nenhuma outra regra corresponde

Name Type Description
Allow
  • string
Deny
  • string

ErrorResponse

Contém informações sobre um erro da API.

Name Type Description
error

Descreve um erro de API particular com um código de erro e uma mensagem.

ErrorResponseBody

Descreve um erro de API particular com um código de erro e uma mensagem.

Name Type Description
code
  • string

Um código de erro que descreve a condição de erro mais precisamente do que um código de estado HTTP. Pode ser usado para lidar programáticamente casos de erro específicos.

details

Contém erros aninhados que estão relacionados com este erro.

message
  • string

Uma mensagem que descreve o erro em detalhe e fornece informações de depurativas.

target
  • string

O alvo do erro particular (por exemplo, o nome da propriedade em erro).

FeatureFlags

FeatureFlags são as funcionalidades suportadas do serviço Azure SignalR.

  • ServiceMode: Bandeira para servidor de backend para o serviço SignalR. Valores permitidos: "Padrão": ter o seu próprio servidor backend; "Serverless": a sua aplicação não tem um servidor backend; "Clássico": para retrocompatibilidade. Suporte o modo Default e Serverless, mas não recomendado; "PredefinedOnly": para utilização futura.
  • EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respectivamente.
Name Type Description
EnableConnectivityLogs
  • string
EnableMessagingLogs
  • string
ServiceMode
  • string

NetworkACL

Rede ACL

Name Type Description
allow
  • string[]

Tipos de pedidos permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.

deny
  • string[]

Tipos de pedidos negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Ponto final privado

Name Type Description
id
  • string

Id completo qualificado do ponto final privado

PrivateEndpointACL

ACL para um ponto final privado

Name Type Description
allow
  • string[]

Tipos de pedidos permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.

deny
  • string[]

Tipos de pedidos negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.

name
  • string

Nome da ligação privada do ponto final

PrivateEndpointConnection

Uma ligação privada ao ponto final ao recurso SignalR

Name Type Description
id
  • string

Identificação de recursos totalmente qualificada para o recurso.

name
  • string

O nome do recurso.

properties.privateEndpoint

Ponto final privado associado à ligação de ponto final privado

properties.privateLinkServiceConnectionState

メンバー ID:

properties.provisioningState

Estado de provisionamento da ligação privada do ponto final

type
  • string

O tipo de recurso - por exemplo, "Microsoft.SignalRService/SignalR"

PrivateLinkServiceConnectionState

Estado de ligação da ligação privada do ponto final

Name Type Description
actionsRequired
  • string

Uma mensagem indicando se as alterações no prestador de serviços requerem quaisquer atualizações sobre o consumidor.

description
  • string

O motivo da aprovação/rejeição da ligação.

status

Indica se a ligação foi aprovada/rejeitada/removida pelo proprietário do serviço.

PrivateLinkServiceConnectionStatus

Indica se a ligação foi aprovada/rejeitada/removida pelo proprietário do serviço.

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

ProvisioningState

Provisionando o estado do recurso.

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Moving
  • string
Running
  • string
Succeeded
  • string
Unknown
  • string
Updating
  • string

ResourceSku

A informação de faturação do recurso SignalR.

Name Type Description
capacity
  • integer

Opcional, inteiro. A contagem de unidades de recurso SignalR. 1 por defeito.

Se presentes, são permitidos seguintes valores: Grátis: 1 Standard: 1,2,5,10,20,50,100

family
  • string

Não usado. Retido para uso futuro.

name
  • string

O nome do SKU. Obrigatório.

Valores permitidos: Standard_S1, Free_F1

size
  • string

Não usado. Retido para uso futuro.

tier

Nível opcional deste SKU em particular. 'Standard' ou 'Free'.

Basic é depreciado, uso Standard em vez disso.

ServerlessUpstreamSettings

As definições para o Upstream quando o Azure SignalR está no modo sem servidor.

Name Type Description
templates

Recebe ou define a lista de modelos de URL a montante. A ordem importa, e o primeiro modelo de correspondência produz efeitos.

ServiceKind

O tipo de serviço - por exemplo, "SignalR", ou "RawWebSockets" para "Microsoft.SignalRService/SignalR"

Name Type Description
RawWebSockets
  • string
SignalR
  • string

SignalRCorsSettings

Definições de partilha de recursos de origem cruzada (CORS).

Name Type Description
allowedOrigins
  • string[]

Obtém ou define a lista de origens que devem ser autorizadas a fazer chamadas de origem cruzada (por exemplo: http://example.com:12345) . Use "*" para permitir tudo. Se omitido, permita tudo por defeito.

SignalRFeature

Característica de um recurso SignalR, que controla o comportamento de execução do SignalR.

Name Type Description
flag

FeatureFlags são as funcionalidades suportadas do serviço Azure SignalR.

  • ServiceMode: Bandeira para servidor de backend para o serviço SignalR. Valores permitidos: "Padrão": ter o seu próprio servidor backend; "Serverless": a sua aplicação não tem um servidor backend; "Clássico": para retrocompatibilidade. Suporte o modo Default e Serverless, mas não recomendado; "PredefinedOnly": para utilização futura.
  • EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respectivamente.
properties
  • object

Propriedades opcionais relacionadas com esta funcionalidade.

value
  • string

Valor da bandeira de recurso. Consulte o documento de serviço Azure SignalR https://docs.microsoft.com/azure/azure-signalr/ para obter valores permitidos.

SignalRNetworkACLs

ACLs de rede para SignalR

Name Type Description
defaultAction

Ação padrão quando nenhuma outra regra corresponde

privateEndpoints

ACLs para pedidos de pontos finais privados

publicNetwork

ACL para pedidos de rede pública

SignalRResource

Uma classe representa um recurso de serviço SignalR.

Name Type Description
id
  • string

Identificação de recursos totalmente qualificada para o recurso.

kind

O tipo de serviço - por exemplo, "SignalR", ou "RawWebSockets" para "Microsoft.SignalRService/SignalR"

location
  • string

A localização GEO do serviço SignalR. por exemplo, | dos EUA Ocidentais | leste dos EUA | central norte dos EUA Centro-Sul dos EUA.

name
  • string

O nome do recurso.

properties.cors

Definições de partilha de recursos de origem cruzada (CORS).

properties.externalIP
  • string

O IP acessível ao público do serviço SignalR.

properties.features

Lista de sinalizadores SignalRFlags. por exemplo, ServiceMode.

CaracterísticaSAs que não estejam incluídas nos parâmetros da operação de atualização não serão modificadas. E a resposta incluirá apenas funcionalidadesFlags que são explicitamente definidos. Quando uma funcionalidadeFlag não estiver explicitamente definida, o serviço SignalR utilizará o seu valor globalmente padrão. Mas lembre-se, o valor padrão não significa "falso". Varia em termos de diferentes FeatureFlags.

properties.hostName
  • string

FQDN da instância de serviço SignalR. Formato: xxx.service.signalr.net

properties.hostNamePrefix
  • string

Prefixo para o nome de anfitrião do serviço SignalR. Retido para uso futuro. O nome anfitrião será de formato: < hostNamePrefix > .service.signalr.net.

properties.networkACLs

ACLs de rede

properties.privateEndpointConnections

Ligações de ponto final privado ao recurso SignalR.

properties.provisioningState

Provisionando o estado do recurso.

properties.publicPort
  • integer

A porta acessível ao público do serviço SignalR que foi projetado para uso do lado do navegador/cliente.

properties.serverPort
  • integer

A porta acessível ao público do serviço SignalR, concebida para o uso do servidor do cliente.

properties.upstream

Configurações a montante quando o Azure SignalR está no modo sem servidor.

properties.version
  • string

Versão do recurso SignalR. Provavelmente precisa da mesma versão ou versão superior dos SDKs clientes.

sku

A informação de faturação do recurso. (por exemplo, Grátis, Standard)

tags
  • object

Tags do serviço que é uma lista de pares de valor chave que descrevem o recurso.

type
  • string

O tipo de recurso - por exemplo, "Microsoft.SignalRService/SignalR"

SignalRResourceList

Objeto que inclui uma série de serviços SignalR e uma possível ligação para o próximo conjunto.

Name Type Description
nextLink
  • string

O URL que o cliente deve utilizar para obter a página seguinte (por paging lateral do servidor). É nulo por enquanto, adicionado para uso futuro.

value

Lista de serviços signalr

SignalRSkuTier

Nível opcional deste SKU em particular. 'Standard' ou 'Free'.

Basic é depreciado, uso Standard em vez disso.

Name Type Description
Basic
  • string
Free
  • string
Premium
  • string
Standard
  • string

UpstreamTemplate

Definições de item do modelo a montante. Define o URL A montante dos pedidos de entrada. O modelo define o padrão do evento, o hub ou a categoria do pedido de entrada que corresponde ao modelo de URL atual.

Name Type Description
categoryPattern
  • string

Obtém ou define o padrão de correspondência para nomes de categorias. Se não estiver definido, corresponde a qualquer categoria. Existem 3 tipos de padrões suportados: 1. "*", para corresponder a qualquer nome de categoria 2. Combine várias categorias com "", por exemplo "ligações, mensagens", corresponde à categoria "ligações" e "mensagens" 3. O nome de categoria única, por exemplo, "ligações", corresponde à categoria "ligações"

eventPattern
  • string

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. "*", que corresponde a qualquer nome de evento 2. Combine vários eventos com "", por exemplo "ligar, desligar", corresponde ao evento "conectar" e "desligar" 3. O nome do evento único, por exemplo, "ligar", corresponde a "ligar"

hubPattern
  • string

Obtém ou define o padrão de correspondência para nomes de hub. Se não estiver definido, combina com qualquer centro. Existem 3 tipos de padrões suportados: 1. "*", que corresponde a qualquer nome de hub 2. Combine vários hubs com "", por exemplo "hub1,hub2", combina com "hub1" e "hub2" 3. O nome do hub único, por exemplo, "hub1", corresponde a "hub1"

urlTemplate
  • string

Recebe ou define o modelo de URL upstream. Pode utilizar 3 parâmetros predefinidos {hub}, {category} {event} dentro do modelo, o valor do URL Upstream é calculado dinamicamente quando o pedido do cliente entra. Por exemplo, se o urlTemplate http://example.com/{hub}/api/{event} for, com um pedido de cliente do hub chat conecta- será primeiro POST a este URL: http://example.com/chat/api/connect .