Operations - List

Service:

SignalR Service

API Version:

2023-02-01

Listák a Microsoft.SignalRService szolgáltató összes elérhető REST API-műveletét.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
api-version	query	True	string	Client API-verzió.

Válaszok

Name	Típus	Description
200 OK	OperationList	Sikeres művelet. A válasz ismerteti a műveletek listáját.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
Dimension	A metrikák dimenziójának specifikációi.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
LogSpecification	Az Azure Monitoring naplóinak specifikációi.
MetricSpecification	Az Azure Monitoring metrikáinak specifikációi.
Operation	Az erőforrás-szolgáltató által támogatott REST API-művelet.
OperationDisplay	A műveletet leíró objektum.
OperationList	A REST API-műveletek listázására irányuló kérelem eredménye. A műveletlistát tartalmazza.
OperationProperties	További művelettulajdonságok.
ServiceSpecification	Egy specifikációt leíró objektum.

Dimension

A metrikák dimenziójának specifikációi.

Name	Típus	Description
displayName	string	A dimenzió honosított, felhasználóbarát megjelenítendő neve.
internalName	string	Az MDM-ben megjelenő dimenzió neve.
name	string	A dimenzió nyilvánosan elérhető neve.
toBeExportedForShoebox	boolean	Logikai jelző, amely azt jelzi, hogy ezt a dimenziót bele kell-e foglalni a shoebox exportálási forgatókönyvébe.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

LogSpecification

Az Azure Monitoring naplóinak specifikációi.

Name	Típus	Description
displayName	string	A napló honosított rövid megjelenítendő neve.
name	string	A napló neve.

MetricSpecification

Az Azure Monitoring metrikáinak specifikációi.

Name	Típus	Description
aggregationType	string	Csak egy értéket adjon meg ehhez a mezőhöz. Érvényes értékek: Átlag, Minimum, Maximum, Összeg, Darabszám.
category	string	Annak a metrikakategóriának a neve, amelyhez a metrika tartozik. A metrikák csak egyetlen kategóriához tartozhatnak.
dimensions	Dimension[]	A metrikák méretei.
displayDescription	string	A metrika honosított rövid leírása.
displayName	string	A metrika honosított rövid megjelenítendő neve.
fillGapWithZero	string	Választható. Ha igaz értékre van állítva, akkor a rendszer nulla értéket ad vissza olyan időtartamra, amikor nem bocsát ki/tesz közzé metrikát. Például egy metrika, amely egy adott hibakód kibocsátásának számát adja vissza. Előfordulhat, hogy a hibakód nem jelenik meg gyakran, az RP-közzététel 0 helyett a Shoebox automatikusan kitölti a 0-s értékeket azokra az időszakokra, amikor semmit nem bocsátottak ki.
name	string	A metrika neve.
unit	string	A metrika szempontjából értelmezhető egység.

Operation

Az erőforrás-szolgáltató által támogatott REST API-művelet.

Name	Típus	Description
display	OperationDisplay	A műveletet leíró objektum.
isDataAction	boolean	Ha a művelet adatművelet. (adatsík rbac esetén)
name	string	A művelet neve formátummal: {provider}/{resource}/{operation}
origin	string	Választható. A művelet tervezett végrehajtója; szabályozza a művelet RBAC felhasználói felületén és az auditnaplók felhasználói felületén való megjelenítését.
properties	OperationProperties	További művelettulajdonságok.

OperationDisplay

A műveletet leíró objektum.

Name	Típus	Description
description	string	A művelet honosított rövid leírása
operation	string	A művelet honosított rövid neve.
provider	string	Az erőforrás-szolgáltató rövid neve
resource	string	Az az erőforrástípus, amelyen a műveletet végrehajtják.

OperationList

A REST API-műveletek listázására irányuló kérelem eredménye. A műveletlistát tartalmazza.

Name	Típus	Description
nextLink	string	Az az URL-cím, amelyet az ügyfélnek használnia kell a következő lap lekéréséhez (kiszolgálóoldali lapozásonként). Ez egyelőre null értékű, későbbi használatra hozzáadva.
value	Operation[]	Az erőforrás-szolgáltató által támogatott műveletek listája.

OperationProperties

További művelettulajdonságok.

Name	Típus	Description
serviceSpecification	ServiceSpecification	Egy specifikációt leíró objektum.

ServiceSpecification

Egy specifikációt leíró objektum.

Name	Típus	Description
logSpecifications	LogSpecification[]	Az Azure Monitoring naplóinak specifikációi.
metricSpecifications	MetricSpecification[]	Az Azure Monitoring metrikáinak specifikációi.