Microsoft.ApiManagement-tjänsten 2016-07-07

• senaste
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01
• 2016-10-10
• 2016-07-07

Bicep-resursdefinition

Tjänstresurstypen kan distribueras med åtgärder som mål:

• Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/tjänstresurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.ApiManagement/service@2016-07-07' = {
  etag: 'string'
  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'
  }
}

Egenskapsvärden

AdditionalRegion

Namn	Beskrivning	Värde
plats	Platsnamnet för den ytterligare regionen mellan Azure Data Center-regioner.	sträng (krävs)
skuType	SKU-typen på platsen.	"Utvecklare" "Premium" "Standard" (krävs)
skuUnitCount	Antalet SKU-enheter på platsen. Det maximala antalet SKU-enheter beror på SkuType. Högsta tillåtna för Developer SKU är 1, för Standard SKU är 4 och för Premium SKU är 10, på en plats.	Int Begränsningar: Maxvärde = 10
vpnconfiguration	Konfiguration av virtuellt nätverk för platsen.	VirtualNetworkConfiguration

ApiManagementServiceBaseParametersTags

Namn	Beskrivning	Värde

ApiManagementServiceProperties

Namn	Beskrivning	Värde
additionalLocations	Ytterligare datacenterplatser för API Management-tjänsten.	AdditionalRegion[]
addresserEmail	E-postadress till adressadressen.	sträng
customProperties	Anpassade egenskaper för API Management-tjänsten, som att inaktivera TLS 1.0.	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	Konfiguration av anpassat värdnamn för API Management-tjänsten.	HostnameConfiguration[]
publisherEmail	E-post för utgivare.	sträng Begränsningar: Maximal längd = (krävs)
publisherName	Utgivarens namn.	sträng (krävs)
vpnconfiguration	Konfiguration av virtuellt nätverk för API Management-tjänsten.	VirtualNetworkConfiguration
vpnType	Den typ av VPN som API Management-tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i något virtuellt nätverk, externt innebär att API Management-distributionen har konfigurerats i ett virtuellt nätverk med en Internetuppkopplad slutpunkt, och intern innebär att API Management-distributionen konfigureras i ett virtuellt nätverk som endast har en intranätuppkopplad slutpunkt.	"Extern" "Internt" "Ingen"

ApiManagementServicePropertiesCustomProperties

Namn	Beskrivning	Värde

ApiManagementServiceSkuProperties

Namn	Beskrivning	Värde
kapacitet	SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). Standardvärdet är 1.	Int
Namn	Namnet på SKU:n.	"Utvecklare" "Premium" "Standard" (krävs)

CertificateInformation

Namn	Beskrivning	Värde
Utgången	Förfallodatum för certifikatet. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt ISO 8601-standarden.	sträng (krävs)
subjekt	Certifikatets ämne.	sträng (krävs)
tumavtryck	Tumavtryck för certifikatet.	sträng (krävs)

HostnameConfiguration

Namn	Beskrivning	Värde
intyg	Certifikatinformation.	CertificateInformation (krävs)
värdnamn	Värdnamn.	sträng (krävs)
typ	Typ av värdnamn.	"Hantering" "Portal" "Proxy" "Scm" (krävs)

Microsoft.ApiManagement/service

Namn	Beskrivning	Värde
etag	ETag för resursen.	sträng
plats	Datacenterplats för API Management-tjänsten.	sträng (krävs)
Namn	Resursnamnet	sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (krävs)
Egenskaper	Egenskaper för API Management-tjänsten.	ApiManagementServiceProperties
Sku	SKU-egenskaper för API Management-tjänsten.	ApiManagementServiceSkuProperties
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar

VirtualNetworkConfiguration

