SignalR - List By Resource Group

Referência

Service:: SignalR Service

API Version:: 2023-02-01

Processa pedidos para listar todos os recursos num grupo de recursos.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	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 Azure Resource Manager ou do portal.
subscriptionId	path	True	string	Obtém o ID da subscrição que identifica exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do Cliente.

Respostas

Name	Tipo	Description
200 OK	SignalRResourceList	Com êxito. A resposta descreve a lista de recursos num resourceGroup.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar 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=2023-02-01

/** Samples for SignalR ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/signalr/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/SignalR_ListByResourceGroup.json
     */
    /**
     * Sample code: SignalR_ListByResourceGroup.
     *
     * @param manager Entry point to SignalRManager.
     */
    public static void signalRListByResourceGroup(com.azure.resourcemanager.signalr.SignalRManager manager) {
        manager.signalRs().listByResourceGroup("myResourceGroup", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.signalr import SignalRManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-signalr
# USAGE
    python signal_r_list_by_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SignalRManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.signal_r.list_by_resource_group(
        resource_group_name="myResourceGroup",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/signalr/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/SignalR_ListByResourceGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsignalr_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/signalr/armsignalr"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/SignalR_ListByResourceGroup.json
func ExampleClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsignalr.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewClient().NewListByResourceGroupPager("myResourceGroup", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ResourceInfoList = armsignalr.ResourceInfoList{
		// 	Value: []*armsignalr.ResourceInfo{
		// 		{
		// 			Name: to.Ptr("mySignalRService"),
		// 			Type: to.Ptr("Microsoft.SignalRService/SignalR"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"),
		// 			Location: to.Ptr("eastus"),
		// 			Tags: map[string]*string{
		// 				"key1": to.Ptr("value1"),
		// 			},
		// 			Identity: &armsignalr.ManagedIdentity{
		// 				Type: to.Ptr(armsignalr.ManagedIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 			},
		// 			Kind: to.Ptr(armsignalr.ServiceKindSignalR),
		// 			Properties: &armsignalr.Properties{
		// 				Cors: &armsignalr.CorsSettings{
		// 					AllowedOrigins: []*string{
		// 						to.Ptr("https://foo.com"),
		// 						to.Ptr("https://bar.com")},
		// 					},
		// 					DisableAADAuth: to.Ptr(false),
		// 					DisableLocalAuth: to.Ptr(false),
		// 					ExternalIP: to.Ptr("10.0.0.1"),
		// 					Features: []*armsignalr.Feature{
		// 						{
		// 							Flag: to.Ptr(armsignalr.FeatureFlagsServiceMode),
		// 							Properties: map[string]*string{
		// 							},
		// 							Value: to.Ptr("Serverless"),
		// 						},
		// 						{
		// 							Flag: to.Ptr(armsignalr.FeatureFlagsEnableConnectivityLogs),
		// 							Properties: map[string]*string{
		// 							},
		// 							Value: to.Ptr("True"),
		// 						},
		// 						{
		// 							Flag: to.Ptr(armsignalr.FeatureFlagsEnableMessagingLogs),
		// 							Properties: map[string]*string{
		// 							},
		// 							Value: to.Ptr("False"),
		// 						},
		// 						{
		// 							Flag: to.Ptr(armsignalr.FeatureFlagsEnableLiveTrace),
		// 							Properties: map[string]*string{
		// 							},
		// 							Value: to.Ptr("False"),
		// 					}},
		// 					HostName: to.Ptr("mysignalrservice.service.signalr.net"),
		// 					LiveTraceConfiguration: &armsignalr.LiveTraceConfiguration{
		// 						Categories: []*armsignalr.LiveTraceCategory{
		// 							{
		// 								Name: to.Ptr("ConnectivityLogs"),
		// 								Enabled: to.Ptr("true"),
		// 						}},
		// 						Enabled: to.Ptr("false"),
		// 					},
		// 					NetworkACLs: &armsignalr.NetworkACLs{
		// 						DefaultAction: to.Ptr(armsignalr.ACLActionDeny),
		// 						PrivateEndpoints: []*armsignalr.PrivateEndpointACL{
		// 							{
		// 								Allow: []*armsignalr.SignalRRequestType{
		// 									to.Ptr(armsignalr.SignalRRequestTypeServerConnection)},
		// 									Name: to.Ptr("mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
		// 							}},
		// 							PublicNetwork: &armsignalr.NetworkACL{
		// 								Allow: []*armsignalr.SignalRRequestType{
		// 									to.Ptr(armsignalr.SignalRRequestTypeClientConnection)},
		// 								},
		// 							},
		// 							PrivateEndpointConnections: []*armsignalr.PrivateEndpointConnection{
		// 								{
		// 									Name: to.Ptr("mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
		// 									Type: to.Ptr("Microsoft.SignalRService/SignalR/privateEndpointConnections"),
		// 									ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
		// 									Properties: &armsignalr.PrivateEndpointConnectionProperties{
		// 										PrivateEndpoint: &armsignalr.PrivateEndpoint{
		// 											ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"),
		// 										},
		// 										PrivateLinkServiceConnectionState: &armsignalr.PrivateLinkServiceConnectionState{
		// 											ActionsRequired: to.Ptr("None"),
		// 											Status: to.Ptr(armsignalr.PrivateLinkServiceConnectionStatusApproved),
		// 										},
		// 										ProvisioningState: to.Ptr(armsignalr.ProvisioningStateSucceeded),
		// 									},
		// 									SystemData: &armsignalr.SystemData{
		// 										CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
		// 										CreatedBy: to.Ptr("string"),
		// 										CreatedByType: to.Ptr(armsignalr.CreatedByTypeUser),
		// 										LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
		// 										LastModifiedBy: to.Ptr("string"),
		// 										LastModifiedByType: to.Ptr(armsignalr.CreatedByTypeUser),
		// 									},
		// 							}},
		// 							ProvisioningState: to.Ptr(armsignalr.ProvisioningStateSucceeded),
		// 							PublicNetworkAccess: to.Ptr("Enabled"),
		// 							PublicPort: to.Ptr[int32](443),
		// 							ResourceLogConfiguration: &armsignalr.ResourceLogConfiguration{
		// 								Categories: []*armsignalr.ResourceLogCategory{
		// 									{
		// 										Name: to.Ptr("ConnectivityLogs"),
		// 										Enabled: to.Ptr("true"),
		// 								}},
		// 							},
		// 							ServerPort: to.Ptr[int32](443),
		// 							Serverless: &armsignalr.ServerlessSettings{
		// 								ConnectionTimeoutInSeconds: to.Ptr[int32](5),
		// 							},
		// 							TLS: &armsignalr.TLSSettings{
		// 								ClientCertEnabled: to.Ptr(true),
		// 							},
		// 							Upstream: &armsignalr.ServerlessUpstreamSettings{
		// 								Templates: []*armsignalr.UpstreamTemplate{
		// 									{
		// 										URLTemplate: to.Ptr("http://foo.com"),
		// 								}},
		// 							},
		// 							Version: to.Ptr("1.0"),
		// 						},
		// 						SKU: &armsignalr.ResourceSKU{
		// 							Name: to.Ptr("Premium_P1"),
		// 							Capacity: to.Ptr[int32](1),
		// 							Size: to.Ptr("P1"),
		// 							Tier: to.Ptr(armsignalr.SignalRSKUTierPremium),
		// 						},
		// 						SystemData: &armsignalr.SystemData{
		// 							CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
		// 							CreatedBy: to.Ptr("string"),
		// 							CreatedByType: to.Ptr(armsignalr.CreatedByTypeUser),
		// 							LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
		// 							LastModifiedBy: to.Ptr("string"),
		// 							LastModifiedByType: to.Ptr(armsignalr.CreatedByTypeUser),
		// 						},
		// 				}},
		// 			}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SignalRManagementClient } = require("@azure/arm-signalr");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Handles requests to list all resources in a resource group.
 *
 * @summary Handles requests to list all resources in a resource group.
 * x-ms-original-file: specification/signalr/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/SignalR_ListByResourceGroup.json
 */
async function signalRListByResourceGroup() {
  const subscriptionId =
    process.env["SIGNALR_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["SIGNALR_RESOURCE_GROUP"] || "myResourceGroup";
  const credential = new DefaultAzureCredential();
  const client = new SignalRManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.signalR.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "sku": {
        "name": "Premium_P1",
        "tier": "Premium",
        "size": "P1",
        "capacity": 1
      },
      "properties": {
        "provisioningState": "Succeeded",
        "externalIP": "10.0.0.1",
        "hostName": "mysignalrservice.service.signalr.net",
        "publicPort": 443,
        "serverPort": 443,
        "version": "1.0",
        "privateEndpointConnections": [
          {
            "systemData": {
              "createdBy": "string",
              "createdByType": "User",
              "createdAt": "2015-02-03T04:05:06Z",
              "lastModifiedBy": "string",
              "lastModifiedByType": "User",
              "lastModifiedAt": "2015-02-03T04:05:06Z"
            },
            "properties": {
              "provisioningState": "Succeeded",
              "privateEndpoint": {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
              },
              "privateLinkServiceConnectionState": {
                "status": "Approved",
                "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"
          }
        ],
        "tls": {
          "clientCertEnabled": true
        },
        "features": [
          {
            "flag": "ServiceMode",
            "value": "Serverless",
            "properties": {}
          },
          {
            "flag": "EnableConnectivityLogs",
            "value": "True",
            "properties": {}
          },
          {
            "flag": "EnableMessagingLogs",
            "value": "False",
            "properties": {}
          },
          {
            "flag": "EnableLiveTrace",
            "value": "False",
            "properties": {}
          }
        ],
        "liveTraceConfiguration": {
          "enabled": "false",
          "categories": [
            {
              "name": "ConnectivityLogs",
              "enabled": "true"
            }
          ]
        },
        "resourceLogConfiguration": {
          "categories": [
            {
              "name": "ConnectivityLogs",
              "enabled": "true"
            }
          ]
        },
        "cors": {
          "allowedOrigins": [
            "https://foo.com",
            "https://bar.com"
          ]
        },
        "serverless": {
          "connectionTimeoutInSeconds": 5
        },
        "upstream": {
          "templates": [
            {
              "urlTemplate": "http://foo.com"
            }
          ]
        },
        "networkACLs": {
          "defaultAction": "Deny",
          "publicNetwork": {
            "allow": [
              "ClientConnection"
            ]
          },
          "privateEndpoints": [
            {
              "name": "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
              "allow": [
                "ServerConnection"
              ]
            }
          ]
        },
        "publicNetworkAccess": "Enabled",
        "disableLocalAuth": false,
        "disableAadAuth": false
      },
      "kind": "SignalR",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "tenantId": "00000000-0000-0000-0000-000000000000"
      },
      "systemData": {
        "createdBy": "string",
        "createdByType": "User",
        "createdAt": "2015-02-03T04:05:06Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2015-02-03T04:05:06Z"
      },
      "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

Name	Description
ACLAction	Ação da ACL de Rede do Azure.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
FeatureFlags	FeatureFlags são as funcionalidades suportadas do serviço Azure SignalR. ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Predefinição": tenha o seu próprio servidor de back-end; "Sem servidor": a aplicação não tem um servidor de back-end; "Clássico": para retrocompatibilidade. Suporte para o modo Predefinido e Sem Servidor, mas não recomendado; "PredefinedOnly": para utilização futura. EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente. EnableMessagingLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente. EnableLiveTrace: o Rastreio Em Direto permite-lhe saber o que está a acontecer dentro do serviço Azure SignalR, irá fornecer-lhe rastreios em tempo real, será útil quando desenvolver a sua própria aplicação Web baseada no Azure SignalR ou resolver automaticamente alguns problemas. Tenha em atenção que os rastreios dinâmicos são contabilizados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para ativar/desativar a funcionalidade de rastreio dinâmico.
LiveTraceCategory	Configuração da categoria de rastreio em direto de um recurso Microsoft.SignalRService.
LiveTraceConfiguration	Configuração de rastreio em direto de um recurso Microsoft.SignalRService.
ManagedIdentity	Uma classe representa identidades geridas utilizadas para pedido e resposta
ManagedIdentitySettings	Definições de identidade gerida para o upstream.
ManagedIdentityType	Representa o tipo de identidade: systemAssigned, userAssigned, None
NetworkACL	ACL de Rede
PrivateEndpoint	Ponto final privado
PrivateEndpointACL	ACL para um ponto final privado
PrivateEndpointConnection	Uma ligação de ponto final privado a um recurso do Azure
PrivateLinkServiceConnectionState	Estado de ligação da ligação do ponto final privado
PrivateLinkServiceConnectionStatus	Indica se a ligação foi Aprovada/Rejeitada/Removida pelo proprietário do serviço.
ProvisioningState	Estado de aprovisionamento do recurso.
ResourceLogCategory	Configuração da categoria de registo de recursos de um recurso Microsoft.SignalRService.
ResourceLogConfiguration	Configuração do registo de recursos de um recurso Microsoft.SignalRService.
ResourceSku	As informações de faturação do recurso.
ServerlessSettings	Definições sem servidor.
ServerlessUpstreamSettings	As definições para o Upstream quando o serviço está no modo sem servidor.
ServiceKind	O tipo de serviço, pode ser SignalR ou RawWebSockets
SharedPrivateLinkResource	Descreve um Recurso de Private Link Partilhado
SharedPrivateLinkResourceStatus	Estado do recurso de ligação privada partilhado
SignalRCorsSettings	Definições de Partilha de Recursos transversais à Origem (CORS).
SignalRFeature	Funcionalidade de um recurso, que controla o comportamento do runtime.
SignalRNetworkACLs	ACLs de rede para o recurso
SignalRRequestType	O tipo de pedido recebido para o serviço
SignalRResource	Uma classe representa um recurso.
SignalRResourceList	Objeto que inclui uma matriz de recursos e uma possível ligação para o próximo conjunto.
SignalRSkuTier	Camada opcional deste SKU específico. "Standard" ou "Gratuito". `Basic` foi preterido, utilize `Standard` em vez disso.
SignalRTlsSettings	Definições de TLS para o recurso
systemData	Metadados relativos à criação e última modificação do recurso.
UpstreamAuthSettings	Definições de autenticação a montante. Se não estiver definido, não será utilizada nenhuma autenticação para mensagens a montante.
UpstreamAuthType	Enumeração do tipo de autenticação a montante.
UpstreamTemplate	Definições de item de modelo a montante. Define o URL de Origem dos pedidos recebidos. O modelo define o padrão do evento, o hub ou a categoria do pedido recebido que corresponde ao modelo de URL atual.
UserAssignedIdentityProperty	Propriedades da identidade atribuída pelo utilizador.

ACLAction

Ação da ACL de Rede do Azure.

Name	Tipo	Description
Allow	string
Deny	string

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

FeatureFlags

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

ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Predefinição": tenha o seu próprio servidor de back-end; "Sem servidor": a aplicação não tem um servidor de back-end; "Clássico": para retrocompatibilidade. Suporte para o modo Predefinido e Sem Servidor, mas não recomendado; "PredefinedOnly": para utilização futura.
EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente.
EnableMessagingLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente.
EnableLiveTrace: o Rastreio Em Direto permite-lhe saber o que está a acontecer dentro do serviço Azure SignalR, irá fornecer-lhe rastreios em tempo real, será útil quando desenvolver a sua própria aplicação Web baseada no Azure SignalR ou resolver automaticamente alguns problemas. Tenha em atenção que os rastreios dinâmicos são contabilizados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para ativar/desativar a funcionalidade de rastreio dinâmico.

Name	Tipo	Description
EnableConnectivityLogs	string
EnableLiveTrace	string
EnableMessagingLogs	string
ServiceMode	string

LiveTraceCategory

Configuração da categoria de rastreio em direto de um recurso Microsoft.SignalRService.

Name	Tipo	Description
enabled	string	Indica se ou a categoria de rastreio dinâmico está ativada. Valores disponíveis: true, false. Não sensível a maiúsculas e minúsculas
name	string	Obtém ou define o nome da categoria de rastreio dinâmico. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não sensível a maiúsculas e minúsculas

LiveTraceConfiguration

Configuração de rastreio em direto de um recurso Microsoft.SignalRService.

Name	Tipo	Valor Predefinido	Description
categories	LiveTraceCategory[]		Obtém ou define a lista de configurações de categorias.
enabled	string	false	Indica se ativa ou não o rastreio em direto. Quando estiver definido como verdadeiro, o cliente de rastreio em direto pode ligar-se ao serviço. Caso contrário, o cliente de rastreio dinâmico não consegue ligar-se ao serviço, pelo que não pode receber qualquer registo, independentemente do que configurar em "categorias". Valores disponíveis: true, false. Não sensível a maiúsculas e minúsculas

ManagedIdentity

Uma classe representa identidades geridas utilizadas para pedido e resposta

Name	Tipo	Description
principalId	string	Obtenha o ID principal da identidade atribuída pelo sistema. Só pode ser utilizado na resposta.
tenantId	string	Obtenha o ID do inquilino da identidade atribuída pelo sistema. Ser utilizado apenas na resposta
type	ManagedIdentityType	Representa o tipo de identidade: systemAssigned, userAssigned, None
userAssignedIdentities	<string, UserAssignedIdentityProperty>	Obter ou definir as identidades atribuídas pelo utilizador

ManagedIdentitySettings

Definições de identidade gerida para o upstream.

Name	Tipo	Description
resource	string	O Recurso que indica o URI do ID da Aplicação do recurso de destino. Também aparece na afirmação aud (audiência) do token emitido.

ManagedIdentityType

Representa o tipo de identidade: systemAssigned, userAssigned, None

Name	Tipo	Description
None	string
SystemAssigned	string
UserAssigned	string

NetworkACL

ACL de Rede

Name	Tipo	Description
allow	SignalRRequestType[]	Tipos de pedido permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.
deny	SignalRRequestType[]	Tipos de pedido negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Ponto final privado

Name	Tipo	Description
id	string	ID completamente qualificado do ponto final privado

PrivateEndpointACL

ACL para um ponto final privado

Name	Tipo	Description
allow	SignalRRequestType[]	Tipos de pedido permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.
deny	SignalRRequestType[]	Tipos de pedido negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.
name	string	Nome da ligação de ponto final privado

PrivateEndpointConnection

Uma ligação de ponto final privado a um recurso do Azure

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso.
name	string	O nome do recurso.
properties.groupIds	string[]	IDs de Grupo
properties.privateEndpoint	PrivateEndpoint	Ponto final privado
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Estado de ligação da ligação do ponto final privado
properties.provisioningState	ProvisioningState	Estado de aprovisionamento do recurso.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
type	string	O tipo do recurso – por exemplo, "Microsoft.SignalRService/SignalR"

PrivateLinkServiceConnectionState

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

Name	Tipo	Description
actionsRequired	string	Uma mensagem a indicar se as alterações no fornecedor de serviços requerem atualizações no consumidor.
description	string	O motivo da aprovação/rejeição da ligação.
status	PrivateLinkServiceConnectionStatus	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	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Estado de aprovisionamento do recurso.

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

ResourceLogCategory

Configuração da categoria de registo de recursos de um recurso Microsoft.SignalRService.

Name	Tipo	Description
enabled	string	Indica se ou a categoria de registo de recursos está ativada. Valores disponíveis: true, false. Não sensível a maiúsculas e minúsculas
name	string	Obtém ou define o nome da categoria de registo de recursos. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não sensível a maiúsculas e minúsculas

ResourceLogConfiguration

Configuração do registo de recursos de um recurso Microsoft.SignalRService.

Name	Tipo	Description
categories	ResourceLogCategory[]	Obtém ou define a lista de configurações de categorias.

ResourceSku

As informações de faturação do recurso.

Name	Tipo	Description
capacity	integer	Opcional, número inteiro. A contagem de unidades do recurso. 1 por predefinição. Se estiverem presentes, são permitidos os seguintes valores: Gratuito: 1; Padrão: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
family	string	Não utilizado. Retido para utilização futura.
name	string	O nome do SKU. Obrigatório. Valores permitidos: Standard_S1, Free_F1, Premium_P1
size	string	Não utilizado. Retido para utilização futura.
tier	SignalRSkuTier	Camada opcional deste SKU específico. "Standard" ou "Gratuito". `Basic` foi preterido, utilize `Standard` em vez disso.

ServerlessSettings

Definições sem servidor.

Name	Tipo	Valor Predefinido	Description
connectionTimeoutInSeconds	integer	30	Obtém ou define o Tempo Limite da Ligação do Cliente. Opcional a ser definido. Valor em segundos. O valor predefinido é 30 segundos. O cliente deve definir o tempo limite para um período mais curto se as mensagens forem enviadas em intervalos mais curtos e pretender que o cliente desligue mais rapidamente após o envio da última mensagem. Pode definir o tempo limite para um período mais longo se as mensagens forem enviadas em intervalos mais longos e quiserem manter viva a mesma ligação de cliente durante esta sessão. O serviço considera o cliente desligado se não tiver recebido uma mensagem (incluindo keep-alive) neste intervalo.

ServerlessUpstreamSettings

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

Name	Tipo	Description
templates	UpstreamTemplate[]	Obtém ou define a lista de modelos de URL a montante. A ordem é importante e o primeiro modelo correspondente tem efeitos.

ServiceKind

O tipo de serviço, pode ser SignalR ou RawWebSockets

Name	Tipo	Description
RawWebSockets	string
SignalR	string

SharedPrivateLinkResource

Descreve um Recurso de Private Link Partilhado

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso.
name	string	O nome do recurso.
properties.groupId	string	O ID de grupo do fornecedor do recurso para o qual o recurso de ligação privada partilhada se destina
properties.privateLinkResourceId	string	O ID de recurso do recurso para o recurso de ligação privada partilhada destina-se a
properties.provisioningState	ProvisioningState	Estado de aprovisionamento do recurso.
properties.requestMessage	string	A mensagem de pedido para pedir a aprovação do recurso de ligação privada partilhada
properties.status	SharedPrivateLinkResourceStatus	Estado do recurso de ligação privada partilhado
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
type	string	O tipo do recurso – por exemplo, "Microsoft.SignalRService/SignalR"

SharedPrivateLinkResourceStatus

Estado do recurso de ligação privada partilhado

Name	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

SignalRCorsSettings

Definições de Partilha de Recursos transversais à Origem (CORS).

Name	Tipo	Description
allowedOrigins	string[]	Obtém ou define a lista de origens que devem ser autorizadas a fazer chamadas entre origens (por exemplo: http://example.com:12345). Utilize "*" para permitir todos. Se for omitido, permita tudo por predefinição.

SignalRFeature

Funcionalidade de um recurso, que controla o comportamento do runtime.

Name	Tipo	Description
flag	FeatureFlags	FeatureFlags são as funcionalidades suportadas do serviço Azure SignalR. ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Predefinição": tenha o seu próprio servidor de back-end; "Sem servidor": a aplicação não tem um servidor de back-end; "Clássico": para retrocompatibilidade. Suporte para o modo Predefinido e Sem Servidor, mas não recomendado; "PredefinedOnly": para utilização futura. EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente. EnableMessagingLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente. EnableLiveTrace: o Rastreio Em Direto permite-lhe saber o que está a acontecer dentro do serviço Azure SignalR, irá fornecer-lhe rastreios em tempo real, será útil quando desenvolver a sua própria aplicação Web baseada no Azure SignalR ou resolver automaticamente alguns problemas. Tenha em atenção que os rastreios dinâmicos são contabilizados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para ativar/desativar a funcionalidade de rastreio dinâmico.
properties	object	Propriedades opcionais relacionadas com esta funcionalidade.
value	string	Valor do sinalizador de funcionalidade. Veja o documento https://docs.microsoft.com/azure/azure-signalr/ do serviço Azure SignalR para obter os valores permitidos.

Name

Tipo

Description

flag

FeatureFlags

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

ServiceMode: sinalizador para o servidor de back-end para o serviço SignalR. Valores permitidos: "Predefinição": tenha o seu próprio servidor de back-end; "Sem servidor": a aplicação não tem um servidor de back-end; "Clássico": para retrocompatibilidade. Suporte para o modo Predefinido e Sem Servidor, mas não recomendado; "PredefinedOnly": para utilização futura.
EnableConnectivityLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente.
EnableMessagingLogs: "true"/"false", para ativar/desativar a categoria de registo de conectividade, respetivamente.
EnableLiveTrace: o Rastreio Em Direto permite-lhe saber o que está a acontecer dentro do serviço Azure SignalR, irá fornecer-lhe rastreios em tempo real, será útil quando desenvolver a sua própria aplicação Web baseada no Azure SignalR ou resolver automaticamente alguns problemas. Tenha em atenção que os rastreios dinâmicos são contabilizados como mensagens de saída que serão cobradas. Valores permitidos: "true"/"false", para ativar/desativar a funcionalidade de rastreio dinâmico.

properties

object

Propriedades opcionais relacionadas com esta funcionalidade.

value

string

Valor do sinalizador de funcionalidade. Veja o documento https://docs.microsoft.com/azure/azure-signalr/ do serviço Azure SignalR para obter os valores permitidos.

SignalRNetworkACLs

ACLs de rede para o recurso

Name	Tipo	Description
defaultAction	ACLAction	Ação da ACL de Rede do Azure.
privateEndpoints	PrivateEndpointACL[]	ACLs para pedidos de pontos finais privados
publicNetwork	NetworkACL	ACL de Rede

SignalRRequestType

O tipo de pedido recebido para o serviço

Name	Tipo	Description
ClientConnection	string
RESTAPI	string
ServerConnection	string
Trace	string

SignalRResource

Uma classe representa um recurso.

Name	Tipo	Valor Predefinido	Description
id	string		ID de recurso completamente qualificado para o recurso.
identity	ManagedIdentity		Uma classe representa identidades geridas utilizadas para pedido e resposta
kind	ServiceKind		O tipo de serviço, pode ser SignalR ou RawWebSockets
location	string		A localização GEO do recurso. Por exemplo, E.U.A. Oeste \| E.U.A. Leste \| E.U.A. Centro-Norte \| E.U.A. Centro-Sul.
name	string		O nome do recurso.
properties.cors	SignalRCorsSettings		Definições de Partilha de Recursos transversais à Origem (CORS).
properties.disableAadAuth	boolean	False	DisableLocalAuth Ativar ou desativar a autenticação de aad Quando definida como verdadeira, a ligação com AuthType=aad não funcionará.
properties.disableLocalAuth	boolean	False	DisableLocalAuth Ativar ou desativar a autenticação local com AccessKey Quando definido como verdadeiro, a ligação com AccessKey=xxx não funcionará.
properties.externalIP	string		O IP acessível publicamente do recurso.
properties.features	SignalRFeature[]		Lista de featureFlags. FeatureFlags que não estão incluídos nos parâmetros da operação de atualização não serão modificados. Além disso, a resposta incluirá apenas featureFlags que estão explicitamente definidos. Quando uma featureFlag não está explicitamente definida, o valor predefinido globalmente será utilizado. No entanto, tenha em atenção que o valor predefinido não significa "falso". Varia em termos de FeatureFlags diferentes.
properties.hostName	string		FQDN da instância de serviço.
properties.hostNamePrefix	string		Preterido.
properties.liveTraceConfiguration	LiveTraceConfiguration		Configuração de rastreio em direto de um recurso Microsoft.SignalRService.
properties.networkACLs	SignalRNetworkACLs		ACLs de rede para o recurso
properties.privateEndpointConnections	PrivateEndpointConnection[]		Ligações de ponto final privado ao recurso.
properties.provisioningState	ProvisioningState		Estado de aprovisionamento do recurso.
properties.publicNetworkAccess	string	Enabled	Ativar ou desativar o acesso à rede pública. A predefinição é "Ativado". Quando estiver Ativado, as ACLs de rede continuam a ser aplicadas. Quando está Desativado, o acesso à rede pública é sempre desativado independentemente do que definir nas ACLs de rede.
properties.publicPort	integer		A porta acessível publicamente do recurso que foi concebida para utilização do lado do browser/cliente.
properties.resourceLogConfiguration	ResourceLogConfiguration		Configuração do registo de recursos de um recurso Microsoft.SignalRService.
properties.serverPort	integer		A porta acessível publicamente do recurso que foi concebida para utilização do lado do servidor do cliente.
properties.serverless	ServerlessSettings		Definições sem servidor.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		A lista de recursos de ligação privada partilhados.
properties.tls	SignalRTlsSettings		Definições de TLS para o recurso
properties.upstream	ServerlessUpstreamSettings		As definições para o Upstream quando o serviço está no modo sem servidor.
properties.version	string		Versão do recurso. Provavelmente, precisa da mesma versão ou versão superior dos SDKs de cliente.
sku	ResourceSku		As informações de faturação do recurso.
systemData	systemData		Metadados relativos à criação e última modificação do recurso.
tags	object		Etiquetas do serviço, que é uma lista de pares chave-valor que descrevem o recurso.
type	string		O tipo do recurso – por exemplo, "Microsoft.SignalRService/SignalR"

SignalRResourceList

Objeto que inclui uma matriz de recursos e uma possível ligação para o próximo conjunto.

Name	Tipo	Description
nextLink	string	O URL que o cliente deve utilizar para obter a página seguinte (por paginação do lado do servidor). É nulo por enquanto, adicionado para utilização futura.
value	SignalRResource[]	Lista dos recursos

SignalRSkuTier

Camada opcional deste SKU específico. "Standard" ou "Gratuito".

Basic foi preterido, utilize Standard em vez disso.

Name	Tipo	Description
Basic	string
Free	string
Premium	string
Standard	string

SignalRTlsSettings

Definições de TLS para o recurso

Name	Tipo	Valor Predefinido	Description
clientCertEnabled	boolean	True	Pedir certificado de cliente durante o handshake TLS, se ativado

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UpstreamAuthSettings

Definições de autenticação a montante. Se não estiver definido, não será utilizada nenhuma autenticação para mensagens a montante.

Name	Tipo	Description
managedIdentity	ManagedIdentitySettings	Definições de identidade gerida para o upstream.
type	UpstreamAuthType	Enumeração do tipo de autenticação a montante.

UpstreamAuthType

Enumeração do tipo de autenticação a montante.

Name	Tipo	Description
ManagedIdentity	string
None	string

UpstreamTemplate

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

Name	Tipo	Description
auth	UpstreamAuthSettings	Definições de autenticação a montante. Se não estiver definido, não será utilizada nenhuma autenticação para mensagens a montante.
categoryPattern	string	Obtém ou define o padrão correspondente para nomes de categorias. Se não estiver definido, corresponde a qualquer categoria. Existem três tipos de padrões suportados: 1. "*", que corresponde a qualquer nome de categoria. 2. Combine múltiplas categorias com "", por exemplo "ligações,mensagens", corresponde às categorias "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 correspondente para nomes de eventos. Se não estiver definido, corresponde a qualquer evento. Existem três tipos de padrões suportados: 1. "*", corresponde a qualquer nome de evento. 2. Combine vários eventos com ",", por exemplo "ligar,desligar", corresponde ao evento "ligar" e "desligar". 3. O nome do evento único, por exemplo, "ligar", corresponde a "ligar".
hubPattern	string	Obtém ou define o padrão correspondente para os nomes dos hubs. Se não estiver definido, corresponde a qualquer hub. Existem três tipos de padrões suportados: 1. "*", que corresponde a qualquer nome do hub. 2. Combine vários hubs com ",", por exemplo "hub1,hub2", corresponde a "hub1" e "hub2". 3. O nome do hub único, por exemplo, "hub1", corresponde a "hub1".
urlTemplate	string	Obtém ou define o modelo de URL a montante. Pode utilizar 3 parâmetros predefinidos {hub}, {category} {event} dentro do modelo. O valor do URL a Montante é calculado dinamicamente quando o pedido de cliente é recebido. Por exemplo, se o urlTemplate for `http://example.com/{hub}/api/{event}`, com um pedido de cliente do hub `chat` ligado, será primeiro POST para este URL: `http://example.com/chat/api/connect`.

UserAssignedIdentityProperty

Propriedades da identidade atribuída pelo utilizador.

Name	Tipo	Description
clientId	string	Obter o ID de cliente da identidade atribuída pelo utilizador
principalId	string	Obter o ID principal da identidade atribuída pelo utilizador

SignalR - List By Resource Group

Parâmetros do URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

SignalR_ListByResourceGroup

Sample Request

Sample Response

Definições

ACLAction

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureFlags

LiveTraceCategory

LiveTraceConfiguration

ManagedIdentity

ManagedIdentitySettings

ManagedIdentityType

NetworkACL

PrivateEndpoint

PrivateEndpointACL

PrivateEndpointConnection

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

ResourceLogCategory

ResourceLogConfiguration

ResourceSku

ServerlessSettings

ServerlessUpstreamSettings

ServiceKind

SharedPrivateLinkResource

SharedPrivateLinkResourceStatus

SignalRCorsSettings

SignalRFeature

SignalRNetworkACLs

SignalRRequestType

SignalRResource

SignalRResourceList

SignalRSkuTier

SignalRTlsSettings

systemData

UpstreamAuthSettings

UpstreamAuthType

UpstreamTemplate

UserAssignedIdentityProperty

Recursos adicionais