Partager via

Apis - List By Service

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

Répertorie toutes les API de l’instance de service de gestion des API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis?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?$filter={$filter}&$top={$top}&$skip={$skip}&tags={tags}&expandApiVersionSet={expandApiVersionSet}&api-version=2021-08-01

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
 path True

string

Nom du groupe de ressources.
serviceName
 path True

string

Nom du service Gestion des API.

Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
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 pour 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 |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| chemin d’accès | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| isCurrent | filter | eq, ne | |
$skip
 query

integer

int32

Nombre d'enregistrements à ignorer.
$top
 query

integer

int32

Nombre d’enregistrements à renvoyer.
expandApiVersionSet
 query

boolean

Inclure la ressource ApiVersionSet complète dans la réponse
tags
 query

string

Incluez des balises dans la réponse.

Réponses

Nom Type Description
200 OK

ApiCollection

Réponse de résultat paginée d’Apis.
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

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

ApiManagementListApis

Exemple de requête

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis?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/a1",
      "type": "Microsoft.ApiManagement/service/apis",
      "name": "a1",
      "properties": {
        "displayName": "api1",
        "apiRevision": "1",
        "serviceUrl": "http://echoapi.cloudapp.net/api",
        "path": "api1",
        "protocols": [
          "https"
        ],
        "isCurrent": true,
        "apiVersionSetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a73933b8f27f7cc82a2d533",
      "type": "Microsoft.ApiManagement/service/apis",
      "name": "5a73933b8f27f7cc82a2d533",
      "properties": {
        "displayName": "api1",
        "apiRevision": "1",
        "serviceUrl": "http://echoapi.cloudapp.net/api",
        "path": "api1",
        "protocols": [
          "https"
        ],
        "isCurrent": true,
        "apiVersion": "v1",
        "apiVersionSetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
      "type": "Microsoft.ApiManagement/service/apis",
      "name": "echo-api",
      "properties": {
        "displayName": "Echo API",
        "apiRevision": "1",
        "serviceUrl": "http://echoapi.cloudapp.net/api",
        "path": "echo",
        "protocols": [
          "https"
        ],
        "isCurrent": true
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a7390baa5816a110435aee0",
      "type": "Microsoft.ApiManagement/service/apis",
      "name": "5a7390baa5816a110435aee0",
      "properties": {
        "displayName": "Swagger Petstore Extensive",
        "apiRevision": "1",
        "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
        "serviceUrl": "http://petstore.swagger.wordnik.com/api",
        "path": "vvv",
        "protocols": [
          "https"
        ],
        "isCurrent": true
      }
    }
  ],
  "count": 4,
  "nextLink": ""
}

Définitions

Nom Description
ApiCollection

Représentation de liste d’API paginée.
ApiContactInformation

Informations de contact de l’API
ApiContract

Détails de l’API.
ApiLicenseInformation

Informations de licence d’API
ApiType

Type d’API.
ApiVersionSetContractDetails

Un jeu de versions d’API contient la configuration commune d’un ensemble de versions d’API relatives
AuthenticationSettingsContract

Paramètres d’authentification de l’API.
bearerTokenSendingMethods

Comment envoyer un jeton au serveur.
ErrorFieldContract

Contrat champ d’erreur.
ErrorResponse

Réponse d’erreur.
OAuth2AuthenticationSettingsContract

Détails des paramètres d’authentification OAuth2 de l’API.
OpenIdAuthenticationSettingsContract

Détails des paramètres d’authentification OAuth2 de l’API.
Protocol

Indique sur quels protocoles les opérations dans cette API peuvent être appelées.
SubscriptionKeyParameterNamesContract

Détails des noms de paramètres de clé d’abonnement.

ApiCollection

Représentation de liste d’API paginée.

Nom Type Description
count

integer

Nombre total d’enregistrements sur toutes les pages.
nextLink

string

Lien de page suivante, le cas échéant.
value

ApiContract[]

Valeurs de page.

ApiContactInformation

Informations de contact de l’API

Nom Type Description
email

string

Adresse e-mail de la personne/organization de contact. DOIT être au format d’une adresse e-mail
name

string

Nom d’identification de la personne/organization de contact
url

string

URL pointant vers les informations de contact. DOIT être au format d’une URL

ApiContract

Détails de l’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.apiRevision

string

Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée
properties.apiRevisionDescription

string

Description de la révision de l’API.
properties.apiVersion

string

Indique l’identificateur de version de l’API si l’API est versionnée
properties.apiVersionDescription

string

Description de la version de l’API.
properties.apiVersionSet

ApiVersionSetContractDetails

Détails du jeu de versions
properties.apiVersionSetId

string

Identificateur de ressource pour l’ApiVersionSet associé.
properties.authenticationSettings

AuthenticationSettingsContract

Collection des paramètres d’authentification inclus dans cette API.
properties.contact

ApiContactInformation

Coordonnées de l’API.
properties.description

string

Description de l’API. Peut comporter des balises de mise en forme.
properties.displayName

string

Nom de l’API. Doit contenir de 1 à 300 caractères.
properties.isCurrent

boolean

Indique si la révision de l’API est la révision actuelle de l’API.
properties.isOnline

boolean

Indique si la révision de l’API est accessible via la passerelle.
properties.license

ApiLicenseInformation

Informations de licence pour l’API.
properties.path

string

URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée lors de la création de l’instance de service pour former l’URL publique de cette API.
properties.protocols

Protocol[]

Indique sur quels protocoles les opérations dans cette API peuvent être appelées.
properties.serviceUrl

string

URL absolue du service principal qui implémente cette API. Ne peut pas dépasser 2 000 caractères.
properties.sourceApiId

string

Identificateur d’API de l’API source.
properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protocoles sur lesquels l’API est mise à disposition.
properties.subscriptionRequired

boolean

Spécifie si un abonnement à l’API ou au produit est requis pour accéder à l’API.
properties.termsOfServiceUrl

string

URL vers les conditions d’utilisation de l’API. DOIT être au format d’une URL.
properties.type

ApiType

Type d’API.
type

string

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

ApiLicenseInformation

Informations de licence d’API

Nom Type Description
name

string

Nom de licence utilisé pour l’API
url

string

URL de la licence utilisée pour l’API. DOIT être au format d’une URL

ApiType

Type d’API.

Nom Type Description
graphql

string

http

string

soap

string

websocket

string

ApiVersionSetContractDetails

Un jeu de versions d’API contient la configuration commune d’un ensemble de versions d’API relatives

Nom Type Description
description

string

Description du jeu de versions d’API.
id

string

Identificateur de l’ensemble de versions d’API existant. Omettez cette valeur pour créer un jeu de versions.
name

string

Nom d’affichage du jeu de versions d’API.
versionHeaderName

string

Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme a la valeur header.
versionQueryName

string

Nom du paramètre de requête qui indique la version de l’API si versioningScheme est défini sur query.
versioningScheme enum:
  • Header
  • Query
  • Segment

Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.

AuthenticationSettingsContract

Paramètres d’authentification de l’API.

Nom Type Description
oAuth2

OAuth2AuthenticationSettingsContract

Paramètres d’authentification OAuth2
openid

OpenIdAuthenticationSettingsContract

Paramètres d’authentification OpenID Connect

bearerTokenSendingMethods

Comment envoyer un jeton au serveur.

Nom Type Description
authorizationHeader

string

Le jeton d’accès sera transmis dans l’en-tête d’autorisation à l’aide du schéma du porteur
query

string

Le jeton d’accès sera transmis en tant que paramètres de requête.

ErrorFieldContract

Contrat champ d’erreur.

Nom Type Description
code

string

Code d'erreur de niveau propriété.
message

string

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

string

Nom de propriété.

ErrorResponse

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 contrôlable de visu de l’erreur.

OAuth2AuthenticationSettingsContract

Détails des paramètres d’authentification OAuth2 de l’API.

Nom Type Description
authorizationServerId

string

Identificateur du serveur d'autorisation OAuth.
scope

string

étendue des opérations.

OpenIdAuthenticationSettingsContract

Détails des paramètres d’authentification OAuth2 de l’API.

Nom Type Description
bearerTokenSendingMethods

bearerTokenSendingMethods[]

Comment envoyer un jeton au serveur.
openidProviderId

string

Identificateur du serveur d'autorisation OAuth.

Protocol

Indique sur quels protocoles les opérations dans cette API peuvent être appelées.

Nom Type Description
http

string

https

string

ws

string

wss

string

SubscriptionKeyParameterNamesContract

Détails des noms de paramètres de clé d’abonnement.

Nom Type Description
header

string

Nom de l’en-tête de la clé d’abonnement.
query

string

Nom du paramètre de chaîne de requête de clé d’abonnement.