Namn	Beskrivning	Värde
plats	Platsen för det virtuella nätverket.	sträng
subnetResourceId	Namnet på undernätets resurs-ID. Detta har formatet /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft. {Nätverk	ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}.	sträng

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil	Beskrivning
Application Gateway med intern API Management och Web App	Application Gateway dirigerar Internettrafik till en API Management-instans för virtuellt nätverk (internt läge) som servar ett webb-API som finns i en Azure-webbapp.
Skapa en API Management-instans på flera regioner på Premium-nivå	Den här mallen visar hur du skapar en API Management-instans med ytterligare platser. Den primära platsen är samma som platsen för resursgruppen. För ytterligare platser visar mallen NorthCentralUs och USA, östra 2. Den primära platsen bör skilja sig från ytterligare platser.
Skapa en API Management-instans med MSI-identitet	Den här mallen skapar en utvecklarinstans av Azure API Management med en MSI-identitet
Skapa en API Management-instans med hjälp av en mall	Den här mallen skapar en utvecklarinstans av Azure API Management
Skapa en API Management-tjänst med en privat slutpunkt	Den här mallen skapar en API Management-tjänst, ett virtuellt nätverk och en privat slutpunkt som exponerar API Management-tjänsten för det virtuella nätverket.
Skapa en API Management-tjänst med SSL från KeyVault	Den här mallen distribuerar en API Management-tjänst som konfigurerats med användartilldelad identitet. Den använder den här identiteten för att hämta SSL-certifikat från KeyVault och håller den uppdaterad genom att kontrollera var fjärde timme.
Skapa API Management i internt VNet med App Gateway	Den här mallen visar hur du skapar en instans av Azure API Management i ett privat nätverk som skyddas av Azure Application Gateway.
Distribuera API Management i externa virtuella nätverk med offentliga IP-	Den här mallen visar hur du skapar en instans av Azure API Management på Premium-nivån i det virtuella nätverkets undernät i externt läge och konfigurerar rekommenderade NSG-regler i undernätet. Instansen distribueras till två tillgänglighetszoner. Mallen konfigurerar också en offentlig IP-adress från din prenumeration.
Distribuera API Management i internt VNet med offentliga IP-	Den här mallen visar hur du skapar en instans av Azure API Management på Premium-nivån i det virtuella nätverkets undernät i internt läge och konfigurerar rekommenderade NSG-regler i undernätet. Instansen distribueras till två tillgänglighetszoner. Mallen konfigurerar också en offentlig IP-adress från din prenumeration.
Distribuera API Management till tillgänglighetszoner	Den här mallen skapar en premiuminstans av Azure API Management och distribueras till en tillgänglighetszon
Distribuera API Management med en extern Azure Cache for Redis-	Den här mallen visar hur du skapar en instans av Azure API Management på förbrukningsnivån med en extern Azure Cache for Redis-instans som extern API Management-cache.
Front Door Standard/Premium med API Management-ursprung	Den här mallen skapar en Front Door Premium och en API Management-instans och använder en NSG- och global API Management-princip för att verifiera att trafiken har kommit via Front Door-ursprunget.

Resursdefinition för ARM-mall

Tjänstresurstypen kan distribueras med åtgärder som mål:

• Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/tjänstresurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2016-07-07",
  "name": "string",
  "etag": "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"
  }
}

Egenskapsvärden

AdditionalRegion

Namn	Beskrivning	Värde
plats	Platsnamnet för den ytterligare regionen mellan Azure Data Center-regioner.	sträng (krävs)
skuType	SKU-typen på platsen.	"Utvecklare" "Premium" "Standard" (krävs)
skuUnitCount	Antalet SKU-enheter på platsen. Det maximala antalet SKU-enheter beror på SkuType. Högsta tillåtna för Developer SKU är 1, för Standard SKU är 4 och för Premium SKU är 10, på en plats.	Int Begränsningar: Maxvärde = 10
vpnconfiguration	Konfiguration av virtuellt nätverk för platsen.	VirtualNetworkConfiguration

ApiManagementServiceBaseParametersTags

Namn	Beskrivning	Värde

ApiManagementServiceProperties

Namn	Beskrivning	Värde
additionalLocations	Ytterligare datacenterplatser för API Management-tjänsten.	AdditionalRegion[]
addresserEmail	E-postadress till adressadressen.	sträng
customProperties	Anpassade egenskaper för API Management-tjänsten, som att inaktivera TLS 1.0.	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	Konfiguration av anpassat värdnamn för API Management-tjänsten.	HostnameConfiguration[]
publisherEmail	E-post för utgivare.	sträng Begränsningar: Maximal längd = (krävs)
publisherName	Utgivarens namn.	sträng (krävs)
vpnconfiguration	Konfiguration av virtuellt nätverk för API Management-tjänsten.	VirtualNetworkConfiguration
vpnType	Den typ av VPN som API Management-tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i något virtuellt nätverk, externt innebär att API Management-distributionen har konfigurerats i ett virtuellt nätverk med en Internetuppkopplad slutpunkt, och intern innebär att API Management-distributionen konfigureras i ett virtuellt nätverk som endast har en intranätuppkopplad slutpunkt.	"Extern" "Internt" "Ingen"

ApiManagementServicePropertiesCustomProperties

Namn	Beskrivning	Värde

ApiManagementServiceSkuProperties

Namn	Beskrivning	Värde
kapacitet	SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). Standardvärdet är 1.	Int
Namn	Namnet på SKU:n.	"Utvecklare" "Premium" "Standard" (krävs)

