Služba /produkty Microsoft.ApiManagement
Definice prostředku Bicep
Typ prostředku služby nebo produktů je možné nasadit do:
- Skupiny prostředků – viz příkazy pro nasazení skupin prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/products, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.ApiManagement/service/products@2022-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
Hodnoty vlastností
služba /produkty
| Název | Description | Hodnota |
|---|---|---|
| name | Název prostředku Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v nástroji Bicep. |
string (povinné) Omezení počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a pomlčky. Začněte písmenem a končíte alfanumerickými znaky. |
| Nadřazené | V nástroji Bicep můžete zadat nadřazený prostředek podřízeného prostředku. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek. |
Symbolický název prostředku typu service |
| properties | Vlastnosti kontraktu entity produktu. | ProductContractProperties |
ProductContractProperties
| Název | Description | Hodnota |
|---|---|---|
| approval (Schválení) – požadováno | 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. | bool |
| description | Popis produktu. Může obsahovat značky formátování HTML. | řetězec |
| displayName | Název produktu. | string (povinné) |
| 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. | 'notPublished' 'publikováno' |
| 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. | bool |
| subscriptionsLimit | Určuje počet předplatných, která uživatel může mít k tomuto produktu 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. | int |
| Podmínky | 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. | řetězec |
Šablony pro rychlý start
Následující šablony pro rychlý start nasadí tento typ prostředku.
| Template (Šablona) | Description |
|---|---|
Vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony |
Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity. |
| Vytvoření služby Azure Front Door před azure API Management |
Tato ukázka ukazuje, jak používat Službu Azure Front Door jako globální nástroj pro vyrovnávání zatížení před azure API Management. |
Definice prostředku šablony ARM
Typ prostředku služby nebo produktů je možné nasadit do:
- Skupiny prostředků – viz příkazy pro nasazení skupin prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/products, přidejte do šablony následující kód JSON.
{
"type": "Microsoft.ApiManagement/service/products",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
Hodnoty vlastností
služba /produkty
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.ApiManagement/service/products |
| apiVersion | Verze rozhraní API prostředků | '2022-08-01' |
| name | Název prostředku Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM. |
string (povinné) Limit počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a spojovníky. Začněte písmenem a končite alfanumerickými číslicemi. |
| properties | Vlastnosti smlouvy entity produktu. | ProductContractProperties |
ProductContractProperties
| Název | Description | Hodnota |
|---|---|---|
| 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í okamžitě po přihlášení k odběru volat rozhraní API produktu. Pokud ano, musí správci předplatné ručně schválit, aby vývojář mohl použít jakékoli rozhraní API produktu. Může být k dispozici pouze v případě, že je k dispozici vlastnost subscriptionRequired a má hodnotu false. | bool |
| description | Popis produktu. Může obsahovat značky formátování HTML. | řetězec |
| displayName | Název produktu. | string (povinné) |
| state | zda je produkt publikovaný nebo ne. 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. | 'notPublished' 'publikováno' |
| subscriptionRequired | Jestli se pro přístup k rozhraním API zahrnutým v tomto produktu vyžaduje předplatné produktu. Pokud ano, 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 zahrnuté v 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. | bool |
| subscriptionsLimit | Určuje počet předplatných, která může mít uživatel k tomuto produktu najednou. Nastavte na hodnotu null nebo vyněžte, pokud chcete povolit neomezená předplatná na uživatele. Může být k dispozici pouze v případě, že je k dispozici vlastnost subscriptionRequired a má hodnotu false. | int |
| Podmínky | 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. | řetězec |
Šablony pro rychlý start
Následující šablony rychlého startu nasadí tento typ prostředku.
| Template (Šablona) | Description |
|---|---|
| Vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony |
Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity. |
| Vytvoření služby Azure Front Door před Azure API Management |
Tato ukázka ukazuje, jak používat Službu Azure Front Door jako globální nástroj pro vyrovnávání zatížení před Azure API Management. |
Definice prostředku Terraformu (zprostředkovatele AzAPI)
Typ prostředku služby nebo produktů je možné nasadit do:
- Skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/products, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/products@2022-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
Hodnoty vlastností
služba/produkty
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.ApiManagement/service/products@2022-08-01 |
| name | Název prostředku | string (povinné) Limit počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a spojovníky. Začněte písmenem a končite alfanumerickými číslicemi. |
| parent_id | ID prostředku, který je nadřazený pro tento prostředek. | ID prostředku typu: service |
| properties | Vlastnosti smlouvy entity produktu. | ProductContractProperties |
ProductContractProperties
| Název | Description | Hodnota |
|---|---|---|
| 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í okamžitě po přihlášení k odběru volat rozhraní API produktu. Pokud ano, musí správci předplatné ručně schválit, aby vývojář mohl použít jakékoli rozhraní API produktu. Může být k dispozici pouze v případě, že je k dispozici vlastnost subscriptionRequired a má hodnotu false. | bool |
| description | Popis produktu. Může obsahovat značky formátování HTML. | řetězec |
| displayName | Název produktu. | string (povinné) |
| 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. | "notPublished" "publikováno" |
| 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. | bool |
| subscriptionsLimit | Určuje počet předplatných, která uživatel může mít k tomuto produktu 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. | int |
| Podmínky | 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. | řetězec |