Sdílet prostřednictvím


Služba Microsoft.ApiManagement 2016-10-10

Definice prostředku Bicep

Typ prostředku služby 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, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service@2016-10-10' = {
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        location: 'string'
        skuType: 'string'
        skuUnitCount: int
        vpnconfiguration: {
          location: 'string'
          subnetResourceId: 'string'
        }
      }
    ]
    addresserEmail: 'string'
    customProperties: {
      {customized property}: 'string'
    }
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        hostname: 'string'
        type: 'string'
      }
    ]
    publisherEmail: 'string'
    publisherName: 'string'
    vpnconfiguration: {
      location: 'string'
      subnetResourceId: 'string'
    }
    vpnType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Hodnoty vlastností

Další oblast

Jméno Popis Hodnota
umístění Název umístění další oblasti mezi oblastmi Azure Data Center. string (povinné)
skuType Skladová položka zadejte do umístění. Vývojář
Premium
Standard (povinné)
skuUnitCount Počet jednotek skladové položky v umístění. Maximální počet jednotek skladové položky závisí na typu SkuType. Maximální povolený počet skladových položek pro vývojáře je 1, pro skladovou položku Standard je 4 a skladová položka Premium je 10 na místě. Int

Omezení:
Maximální hodnota = 10
vpnconfiguration Konfigurace virtuální sítě pro umístění virtualNetworkConfiguration

ApiManagementServiceProperties

Jméno Popis Hodnota
additionalLocations Další umístění datacenter služby API Management Další oblast[]
addresserEmail Adresaře e-mail. řetězec
customProperties Vlastní vlastnosti služby API Management, jako je zakázání protokolu TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Vlastní konfigurace názvu hostitele služby API Management Konfigurace názvu hostitele[]
publisherEmail E-mail vydavatele. řetězec

Omezení:
Maximální délka = (povinné)
publisherName Název vydavatele. string (povinné)
vpnconfiguration Konfigurace virtuální sítě služby API Management virtualNetworkConfiguration
vpnType Typ sítě VPN, ve které je potřeba nakonfigurovat službu API Management. Žádná (výchozí hodnota) znamená, že služba API Management není součástí žádné virtuální sítě, externí znamená, že nasazení služby API Management je nastavené uvnitř virtuální sítě s internetovým koncovým bodem a interní znamená, že nasazení služby API Management je nastaveno uvnitř virtuální sítě, která má pouze intranetový koncový bod. Externí
Interní
None (Žádný)

ApiManagementServicePropertiesCustomProperties

Jméno Popis Hodnota

ApiManagementServiceSkuProperties

Jméno Popis Hodnota
kapacita Kapacita skladové položky (počet nasazených jednotek skladové položky). Výchozí hodnota je 1. Int
Jméno Název skladové položky. Vývojář
Premium
Standard (povinné)

CertificateInformation

Jméno Popis Hodnota
vypršení Datum vypršení platnosti certifikátu Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601. string (povinné)
předmět Předmět certifikátu. string (povinné)
otisk palce Kryptografický otisk certifikátu. string (povinné)

Konfigurace názvu hostitele

Jméno Popis Hodnota
certifikát Informace o certifikátu CertificateInformation (povinné)
název hostitele Název hostitele. string (povinné)
typ Typ názvu hostitele. Správa
Portál
Proxy
Scm (povinné)

Microsoft.ApiManagement/service

Jméno Popis Hodnota
umístění Umístění prostředku string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (povinné)
vlastnosti Vlastnosti služby API Management apiManagementServiceProperties (povinné)
sku Vlastnosti skladové položky služby API Management ApiManagementServiceSkuProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

Značky prostředků

Jméno Popis Hodnota

VirtualNetworkConfiguration

Jméno Popis Hodnota
umístění Umístění virtuální sítě. řetězec
subnetResourceId Úplné ID prostředku podsítě ve virtuální síti pro nasazení služby API Management do. řetězec

Omezení:
Model = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

Ukázky rychlého startu

Následující ukázky rychlého startu nasadí tento typ prostředku.

