Sdílet prostřednictvím

Služba Microsoft.ApiManagement / produkty 2018-01-01

  • Článek

Definice prostředku Bicep

Typ prostředku služby nebo produktů je možné nasadit s operacemi, které cílí:

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@2018-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    approvalRequired: bool
    description: 'string'
    displayName: 'string'
    state: 'string'
    subscriptionRequired: bool
    subscriptionsLimit: int
    terms: 'string'
  }
}

Hodnoty vlastností

Microsoft.ApiManagement/service/products

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba 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: služby
vlastnosti Vlastnosti kontraktu entity produktu. ProductContractProperties

ProductContractProperties

Jméno Popis Hodnota
approvalRequired zda je vyžadováno schválení předplatného. Pokud je false, nová předplatná se automaticky schválí, aby vývojáři mohli volat rozhraní API produktu hned po přihlášení k odběru. Pokud je pravda, musí správci předplatné schválit ručně, aby vývojář mohl některé z rozhraní API produktu. Může být přítomna pouze v případě, že je vlastnost subscriptionRequired k dispozici a má hodnotu true. Bool
popis Popis produktu. Může obsahovat značky formátování HTML. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
displayName Název produktu. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
stát bez ohledu na to, zda je produkt publikován nebo ne. Publikované produkty můžou zjistit uživatelé portálu pro vývojáře. Nepublikovaná produkty jsou viditelné pouze 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 pro úspěšné provedení požadavku na rozhraní API zahrnutého do 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é do produktu je možné provést bez klíče předplatného. Pokud při vytváření nového produktu není vlastnost vynechána, předpokládá se, že má hodnotu true. Bool
subscriptionsLimit Určuje, jestli počet předplatných, které může uživatel mít k tomuto produktu současně. Nastavte na hodnotu null nebo vynecháte povolení neomezeného počtu předplatných pro jednotlivé uživatele. Může být přítomna pouze v případě, že je vlastnost subscriptionRequired k dispozici a má hodnotu true. Int
termíny Podmínky použití produktu. Vývojáři, kteří se pokoušejí přihlásit k odběru produktu, se zobrazí a před dokončením procesu předplatného musí tyto podmínky přijmout. řetězec

Definice prostředku šablony ARM

Typ prostředku služby nebo produktů je možné nasadit s operacemi, které cílí:

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í JSON.

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2018-01-01",
  "name": "string",
  "properties": {
    "approvalRequired": "bool",
    "description": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionRequired": "bool",
    "subscriptionsLimit": "int",
    "terms": "string"
  }
}

Hodnoty vlastností

Microsoft.ApiManagement/service/products

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2018-01-01'
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (povinné)
vlastnosti Vlastnosti kontraktu entity produktu. ProductContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/products

ProductContractProperties

Jméno Popis Hodnota
approvalRequired zda je vyžadováno schválení předplatného. Pokud je false, nová předplatná se automaticky schválí, aby vývojáři mohli volat rozhraní API produktu hned po přihlášení k odběru. Pokud je pravda, musí správci předplatné schválit ručně, aby vývojář mohl některé z rozhraní API produktu. Může být přítomna pouze v případě, že je vlastnost subscriptionRequired k dispozici a má hodnotu true. Bool
popis Popis produktu. Může obsahovat značky formátování HTML. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
displayName Název produktu. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
stát bez ohledu na to, zda je produkt publikován nebo ne. Publikované produkty můžou zjistit uživatelé portálu pro vývojáře. Nepublikovaná produkty jsou viditelné pouze 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 pro úspěšné provedení požadavku na rozhraní API zahrnutého do 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é do produktu je možné provést bez klíče předplatného. Pokud při vytváření nového produktu není vlastnost vynechána, předpokládá se, že má hodnotu true. Bool
subscriptionsLimit Určuje, jestli počet předplatných, které může uživatel mít k tomuto produktu současně. Nastavte na hodnotu null nebo vynecháte povolení neomezeného počtu předplatných pro jednotlivé uživatele. Může být přítomna pouze v případě, že je vlastnost subscriptionRequired k dispozici a má hodnotu true. Int
termíny Podmínky použití produktu. Vývojáři, kteří se pokoušejí přihlásit k odběru produktu, se zobrazí a před dokončením procesu předplatného musí tyto podmínky přijmout. řetězec

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku služby nebo produktů je možné nasadit s operacemi, které cílí:

  • 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@2018-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      approvalRequired = bool
      description = "string"
      displayName = "string"
      state = "string"
      subscriptionRequired = bool
      subscriptionsLimit = int
      terms = "string"
    }
  })
}

Hodnoty vlastností

Microsoft.ApiManagement/service/products

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služby
vlastnosti Vlastnosti kontraktu entity produktu. ProductContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/products@2018-01-01

ProductContractProperties

Jméno Popis Hodnota
approvalRequired zda je vyžadováno schválení předplatného. Pokud je false, nová předplatná se automaticky schválí, aby vývojáři mohli volat rozhraní API produktu hned po přihlášení k odběru. Pokud je pravda, musí správci předplatné schválit ručně, aby vývojář mohl některé z rozhraní API produktu. Může být přítomna pouze v případě, že je vlastnost subscriptionRequired k dispozici a má hodnotu true. Bool
popis Popis produktu. Může obsahovat značky formátování HTML. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
displayName Název produktu. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
stát bez ohledu na to, zda je produkt publikován nebo ne. Publikované produkty můžou zjistit uživatelé portálu pro vývojáře. Nepublikovaná produkty jsou viditelné pouze 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 pro úspěšné provedení požadavku na rozhraní API zahrnutého do 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é do produktu je možné provést bez klíče předplatného. Pokud při vytváření nového produktu není vlastnost vynechána, předpokládá se, že má hodnotu true. Bool
subscriptionsLimit Určuje, jestli počet předplatných, které může uživatel mít k tomuto produktu současně. Nastavte na hodnotu null nebo vynecháte povolení neomezeného počtu předplatných pro jednotlivé uživatele. Může být přítomna pouze v případě, že je vlastnost subscriptionRequired k dispozici a má hodnotu true. Int
termíny Podmínky použití produktu. Vývojáři, kteří se pokoušejí přihlásit k odběru produktu, se zobrazí a před dokončením procesu předplatného musí tyto podmínky přijmout. řetězec