Operations - List

Service:

SignalR Service

API Version:

2023-02-01

Microsoft.SignalRService プロバイダーで使用可能なすべての REST API 操作をListsします。

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

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	OperationList	正常終了しました。 応答では、操作の一覧が記述されます。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

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

定義

名前	説明
Dimension	メトリックのディメンションの仕様。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
LogSpecification	Azure 監視のログの仕様。
MetricSpecification	Azure 監視のメトリックの仕様。
Operation	リソース プロバイダーでサポートされている REST API 操作。
OperationDisplay	操作を記述する オブジェクト。
OperationList	REST API 操作を一覧表示する要求の結果。 これには、操作の一覧が含まれています。
OperationProperties	追加の操作プロパティ。
ServiceSpecification	仕様を記述する オブジェクト。

Dimension

メトリックのディメンションの仕様。

名前	型	説明
displayName	string	ディメンションのローカライズされたフレンドリ表示名。
internalName	string	MDM に表示されるディメンションの名前。
name	string	ディメンションの公開名。
toBeExportedForShoebox	boolean	このディメンションを shoebox エクスポート シナリオに含める必要があるかどうかを示すブール型 (Boolean) のフラグ。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

LogSpecification

Azure 監視のログの仕様。

名前	型	説明
displayName	string	ログのローカライズされたフレンドリ表示名。
name	string	ログの名前。

MetricSpecification

Azure 監視のメトリックの仕様。

名前	型	説明
aggregationType	string	このフィールドには 1 つの値のみを指定します。 有効な値: Average、Minimum、Maximum、Total、Count。
category	string	メトリックが属するメトリック カテゴリの名前。 メトリックは 1 つのカテゴリにのみ属できます。
dimensions	Dimension[]	メトリックのディメンション。
displayDescription	string	メトリックのローカライズされたわかりやすい説明。
displayName	string	メトリックのローカライズされたフレンドリ表示名。
fillGapWithZero	string	省略可能。 true に設定すると、メトリックが出力または発行されない期間は 0 が返されます。たとえば、特定のエラー コードが生成された回数を返すメトリックです。 エラー コードが頻繁に表示されない場合があります。RP 発行 0 の代わりに、Shoebox は何も出力されなかった期間に 0 を自動的に入力できます。
name	string	メトリックの名前。
unit	string	メトリックに適した単位。

Operation

リソース プロバイダーでサポートされている REST API 操作。

名前	型	説明
display	OperationDisplay	操作を記述する オブジェクト。
isDataAction	boolean	操作がデータ アクションの場合。 (データ プレーン RBAC の場合)
name	string	形式の操作の名前: {provider}/{resource}/{operation}
origin	string	省略可能。 操作の目的の Executor。は、RBAC UX と監査ログ UX での操作の表示を制御します。
properties	OperationProperties	追加の操作プロパティ。

OperationDisplay

操作を記述する オブジェクト。

名前	型	説明
description	string	操作のローカライズされたわかりやすい説明
operation	string	操作のローカライズされたフレンドリ名。
provider	string	リソース プロバイダーのフレンドリ名
resource	string	操作が実行されるリソースの種類。

OperationList

REST API 操作を一覧表示する要求の結果。 これには、操作の一覧が含まれています。

名前	型	説明
nextLink	string	クライアントが次のページをフェッチするために使用する URL (サーバー側ページングごと)。 現時点では null であり、今後の使用のために追加されます。
value	Operation[]	リソース プロバイダーでサポートされている操作の一覧。

OperationProperties

追加の操作プロパティ。

名前	型	説明
serviceSpecification	ServiceSpecification	仕様を記述する オブジェクト。

ServiceSpecification

仕様を記述する オブジェクト。

名前	型	説明
logSpecifications	LogSpecification[]	Azure 監視のログの仕様。
metricSpecifications	MetricSpecification[]	Azure 監視のメトリックの仕様。