Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
- nejnovější
- 2025-09-01-náhled
- 2025-03-01-preview
- z 10. 10. 2024 ve verzi Preview
-
2024-06-01-preview - 2024-05-01
-
2023-09-01-preview -
2023-05-01-preview - 1. 3. 2023 ve verzi Preview
-
2022-09-01-preview - 2022-08-01
-
2022-04-01-preview -
12. 12. 2021 ve verzi Preview -
2021-08-01 -
2021-04-01-preview -
2021-01-01-preview - 12. 12. 2020
- 2020-06-01-preview
- 12. 12. 2019
-
12. 12. 2019 -
1. 1. 2019 - 06. 6. 2018 ve verzi Preview
- 1. 1. 2018
-
03.03.2017 - 10. 10. 2016
-
2016-07-07
Definice prostředku Bicep
Typ prostředku služby nebo produktů je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Příklady použití
Ukázky Bicep
Základní příklad nasazení produktu API Management.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
name: resourceName
location: location
sku: {
capacity: 0
name: 'Consumption'
}
properties: {
certificates: []
customProperties: {
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
}
disableGateway: false
publicNetworkAccess: 'Enabled'
publisherEmail: 'pub1@email.com'
publisherName: 'pub1'
virtualNetworkType: 'None'
}
}
resource product 'Microsoft.ApiManagement/service/products@2021-08-01' = {
name: resourceName
parent: service
properties: {
description: ''
displayName: 'Test Product'
state: 'notPublished'
subscriptionRequired: false
terms: ''
}
}
Ověřené moduly Azure
K nasazení tohoto typu prostředku je možné použít následující ověřené moduly Azure.
| Module | Popis |
|---|---|
| Služba správy API - produkt | AVM Child Module for API Management Service - produkt |
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@2019-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 = 256 (povinné) |
| nadřazený objekt | 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 = 1000 |
| zobrazované jméno | Název produktu. | řetězec Omezení: Minimální délka = 1 Maximální délka = 300 (povinné) |
| stav | 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 |
| podmínky | 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í:
- Skupiny zdrojů – viz příkazy pro nasazení skupin zdrojů Pro seznam změněných vlastností v každé verzi API viz log změn.
Příklady použití
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": "2019-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
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 = 1000 |
| zobrazované jméno | Název produktu. | řetězec Omezení: Minimální délka = 1 Maximální délka = 300 (povinné) |
| stav | 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 |
| podmínky | 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 zdrojů Pro seznam změněných vlastností v každé verzi API viz log změn.
Příklady použití
Ukázky Terraformu
Základní příklad nasazení produktu API Management.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "service" {
type = "Microsoft.ApiManagement/service@2021-08-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
certificates = [
]
customProperties = {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11" = "false"
}
disableGateway = false
publicNetworkAccess = "Enabled"
publisherEmail = "pub1@email.com"
publisherName = "pub1"
virtualNetworkType = "None"
}
sku = {
capacity = 0
name = "Consumption"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "product" {
type = "Microsoft.ApiManagement/service/products@2021-08-01"
parent_id = azapi_resource.service.id
name = var.resource_name
body = {
properties = {
description = ""
displayName = "Test Product"
state = "notPublished"
subscriptionRequired = false
terms = ""
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
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@2019-01-01"
name = "string"
parent_id = "string"
body = {
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
}
}
Hodnoty vlastností
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 = 1000 |
| zobrazované jméno | Název produktu. | řetězec Omezení: Minimální délka = 1 Maximální délka = 300 (povinné) |
| stav | 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 |
| podmínky | 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 |