Operations - List

Riferimento

Service:: SignalR Service

API Version:: 2023-02-01

Elenchi tutte le operazioni API REST disponibili del provider Microsoft.SignalRService.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
api-version	query	True	string	Versione api client.

Risposte

Nome	Tipo	Descrizione
200 OK	OperationList	Operazione completata. La risposta descrive l'elenco di operazioni.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Operations_List

Sample Request

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

/** 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

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

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

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

Definizioni

Nome	Descrizione
Dimension	Specifiche della dimensione delle metriche.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
LogSpecification	Specifiche dei log per Monitoraggio di Azure.
MetricSpecification	Specifiche delle metriche per il monitoraggio di Azure.
Operation	Operazione API REST supportata dal provider di risorse.
OperationDisplay	Oggetto che descrive un'operazione.
OperationList	Risultato della richiesta di elencare le operazioni dell'API REST. Contiene un elenco di operazioni.
OperationProperties	Proprietà aggiuntive dell'operazione.
ServiceSpecification	Oggetto che descrive una specifica.

Dimension

Specifiche della dimensione delle metriche.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato descrittivo localizzato della dimensione.
internalName	string	Nome della dimensione visualizzata in MDM.
name	string	Nome pubblico della dimensione.
toBeExportedForShoebox	boolean	Flag booleano che indica se questa dimensione deve essere inclusa per lo scenario di esportazione di shoebox.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

LogSpecification

Specifiche dei log per Monitoraggio di Azure.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato descrittivo localizzato del log.
name	string	Nome del log.

MetricSpecification

Specifiche delle metriche per il monitoraggio di Azure.

Nome	Tipo	Descrizione
aggregationType	string	Specificare un solo valore per questo campo. Valori validi: Average, Minimum, Maximum, Total, Count.
category	string	Nome della categoria di metriche a cui appartiene la metrica. Una metrica può appartenere solo a una singola categoria.
dimensions	Dimension[]	Dimensioni delle metriche.
displayDescription	string	Descrizione descrittiva localizzata della metrica.
displayName	string	Nome visualizzato descrittivo localizzato della metrica.
fillGapWithZero	string	facoltativo. Se impostato su true, verrà restituito zero per la durata del tempo in cui non viene generata/pubblicata alcuna metrica. Ad esempio, una metrica che restituisce il numero di volte in cui è stato generato un codice di errore specifico. Il codice di errore potrebbe non essere visualizzato spesso, invece della pubblicazione rp 0, Shoebox può compilare automaticamente 0 per periodi di tempo in cui non è stato generato nulla.
name	string	Nome della metrica.
unit	string	Unità che ha senso per la metrica.

Operation

Operazione API REST supportata dal provider di risorse.

Nome	Tipo	Descrizione
display	OperationDisplay	Oggetto che descrive un'operazione.
isDataAction	boolean	Se l'operazione è un'azione dati. (per il controllo degli accessi in base al piano dati)
name	string	Nome dell'operazione con formato: {provider}/{resource}/{operation}
origin	string	facoltativo. Executor previsto dell'operazione; controlla la visualizzazione dell'operazione nell'esperienza utente del controllo degli accessi in base al ruolo e nell'esperienza utente dei log di controllo.
properties	OperationProperties	Proprietà aggiuntive dell'operazione.

OperationDisplay

Oggetto che descrive un'operazione.

Nome	Tipo	Descrizione
description	string	Descrizione descrittiva localizzata per l'operazione
operation	string	Nome descrittivo localizzato per l'operazione.
provider	string	Nome descrittivo del provider di risorse
resource	string	Tipo di risorsa in cui viene eseguita l'operazione.

OperationList

Risultato della richiesta di elencare le operazioni dell'API REST. Contiene un elenco di operazioni.

Nome	Tipo	Descrizione
nextLink	string	URL che il client deve usare per recuperare la pagina successiva (paging lato server). Per il momento è Null, aggiunto per un uso futuro.
value	Operation[]	Elenco delle operazioni supportate dal provider di risorse.

OperationProperties

Proprietà aggiuntive dell'operazione.

Nome	Tipo	Descrizione
serviceSpecification	ServiceSpecification	Oggetto che descrive una specifica.

ServiceSpecification

Oggetto che descrive una specifica.

Nome	Tipo	Descrizione
logSpecifications	LogSpecification[]	Specifiche dei log per Monitoraggio di Azure.
metricSpecifications	MetricSpecification[]	Specifiche delle metriche per il monitoraggio di Azure.

Operations - List

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Scopes

Esempio

Operations_List

Sample Request

Sample Response

Definizioni

Dimension

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LogSpecification

MetricSpecification

Operation

OperationDisplay

OperationList

OperationProperties

ServiceSpecification

Risorse aggiuntive