Microsoft.ApiManagement szolgáltatás/termékek

  • Cikk

Bicep-erőforrásdefiníció

A szolgáltatás/termékek erőforrástípusa üzembe helyezhető olyan műveletekkel, amelyek a következő műveleteket célják:

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.

Erőforrás formátuma

Microsoft.ApiManagement/service/products erőforrás létrehozásához adja hozzá a következő Bicep-et a sablonhoz.

resource symbolicname 'Microsoft.ApiManagement/service/products@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    approvalRequired: bool
    description: 'string'
    displayName: 'string'
    state: 'string'
    subscriptionRequired: bool
    subscriptionsLimit: int
    terms: 'string'
  }
}

Tulajdonságértékek

szolgáltatás/termékek

Név Leírás Érték
name Az erőforrás neve

Megtudhatja, hogyan állíthatja be a gyermekerőforrások nevét és típusát a Bicepben.		 sztring (kötelező)

Karakterkorlát: 1-80

Érvényes karakterek:
Alfanumerikák és kötőjelek.

Kezdje betűvel és végződéssel alfanumerikussal.
Szülő A Bicepben megadhatja egy gyermekerőforrás szülőerőforrását. Ezt a tulajdonságot csak akkor kell hozzáadnia, ha a gyermekerőforrás a szülőerőforráson kívül van deklarálva.

További információ: Gyermekerőforrás a szülőerőforráson kívül.		 A típus erőforrásának szimbolikus neve: szolgáltatás
properties Termék entitásszerződésének tulajdonságai. ProductContractProperties

ProductContractProperties

Név Leírás Érték
approvalRequired szükség van-e az előfizetés jóváhagyására. Ha hamis, a rendszer automatikusan jóváhagyja az új előfizetéseket, így a fejlesztők közvetlenül a feliratkozás után meghívhatják a termék API-jait. Ha igaz, a rendszergazdáknak manuálisan jóvá kell hagyniuk az előfizetést, mielőtt a fejlesztő bármelyik termék API-ját használhatják. Csak akkor lehet jelen, ha az subscriptionRequired tulajdonság jelen van, és értéke hamis. logikai
leírás Termék leírása. Tartalmazhat HTML-formázási címkéket is. sztring
displayName Terméknév. sztring (kötelező)
állapot hogy a termék közzé van-e téve vagy sem. A közzétett termékeket a fejlesztői portál felhasználói felfedezhetik. A nem közzétett termékek csak a rendszergazdák számára láthatók. A Product (Termék) alapértelmezett állapota nem Közzététel. "notPublished"
"közzétett"
subscriptionRequired Azt jelzi, hogy szükség van-e termék-előfizetésre a termékben található API-k eléréséhez. Ha igaz, a terméket "védettnek" nevezik, és érvényes előfizetési kulcsra van szükség ahhoz, hogy a termékben szereplő API-ra irányuló kérés sikeres legyen. Ha hamis, a terméket "nyitottnak" nevezik, és a termékben szereplő API-ra irányuló kérések előfizetési kulcs nélkül is adhatók meg. Ha a tulajdonság hiányzik egy új termék létrehozásakor, az érték igaznak lesz feltételezve. logikai
subscriptionsLimit Azt jelzi, hogy a felhasználónak hány előfizetése lehet egyszerre ehhez a termékhez. Állítsa null értékűre vagy kihagyásra a korlátlan felhasználónkénti előfizetések engedélyezéséhez. Csak akkor lehet jelen, ha az subscriptionRequired tulajdonság jelen van, és értéke hamis. int
Feltételek Termék használati feltételei. A termékre feliratkozni próbáló fejlesztők megjelennek, és el kell fogadniuk ezeket a feltételeket, mielőtt befejezhetik az előfizetési folyamatot. sztring

Gyorssablonok

Az alábbi rövid útmutatósablonok ezt az erőforrástípust helyezik üzembe.

