Partager via

Api Operation - List By Api

  • Référence
Service:
API Management
Version d'API:
2021-08-01

Répertorie une collection des opérations pour l’API spécifiée.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations?api-version=2021-08-01
Avec des paramètres facultatifs: 
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=2021-08-01

Paramètres URI

Nom Dans Obligatoire Type Description
apiId
 path True

string

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

Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
resourceGroupName
 path True

string

Nom du groupe de ressources.
serviceName
 path True

string

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

Nom du service Gestion des API.
subscriptionId
 path True

string

Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version
 query True

string

Version de l’API à utiliser avec la demande cliente.
$filter
 query

string

| Champ | Utilisation | Opérateurs pris en charge | Fonctions prises en charge |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| méthode | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip
 query

integer (int32)

minimum: 0

Nombre d’enregistrements à ignorer.
$top
 query

integer (int32)

minimum: 1

Nombre d’enregistrements à retourner.
tags
 query

string

Incluez des balises dans la réponse.

Réponses

Nom Type Description
200 OK

OperationCollection

Collection d’entités récapitulatives d’opération au niveau de l’API.
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementListApiOperations

Exemple de requête

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations?api-version=2021-08-01

Exemple de réponse

Code d’état:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/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/subid/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/subid/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/subid/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/subid/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": ""
}

Définitions

Nom Description
ErrorFieldContract

Contrat de champ d’erreur.
ErrorResponse

Réponse d’erreur.
OperationCollection

Représentation de liste des opérations paginées.
OperationContract

Détails de l’opération API.
ParameterContract

Détails des paramètres d’opération.
ParameterExampleContract

Exemple de paramètre.
RepresentationContract

Détails de la représentation de demande/réponse de l’opération.
RequestContract

Détails de la demande d’opération.
ResponseContract

Détails de la réponse de l’opération.

ErrorFieldContract

Object

Contrat de champ d’erreur.

Nom Type Description
code

string

Code d’erreur au niveau de la propriété.
message

string

Représentation lisible par l’homme de l’erreur au niveau de la propriété.
target

string

Nom de la propriété.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
error.code

string

Code d’erreur défini par le service. Ce code sert de sous-état pour le code d’erreur HTTP spécifié dans la réponse.
error.details

ErrorFieldContract[]

Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.
error.message

string

Représentation lisible par l’homme de l’erreur.

OperationCollection

Object

Représentation de liste des opérations paginées.

Nom Type Description
count

integer (int64)

Nombre total d’enregistrements sur toutes les pages.
nextLink

string

Lien de page suivant le cas échéant.
value

OperationContract[]

Valeurs de page.

OperationContract

Object

Détails de l’opération API.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nom de la ressource
properties.description

string

maxLength: 1000

Description de l’opération. Peut inclure des balises de mise en forme HTML.
properties.displayName

string

minLength: 1
maxLength: 300

Nom de l’opération.
properties.method

string

Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas seulement par eux.
properties.policies

string

Stratégies d’opération
properties.request

RequestContract

Entité contenant les détails de la demande.
properties.responses

ResponseContract[]

Tableau de réponses d’opération.
properties.templateParameters

ParameterContract[]

Collection de paramètres de modèle d’URL.
properties.urlTemplate

string

minLength: 1
maxLength: 1000

Modèle d’URL relative identifiant la ressource cible pour cette opération. Peut inclure des paramètres. Exemple : /customers/{cid}/orders/{oid}/ ?date={date}
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ParameterContract

Object

Détails des paramètres d’opération.

Nom Type Description
defaultValue

string

Valeur de paramètre par défaut.
description

string

Description du paramètre.
examples

<string,  ParameterExampleContract>

Exemple défini pour le paramètre.
name

string

Nom du paramètre.
required

boolean

Spécifie si le paramètre est obligatoire ou non.
schemaId

string

Identificateur de schéma.
type

string

Type de paramètre.
typeName

string

Nom de type défini par le schéma.
values

string[]

Valeurs des paramètres.

ParameterExampleContract

Object

Exemple de paramètre.

Nom Type Description
description

string

Description longue de l’exemple
externalValue

string

URL qui pointe vers l’exemple littéral
summary

string

Brève description de l’exemple
value

Exemple de valeur. Peut être une valeur primitive ou un objet.

RepresentationContract

Object

Détails de la représentation de demande/réponse de l’opération.

Nom Type Description
contentType

string

Spécifie un type de contenu inscrit ou personnalisé pour cette représentation, par exemple application/xml.
examples

<string,  ParameterExampleContract>

Exemple défini pour la représentation.
formParameters

ParameterContract[]

Collection de paramètres de formulaire. Obligatoire si la valeur « contentType » est « application/x-www-form-urlencoded » ou « multipart/form-data ».
schemaId

string

Identificateur de schéma. Applicable uniquement si la valeur « contentType » n’est ni « application/x-www-form-urlencoded » ni « multipart/form-data ».
typeName

string

Nom de type défini par le schéma. Applicable uniquement si la valeur « contentType » n’est ni « application/x-www-form-urlencoded » ni « multipart/form-data ».

RequestContract

Object

Détails de la demande d’opération.

Nom Type Description
description

string

Description de la demande d’opération.
headers

ParameterContract[]

Collection d’en-têtes de demande d’opération.
queryParameters

ParameterContract[]

Collection de paramètres de requête de requête d’opération.
representations

RepresentationContract[]

Collection de représentations de demande d’opération.

ResponseContract

Object

Détails de la réponse de l’opération.

Nom Type Description
description

string

Description de la réponse de l’opération.
headers

ParameterContract[]

Collection d’en-têtes de réponse d’opération.
representations

RepresentationContract[]

Collection de représentations de réponse d’opération.
statusCode

integer (int32)

Code d’état HTTP de réponse aux opérations.