Product - List By Service

Wyświetla kolekcję produktów w określonym wystąpieniu usługi.

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

Parametry identyfikatora URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nazwa grupy zasobów.

serviceName
path True
  • string

Nazwa usługi API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True
  • string

Wersja interfejsu API, która ma być używana z żądaniem klienta.

$filter
query
  • string

| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje |
|-------------|-------------|-------------|-------------|
| Nazwa | Filtr | GE, Le, EQ, ne, gt, lt | substringof, zawiera, StartsWith, EndsWith |
| Nazwa wyświetlana | Filtr | GE, Le, EQ, ne, gt, lt | substringof, zawiera, StartsWith, EndsWith |
| Opis | Filtr | GE, Le, EQ, ne, gt, lt | substringof, zawiera, StartsWith, EndsWith |
| warunki | Filtr | GE, Le, EQ, ne, gt, lt | substringof, zawiera, StartsWith, EndsWith |
| stan | Filtr | EQ | |
| grupy | Rozwiń węzeł | | |

$skip
query
  • integer
int32

Liczba rekordów do pominięcia.

$top
query
  • integer
int32

Liczba rekordów do zwrócenia.

expandGroups
query
  • boolean

Po ustawieniu na wartość true odpowiedź zawiera tablicę grup, które mają wgląd w produkt. Wartością domyślną jest false.

tags
query
  • string

Produkty, które są częścią określonego tagu.

Odpowiedzi

Name Type Description
200 OK

Kolekcja jednostek produktu dla określonego wystąpienia usługi API Management.

Other Status Codes

Odpowiedź na błąd z opisem przyczyny niepowodzenia operacji.

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2.

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

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Przykłady

ApiManagementListProducts

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmtemplateCert1",
      "type": "Microsoft.ApiManagement/service/products",
      "name": "kjoshiarmtemplateCert1",
      "properties": {
        "displayName": "Dev",
        "description": "Development Product",
        "subscriptionRequired": false,
        "state": "published"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter",
      "type": "Microsoft.ApiManagement/service/products",
      "name": "starter",
      "properties": {
        "displayName": "Starter",
        "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.",
        "terms": "",
        "subscriptionRequired": true,
        "approvalRequired": false,
        "subscriptionsLimit": 1,
        "state": "published"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited",
      "type": "Microsoft.ApiManagement/service/products",
      "name": "unlimited",
      "properties": {
        "displayName": "Unlimited",
        "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
        "subscriptionRequired": true,
        "approvalRequired": true,
        "subscriptionsLimit": 1,
        "state": "published"
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Definicje

ErrorFieldContract

Umowa pola błędu.

ErrorResponse

Odpowiedź na błąd.

ProductCollection

Reprezentacja listy produktów z podziałem na strony.

ProductContract

Szczegóły produktu.

ProductState

Czy produkt jest publikowany. Opublikowane produkty są odnajdywane przez użytkowników portalu deweloperów. Nieopublikowane produkty są widoczne tylko dla administratorów. Domyślnym stanem produktu jest notPublished.

ErrorFieldContract

Umowa pola błędu.

Name Type Description
code
  • string

Kod błędu poziomu właściwości.

message
  • string

Czytelna dla człowieka Reprezentacja błędu poziomu właściwości.

target
  • string

Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Name Type Description
error.code
  • string

Kod błędu zdefiniowany przez usługę. Ten kod służy jako status podrzędny dla kodu błędu HTTP określonego w odpowiedzi.

error.details

Lista nieprawidłowych pól wysyłanych w żądaniu, w przypadku błędu walidacji.

error.message
  • string

Czytelna dla człowieka Reprezentacja błędu.

ProductCollection

Reprezentacja listy produktów z podziałem na strony.

Name Type Description
count
  • integer

Łączna liczba rekordów na wszystkich stronach.

nextLink
  • string

Link następnej strony, jeśli istnieje.

value

Wartości strony.

ProductContract

Szczegóły produktu.

Name Type Description
id
  • string

Identyfikator zasobu.

name
  • string

Nazwa zasobu.

properties.approvalRequired
  • boolean

czy wymagane jest zatwierdzenie subskrypcji. W przypadku wartości false nowe subskrypcje zostaną zatwierdzone automatycznie, umożliwiając deweloperom natychmiastowe wywołanie interfejsów API produktu po zasubskrybowaniu. W przypadku wartości true Administratorzy muszą ręcznie zatwierdzić subskrypcję, zanim deweloper będzie mógł dowolnie dowolnych interfejsów API produktu. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false.

properties.description
  • string

Opis produktu. Może zawierać Tagi formatowania HTML.

properties.displayName
  • string

Nazwa produktu.

properties.state

Czy produkt jest publikowany. Opublikowane produkty są odnajdywane przez użytkowników portalu deweloperów. Nieopublikowane produkty są widoczne tylko dla administratorów. Domyślnym stanem produktu jest notPublished.

properties.subscriptionRequired
  • boolean

Czy subskrypcja produktu jest wymagana do uzyskiwania dostępu do interfejsów API zawartych w tym produkcie. W przypadku wartości true produkt jest określany jako "chroniony" i prawidłowy klucz subskrypcji jest wymagany do pomyślnego żądania do interfejsu API dołączonego do produktu. W przypadku wartości false produkt jest określany jako "Open" i żądania kierowane do interfejsu API zawartego w produkcie mogą być tworzone bez klucza subskrypcji. Jeśli właściwość zostanie pominięta podczas tworzenia nowego produktu, przyjmuje się, że wartość jest równa true.

properties.subscriptionsLimit
  • integer

Czy liczba subskrypcji, które użytkownik może mieć w tym samym czasie. Ustaw wartość null lub Pomiń, aby zezwalać na nieograniczone subskrypcje dla poszczególnych użytkowników. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false.

properties.terms
  • string

Warunki użytkowania produktu. Deweloperzy próbujący subskrybować produkt będą przedstawiani i zobowiązani do zaakceptowania tych warunków przed ukończeniem procesu subskrypcji.

type
  • string

Typ zasobu dla API Management zasobu.

ProductState

Czy produkt jest publikowany. Opublikowane produkty są odnajdywane przez użytkowników portalu deweloperów. Nieopublikowane produkty są widoczne tylko dla administratorów. Domyślnym stanem produktu jest notPublished.

Name Type Description
notPublished
  • string
published
  • string