Operations - List

Reference

Service:: Azure Web PubSub Service

API Version:: 2023-02-01

Seznamy všechny dostupné operace rozhraní REST API poskytovatele Microsoft.SignalRService.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	OperationList	Úspěch. Odpověď popisuje seznam operací.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
Dimension	Specifikace dimenze metrik.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
LogSpecification	Specifikace protokolů pro monitorování Azure
MetricSpecification	Specifikace metrik pro monitorování Azure
Operation	Operace rozhraní REST API podporovaná poskytovatelem prostředků
OperationDisplay	Objekt, který popisuje operaci.
OperationList	Výsledek požadavku na výpis operací rozhraní REST API Obsahuje seznam operací.
OperationProperties	Další vlastnosti operace.
ServiceSpecification	Objekt, který popisuje specifikaci.

Dimension

Specifikace dimenze metrik.

Name	Typ	Description
displayName	string	Lokalizovaný popisný zobrazovaný název dimenze.
internalName	string	Název dimenze tak, jak se zobrazuje v MDM.
name	string	Veřejně přístupný název dimenze.
toBeExportedForShoebox	boolean	Logický příznak označující, zda má být tato dimenze zahrnuta do scénáře exportu Shoebox.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

LogSpecification

Specifikace protokolů pro monitorování Azure

Name	Typ	Description
displayName	string	Lokalizovaný popisný zobrazovaný název protokolu.
name	string	Název protokolu.

MetricSpecification

Specifikace metrik pro monitorování Azure

Name	Typ	Description
aggregationType	string	Zadejte pouze jednu hodnotu pro toto pole. Platné hodnoty: Průměr, Minimum, Maximum, Celkem, Počet.
category	string	Název kategorie metriky, do které metrika patří. Metrika může patřit pouze do jedné kategorie.
dimensions	Dimension[]	Dimenze metrik.
displayDescription	string	Lokalizovaný popis metriky.
displayName	string	Lokalizovaný popisný zobrazovaný název metriky
fillGapWithZero	string	Nepovinný parametr. Pokud je nastavená hodnota true, po dobu trvání, kdy se nevygeneruje ani nepublikuje žádná metrika, se vrátí nula. Například metrika, která vrací kolikrát byl vygenerován konkrétní kód chyby. Kód chyby se nemusí zobrazovat často, místo rp publikování 0 může Shoebox automaticky vyplnit 0s pro časová období, kdy se nic nevygenerovalo.
name	string	Název metriky
unit	string	Jednotka, která dává smysl pro metriku.

Operation

Operace rozhraní REST API podporovaná poskytovatelem prostředků

Name	Typ	Description
display	OperationDisplay	Objekt, který popisuje operaci.
isDataAction	boolean	Pokud je operace datová akce. (pro rbac roviny dat)
name	string	Název operace ve formátu: {provider}/{resource}/{operation}
origin	string	Nepovinný parametr. Zamýšlený exekutor operace; řídí zobrazení operace v uživatelském prostředí RBAC a v uživatelském prostředí protokolů auditu.
properties	OperationProperties	Další vlastnosti operace.

OperationDisplay

Objekt, který popisuje operaci.

Name	Typ	Description
description	string	Lokalizovaný popis operace
operation	string	Lokalizovaný popisný název operace.
provider	string	Popisný název poskytovatele prostředků
resource	string	Typ prostředku, se kterým se operace provádí.

OperationList

Výsledek požadavku na výpis operací rozhraní REST API Obsahuje seznam operací.

Name	Typ	Description
nextLink	string	Adresa URL, pomocí které by měl klient načíst další stránku (stránkování na straně serveru). Prozatím má hodnotu null a je přidaná pro budoucí použití.
value	Operation[]	Seznam operací podporovaných poskytovatelem prostředků

OperationProperties

Další vlastnosti operace.

Name	Typ	Description
serviceSpecification	ServiceSpecification	Objekt, který popisuje specifikaci.

ServiceSpecification

Objekt, který popisuje specifikaci.

Name	Typ	Description
logSpecifications	LogSpecification[]	Specifikace protokolů pro monitorování Azure
metricSpecifications	MetricSpecification[]	Specifikace metrik pro monitorování Azure

Operations - List

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

Operations_List

Sample Request

Sample Response

Definice

Dimension

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LogSpecification

MetricSpecification

Operation

OperationDisplay

OperationList

OperationProperties

ServiceSpecification

Další materiály