Microsoft.ApiManagement szolgáltatás/termékek
Bicep-erőforrásdefiníció
A szolgáltatás/termékek erőforrástípusa üzembe helyezhető olyan műveletekkel, amelyek a következő célokat célják:
- Erőforráscsoportok – Lásd erőforráscsoport üzembe helyezési parancsaival
Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplócímű témakörben 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-09-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 |
|---|---|---|
| név | Az erőforrás neve Megtudhatja, hogyan állíthat be neveket és típusokat a gyermekerőforrásokhoz Bicep. |
sztring (kötelező) Karakterkorlát: 1-80 Érvényes karakterek: Alfanumerikus és kötőjelek. Kezdje betűvel és végződéssel alfanumerikussal. |
| szülő | A Bicepben megadhatja a 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ó: szülőerőforráson kívüli gyermekerőforrás. |
A típus erőforrásának szimbolikus neve: szolgáltatás |
| kellékek | Termékentitási szerződés tulajdonságai. | ProductContractProperties |
ProductContractProperties
| Név | Leírás | Érték |
|---|---|---|
| approvalRequired | az előfizetés jóváhagyására van-e szükség. 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 az subscriptionRequired tulajdonság jelen van, és értéke hamis. | Bool |
| leírás | Termék leírása. HTML-formázási címkéket is tartalmazhat. | húr Korlátok: Maximális hossz = 1000 |
| displayName | Terméknév. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 300 |
| állam | függetlenül attól, hogy a termék közzé van-e téve. A közzétett termékeket a fejlesztői portál felhasználói fedezhetik fel. A nem közzétett termékek csak a rendszergazdák számára láthatók. A Termék alapértelmezett állapota nincs közzétéve. | "notPublished" "közzétett" |
| 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ék neve "védett", és érvényes előfizetési kulcs szükséges a termékben található API-ra irányuló kérés sikerességéhez. Ha hamis, a termék neve "nyitott", és a termékben szereplő API-ra irányuló kérések előfizetési kulcs nélkül is adhatók meg. Ha egy új termék létrehozásakor a tulajdonság nincs megadva, akkor az értéke igaznak lesz feltételezve. | Bool |
| subscriptionsLimit | Azt jelzi, hogy a felhasználónak hány előfizetése lehet egyszerre ehhez a termékhez. Állítsa null értékre vagy kihagyásra, hogy felhasználói előfizetésenként korlátlan legyen. 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. | húr |
Rövid útmutatósablonok
Az alábbi rövid útmutatósablonok üzembe helyezik ezt az erőforrástípust.
| Sablon | Leírás |
|---|---|
API Management-példány és az összes alerőforrás létrehozása sablon
|
Ez a sablon bemutatja, hogyan hozhat létre API Management-szolgáltatást és konfigurálhat alentititásokat |
|
Azure Front Door létrehozása az Azure API Management előtt
|
Ez a minta bemutatja, hogyan használható az Azure Front Door 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ő célokat célják:
- Erőforráscsoportok – Lásd erőforráscsoport üzembe helyezési parancsaival
Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplócímű témakörben 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-09-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-09-01-preview" |
| név | Az erőforrás neve Megtudhatja, hogyan állíthat be neveket és típusokat a gyermekerőforrásokhoz 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éssel alfanumerikussal. |
| kellékek | Termékentitási szerződés tulajdonságai. | ProductContractProperties |
ProductContractProperties
| Név | Leírás | Érték |
|---|---|---|
| approvalRequired | az előfizetés jóváhagyására van-e szükség. 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 az subscriptionRequired tulajdonság jelen van, és értéke hamis. | Bool |
| leírás | Termék leírása. HTML-formázási címkéket is tartalmazhat. | húr Korlátok: Maximális hossz = 1000 |
| displayName | Terméknév. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 300 |
| állam | függetlenül attól, hogy a termék közzé van-e téve. A közzétett termékeket a fejlesztői portál felhasználói fedezhetik fel. A nem közzétett termékek csak a rendszergazdák számára láthatók. A Termék alapértelmezett állapota nincs közzétéve. | "notPublished" "közzétett" |
| 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ék neve "védett", és érvényes előfizetési kulcs szükséges a termékben található API-ra irányuló kérés sikerességéhez. Ha hamis, a termék neve "nyitott", és a termékben szereplő API-ra irányuló kérések előfizetési kulcs nélkül is adhatók meg. Ha egy új termék létrehozásakor a tulajdonság nincs megadva, akkor az értéke igaznak lesz feltételezve. | Bool |
| subscriptionsLimit | Azt jelzi, hogy a felhasználónak hány előfizetése lehet egyszerre ehhez a termékhez. Állítsa null értékre vagy kihagyásra, hogy felhasználói előfizetésenként korlátlan legyen. 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. | húr |
Rövid útmutatósablonok
Az alábbi rövid útmutatósablonok üzembe helyezik ezt az erőforrástípust.
| Sablon | Leírás |
|---|---|
|
API Management-példány és az összes alerőforrás létrehozása sablon
|
Ez a sablon bemutatja, hogyan hozhat létre API Management-szolgáltatást és konfigurálhat alentititásokat |
|
Azure Front Door létrehozása az Azure API Management előtt
|
Ez a minta bemutatja, hogyan használható az Azure Front Door globális terheléselosztóként az Azure API Management előtt. |
Terraform (AzAPI-szolgáltató) erőforrásdefiníciója
A szolgáltatás/termékek erőforrástípusa üzembe helyezhető olyan műveletekkel, amelyek a következő célokat célják:
- erőforráscsoportok
Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplócímű témakörben 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-09-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-09-01-preview" |
| név | 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éssel alfanumerikussal. |
| parent_id | Annak az erőforrásnak az azonosítója, amely az erőforrás szülője. | Típus típusú erőforrás azonosítója: szolgáltatás |
| kellékek | Termékentitási szerződés tulajdonságai. | ProductContractProperties |
ProductContractProperties
| Név | Leírás | Érték |
|---|---|---|
| approvalRequired | az előfizetés jóváhagyására van-e szükség. 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 az subscriptionRequired tulajdonság jelen van, és értéke hamis. | Bool |
| leírás | Termék leírása. HTML-formázási címkéket is tartalmazhat. | húr Korlátok: Maximális hossz = 1000 |
| displayName | Terméknév. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 300 |
| állam | függetlenül attól, hogy a termék közzé van-e téve. A közzétett termékeket a fejlesztői portál felhasználói fedezhetik fel. A nem közzétett termékek csak a rendszergazdák számára láthatók. A Termék alapértelmezett állapota nincs közzétéve. | "notPublished" "közzétett" |
| 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ék neve "védett", és érvényes előfizetési kulcs szükséges a termékben található API-ra irányuló kérés sikerességéhez. Ha hamis, a termék neve "nyitott", és a termékben szereplő API-ra irányuló kérések előfizetési kulcs nélkül is adhatók meg. Ha egy új termék létrehozásakor a tulajdonság nincs megadva, akkor az értéke igaznak lesz feltételezve. | Bool |
| subscriptionsLimit | Azt jelzi, hogy a felhasználónak hány előfizetése lehet egyszerre ehhez a termékhez. Állítsa null értékre vagy kihagyásra, hogy felhasználói előfizetésenként korlátlan legyen. 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. | húr |