Operations - List

Serviço:

AI Foundry

Versão da API:

2025-06-01

Lista todas as operações de conta dos Serviços Cognitivos disponíveis.

GET https://management.azure.com/providers/Microsoft.CognitiveServices/operations?api-version=2025-06-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	OperationListResult	OK.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Exemplos

Get Operations

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.CognitiveServices/operations?api-version=2025-06-01

Java

/**
 * Samples for Operations List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/
     * GetOperations.json
     */
    /**
     * Sample code: Get Operations.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void getOperations(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager 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.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python get_operations.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 = CognitiveServicesManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.operations.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/GetOperations.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 armcognitiveservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cognitiveservices/armcognitiveservices/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1004eed4202d64b48157c084fe2830760f8190f4/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/GetOperations.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 := armcognitiveservices.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.OperationListResult = armcognitiveservices.OperationListResult{
		// 	Value: []*armcognitiveservices.Operation{
		// 		{
		// 			Name: to.Ptr("Microsoft.CognitiveServices/accounts/read"),
		// 			Display: &armcognitiveservices.OperationDisplay{
		// 				Description: to.Ptr("Reads API accounts."),
		// 				Operation: to.Ptr("Read API Account"),
		// 				Provider: to.Ptr("Microsoft Cognitive Services"),
		// 				Resource: to.Ptr("Cognitive Services API Account"),
		// 			},
		// 			Origin: to.Ptr(armcognitiveservices.OriginUserSystem),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CognitiveServices/accounts/write"),
		// 			Display: &armcognitiveservices.OperationDisplay{
		// 				Description: to.Ptr("Writes API Accounts."),
		// 				Operation: to.Ptr("Write API Account"),
		// 				Provider: to.Ptr("Microsoft Cognitive Services"),
		// 				Resource: to.Ptr("Cognitive Services API Account"),
		// 			},
		// 			Origin: to.Ptr(armcognitiveservices.OriginUserSystem),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.CognitiveServices/accounts/delete"),
		// 			Display: &armcognitiveservices.OperationDisplay{
		// 				Description: to.Ptr("Deletes API accounts"),
		// 				Operation: to.Ptr("Delete API Account"),
		// 				Provider: to.Ptr("Microsoft Cognitive Services"),
		// 				Resource: to.Ptr("Cognitive Services API Account"),
		// 			},
		// 			Origin: to.Ptr(armcognitiveservices.OriginUserSystem),
		// 	}},
		// }
	}
}

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 { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Lists all the available Cognitive Services account operations.
 *
 * @summary Lists all the available Cognitive Services account operations.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/GetOperations.json
 */
async function getOperations() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const 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

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "name": "Microsoft.CognitiveServices/accounts/read",
      "display": {
        "provider": "Microsoft Cognitive Services",
        "resource": "Cognitive Services API Account",
        "operation": "Read API Account",
        "description": "Reads API accounts."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.CognitiveServices/accounts/write",
      "display": {
        "provider": "Microsoft Cognitive Services",
        "resource": "Cognitive Services API Account",
        "operation": "Write API Account",
        "description": "Writes API Accounts."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.CognitiveServices/accounts/delete",
      "display": {
        "provider": "Microsoft Cognitive Services",
        "resource": "Cognitive Services API Account",
        "operation": "Delete API Account",
        "description": "Deletes API accounts"
      },
      "origin": "user,system"
    }
  ]
}

Definições

Nome	Description
ActionType	Enumeração. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.
Display	Informações de exibição localizadas para esta operação específica.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Operation	Operação da API REST
OperationListResult	Uma lista de operações da API REST com suporte por um Provedor de Recursos do Azure. Ele contém um link de URL para obter o próximo conjunto de resultados.
Origin	O executor pretendido da operação; como no RBAC (Controle de Acesso Baseado em Recursos) e na UX de logs de auditoria. O valor padrão é "user,system"

ActionType

Enumeração

Enumeração. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.

Valor	Description
Internal

Display

Objeto

Informações de exibição localizadas para esta operação específica.

Nome	Tipo	Description
description	string	A descrição amigável curta e localizada da operação; adequado para dicas de ferramentas e exibições detalhadas.
operation	string	O nome amigável conciso localizado para a operação; adequado para listas suspensas. Por exemplo, "Criar ou atualizar máquina virtual", "Reiniciar máquina virtual".
provider	string	A forma amigável localizada do nome do provedor de recursos, por exemplo, "Microsoft Monitoring Insights" ou "Microsoft Compute".
resource	string	O nome amigável localizado do tipo de recurso relacionado a essa operação. Por exemplo, "Máquinas Virtuais" ou "Coleções de Agendamento de Trabalho".

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código do erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Operation

Objeto

Operação da API REST

Nome	Tipo	Description
actionType	ActionType	Enumeração. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.
display	Display	Informações de exibição localizadas para esta operação específica.
isDataAction	boolean	Se a operação se aplica ao plano de dados. Isso é "true" para operações de plano de dados e "false" para operações arm/control-plane.
name	string	O nome da operação, de acordo com o RBAC (Controle de Acesso Resource-Based). Exemplos: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
origin	Origin	O executor pretendido da operação; como no RBAC (Controle de Acesso Baseado em Recursos) e na UX de logs de auditoria. O valor padrão é "user,system"

OperationListResult

Objeto

Uma lista de operações da API REST com suporte por um Provedor de Recursos do Azure. Ele contém um link de URL para obter o próximo conjunto de resultados.

Nome	Tipo	Description
nextLink	string	URL para obter o próximo conjunto de resultados da lista de operações (se houver algum).
value	Operation[]	Lista de operações com suporte pelo provedor de recursos

Origin

Enumeração

O executor pretendido da operação; como no RBAC (Controle de Acesso Baseado em Recursos) e na UX de logs de auditoria. O valor padrão é "user,system"

Valor	Description
user
system
user,system