Operations - List

Ссылка

Service:: Azure Web PubSub Service

API Version:: 2023-02-01

Списки все доступные операции REST API поставщика Microsoft.SignalRService.

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

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
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.

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	Укажите только одно значение для этого поля. Допустимые значения: Average, Minimum, Maximum, Total, Count.
category	string	Имя категории метрик, к которой относится эта метрика. Метрика может относиться только к одной категории.
dimensions	Dimension[]	Измерения метрик.
displayDescription	string	Локализованное понятное описание метрики.
displayName	string	Локализованное понятное отображаемое имя метрики.
fillGapWithZero	string	Необязательный элемент. Если задано значение true, в течение времени возвращается ноль, при котором метрика не создается или не публикуется. Например, метрика, возвращающая количество выдачи определенного кода ошибки. Код ошибки может отображаться не так часто. Вместо публикации RP 0 Shoebox может автоматически заполнить 0 для периодов времени, когда ничего не было создано.
name	string	Имя метрики.
unit	string	Единица измерения, которая имеет смысл для метрики.

Operation

Операция REST API, поддерживаемая поставщиком ресурсов.

Имя	Тип	Описание
display	OperationDisplay	Объект , описывающий операцию.
isDataAction	boolean	Если операция является действием данных. (для rbac плоскости данных)
name	string	Имя операции в формате: {provider}/{resource}/{operation}
origin	string	Необязательный элемент. Предполагаемый исполнитель операции; управляет отображением операции в пользовательском интерфейсе RBAC и в пользовательском интерфейсе журналов аудита.
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.

Operations - List

Параметры URI

Ответы

Безопасность

azure_auth

Scopes

Примеры

Operations_List

Sample Request

Sample Response

Определения

Dimension

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LogSpecification

MetricSpecification

Operation

OperationDisplay

OperationList

OperationProperties

ServiceSpecification

Дополнительные ресурсы