Soubor Bicep Popis
Application Gateway s interní službou API Management a webovou aplikací Služba Application Gateway směruje internetový provoz do instance služby API Management (interní režim), která obsluhuje webové rozhraní API hostované ve webové aplikaci Azure.
Vytvoření instance SLUŽBY API Management s více oblastmi úrovně Premium Tato šablona ukazuje, jak vytvořit instanci služby API Management s dalšími umístěními. Primární umístění je stejné jako umístění skupiny prostředků. V případě dalších umístění se v šabloně zobrazí oblasti NorthCentralUs a USA – východ 2. Primární umístění by se mělo lišit od dalších umístění.
vytvoření instance služby API Management s identitou MSI Tato šablona vytvoří instanci vývojáře služby Azure API Management s identitou MSI.
Vytvoření instance služby API Management pomocí šablony Tato šablona vytvoří instanci vývojáře služby Azure API Management.
vytvoření služby API Management s privátním koncovým bodem Tato šablona vytvoří službu API Management, virtuální síť a privátní koncový bod, které službu API Management zpřístupňuje virtuální síti.
vytvoření služby API Management s protokolem SSL ze služby KeyVault Tato šablona nasadí službu API Management nakonfigurovanou s identitou přiřazenou uživatelem. Tato identita používá k načtení certifikátu SSL ze služby KeyVault a udržuje ji aktualizovanou kontrolou každých 4 hodin.
vytvoření služby API Management v interní virtuální síti s služby App Gateway Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management v privátní síti chráněné službou Azure Application Gateway.
Nasazení služby API Management v externí virtuální síti s veřejnými IP Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management na úrovni Premium v podsíti virtuální sítě v externím režimu a nakonfigurovat doporučená pravidla NSG v podsíti. Instance se nasadí do dvou zón dostupnosti. Šablona také nakonfiguruje veřejnou IP adresu z vašeho předplatného.
Nasazení služby API Management v interní virtuální síti s veřejnými IP Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management na úrovni Premium v podsíti virtuální sítě v interním režimu a nakonfigurovat doporučená pravidla NSG v podsíti. Instance se nasadí do dvou zón dostupnosti. Šablona také nakonfiguruje veřejnou IP adresu z vašeho předplatného.
nasazení služby API Management do zón dostupnosti Tato šablona vytvoří instanci služby Azure API Management úrovně Premium a nasadí ji do zóny dostupnosti.
nasazení služby API Management s externí službou Azure Cache for Redis Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management na úrovni Consumption s externí instancí Azure Cache for Redis jako externí mezipamětí SLUŽBY API Management.
služby Front Door Standard/Premium s původu služby API Management Tato šablona vytvoří front Door Premium a instanci služby API Management a použije zásadu NSG a globální služby API Management k ověření, že provoz prošel původem služby Front Door.

Definice prostředku šablony ARM

Typ prostředku služby 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, přidejte do šablony následující JSON.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2016-10-10",
  "name": "string",
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "location": "string",
        "skuType": "string",
        "skuUnitCount": "int",
        "vpnconfiguration": {
          "location": "string",
          "subnetResourceId": "string"
        }
      }
    ],
    "addresserEmail": "string",
    "customProperties": {
      "{customized property}": "string"
    },
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "hostname": "string",
        "type": "string"
      }
    ],
    "publisherEmail": "string",
    "publisherName": "string",
    "vpnconfiguration": {
      "location": "string",
      "subnetResourceId": "string"
    },
    "vpnType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Hodnoty vlastností

Další oblast

Jméno Popis Hodnota
umístění Název umístění další oblasti mezi oblastmi Azure Data Center. string (povinné)
skuType Skladová položka zadejte do umístění. Vývojář
Premium
Standard (povinné)
skuUnitCount Počet jednotek skladové položky v umístění. Maximální počet jednotek skladové položky závisí na typu SkuType. Maximální povolený počet skladových položek pro vývojáře je 1, pro skladovou položku Standard je 4 a skladová položka Premium je 10 na místě. Int

Omezení:
Maximální hodnota = 10
vpnconfiguration Konfigurace virtuální sítě pro umístění virtualNetworkConfiguration

ApiManagementServiceProperties

Jméno Popis Hodnota
additionalLocations Další umístění datacenter služby API Management Další oblast[]
addresserEmail Adresaře e-mail. řetězec
customProperties Vlastní vlastnosti služby API Management, jako je zakázání protokolu TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Vlastní konfigurace názvu hostitele služby API Management Konfigurace názvu hostitele[]
publisherEmail E-mail vydavatele. řetězec

Omezení:
Maximální délka = (povinné)
publisherName Název vydavatele. string (povinné)
vpnconfiguration Konfigurace virtuální sítě služby API Management virtualNetworkConfiguration
vpnType Typ sítě VPN, ve které je potřeba nakonfigurovat službu API Management. Žádná (výchozí hodnota) znamená, že služba API Management není součástí žádné virtuální sítě, externí znamená, že nasazení služby API Management je nastavené uvnitř virtuální sítě s internetovým koncovým bodem a interní znamená, že nasazení služby API Management je nastaveno uvnitř virtuální sítě, která má pouze intranetový koncový bod. Externí
Interní
None (Žádný)

ApiManagementServicePropertiesCustomProperties

Jméno Popis Hodnota

ApiManagementServiceSkuProperties

