Operations - List

Service:

SignalR Service

API Version:

2023-02-01

Listas todas las operaciones de API REST disponibles del proveedor Microsoft.SignalRService.

GET https://management.azure.com/providers/Microsoft.SignalRService/operations?api-version=2023-02-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	OperationList	Correcto. La respuesta describe la lista de operaciones.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Operations_List

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.SignalRService/operations?api-version=2023-02-01

Java

/** Samples for Operations List. */
public final class Main {
    /*
     * x-ms-original-file: specification/signalr/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/Operations_List.json
     */
    /**
     * Sample code: Operations_List.
     *
     * @param manager Entry point to SignalRManager.
     */
    public static void operationsList(com.azure.resourcemanager.signalr.SignalRManager manager) {
        manager.operations().list(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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-signalr
# USAGE
    python operations_list.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="SUBSCRIPTION_ID",
    )

    response = client.operations.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/signalr/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/Operations_List.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

Go

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/Operations_List.json
func ExampleOperationsClient_NewListPager() {
	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.NewOperationsClient().NewListPager(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.OperationList = armsignalr.OperationList{
		// 	Value: []*armsignalr.Operation{
		// 		{
		// 			Name: to.Ptr("Microsoft.SignalRService/SignalR/read"),
		// 			Display: &armsignalr.OperationDisplay{
		// 				Description: to.Ptr("View the resource settings and configurations in the management portal or through API"),
		// 				Operation: to.Ptr("Manage SignalR (read-only)"),
		// 				Provider: to.Ptr("Microsoft.SignalRService"),
		// 				Resource: to.Ptr("SignalR"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 			Properties: &armsignalr.OperationProperties{
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Lists all of the available REST API operations of the Microsoft.SignalRService provider.
 *
 * @summary Lists all of the available REST API operations of the Microsoft.SignalRService provider.
 * x-ms-original-file: specification/signalr/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/Operations_List.json
 */
async function operationsList() {
  const subscriptionId =
    process.env["SIGNALR_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new SignalRManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.operations.list()) {
    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": [
    {
      "name": "Microsoft.SignalRService/SignalR/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft.SignalRService",
        "resource": "SignalR",
        "operation": "Manage SignalR (read-only)",
        "description": "View the resource settings and configurations in the management portal or through API"
      },
      "properties": {}
    }
  ],
  "nextLink": "providers/Microsoft.SignalRService?$skipToken={opaqueString}"
}

Definiciones

Nombre	Description
Dimension	Especificaciones de la dimensión de las métricas.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
LogSpecification	Especificaciones de los registros para la supervisión de Azure.
MetricSpecification	Especificaciones de las métricas para la supervisión de Azure.
Operation	Operación de API REST compatible con el proveedor de recursos.
OperationDisplay	Objeto que describe una operación.
OperationList	Resultado de la solicitud para enumerar las operaciones de la API REST. Contiene una lista de operaciones.
OperationProperties	Propiedades de operación adicional.
ServiceSpecification	Objeto que describe una especificación.

Dimension

Especificaciones de la dimensión de las métricas.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar descriptivo localizado de la dimensión.
internalName	string	Nombre de la dimensión tal como aparece en MDM.
name	string	Nombre público de la dimensión.
toBeExportedForShoebox	boolean	Marca booleana que indica si se debe incluir esta dimensión para el escenario de exportación de la caja de zapatos.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

LogSpecification

Especificaciones de los registros para la supervisión de Azure.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar descriptivo localizado del registro.
name	string	Nombre del registro.

MetricSpecification

Especificaciones de las métricas para la supervisión de Azure.

Nombre	Tipo	Description
aggregationType	string	Proporcione solo un valor para este campo. Valores válidos: Average, Minimum, Maximum, Total, Count.
category	string	Nombre de la categoría de métrica a la que pertenece la métrica. Una métrica solo puede pertenecer a una sola categoría.
dimensions	Dimension[]	Dimensiones de las métricas.
displayDescription	string	Descripción fácil localizada de la métrica.
displayName	string	Nombre para mostrar descriptivo localizado de la métrica.
fillGapWithZero	string	Opcional. Si se establece en true, se devolverá cero durante el tiempo en el que no se emite o publica ninguna métrica. Por ejemplo, una métrica que devuelve el número de veces que se emitió un código de error determinado. Es posible que el código de error no aparezca a menudo, en lugar del RP publishing 0, Shoebox puede rellenar automáticamente 0s durante períodos de tiempo en los que no se emitió nada.
name	string	el nombre de la métrica.
unit	string	Unidad que tiene sentido para la métrica.

Operation

Operación de API REST compatible con el proveedor de recursos.

Nombre	Tipo	Description
display	OperationDisplay	Objeto que describe una operación.
isDataAction	boolean	Si la operación es una acción de datos. (para rbac del plano de datos)
name	string	Nombre de la operación con formato: {provider}/{resource}/{operation}
origin	string	Opcional. Ejecutor previsto de la operación; rige la presentación de la operación en la experiencia de usuario de RBAC y la experiencia de usuario de los registros de auditoría.
properties	OperationProperties	Propiedades de operación adicional.

OperationDisplay

Objeto que describe una operación.

Nombre	Tipo	Description
description	string	Descripción fácil de localizar para la operación
operation	string	Nombre descriptivo localizado para la operación.
provider	string	Nombre descriptivo del proveedor de recursos
resource	string	Tipo de recurso en el que se realiza la operación.

OperationList

Resultado de la solicitud para enumerar las operaciones de la API REST. Contiene una lista de operaciones.

Nombre	Tipo	Description
nextLink	string	La dirección URL que el cliente debe usar para capturar la página siguiente (por paginación del lado servidor). Es null por ahora, agregado para su uso futuro.
value	Operation[]	Lista de operaciones admitidas por el proveedor de recursos.

OperationProperties

Propiedades de operación adicional.

Nombre	Tipo	Description
serviceSpecification	ServiceSpecification	Objeto que describe una especificación.

ServiceSpecification

Objeto que describe una especificación.

Nombre	Tipo	Description
logSpecifications	LogSpecification[]	Especificaciones de los registros para la supervisión de Azure.
metricSpecifications	MetricSpecification[]	Especificaciones de las métricas para la supervisión de Azure.