CertificateInformation

Namn	Beskrivning	Värde
Utgången	Förfallodatum för certifikatet. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt ISO 8601-standarden.	sträng (krävs)
subjekt	Certifikatets ämne.	sträng (krävs)
tumavtryck	Tumavtryck för certifikatet.	sträng (krävs)

HostnameConfiguration

Namn	Beskrivning	Värde
intyg	Certifikatinformation.	CertificateInformation (krävs)
värdnamn	Värdnamn.	sträng (krävs)
typ	Typ av värdnamn.	"Hantering" "Portal" "Proxy" "Scm" (krävs)

Microsoft.ApiManagement/service

Namn	Beskrivning	Värde
apiVersion	API-versionen	'2016-07-07'
etag	ETag för resursen.	sträng
plats	Datacenterplats för API Management-tjänsten.	sträng (krävs)
Namn	Resursnamnet	sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (krävs)
Egenskaper	Egenskaper för API Management-tjänsten.	ApiManagementServiceProperties
Sku	SKU-egenskaper för API Management-tjänsten.	ApiManagementServiceSkuProperties
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar
typ	Resurstypen	"Microsoft.ApiManagement/service"

VirtualNetworkConfiguration

Namn	Beskrivning	Värde
plats	Platsen för det virtuella nätverket.	sträng
subnetResourceId	Namnet på undernätets resurs-ID. Detta har formatet /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft. {Nätverk	ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}.	sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Beskrivning
Application Gateway med intern API Management och Web App	Application Gateway dirigerar Internettrafik till en API Management-instans för virtuellt nätverk (internt läge) som servar ett webb-API som finns i en Azure-webbapp.
Skapa en API Management-instans på flera regioner på Premium-nivå	Den här mallen visar hur du skapar en API Management-instans med ytterligare platser. Den primära platsen är samma som platsen för resursgruppen. För ytterligare platser visar mallen NorthCentralUs och USA, östra 2. Den primära platsen bör skilja sig från ytterligare platser.
Skapa en API Management-instans och alla underresurser med hjälp av mallen	Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter
Skapa en API Management-instans med MSI-identitet	Den här mallen skapar en utvecklarinstans av Azure API Management med en MSI-identitet
Skapa en API Management-instans med hjälp av en mall	Den här mallen skapar en utvecklarinstans av Azure API Management
Skapa en API Management-instans med anpassade värdnamn	Den här mallen visar hur du skapar en instans av Azure API Management med anpassat värdnamn för portalen och flera anpassade värdnamn för proxy
Skapa en API Management-tjänst med en privat slutpunkt	Den här mallen skapar en API Management-tjänst, ett virtuellt nätverk och en privat slutpunkt som exponerar API Management-tjänsten för det virtuella nätverket.
Skapa en API Management-tjänst med SSL från KeyVault	Den här mallen distribuerar en API Management-tjänst som konfigurerats med användartilldelad identitet. Den använder den här identiteten för att hämta SSL-certifikat från KeyVault och håller den uppdaterad genom att kontrollera var fjärde timme.
Skapa och övervaka API Management-instanser	Den här mallen skapar en instans av Azure API Management-tjänsten och Log Analytics-arbetsytan och konfigurerar övervakning för DIN API Management-tjänst med Log Analytics
Skapa API Management i internt VNet med App Gateway	Den här mallen visar hur du skapar en instans av Azure API Management i ett privat nätverk som skyddas av Azure Application Gateway.
Skapa API Management med anpassad proxy-SSL med Hjälp av KeyVault	Den här mallen visar hur du skapar en instans av Azure API Management och konfigurerar anpassat värdnamn för proxy med SSL-certifikat från keyvault.
Skapa Azure Front Door framför Azure API Management	Det här exemplet visar hur du använder Azure Front Door som global lastbalanserare framför Azure API Management.
Distribuera API Management i externa virtuella nätverk med offentliga IP-	Den här mallen visar hur du skapar en instans av Azure API Management på Premium-nivån i det virtuella nätverkets undernät i externt läge och konfigurerar rekommenderade NSG-regler i undernätet. Instansen distribueras till två tillgänglighetszoner. Mallen konfigurerar också en offentlig IP-adress från din prenumeration.
Distribuera API Management i internt VNet med offentliga IP-	Den här mallen visar hur du skapar en instans av Azure API Management på Premium-nivån i det virtuella nätverkets undernät i internt läge och konfigurerar rekommenderade NSG-regler i undernätet. Instansen distribueras till två tillgänglighetszoner. Mallen konfigurerar också en offentlig IP-adress från din prenumeration.
Distribuera API Management till tillgänglighetszoner	Den här mallen skapar en premiuminstans av Azure API Management och distribueras till en tillgänglighetszon
Distribuera API Management med en extern Azure Cache for Redis-	Den här mallen visar hur du skapar en instans av Azure API Management på förbrukningsnivån med en extern Azure Cache for Redis-instans som extern API Management-cache.
Front Door Standard/Premium med API Management-ursprung	Den här mallen skapar en Front Door Premium och en API Management-instans och använder en NSG- och global API Management-princip för att verifiera att trafiken har kommit via Front Door-ursprunget.

