Product - List By Service

Vypíše kolekci produktů v zadané instanci služby.

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 identifikátoru URI

Name In Required Type Description
resourceGroupName
path True
  • string

Název skupiny prostředků.

serviceName
path True
  • string

Název služby API Management.

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

subscriptionId
path True
  • string

Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří část identifikátoru URI pro každé volání služby.

api-version
query True
  • string

Verze rozhraní API, která se má použít s požadavkem klienta

$filter
query
  • string

| Pole | Použití | Podporované operátory | Podporované funkce |
|-------------|-------------|-------------|-------------|
| název | filtr | GE, Le, EQ, ne, gt, lt | substringof, Contains, StartsWith, EndsWith |
| DisplayName | filtr | GE, Le, EQ, ne, gt, lt | substringof, Contains, StartsWith, EndsWith |
| Popis | filtr | GE, Le, EQ, ne, gt, lt | substringof, Contains, StartsWith, EndsWith |
| výrazy | filtr | GE, Le, EQ, ne, gt, lt | substringof, Contains, StartsWith, EndsWith |
| stav | filtr | EQ | |
| skupiny | Rozbalit | | |

$skip
query
  • integer
int32

Počet záznamů, které se mají přeskočit

$top
query
  • integer
int32

Počet vrácených záznamů.

expandGroups
query
  • boolean

Při nastavení na hodnotu true obsahuje odpověď pole skupin, které mají na produkt přehled. Výchozí hodnotou je hodnota false.

tags
query
  • string

Produkty, které jsou součástí konkrétní značky.

Odpovědi

Name Type Description
200 OK

Kolekce entit produktu pro zadanou instanci API Management služby.

Other Status Codes

Chybová odezva popisující, proč se operace nezdařila

Zabezpečení

azure_auth

Azure Active Directory tok OAuth2.

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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": ""
}

Definice

ErrorFieldContract

Kontrakt pole chyby.

ErrorResponse

Chybná odpověď.

ProductCollection

Reprezentace seznamu stránkovaných produktů

ProductContract

Podrobnosti o produktu.

ProductState

zda je produkt publikován nebo nikoli. Publikované produkty můžou uživatelé portálu pro vývojáře zjistit. Nepublikované produkty jsou viditelné pouze správcům. Výchozí stav produktu je notPublished.

ErrorFieldContract

Kontrakt pole chyby.

Name Type Description
code
  • string

Kód chyby úrovně vlastnosti

message
  • string

Uživatelsky čitelné reprezentace chyby na úrovni vlastností.

target
  • string

Název vlastnosti

ErrorResponse

Chybná odpověď.

Name Type Description
error.code
  • string

Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.

error.details

Seznam neplatných polí odesílaných v žádosti v případě chyby ověřování.

error.message
  • string

Reprezentace chyby v čitelném člověku

ProductCollection

Reprezentace seznamu stránkovaných produktů

Name Type Description
count
  • integer

Celkový počet záznamů v počtu všech stránek.

nextLink
  • string

Odkaz na další stránku, pokud existuje.

value

Hodnoty stránky.

ProductContract

Podrobnosti o produktu.

Name Type Description
id
  • string

ID prostředku

name
  • string

Název prostředku

properties.approvalRequired
  • boolean

zda je požadováno schválení předplatného. V případě hodnoty false budou nové odběry schváleny automaticky, aby vývojáři mohli volat rozhraní API produktu hned po přihlášení k odběru. Pokud má hodnotu true, správci musí předplatné před jakýmkoli použitím rozhraní API produktu ručně schválit. Může být přítomen pouze v případě, že je přítomna vlastnost subscriptionRequired a má hodnotu false.

properties.description
  • string

Popis produktu Může obsahovat značky formátování HTML.

properties.displayName
  • string

Název produktu

properties.state

zda je produkt publikován nebo nikoli. Publikované produkty můžou uživatelé portálu pro vývojáře zjistit. Nepublikované produkty jsou viditelné pouze správcům. Výchozí stav produktu je notPublished.

properties.subscriptionRequired
  • boolean

Zda je předplatné produktu vyžadováno pro přístup k rozhraním API, která jsou součástí tohoto produktu. Pokud je hodnota true, produkt se označuje jako chráněný a vyžaduje se pro úspěšné požadavky na rozhraní API zahrnuté v produktu platný klíč předplatného. Pokud je hodnota false, produkt se označuje jako "otevřený" a požadavky na rozhraní API zahrnuté v produktu lze vytvořit bez klíče předplatného. Pokud je vlastnost při vytváření nového produktu vynechána, předpokládá se, že má hodnotu true.

properties.subscriptionsLimit
  • integer

Určuje, zda může uživatel pro tento produkt současně vytvořit tento počet předplatných. Nastavte na null nebo vynechat, aby bylo možné neomezeně neomezené předplatné na uživatele. Může být přítomen pouze v případě, že je přítomna vlastnost subscriptionRequired a má hodnotu false.

properties.terms
  • string

Produktové podmínkami použití. Vývojářům, kteří se pokoušejí přihlásit k odběru produktu, se zobrazí a bude muset tyto podmínky přijmout, aby mohli dokončit proces předplatného.

type
  • string

Typ prostředku pro prostředek API Management.

ProductState

zda je produkt publikován nebo nikoli. Publikované produkty můžou uživatelé portálu pro vývojáře zjistit. Nepublikované produkty jsou viditelné pouze správcům. Výchozí stav produktu je notPublished.

Name Type Description
notPublished
  • string
published
  • string