Sablon Description
Az API Management-példány és az összes alárendelt erőforrás létrehozása sablonból

Üzembe helyezés az Azure-ban		 Ez a sablon bemutatja, hogyan hozhat létre API Management szolgáltatást, és hogyan konfigurálhat alentititásokat
Azure Front Door létrehozása az Azure API Management előtt

Üzembe helyezés az Azure-ban		 Ez a minta bemutatja, hogyan használhatja az Azure Front Doort globális terheléselosztóként az Azure API Management előtt.

ARM-sablon erőforrásdefiníciója

A szolgáltatás/termékek erőforrástípusa üzembe helyezhető olyan műveletekkel, amelyek a következő műveleteket célják:

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.

Erőforrás formátuma

Microsoft.ApiManagement/service/products erőforrás létrehozásához adja hozzá a következő JSON-t a sablonhoz.

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

Tulajdonságértékek

szolgáltatás/termékek

Név Leírás Érték
típus Az erőforrás típusa "Microsoft.ApiManagement/service/products"
apiVersion Az erőforrás API-verziója '2023-05-01-preview"
name Az erőforrás neve

Megtudhatja, hogyan állíthatja be a gyermekerőforrások nevét és típusát JSON ARM-sablonokban.		 sztring (kötelező)

Karakterkorlát: 1-80

Érvényes karakterek:
Alfanumerikus és kötőjelek.

Kezdje betűvel, és végződés alfanumerikussal.
properties Termékentitás-szerződés tulajdonságai. ProductContractProperties

ProductContractProperties

Név Leírás Érték
approvalRequired szükség van-e az előfizetés jóváhagyására. Ha hamis, a rendszer automatikusan jóváhagyja az új előfizetéseket, így a fejlesztők közvetlenül a feliratkozás után meghívhatják a termék API-jait. Ha igaz, a rendszergazdáknak manuálisan jóvá kell hagyniuk az előfizetést, mielőtt a fejlesztő bármelyik termék API-ját használhatja. Csak akkor lehet jelen, ha a subscriptionRequired tulajdonság jelen van, és értéke hamis. logikai
leírás Termék leírása. Html-formázási címkéket is tartalmazhat. sztring
displayName Terméknév. sztring (kötelező)
állapot hogy a termék közzé van-e téve vagy sem. A közzétett termékeket a fejlesztői portál felhasználói felfedezhetik. A nem közzétett termékek csak a rendszergazdák számára láthatók. A Product (Termék) alapértelmezett állapota notPublished. "notPublished"
"közzétéve"
subscriptionRequired Az, hogy szükség van-e termék-előfizetésre a termékben található API-k eléréséhez. Ha igaz, a terméket "védettnek" nevezik, és érvényes előfizetői azonosítóra van szükség ahhoz, hogy a termék részét képező API-ra irányuló kérés sikeres legyen. Ha hamis, a termék neve "nyitott", és a termékben található API-ra irányuló kérések előfizetési kulcs nélkül is adhatók meg. Ha a tulajdonság nincs megadva egy új termék létrehozásakor, akkor a rendszer azt feltételezi, hogy az értéke igaz. logikai
subscriptionsLimit Azt határozza meg, hogy a felhasználónak hány előfizetése lehet egyszerre ehhez a termékhez. Állítsa null értékre vagy kihagyásra a felhasználónkénti korlátlan előfizetések engedélyezéséhez. Csak akkor lehet jelen, ha a subscriptionRequired tulajdonság jelen van, és értéke hamis. int
Feltételek Termék használati feltételei. A termékre feliratkozni próbáló fejlesztőknek meg kell jelenniük, és el kell fogadniuk ezeket a feltételeket, mielőtt befejezhetik az előfizetési folyamatot. sztring

Gyorssablonok

Az alábbi rövid útmutatósablonok üzembe helyezik ezt az erőforrástípust.

Sablon Description
Az API Management-példány és az összes alárendelt erőforrás létrehozása sablonból

