Sdílet prostřednictvím

ProductContract interface

  • Reference
Balíček:
@azure/arm-apimanagement

Podrobnosti o produktu.

Extends
ProxyResource

Vlastnosti

approvalRequired

jestli se vyžaduje schválení předplatného. Pokud je hodnota false, nová předplatná se automaticky schválí, což vývojářům umožní volat rozhraní API produktu okamžitě po přihlášení k odběru. Pokud je hodnota true, musí správci předplatné ručně schválit, aby vývojář mohl použít jakékoli rozhraní API produktu. Může být přítomen pouze v případě, že je k dispozici vlastnost subscriptionRequired a má hodnotu false.
description

Popis produktu. Mohou obsahovat značky formátování HTML.
displayName

Název produktu.
state

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

Určuje, jestli se pro přístup k rozhraním API zahrnutým v tomto produktu vyžaduje předplatné produktu. Pokud je hodnota true, produkt se označuje jako chráněný a k úspěšnému požadavku na rozhraní API, které je součástí produktu, se vyžaduje platný klíč předplatného. Pokud je false, produkt se označuje jako "otevřený" a požadavky na rozhraní API, které jsou součástí produktu, je možné provádět bez klíče předplatného. Pokud je vlastnost při vytváření nového produktu vynechána, předpokládá se, že hodnota je true.
subscriptionsLimit

Určuje, kolik předplatných může uživatel k tomuto produktu mít současně. Nastavte na hodnotu null nebo vypustit, pokud chcete povolit neomezený počet předplatných na uživatele. Může být přítomen pouze v případě, že je k dispozici vlastnost subscriptionRequired a má hodnotu false.
terms

Podmínky použití produktu. Vývojáři, kteří se pokusí přihlásit k odběru produktu, se zobrazí a před dokončením procesu předplatného budou muset přijmout tyto podmínky.

Zděděné vlastnosti

id

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{resourceType}/{název_prostředku} POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
type

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

Podrobnosti vlastnosti

approvalRequired

jestli se vyžaduje schválení předplatného. Pokud je hodnota false, nová předplatná se automaticky schválí, což vývojářům umožní volat rozhraní API produktu okamžitě po přihlášení k odběru. Pokud je hodnota true, musí správci předplatné ručně schválit, aby vývojář mohl použít jakékoli rozhraní API produktu. Může být přítomen pouze v případě, že je k dispozici vlastnost subscriptionRequired a má hodnotu false.

approvalRequired?: boolean

Hodnota vlastnosti

boolean

description

Popis produktu. Mohou obsahovat značky formátování HTML.

description?: string

Hodnota vlastnosti

string

displayName

Název produktu.

displayName?: string

Hodnota vlastnosti

string

state

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

state?: ProductState

Hodnota vlastnosti

ProductState

subscriptionRequired

Určuje, jestli se pro přístup k rozhraním API zahrnutým v tomto produktu vyžaduje předplatné produktu. Pokud je hodnota true, produkt se označuje jako chráněný a k úspěšnému požadavku na rozhraní API, které je součástí produktu, se vyžaduje platný klíč předplatného. Pokud je false, produkt se označuje jako "otevřený" a požadavky na rozhraní API, které jsou součástí produktu, je možné provádět bez klíče předplatného. Pokud je vlastnost při vytváření nového produktu vynechána, předpokládá se, že hodnota je true.

subscriptionRequired?: boolean

Hodnota vlastnosti

boolean

subscriptionsLimit

Určuje, kolik předplatných může uživatel k tomuto produktu mít současně. Nastavte na hodnotu null nebo vypustit, pokud chcete povolit neomezený počet předplatných na uživatele. Může být přítomen pouze v případě, že je k dispozici vlastnost subscriptionRequired a má hodnotu false.

subscriptionsLimit?: number

Hodnota vlastnosti

number

terms

Podmínky použití produktu. Vývojáři, kteří se pokusí přihlásit k odběru produktu, se zobrazí a před dokončením procesu předplatného budou muset přijmout tyto podmínky.

terms?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

id

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{resourceType}/{název_prostředku} POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

id?: string

Hodnota vlastnosti

string

Zděděno zProxyResource.id

name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

name?: string

Hodnota vlastnosti

string

Zděděno zProxyResource.name

type

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.

type?: string

Hodnota vlastnosti

string

Zděděno zProxyResource.type