Jméno Popis Hodnota
kapacita Kapacita skladové položky (počet nasazených jednotek skladové položky). Výchozí hodnota je 1. Int
Jméno Název skladové položky. Vývojář
Premium
Standard (povinné)

CertificateInformation

Jméno Popis Hodnota
vypršení Datum vypršení platnosti certifikátu Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601. string (povinné)
předmět Předmět certifikátu. string (povinné)
otisk palce Kryptografický otisk certifikátu. string (povinné)

Konfigurace názvu hostitele

Jméno Popis Hodnota
certifikát Informace o certifikátu CertificateInformation (povinné)
název hostitele Název hostitele. string (povinné)
typ Typ názvu hostitele. Správa
Portál
Proxy
Scm (povinné)

Microsoft.ApiManagement/service

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2016-10-10'
umístění Umístění prostředku string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (povinné)
vlastnosti Vlastnosti služby API Management apiManagementServiceProperties (povinné)
sku Vlastnosti skladové položky služby API Management ApiManagementServiceSkuProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.ApiManagement/service

Značky prostředků

Jméno Popis Hodnota

VirtualNetworkConfiguration

Jméno Popis Hodnota
umístění Umístění virtuální sítě. řetězec
subnetResourceId Úplné ID prostředku podsítě ve virtuální síti pro nasazení služby API Management do. řetězec

Omezení:
Model = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

Šablony pro rychlý start

Následující šablony pro rychlý start nasazují tento typ prostředku.

Šablona Popis
Application Gateway s interní službou API Management a webovou aplikací

nasazení do Azure
Služba Application Gateway směruje internetový provoz do instance služby API Management (interní režim), která obsluhuje webové rozhraní API hostované ve webové aplikaci Azure.
Vytvoření instance SLUŽBY API Management s více oblastmi úrovně Premium

nasazení do Azure
Tato šablona ukazuje, jak vytvořit instanci služby API Management s dalšími umístěními. Primární umístění je stejné jako umístění skupiny prostředků. V případě dalších umístění se v šabloně zobrazí oblasti NorthCentralUs a USA – východ 2. Primární umístění by se mělo lišit od dalších umístění.
vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony

nasazení do Azure
Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity.
vytvoření instance služby API Management s identitou MSI

nasazení do Azure
Tato šablona vytvoří instanci vývojáře služby Azure API Management s identitou MSI.
Vytvoření instance služby API Management pomocí šablony

nasazení do Azure
Tato šablona vytvoří instanci vývojáře služby Azure API Management.
vytvoření instance služby API Management s vlastními názvy hostitelů

nasazení do Azure
Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management s vlastním názvem hostitele pro portál a více vlastních názvů hostitelů pro proxy server.
vytvoření služby API Management s privátním koncovým bodem

nasazení do Azure
Tato šablona vytvoří službu API Management, virtuální síť a privátní koncový bod, které službu API Management zpřístupňuje virtuální síti.
vytvoření služby API Management s protokolem SSL ze služby KeyVault

nasazení do Azure
Tato šablona nasadí službu API Management nakonfigurovanou s identitou přiřazenou uživatelem. Tato identita používá k načtení certifikátu SSL ze služby KeyVault a udržuje ji aktualizovanou kontrolou každých 4 hodin.
vytvoření a monitorování instance služby API Management

nasazení do Azure
Tato šablona vytvoří instanci služby Azure API Management a pracovního prostoru služby Log Analytics a nastaví monitorování pro vaši službu API Management pomocí Log Analytics.
vytvoření služby API Management v interní virtuální síti s služby App Gateway

nasazení do Azure
Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management v privátní síti chráněné službou Azure Application Gateway.
vytvoření služby API Management s vlastním ssl proxy pomocí služby KeyVault

nasazení do Azure
Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management a nakonfigurovat vlastní název hostitele pro proxy server s certifikátem SSL z keyvault.
vytvoření služby Azure Front Door před službou Azure API Management

nasazení do Azure
Tato ukázka ukazuje, jak používat Azure Front Door jako globální nástroj pro vyrovnávání zatížení před službou Azure API Management.
Nasazení služby API Management v externí virtuální síti s veřejnými IP

nasazení do Azure
Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management na úrovni Premium v podsíti virtuální sítě v externím režimu a nakonfigurovat doporučená pravidla NSG v podsíti. Instance se nasadí do dvou zón dostupnosti. Šablona také nakonfiguruje veřejnou IP adresu z vašeho předplatného.
Nasazení služby API Management v interní virtuální síti s veřejnými IP