Resursdefinition för Terraform (AzAPI-provider)

Tjänstresurstypen kan distribueras med åtgärder som mål:

• Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/tjänstresurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2016-07-07"
  name = "string"
  etag = "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"
    }
  })
}

Egenskapsvärden

AdditionalRegion

Namn	Beskrivning	Värde
plats	Platsnamnet för den ytterligare regionen mellan Azure Data Center-regioner.	sträng (krävs)
skuType	SKU-typen på platsen.	"Utvecklare" "Premium" "Standard" (krävs)
skuUnitCount	Antalet SKU-enheter på platsen. Det maximala antalet SKU-enheter beror på SkuType. Högsta tillåtna för Developer SKU är 1, för Standard SKU är 4 och för Premium SKU är 10, på en plats.	Int Begränsningar: Maxvärde = 10
vpnconfiguration	Konfiguration av virtuellt nätverk för platsen.	VirtualNetworkConfiguration

ApiManagementServiceBaseParametersTags

Namn	Beskrivning	Värde

ApiManagementServiceProperties

Namn	Beskrivning	Värde
additionalLocations	Ytterligare datacenterplatser för API Management-tjänsten.	AdditionalRegion[]
addresserEmail	E-postadress till adressadressen.	sträng
customProperties	Anpassade egenskaper för API Management-tjänsten, som att inaktivera TLS 1.0.	ApiManagementServicePropertiesCustomProperties
hostnameConfigurations	Konfiguration av anpassat värdnamn för API Management-tjänsten.	HostnameConfiguration[]
publisherEmail	E-post för utgivare.	sträng Begränsningar: Maximal längd = (krävs)
publisherName	Utgivarens namn.	sträng (krävs)
vpnconfiguration	Konfiguration av virtuellt nätverk för API Management-tjänsten.	VirtualNetworkConfiguration
vpnType	Den typ av VPN som API Management-tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i något virtuellt nätverk, externt innebär att API Management-distributionen har konfigurerats i ett virtuellt nätverk med en Internetuppkopplad slutpunkt, och intern innebär att API Management-distributionen konfigureras i ett virtuellt nätverk som endast har en intranätuppkopplad slutpunkt.	"Extern" "Internt" "Ingen"

ApiManagementServicePropertiesCustomProperties

Namn	Beskrivning	Värde

ApiManagementServiceSkuProperties

Namn	Beskrivning	Värde
kapacitet	SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). Standardvärdet är 1.	Int
Namn	Namnet på SKU:n.	"Utvecklare" "Premium" "Standard" (krävs)

CertificateInformation

Namn	Beskrivning	Värde
Utgången	Förfallodatum för certifikatet. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt ISO 8601-standarden.	sträng (krävs)
subjekt	Certifikatets ämne.	sträng (krävs)
tumavtryck	Tumavtryck för certifikatet.	sträng (krävs)

HostnameConfiguration

Namn	Beskrivning	Värde
intyg	Certifikatinformation.	CertificateInformation (krävs)
värdnamn	Värdnamn.	sträng (krävs)
typ	Typ av värdnamn.	"Hantering" "Portal" "Proxy" "Scm" (krävs)

Microsoft.ApiManagement/service

Namn	Beskrivning	Värde
etag	ETag för resursen.	sträng
plats	Datacenterplats för API Management-tjänsten.	sträng (krävs)
Namn	Resursnamnet	sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (krävs)
Egenskaper	Egenskaper för API Management-tjänsten.	ApiManagementServiceProperties
Sku	SKU-egenskaper för API Management-tjänsten.	ApiManagementServiceSkuProperties
Taggar	Resurstaggar	Ordlista med taggnamn och värden.
typ	Resurstypen	"Microsoft.ApiManagement/service@2016-07-07"

VirtualNetworkConfiguration

Namn	Beskrivning	Värde
plats	Platsen för det virtuella nätverket.	sträng
subnetResourceId	Namnet på undernätets resurs-ID. Detta har formatet /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft. {Nätverk	ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}.	sträng