Operations - List

Odwołanie

Service:: Azure Web PubSub Service

API Version:: 2023-02-01

Listy wszystkie dostępne operacje interfejsu API REST dostawcy Microsoft.SignalRService.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	OperationList	Powodzenie. Odpowiedź opisuje listę operacji.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
Dimension	Specyfikacje wymiaru metryk.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
LogSpecification	Specyfikacje dzienników monitorowania platformy Azure.
MetricSpecification	Specyfikacje metryk monitorowania platformy Azure.
Operation	Operacja interfejsu API REST obsługiwana przez dostawcę zasobów.
OperationDisplay	Obiekt, który opisuje operację.
OperationList	Wynik żądania wyświetlenia listy operacji interfejsu API REST. Zawiera listę operacji.
OperationProperties	Właściwości dodatkowej operacji.
ServiceSpecification	Obiekt opisujący specyfikację.

Dimension

Specyfikacje wymiaru metryk.

Nazwa	Typ	Opis
displayName	string	Zlokalizowana przyjazna nazwa wyświetlana wymiaru.
internalName	string	Nazwa wymiaru wyświetlanego w rozwiązaniu MDM.
name	string	Publiczna nazwa wymiaru.
toBeExportedForShoebox	boolean	Flaga logiczna wskazująca, czy ten wymiar powinien być uwzględniony w scenariuszu eksportu shoebox.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

LogSpecification

Specyfikacje dzienników monitorowania platformy Azure.

Nazwa	Typ	Opis
displayName	string	Zlokalizowana przyjazna nazwa wyświetlana dziennika.
name	string	Nazwa dziennika.

MetricSpecification

Specyfikacje metryk monitorowania platformy Azure.

Nazwa	Typ	Opis
aggregationType	string	Podaj tylko jedną wartość dla tego pola. Prawidłowe wartości: Average, Minimum, Maximum, Total, Count.
category	string	Nazwa kategorii metryk, do którego należy metryka. Metryka może należeć tylko do jednej kategorii.
dimensions	Dimension[]	Wymiary metryk.
displayDescription	string	Zlokalizowany przyjazny opis metryki.
displayName	string	Zlokalizowana przyjazna nazwa wyświetlana metryki.
fillGapWithZero	string	Opcjonalny. Jeśli ustawiono wartość true, wartość zero zostanie zwrócona przez czas trwania, w którym nie jest emitowana/opublikowana żadna metryka. Na przykład metryka zwracająca liczbę emitowanych kodów określonego błędu. Kod błędu może nie pojawiać się często, zamiast publikowania 0, Shoebox może automatycznie wypełniać 0s w okresach, w których nic nie zostało emitowane.
name	string	Nazwa metryki.
unit	string	Jednostka, która ma sens dla metryki.

Operation

Operacja interfejsu API REST obsługiwana przez dostawcę zasobów.

Nazwa	Typ	Opis
display	OperationDisplay	Obiekt, który opisuje operację.
isDataAction	boolean	Jeśli operacja jest akcją danych. (w przypadku kontroli rbac płaszczyzny danych)
name	string	Nazwa operacji o formacie: {provider}/{resource}/{operation}
origin	string	Opcjonalny. Zamierzony wykonawca operacji; Zarządza wyświetlaniem operacji w środowisku użytkownika RBAC i środowiskiem użytkownika dzienników inspekcji.
properties	OperationProperties	Właściwości dodatkowej operacji.

OperationDisplay

Obiekt, który opisuje operację.

Nazwa	Typ	Opis
description	string	Zlokalizowany przyjazny opis operacji
operation	string	Zlokalizowana przyjazna nazwa operacji.
provider	string	Przyjazna nazwa dostawcy zasobów
resource	string	Typ zasobu, na którym jest wykonywana operacja.

OperationList

Wynik żądania wyświetlenia listy operacji interfejsu API REST. Zawiera listę operacji.

Nazwa	Typ	Opis
nextLink	string	Adres URL, który klient powinien użyć do pobrania następnej strony (na stronicowanie po stronie serwera). Na razie ma wartość null, dodaną do użytku w przyszłości.
value	Operation[]	Lista operacji obsługiwanych przez dostawcę zasobów.

OperationProperties

Właściwości dodatkowej operacji.

Nazwa	Typ	Opis
serviceSpecification	ServiceSpecification	Obiekt opisujący specyfikację.

ServiceSpecification

Obiekt opisujący specyfikację.

Nazwa	Typ	Opis
logSpecifications	LogSpecification[]	Specyfikacje dzienników monitorowania platformy Azure.
metricSpecifications	MetricSpecification[]	Specyfikacje metryk monitorowania platformy Azure.

Operations - List

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

Operations_List

Sample Request

Sample Response

Definicje

Dimension

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LogSpecification

MetricSpecification

Operation

OperationDisplay

OperationList

OperationProperties

ServiceSpecification

Dodatkowe zasoby