nasazení do Azure
Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management na úrovni Premium v podsíti virtuální sítě v interním režimu a nakonfigurovat doporučená pravidla NSG v podsíti. Instance se nasadí do dvou zón dostupnosti. Šablona také nakonfiguruje veřejnou IP adresu z vašeho předplatného.
nasazení služby API Management do zón dostupnosti

nasazení do Azure
Tato šablona vytvoří instanci služby Azure API Management úrovně Premium a nasadí ji do zóny dostupnosti.
nasazení služby API Management s externí službou Azure Cache for Redis

nasazení do Azure
Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management na úrovni Consumption s externí instancí Azure Cache for Redis jako externí mezipamětí SLUŽBY API Management.
služby Front Door Standard/Premium s původu služby API Management

nasazení do Azure
Tato šablona vytvoří front Door Premium a instanci služby API Management a použije zásadu NSG a globální služby API Management k ověření, že provoz prošel původem služby Front Door.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku služby 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, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2016-10-10"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          location = "string"
          skuType = "string"
          skuUnitCount = int
          vpnconfiguration = {
            location = "string"
            subnetResourceId = "string"
          }
        }
      ]
      addresserEmail = "string"
      customProperties = {
        {customized property} = "string"
      }
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          hostname = "string"
          type = "string"
        }
      ]
      publisherEmail = "string"
      publisherName = "string"
      vpnconfiguration = {
        location = "string"
        subnetResourceId = "string"
      }
      vpnType = "string"
    }
  })
}

Hodnoty vlastností

Další oblast

Jméno Popis Hodnota
umístění Název umístění další oblasti mezi oblastmi Azure Data Center. string (povinné)
skuType Skladová položka zadejte do umístění. Vývojář
Premium
Standard (povinné)
skuUnitCount Počet jednotek skladové položky v umístění. Maximální počet jednotek skladové položky závisí na typu SkuType. Maximální povolený počet skladových položek pro vývojáře je 1, pro skladovou položku Standard je 4 a skladová položka Premium je 10 na místě. Int

Omezení:
Maximální hodnota = 10
vpnconfiguration Konfigurace virtuální sítě pro umístění virtualNetworkConfiguration

ApiManagementServiceProperties

Jméno Popis Hodnota
additionalLocations Další umístění datacenter služby API Management Další oblast[]
addresserEmail Adresaře e-mail. řetězec
customProperties Vlastní vlastnosti služby API Management, jako je zakázání protokolu TLS 1.0. ApiManagementServicePropertiesCustomProperties
hostnameConfigurations Vlastní konfigurace názvu hostitele služby API Management Konfigurace názvu hostitele[]
publisherEmail E-mail vydavatele. řetězec

Omezení:
Maximální délka = (povinné)
publisherName Název vydavatele. string (povinné)
vpnconfiguration Konfigurace virtuální sítě služby API Management virtualNetworkConfiguration
vpnType Typ sítě VPN, ve které je potřeba nakonfigurovat službu API Management. Žádná (výchozí hodnota) znamená, že služba API Management není součástí žádné virtuální sítě, externí znamená, že nasazení služby API Management je nastavené uvnitř virtuální sítě s internetovým koncovým bodem a interní znamená, že nasazení služby API Management je nastaveno uvnitř virtuální sítě, která má pouze intranetový koncový bod. Externí
Interní
None (Žádný)

ApiManagementServicePropertiesCustomProperties

Jméno Popis Hodnota

ApiManagementServiceSkuProperties

Jméno Popis Hodnota
kapacita Kapacita skladové položky (počet nasazených jednotek skladové položky). Výchozí hodnota je 1. Int
Jméno Název skladové položky. Vývojář
Premium
Standard (povinné)

CertificateInformation

Jméno Popis Hodnota
vypršení Datum vypršení platnosti certifikátu Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601. string (povinné)
předmět Předmět certifikátu. string (povinné)
otisk palce Kryptografický otisk certifikátu. string (povinné)

Konfigurace názvu hostitele

Jméno Popis Hodnota
certifikát Informace o certifikátu CertificateInformation (povinné)
název hostitele Název hostitele. string (povinné)
typ Typ názvu hostitele. Správa
Portál
Proxy
Scm (povinné)

Microsoft.ApiManagement/service

Jméno Popis Hodnota
umístění Umístění prostředku string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (povinné)
vlastnosti Vlastnosti služby API Management apiManagementServiceProperties (povinné)
sku Vlastnosti skladové položky služby API Management ApiManagementServiceSkuProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.ApiManagement/service@2016-10-10

Značky prostředků

Jméno Popis Hodnota

VirtualNetworkConfiguration

Jméno Popis Hodnota
umístění Umístění virtuální sítě. řetězec
subnetResourceId Úplné ID prostředku podsítě ve virtuální síti pro nasazení služby API Management do. řetězec

Omezení:
Model = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$