Api Operation - List By Api

Serviço:
API Management
Versão da API:
2024-05-01

Lista uma coleção de operações para a API especificada.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations?api-version=2024-05-01
Com parâmetros opcionais: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations?$filter={$filter}&$top={$top}&$skip={$skip}&tags={tags}&api-version=2024-05-01

Parâmetros do URI

Name Em Necessário Tipo Description
apiId
 path True

string

minLength: 1
maxLength: 256
pattern: ^[^*#&+:<>?]+$

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

O nome do serviço de Gerenciamento de API.
subscriptionId
 path True

string (uuid)

A ID da assinatura de destino. O valor deve ser um UUID.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.
$filter
 query

string

| Campo | Utilização | Operadores suportados | Funções suportadas |
|-------------|-------------|-------------|-------------|
| nome | Filtrar | GE, LE, EQ, NE, GT, LT | substringof, contém, começa, termina com |
| displayName | Filtrar | GE, LE, EQ, NE, GT, LT | substringof, contém, começa, termina com |
| método | Filtrar | GE, LE, EQ, NE, GT, LT | substringof, contém, começa, termina com |
| descrição | Filtrar | GE, LE, EQ, NE, GT, LT | substringof, contém, começa, termina com |
| urlTemplate | Filtrar | GE, LE, EQ, NE, GT, LT | substringof, contém, começa, termina com |
$skip
 query

integer (int32)

minimum: 0

Número de registos a ignorar.
$top
 query

integer (int32)

minimum: 1

Número de registos a devolver.
tags
 query

string

Inclua tags na resposta.

Respostas

Name Tipo Description
200 OK

OperationCollection

Uma coleção de entidades de resumo de operação no nível da API.
Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

ApiManagementListApiOperations

Pedido de amostra

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations?api-version=2024-05-01

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cdc",
      "properties": {
        "displayName": "CancelOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cda",
      "properties": {
        "displayName": "GetMostRecentOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cd9",
      "properties": {
        "displayName": "GetOpenOrders",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cdb",
      "properties": {
        "displayName": "GetOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cd8",
      "properties": {
        "displayName": "submitOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/submitOrder"
      }
    }
  ],
  "count": 5,
  "nextLink": ""
}

Definições

Name Description
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
OperationCollection

Representação da lista de operações paginadas.
OperationContract

Detalhes da operação da API.
ParameterContract

Detalhes dos parâmetros de operação.
ParameterExampleContract

Exemplo de parâmetro.
RepresentationContract

Detalhes da representação da solicitação/resposta da operação.
RequestContract

Detalhes da solicitação da operação.
ResponseContract

Detalhes da resposta da operação.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

OperationCollection

Object

Representação da lista de operações paginadas.

Name Tipo Description
count

integer (int64)

Número total de registros em todas as páginas.
nextLink

string

Link da próxima página, se houver.
value

OperationContract[]

Valores de página.

OperationContract

Object

Detalhes da operação da API.

Name Tipo Description
id

string

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

O nome do recurso
properties.description

string

maxLength: 1000

Descrição da operação. Pode incluir tags de formatação HTML.
properties.displayName

string

minLength: 1
maxLength: 300

Nome da operação.
properties.method

string

Um método de operação HTTP válido. Métodos Http típicos como GET, PUT, POST mas não limitados apenas por eles.
properties.policies

string

Políticas de Operação
properties.request

RequestContract

Uma entidade que contém detalhes da solicitação.
properties.responses

ResponseContract[]

Matriz de respostas de operação.
properties.templateParameters

ParameterContract[]

Coleção de parâmetros de modelo de URL.
properties.urlTemplate

string

minLength: 1
maxLength: 1000

Modelo de URL relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date}
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ParameterContract

Object

Detalhes dos parâmetros de operação.

Name Tipo Description
defaultValue

string

Valor do parâmetro padrão.
description

string

Descrição do parâmetro.
examples

<string,  ParameterExampleContract>

Exemplo definido para o parâmetro.
name

string

Nome do parâmetro.
required

boolean

Especifica se o parâmetro é necessário ou não.
schemaId

string

Identificador de esquema.
type

string

Tipo de parâmetro.
typeName

string

Nome do tipo definido pelo esquema.
values

string[]

Valores de parâmetros.

ParameterExampleContract

Object

Exemplo de parâmetro.

Name Tipo Description
description

string

Descrição longa para o exemplo
externalValue

string

Um URL que aponta para o exemplo literal
summary

string

Breve descrição do exemplo
value

Valor de exemplo. Pode ser um valor primitivo ou um objeto.

RepresentationContract

Object

Detalhes da representação da solicitação/resposta da operação.

Name Tipo Description
contentType

string

Especifica um tipo de conteúdo registrado ou personalizado para essa representação, por exemplo, application/xml.
examples

<string,  ParameterExampleContract>

Exemplo definido para a representação.
formParameters

ParameterContract[]

Coleção de parâmetros de formulário. Obrigatório se o valor 'contentType' for 'application/x-www-form-urlencoded' ou 'multipart/form-data'..
schemaId

string

Identificador de esquema. Aplicável somente se o valor 'contentType' não for 'application/x-www-form-urlencoded' nem 'multipart/form-data'.
typeName

string

Nome do tipo definido pelo esquema. Aplicável somente se o valor 'contentType' não for 'application/x-www-form-urlencoded' nem 'multipart/form-data'.

RequestContract

Object

Detalhes da solicitação da operação.

Name Tipo Description
description

string

Descrição do pedido de operação.
headers

ParameterContract[]

Coleta de cabeçalhos de solicitação de operação.
queryParameters

ParameterContract[]

Coleção de parâmetros de consulta de solicitação de operação.
representations

RepresentationContract[]

Recolha de representações de pedidos de operação.

ResponseContract

Object

Detalhes da resposta da operação.

Name Tipo Description
description

string

Descrição da resposta da operação.
headers

ParameterContract[]

Coleção de cabeçalhos de resposta de operação.
representations

RepresentationContract[]

Recolha de representações de resposta à operação.
statusCode

integer (int32)

Código de status HTTP de resposta da operação.