Operations - List

Référence

Service:: Azure Web PubSub Service

API Version:: 2023-02-01

Listes toutes les opérations d’API REST disponibles du fournisseur Microsoft.SignalRService.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	OperationList	Réussite. La réponse décrit la liste des opérations.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/Operations_List.json
     */
    /**
     * Sample code: Operations_List.
     *
     * @param manager Entry point to WebPubSubManager.
     */
    public static void operationsList(com.azure.resourcemanager.webpubsub.WebPubSubManager 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.webpubsub import WebPubSubManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-webpubsub
# 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 = WebPubSubManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

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


# x-ms-original-file: specification/webpubsub/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 armwebpubsub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/webpubsub/armwebpubsub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/webpubsub/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 := armwebpubsub.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 = armwebpubsub.OperationList{
		// 	Value: []*armwebpubsub.Operation{
		// 		{
		// 			Name: to.Ptr("Microsoft.SignalRService/WebPubSub/read"),
		// 			Display: &armwebpubsub.OperationDisplay{
		// 				Description: to.Ptr("View the resource settings and configurations in the management portal or through API"),
		// 				Operation: to.Ptr("Manage WebPubSub (read-only)"),
		// 				Provider: to.Ptr("Microsoft.SignalRService"),
		// 				Resource: to.Ptr("WebPubSub"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 			Properties: &armwebpubsub.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 { WebPubSubManagementClient } = require("@azure/arm-webpubsub");
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/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/Operations_List.json
 */
async function operationsList() {
  const subscriptionId =
    process.env["WEB-PUBSUB_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new WebPubSubManagementClient(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/WebPubSub/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft.SignalRService",
        "resource": "WebPubSub",
        "operation": "Manage WebPubSub (read-only)",
        "description": "View the resource settings and configurations in the management portal or through API"
      },
      "properties": {}
    }
  ],
  "nextLink": "providers/Microsoft.SignalRService?$skipToken={opaqueString}"
}

Définitions

Nom	Description
Dimension	Spécifications de la dimension des métriques.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
LogSpecification	Spécifications des journaux d’activité pour Azure Monitoring.
MetricSpecification	Spécifications des métriques pour Azure Monitoring.
Operation	Opération d’API REST prise en charge par le fournisseur de ressources.
OperationDisplay	Objet qui décrit une opération.
OperationList	Résultat de la demande de liste des opérations d’API REST. Il contient une liste d’opérations.
OperationProperties	Propriétés d’opération supplémentaires.
ServiceSpecification	Objet qui décrit une spécification.

Dimension

Spécifications de la dimension des métriques.

Nom	Type	Description
displayName	string	Nom d’affichage convivial localisé de la dimension.
internalName	string	Nom de la dimension telle qu’elle apparaît dans GPM.
name	string	Nom public de la dimension.
toBeExportedForShoebox	boolean	Indicateur booléen indiquant si cette dimension doit être incluse pour le scénario d’exportation shoebox.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

LogSpecification

Spécifications des journaux d’activité pour Azure Monitoring.

Nom	Type	Description
displayName	string	Nom d’affichage convivial localisé du journal.
name	string	Nom du journal.

MetricSpecification

Spécifications des métriques pour Azure Monitoring.

Nom	Type	Description
aggregationType	string	Fournissez une seule valeur pour ce champ. Valeurs valides : Moyenne, Minimum, Maximum, Total, Nombre.
category	string	Nom de la catégorie de métrique à laquelle appartient la métrique. Une métrique ne peut appartenir qu’à une seule catégorie.
dimensions	Dimension[]	Dimensions des métriques.
displayDescription	string	Description conviviale localisée de la métrique.
displayName	string	Nom d’affichage convivial localisé de la métrique.
fillGapWithZero	string	facultatif. Si la valeur est true, zéro est retourné pendant la durée pendant laquelle aucune métrique n’est émise/publiée. Par exemple, une métrique qui retourne le nombre de fois où un code d’erreur particulier a été émis. Le code d’erreur peut ne pas apparaître souvent, à la place de la publication rp 0, Shoebox peut remplir automatiquement 0s pour les périodes où rien n’a été émis.
name	string	nom attribué à la métrique.
unit	string	Unité qui est logique pour la métrique.

Operation

Opération d’API REST prise en charge par le fournisseur de ressources.

Nom	Type	Description
display	OperationDisplay	Objet qui décrit une opération.
isDataAction	boolean	Si l’opération est une action de données. (pour rbac de plan de données)
name	string	Nom de l’opération au format : {provider}/{resource}/{operation}
origin	string	facultatif. Exécuteur prévu de l’opération ; régit l’affichage de l’opération dans l’expérience utilisateur RBAC et l’expérience utilisateur des journaux d’audit.
properties	OperationProperties	Propriétés d’opération supplémentaires.

OperationDisplay

Objet qui décrit une opération.

Nom	Type	Description
description	string	Description conviviale localisée de l’opération
operation	string	Nom convivial localisé de l’opération.
provider	string	Nom convivial du fournisseur de ressources
resource	string	Type de ressource sur lequel l’opération est effectuée.

OperationList

Résultat de la demande de liste des opérations d’API REST. Il contient une liste d’opérations.

Nom	Type	Description
nextLink	string	URL que le client doit utiliser pour extraire la page suivante (par pagination côté serveur). Il est null pour l’instant, ajouté pour une utilisation ultérieure.
value	Operation[]	Liste des opérations prises en charge par le fournisseur de ressources.

OperationProperties

Propriétés d’opération supplémentaires.

Nom	Type	Description
serviceSpecification	ServiceSpecification	Objet qui décrit une spécification.

ServiceSpecification

Objet qui décrit une spécification.

Nom	Type	Description
logSpecifications	LogSpecification[]	Spécifications des journaux d’activité pour Azure Monitoring.
metricSpecifications	MetricSpecification[]	Spécifications des métriques pour Azure Monitoring.

Operations - List

Paramètres URI

Réponses

Sécurité

azure_auth

Scopes

Exemples

Operations_List

Sample Request

Sample Response

Définitions

Dimension

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LogSpecification

MetricSpecification

Operation

OperationDisplay

OperationList

OperationProperties

ServiceSpecification

Ressources supplémentaires