Partager via

Product Group Link - List By Product

Service:
API Management
Version d'API:
2024-05-01

Répertorie une collection des liens de groupe associés à un produit.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groupLinks?api-version=2024-05-01
Avec des paramètres facultatifs: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groupLinks?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

Paramètres URI

Nom Dans Obligatoire Type Description
productId
 path True

string

minLength: 1
maxLength: 256

Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.
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 (uuid)

ID de l’abonnement cible. La valeur doit être un UUID.
api-version
 query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.
$filter
 query

string

| Champ | Utilisation | Opérateurs pris en charge | Fonctions prises en charge |
|-------------|-------------|-------------|-------------|
| groupId | 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.

Réponses

Nom Type Description
200 OK

ProductGroupLinkCollection

Le corps de la réponse contient une collection d’entités de liaison de groupe dans le produit.
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

Exemple de requête

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1/groupLinks?api-version=2024-05-01

Exemple de réponse

Code d’état:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/product1/groupLinks/link1",
      "type": "Microsoft.ApiManagement/service/products/groupLinks",
      "name": "link1",
      "properties": {
        "groupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/group1"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Définitions

Nom Description
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
ProductGroupLinkCollection

Représentation de liste de liens de groupe de produits paginées.
ProductGroupLinkContract

Détails du lien de groupe de produits.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

ProductGroupLinkCollection

Object

Représentation de liste de liens de groupe de produits 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

ProductGroupLinkContract[]

Valeurs de page.

ProductGroupLinkContract

Object

Détails du lien de groupe de produits.

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.groupId

string

ID de ressource complet d’un groupe.
type

string

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