Üzembe helyezés az Azure-ban		 Ez a sablon bemutatja, hogyan hozhat létre API Management szolgáltatást és konfigurálhat alentitásokat
Azure Front Door létrehozása az Azure API Management előtt

Üzembe helyezés az Azure-ban		 Ez a minta bemutatja, hogyan használhatja az Azure Front Doort globális terheléselosztóként az Azure API Management előtt.

Terraform -erőforrásdefiníció (AzAPI-szolgáltató)

A szolgáltatás/termékek erőforrástípusa olyan műveletekkel helyezhető üzembe, amelyek a következőket célják:

  • Erőforráscsoportok

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.

Erőforrás formátuma

Microsoft.ApiManagement/service/products erőforrás létrehozásához adja hozzá a következő Terraformot a sablonhoz.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      approvalRequired = bool
      description = "string"
      displayName = "string"
      state = "string"
      subscriptionRequired = bool
      subscriptionsLimit = int
      terms = "string"
    }
  })
}

Tulajdonságértékek

szolgáltatás/termékek

Név Leírás Érték
típus Az erőforrás típusa "Microsoft.ApiManagement/service/products@2023-05-01-preview"
name Az erőforrás neve sztring (kötelező)

Karakterkorlát: 1-80

Érvényes karakterek:
Alfanumerikus és kötőjelek.

Kezdje betűvel, és végződés alfanumerikussal.
parent_id Annak az erőforrásnak az azonosítója, amely ennek az erőforrásnak a szülője. A következő típusú erőforrás azonosítója: szolgáltatás
properties Termékentitás-szerződés tulajdonságai. ProductContractProperties

ProductContractProperties

Név Leírás Érték
approvalRequired szükség van-e az előfizetés jóváhagyására. Ha hamis, a rendszer automatikusan jóváhagyja az új előfizetéseket, így a fejlesztők közvetlenül a feliratkozás után meghívhatják a termék API-jait. Ha igaz, a rendszergazdáknak manuálisan jóvá kell hagyniuk az előfizetést, mielőtt a fejlesztő bármelyik termék API-ját használhatja. Csak akkor lehet jelen, ha a subscriptionRequired tulajdonság jelen van, és értéke hamis. logikai
leírás Termék leírása. Html-formázási címkéket is tartalmazhat. sztring
displayName Terméknév. sztring (kötelező)
állapot hogy a termék közzé van-e téve vagy sem. A közzétett termékeket a fejlesztői portál felhasználói felfedezhetik. A nem közzétett termékek csak a rendszergazdák számára láthatók. A Product (Termék) alapértelmezett állapota notPublished. "notPublished"
"közzétéve"
subscriptionRequired Az, hogy szükség van-e termék-előfizetésre a termékben található API-k eléréséhez. Ha igaz, a terméket "védettnek" nevezik, és érvényes előfizetői azonosítóra van szükség ahhoz, hogy a termék részét képező API-ra irányuló kérés sikeres legyen. Ha hamis, a termék neve "nyitott", és a termékben található API-ra irányuló kérések előfizetési kulcs nélkül is adhatók meg. Ha a tulajdonság nincs megadva egy új termék létrehozásakor, akkor a rendszer azt feltételezi, hogy az értéke igaz. logikai
subscriptionsLimit Azt határozza meg, hogy a felhasználónak hány előfizetése lehet egyszerre ehhez a termékhez. Állítsa null értékre vagy kihagyásra a felhasználónkénti korlátlan előfizetések engedélyezéséhez. Csak akkor lehet jelen, ha a subscriptionRequired tulajdonság jelen van, és értéke hamis. int
Feltételek Termék használati feltételei. A termékre feliratkozni próbáló fejlesztőknek meg kell jelenniük, és el kell fogadniuk ezeket a feltételeket, mielőtt befejezhetik az előfizetési folyamatot. sztring