Operations - List

Referensi

Service:: Azure Web PubSub Service

API Version:: 2023-02-01

Lists semua operasi REST API yang tersedia dari penyedia Microsoft.SignalRService.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
api-version	query	True	string	Versi Api Klien.

Respons

Nama	Jenis	Deskripsi
200 OK	OperationList	Berhasil. Respons menjelaskan daftar operasi.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
Dimension	Spesifikasi Dimensi metrik.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
LogSpecification	Spesifikasi Log untuk Azure Monitoring.
MetricSpecification	Spesifikasi Metrik untuk Azure Monitoring.
Operation	Operasi REST API didukung oleh penyedia sumber daya.
OperationDisplay	Objek yang menjelaskan operasi.
OperationList	Hasil permintaan untuk mencantumkan operasi REST API. Ini berisi daftar operasi.
OperationProperties	Properti Operasi Ekstra.
ServiceSpecification	Objek yang menjelaskan spesifikasi.

Dimension

Spesifikasi Dimensi metrik.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan dimensi yang mudah dilokalkan.
internalName	string	Nama dimensi seperti yang muncul di MDM.
name	string	Nama dimensi yang menghadap publik.
toBeExportedForShoebox	boolean	Bendera Boolean yang menunjukkan apakah dimensi ini harus disertakan untuk skenario ekspor kotak sepatu.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

LogSpecification

Spesifikasi Log untuk Azure Monitoring.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan log yang mudah dilokalkan.
name	string	Nama log.

MetricSpecification

Spesifikasi Metrik untuk Azure Monitoring.

Nama	Jenis	Deskripsi
aggregationType	string	Hanya berikan satu nilai untuk bidang ini. Nilai yang valid: Rata-rata, Minimum, Maksimum, Total, Hitungan.
category	string	Nama kategori metrik tempat metrik berada. Metrik hanya dapat termasuk dalam satu kategori.
dimensions	Dimension[]	Dimensi metrik.
displayDescription	string	Deskripsi metrik yang mudah dilokalkan.
displayName	string	Nama tampilan metrik yang mudah dilokalkan.
fillGapWithZero	string	Pilihan. Jika diatur ke true, maka nol akan dikembalikan selama durasi waktu di mana tidak ada metrik yang dikeluarkan/diterbitkan. Misalnya, metrik yang mengembalikan berapa kali kode kesalahan tertentu dipancarkan. Kode kesalahan mungkin tidak sering muncul, alih-alih RP penerbitan 0, Shoebox dapat mengisi 0 detik secara otomatis untuk periode waktu di mana tidak ada yang dipancarkan.
name	string	Nama metrik.
unit	string	Unit yang masuk akal untuk metrik.

Operation

Operasi REST API didukung oleh penyedia sumber daya.

Nama	Jenis	Deskripsi
display	OperationDisplay	Objek yang menjelaskan operasi.
isDataAction	boolean	Jika operasi adalah tindakan data. (untuk data plane rbac)
name	string	Nama operasi dengan format: {provider}/{resource}/{operation}
origin	string	Pilihan. Pelaksana operasi yang dimaksudkan; mengatur tampilan operasi di UX RBAC dan UX log audit.
properties	OperationProperties	Properti Operasi Ekstra.

OperationDisplay

Objek yang menjelaskan operasi.

Nama	Jenis	Deskripsi
description	string	Deskripsi ramah yang dilokalkan untuk operasi
operation	string	Nama ramah yang dilokalkan untuk operasi.
provider	string	Nama yang mudah diingat dari penyedia sumber daya
resource	string	Jenis sumber daya tempat operasi dilakukan.

OperationList

Hasil permintaan untuk mencantumkan operasi REST API. Ini berisi daftar operasi.

Nama	Jenis	Deskripsi
nextLink	string	URL yang harus digunakan klien untuk mengambil halaman berikutnya (per halaman sisi server). Ini null untuk saat ini, ditambahkan untuk penggunaan di masa mendatang.
value	Operation[]	Daftar operasi yang didukung oleh penyedia sumber daya.

OperationProperties

Properti Operasi Ekstra.

Nama	Jenis	Deskripsi
serviceSpecification	ServiceSpecification	Objek yang menjelaskan spesifikasi.

ServiceSpecification

Objek yang menjelaskan spesifikasi.

Nama	Jenis	Deskripsi
logSpecifications	LogSpecification[]	Spesifikasi Log untuk Azure Monitoring.
metricSpecifications	MetricSpecification[]	Spesifikasi Metrik untuk Azure Monitoring.

Operations - List

Parameter URI

Respons

Keamanan

azure_auth

Scopes

Contoh

Operations_List

Sample Request

Sample Response

Definisi

Dimension

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LogSpecification

MetricSpecification

Operation

OperationDisplay

OperationList

OperationProperties

ServiceSpecification

Sumber Daya Tambahan: