Product Subscriptions - List

Répertorie la collection d’abonnements au produit spécifié.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions?api-version=2020-12-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2020-12-01

Paramètres URI

Name In Required Type Description
productId
path True
  • string

Identificateur de produit. Doit être unique dans l’instance actuelle du service gestion des API.

resourceGroupName
path True
  • string

Nom du groupe de ressources.

serviceName
path True
  • string

Nom du service gestion des API.

Regex pattern: ^[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 Microsoft Azure abonnement. 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 du client.

$filter
query
  • string

| Champ | Utilisation | Opérateurs pris en charge | Fonctions prises en charge |
|-------------|-------------|-------------|-------------|
| nom | filtre | GE, le, EQ, ne, gt, LT | SubstringOf, Contains, StartsWith, EndsWith |
| displayName | filtre | GE, le, EQ, ne, gt, LT | SubstringOf, Contains, StartsWith, EndsWith |
| stateComment | filtre | GE, le, EQ, ne, gt, LT | SubstringOf, Contains, StartsWith, EndsWith |
| ownerId | filtre | GE, le, EQ, ne, gt, LT | SubstringOf, Contains, StartsWith, EndsWith |
| étendue | filtre | GE, le, EQ, ne, gt, LT | SubstringOf, Contains, StartsWith, EndsWith |
| userId | filtre | GE, le, EQ, ne, gt, LT | SubstringOf, Contains, StartsWith, EndsWith |
| productId | filtre | GE, le, EQ, ne, gt, LT | SubstringOf, Contains, StartsWith, EndsWith |
| État | filtre | EQ | |
| utilisateur | développer | | |

$skip
query
  • integer
int32

Nombre d'enregistrements à ignorer.

$top
query
  • integer
int32

Nombre d’enregistrements à renvoyer.

Réponses

Name Type Description
200 OK

Répertorie une collection d’entités d’abonnement.

Other Status Codes

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

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

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

Exemples

ApiManagementListProductSubscriptions

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions?api-version=2020-12-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions/5600b57e7e8880006a070002",
      "type": "Microsoft.ApiManagement/service/products/subscriptions",
      "name": "5600b57e7e8880006a070002",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002",
        "state": "active",
        "createdDate": "2015-09-22T01:57:18.723Z"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Définitions

ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

SubscriptionCollection

Représentation de la liste des abonnements paginés.

SubscriptionContract

Détails de l’abonnement.

SubscriptionState

État de l’abonnement. Les États possibles sont * actif : l’abonnement est actif, * suspendu : l’abonnement est bloqué et l’abonné ne peut pas appeler les API du produit * soumis : la demande d’abonnement a été effectuée par le développeur, mais n’a pas encore été approuvée ou rejetée, * rejetée : la demande d’abonnement a été refusée par un administrateur, * annulée , * expiré : l’abonnement a atteint sa date d’expiration et a été désactivé.

ErrorFieldContract

Contrat de champ d’erreur.

Name Type Description
code
  • string

Code d'erreur de niveau propriété.

message
  • string

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

target
  • string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Name 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

La liste des champs non valides est envoyée dans la demande, en cas d’erreur de validation.

error.message
  • string

Représentation contrôlable de visu de l’erreur.

SubscriptionCollection

Représentation de la liste des abonnements paginés.

Name Type Description
count
  • integer

Nombre total d’enregistrements dans toutes les pages.

nextLink
  • string

Lien vers la page suivante, le cas échéant.

value

Valeurs de page.

SubscriptionContract

Détails de l’abonnement.

Name Type Description
id
  • string

ID de la ressource

name
  • string

Nom de la ressource.

properties.allowTracing
  • boolean

Détermine si le suivi est activé

properties.createdDate
  • string

Date de création de l’abonnement. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.

properties.displayName
  • string

Nom de l’abonnement, ou null si l’abonnement n’a pas de nom.

properties.endDate
  • string

Date à laquelle l’abonnement a été annulé ou a expiré. Le paramètre est uniquement à des fins d’audit et l’abonnement n’est pas automatiquement annulé. Le cycle de vie de l’abonnement peut être géré à l’aide de la state propriété. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.

properties.expirationDate
  • string

Date d’expiration de l’abonnement. Le paramètre est uniquement à des fins d’audit et l’abonnement n’est pas automatiquement arrivé à expiration. Le cycle de vie de l’abonnement peut être géré à l’aide de la state propriété. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.

properties.notificationDate
  • string

Date de notification d’expiration de l’abonnement à venir. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.

properties.ownerId
  • string

Identificateur de ressource d'utilisateur du propriétaire de l'abonnement. La valeur est une URL relative valide au format/users/{userId}, où {userId} est un identificateur d’utilisateur.

properties.primaryKey
  • string

Clé primaire de l’abonnement. Cette propriété ne sera pas remplie sur les opérations « d’extraction » ! Utilisez la demande de publication « /listSecrets » pour obtenir la valeur.

properties.scope
  • string

Portée comme/products/{productId} ou/APIs ou/apis/{apiId}.

properties.secondaryKey
  • string

Clé secondaire d’abonnement. Cette propriété ne sera pas remplie sur les opérations « d’extraction » ! Utilisez la demande de publication « /listSecrets » pour obtenir la valeur.

properties.startDate
  • string

Date d’activation de l’abonnement. Le paramètre est uniquement à des fins d’audit et l’abonnement n’est pas activé automatiquement. Le cycle de vie de l’abonnement peut être géré à l’aide de la state propriété. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.

properties.state

État de l’abonnement. Les États possibles sont * actif : l’abonnement est actif, * suspendu : l’abonnement est bloqué et l’abonné ne peut pas appeler les API du produit * soumis : la demande d’abonnement a été effectuée par le développeur, mais n’a pas encore été approuvée ou rejetée, * rejetée : la demande d’abonnement a été refusée par un administrateur, * annulée , * expiré : l’abonnement a atteint sa date d’expiration et a été désactivé.

properties.stateComment
  • string

Commentaire d’abonnement facultatif ajouté par un administrateur lorsque l’État est remplacé par « rejeté ».

type
  • string

Type de ressource pour la ressource gestion des API.

SubscriptionState

État de l’abonnement. Les États possibles sont * actif : l’abonnement est actif, * suspendu : l’abonnement est bloqué et l’abonné ne peut pas appeler les API du produit * soumis : la demande d’abonnement a été effectuée par le développeur, mais n’a pas encore été approuvée ou rejetée, * rejetée : la demande d’abonnement a été refusée par un administrateur, * annulée , * expiré : l’abonnement a atteint sa date d’expiration et a été désactivé.

Name Type Description
active
  • string
cancelled
  • string
expired
  • string
rejected
  • string
submitted
  • string
suspended
  • string