Microsoft.ApiManagement-tjänsten

Artikel
07/24/2024

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@2023-09-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    additionalLocations: [
      {
        disableGateway: bool
        location: 'string'
        natGatewayState: 'string'
        publicIpAddressId: 'string'
        sku: {
          capacity: int
          name: 'string'
        }
        virtualNetworkConfiguration: {
          subnetResourceId: 'string'
        }
        zones: [
          'string'
        ]
      }
    ]
    apiVersionConstraint: {
      minApiVersion: 'string'
    }
    certificates: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        encodedCertificate: 'string'
        storeName: 'string'
      }
    ]
    configurationApi: {
      legacyApi: 'string'
    }
    customProperties: {
      {customized property}: 'string'
    }
    developerPortalStatus: 'string'
    disableGateway: bool
    enableClientCertificate: bool
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        certificateSource: 'string'
        certificateStatus: 'string'
        defaultSslBinding: bool
        encodedCertificate: 'string'
        hostName: 'string'
        identityClientId: 'string'
        keyVaultId: 'string'
        negotiateClientCertificate: bool
        type: 'string'
      }
    ]
    legacyPortalStatus: 'string'
    natGatewayState: 'string'
    notificationSenderEmail: 'string'
    privateEndpointConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
        type: 'string'
      }
    ]
    publicIpAddressId: 'string'
    publicNetworkAccess: 'string'
    publisherEmail: 'string'
    publisherName: 'string'
    restore: bool
    virtualNetworkConfiguration: {
      subnetResourceId: 'string'
    }
    virtualNetworkType: 'string'
  }
  zones: [
    'string'
  ]
}

Egenskapsvärden

tjänst

Namn	Beskrivning	Värde
Namn	Resursnamnet	sträng (krävs) Teckengräns: 1–50 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. Resursnamnet måste vara unikt i Hela Azure.
plats	Resursplats.	sträng (krävs)
Taggar	Resurstaggar.	Ordlista med taggnamn och värden. Se taggar i mallar
Sku	SKU-egenskaper för API Management-tjänsten.	ApiManagementServiceSkuProperties (krävs)
identitet	Hanterad tjänstidentitet för Api Management-tjänsten.	ApiManagementServiceIdentity
Egenskaper	Egenskaper för API Management-tjänsten.	ApiManagementServiceProperties (krävs)
Zoner	En lista över tillgänglighetszoner som anger var resursen måste komma ifrån.	string[]

ApiManagementServiceIdentity

Namn	Beskrivning	Värde
typ	Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.	"Ingen" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (krävs)
userAssignedIdentities	Listan över användaridentiteter som är associerade med resursen. Användaridentiteten ordlistenyckelreferenser är ARM-resurs-ID:t i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ApiManagementServiceIdentityUserAssignedIdentiteter

ApiManagementServiceIdentityUserAssignedIdentiteter

Namn	Beskrivning	Värde
{anpassad egenskap}		UserIdentityProperties

UserIdentityProperties

Namn	Beskrivning	Värde
clientId	Klient-ID för användartilldelad identitet.	sträng
principalId	Huvud-ID för användartilldelad identitet.	sträng

ApiManagementServiceProperties

Namn	Beskrivning	Värde
additionalLocations	Ytterligare datacenterplatser för API Management-tjänsten.	AdditionalLocation[]
apiVersionConstraint	Kontrollplans-API:ets versionsvillkor för API Management-tjänsten.	ApiVersionConstraint
certifikaten	Lista över certifikat som måste installeras i API Management-tjänsten. Maximalt antal certifikat som stöds som kan installeras är 10.	CertificateConfiguration[]
configurationApi	Konfigurations-API-konfiguration för API Management-tjänsten.	ConfigurationApi
customProperties	Anpassade egenskaper för API Management-tjänsten. Om du anger `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` inaktiveras chiffer TLS_RSA_WITH_3DES_EDE_CBC_SHA för alla TLS(1.0, 1.1 och 1.2). Inställning `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` kan användas för att inaktivera bara TLS 1.1. Ange `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` kan användas för att inaktivera TLS 1.0 på en API Management-tjänst. Inställningen `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` kan användas för att inaktivera bara TLS 1.1 för kommunikation med serverdelar. Inställning `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` kan användas för att inaktivera TLS 1.0 för kommunikation med serverdelar. Ange `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` kan användas för att aktivera HTTP2-protokoll på en API Management-tjänst. Om du inte anger någon av dessa egenskaper för PATCH-åtgärden återställs utelämnade egenskapers värden till deras standardvärden. För alla inställningar utom Http2 är standardvärdet `True` om tjänsten skapades den 1 april 2018 eller före den 1 april 2018 och `False` annat. Http2-inställningens standardvärde är `False`. Du kan inaktivera något av följande chiffer med hjälp av inställningarna `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Till exempel `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Standardvärdet är `true` för dem. Obs! Följande chiffer kan inte inaktiveras eftersom de krävs av interna plattformskomponenter: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256	ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus	Status för utvecklarportalen i den här API Management-tjänsten.	"Inaktiverad" "Aktiverad"
disableGateway	Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen i huvudregionen.	Bool
enableClientCertificate	Egenskapen är endast avsedd att användas för förbruknings-SKU-tjänsten. Detta framtvingar att ett klientcertifikat visas på varje begäran till gatewayen. Detta gör det också möjligt att autentisera certifikatet i principen på gatewayen.	Bool
hostnameConfigurations	Konfiguration av anpassat värdnamn för API Management-tjänsten.	HostnameConfiguration[]
legacyPortalStatus	Status för den äldre portalen i API Management-tjänsten.	"Inaktiverad" "Aktiverad"
natGatewayState	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.	"Inaktiverad" "Aktiverad"
notificationSenderEmail	E-postadress som meddelandet ska skickas från.	sträng Begränsningar: Maxlängd = 100
privateEndpointConnections	Lista över privata slutpunktsanslutningar för den här tjänsten.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Public Standard SKU IP V4-baserad IP-adress som ska associeras med distribuerad tjänst för virtuellt nätverk i regionen. Stöds endast för utvecklare och Premium SKU som distribueras i virtuellt nätverk.	sträng
publicNetworkAccess	Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat"	"Inaktiverad" "Aktiverad"
publisherEmail	E-post för utgivare.	sträng (krävs) Begränsningar: Maxlängd = 100
publisherName	Utgivarens namn.	sträng (krävs) Begränsningar: Maxlängd = 100
återställa	Ta bort Api Management-tjänsten om den tidigare var mjuk borttagen. Om den här flaggan anges och är inställd på Sant ignoreras alla andra egenskaper.	Bool
virtualNetworkConfiguration	Konfiguration av virtuellt nätverk för API Management-tjänsten.	VirtualNetworkConfiguration
virtualNetworkType	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"

AdditionalLocation

Namn	Beskrivning	Värde
disableGateway	Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen på den här ytterligare platsen.	Bool
plats	Platsnamnet för den ytterligare regionen mellan Azure Data Center-regioner.	sträng (krävs)
natGatewayState	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.	"Inaktiverad" "Aktiverad"
publicIpAddressId	Public Standard SKU IP V4-baserad IP-adress som ska associeras med distribuerad tjänst för virtuellt nätverk på platsen. Stöds endast för Premium SKU som distribueras i virtuellt nätverk.	sträng
Sku	SKU-egenskaper för API Management-tjänsten.	ApiManagementServiceSkuProperties (krävs)
virtualNetworkConfiguration	Konfiguration av virtuellt nätverk för platsen.	VirtualNetworkConfiguration
Zoner	En lista över tillgänglighetszoner som anger var resursen måste komma ifrån.	string[]

ApiManagementServiceSkuProperties

Namn	Beskrivning	Värde
kapacitet	SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). För SKU-kapacitet för förbrukning måste anges som 0.	int (krävs)
Namn	Namnet på SKU:n.	"Standard" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (krävs)

VirtualNetworkConfiguration

Namn	Beskrivning	Värde
subnetResourceId	Det fullständiga resurs-ID:t för ett undernät i ett virtuellt nätverk för att distribuera API Management-tjänsten i.	sträng Begränsningar: Mönster = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

ApiVersionConstraint

Namn	Beskrivning	Värde
minApiVersion	Begränsa API-anrop för kontrollplan till API Management-tjänsten med en version som är lika med eller nyare än det här värdet.	sträng

CertificateConfiguration

Namn	Beskrivning	Värde
intyg	Certifikatinformation.	CertificateInformation
certificatePassword	Certifikatlösenord.	sträng
encodedCertificate	Base64-kodat certifikat.	sträng
storeName	Certifikatarkivet System.Security.Cryptography.x509certificates.StoreName. Endast Rot- och CertificateAuthority är giltiga platser.	"CertificateAuthority" "Rot" (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)

ConfigurationApi

Namn	Beskrivning	Värde
legacyApi	Ange om det äldre konfigurations-API:et (v1) ska exponeras på API Management-tjänsten eller inte. Värdet är valfritt men måste vara Aktiverat eller Inaktiverat. Om "Inaktiverad" är äldre konfigurations-API (v1) inte tillgängligt för gatewayer med egen värd. Standardvärdet är "Aktiverat"	"Inaktiverad" "Aktiverad"

ApiManagementServiceBasePropertiesCustomProperties

Namn	Beskrivning	Värde
{anpassad egenskap}		sträng

HostnameConfiguration

Namn	Beskrivning	Värde
intyg	Certifikatinformation.	CertificateInformation
certificatePassword	Certifikatlösenord.	sträng
certificateSource	Certifikatkälla.	"BuiltIn" "Anpassad" "KeyVault" "Hanterad"
certificateStatus	Certifikatstatus.	"Slutförd" "Misslyckades" "InProgress"
defaultSslBinding	Ange true för att konfigurera certifikatet som är associerat med det här värdnamnet som standard-SSL-certifikat. Om en klient inte skickar SNI-huvudet blir det här certifikatet som kommer att utmanas. Egenskapen är användbar om en tjänst har flera anpassade värdnamn aktiverade och måste bestämma standard-SSL-certifikatet. Inställningen tillämpas endast på gatewayens värdnamnstyp.	Bool
encodedCertificate	Base64-kodat certifikat.	sträng
hostName	Värdnamn som ska konfigureras på Api Management-tjänsten.	sträng (krävs)
identityClientId	Klient-ID för system- eller användartilldelad hanterad identitet som genererats av Azure AD, som har GET-åtkomst till keyVault som innehåller SSL-certifikatet.	sträng
keyVaultId	Url till KeyVault-hemligheten som innehåller Ssl-certifikatet. Om absolut URL som innehåller version tillhandahålls fungerar inte automatisk uppdatering av SSL-certifikatet. Detta kräver att Api Management-tjänsten konfigureras med aka.ms/apimmsi. Hemligheten ska vara av typen application/x-pkcs12	sträng
negotiateClientCertificate	Ange true för att alltid förhandla om klientcertifikatet på värdnamnet. Standardvärdet är falskt.	Bool
typ	Typ av värdnamn.	"ConfigurationApi" "DeveloperPortal" "Hantering" "Portal" "Proxy" "Scm" (krävs)

RemotePrivateEndpointConnectionWrapper

Namn	Beskrivning	Värde
Id	Resurs-ID för privat slutpunktsanslutning	sträng
Namn	Namn på privat slutpunktsanslutning	sträng
Egenskaper	Resursegenskaper.	PrivateEndpointConnectionWrapperProperties
typ	Resurstyp för privat slutpunktsanslutning	sträng

PrivateEndpointConnectionWrapperProperties

Namn	Beskrivning	Värde
privateEndpoint	Resursen för den privata slutpunkten.	ArmIdWrapper
privateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.	PrivateLinkServiceConnectionState (krävs)

ArmIdWrapper

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

PrivateLinkServiceConnectionState

Namn	Beskrivning	Värde
actionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.	sträng
beskrivning	Orsak till godkännande/avvisande av anslutningen.	sträng
status	Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.	"Godkänd" "Väntar" "Avvisade"

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Beskrivning
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
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.
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.
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 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 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.
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 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 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 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 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.
Distribuera API Management till tillgänglighetszoner	Den här mallen skapar en premiuminstans av Azure API Management och distribueras till en tillgänglighetszon
Skapa en API Management-instans med hjälp av en mall	Den här mallen skapar en utvecklarinstans av Azure API Management
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.
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.
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.

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": "2023-09-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": "bool",
        "location": "string",
        "natGatewayState": "string",
        "publicIpAddressId": "string",
        "sku": {
          "capacity": "int",
          "name": "string"
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "string"
        },
        "zones": [ "string" ]
      }
    ],
    "apiVersionConstraint": {
      "minApiVersion": "string"
    },
    "certificates": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "encodedCertificate": "string",
        "storeName": "string"
      }
    ],
    "configurationApi": {
      "legacyApi": "string"
    },
    "customProperties": {
      "{customized property}": "string"
    },
    "developerPortalStatus": "string",
    "disableGateway": "bool",
    "enableClientCertificate": "bool",
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "certificateSource": "string",
        "certificateStatus": "string",
        "defaultSslBinding": "bool",
        "encodedCertificate": "string",
        "hostName": "string",
        "identityClientId": "string",
        "keyVaultId": "string",
        "negotiateClientCertificate": "bool",
        "type": "string"
      }
    ],
    "legacyPortalStatus": "string",
    "natGatewayState": "string",
    "notificationSenderEmail": "string",
    "privateEndpointConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        },
        "type": "string"
      }
    ],
    "publicIpAddressId": "string",
    "publicNetworkAccess": "string",
    "publisherEmail": "string",
    "publisherName": "string",
    "restore": "bool",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "string"
    },
    "virtualNetworkType": "string"
  },
  "zones": [ "string" ]
}

Egenskapsvärden

tjänst

Namn	Beskrivning	Värde
typ	Resurstypen	"Microsoft.ApiManagement/service"
apiVersion	Resurs-API-versionen	"2023-09-01-preview"
Namn	Resursnamnet	sträng (krävs) Teckengräns: 1–50 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. Resursnamnet måste vara unikt i Hela Azure.
plats	Resursplats.	sträng (krävs)
Taggar	Resurstaggar.	Ordlista med taggnamn och värden. Se taggar i mallar
Sku	SKU-egenskaper för API Management-tjänsten.	ApiManagementServiceSkuProperties (krävs)
identitet	Hanterad tjänstidentitet för Api Management-tjänsten.	ApiManagementServiceIdentity
Egenskaper	Egenskaper för API Management-tjänsten.	ApiManagementServiceProperties (krävs)
Zoner	En lista över tillgänglighetszoner som anger var resursen måste komma ifrån.	string[]

ApiManagementServiceIdentity

Namn	Beskrivning	Värde
typ	Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.	"Ingen" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (krävs)
userAssignedIdentities	Listan över användaridentiteter som är associerade med resursen. Användaridentiteten ordlistenyckelreferenser är ARM-resurs-ID:t i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ApiManagementServiceIdentityUserAssignedIdentiteter

ApiManagementServiceIdentityUserAssignedIdentiteter

Namn	Beskrivning	Värde
{anpassad egenskap}		UserIdentityProperties

UserIdentityProperties

Namn	Beskrivning	Värde
clientId	Klient-ID för användartilldelad identitet.	sträng
principalId	Huvud-ID för användartilldelad identitet.	sträng

ApiManagementServiceProperties

Namn	Beskrivning	Värde
additionalLocations	Ytterligare datacenterplatser för API Management-tjänsten.	AdditionalLocation[]
apiVersionConstraint	Kontrollplans-API:ets versionsvillkor för API Management-tjänsten.	ApiVersionConstraint
certifikaten	Lista över certifikat som måste installeras i API Management-tjänsten. Maximalt antal certifikat som stöds som kan installeras är 10.	CertificateConfiguration[]
configurationApi	Konfigurations-API-konfiguration för API Management-tjänsten.	ConfigurationApi
customProperties	Anpassade egenskaper för API Management-tjänsten. Om du anger `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` inaktiveras chiffer TLS_RSA_WITH_3DES_EDE_CBC_SHA för alla TLS(1.0, 1.1 och 1.2). Inställning `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` kan användas för att inaktivera bara TLS 1.1. Ange `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` kan användas för att inaktivera TLS 1.0 på en API Management-tjänst. Inställningen `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` kan användas för att inaktivera bara TLS 1.1 för kommunikation med serverdelar. Inställning `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` kan användas för att inaktivera TLS 1.0 för kommunikation med serverdelar. Ange `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` kan användas för att aktivera HTTP2-protokoll på en API Management-tjänst. Om du inte anger någon av dessa egenskaper för PATCH-åtgärden återställs utelämnade egenskapers värden till deras standardvärden. För alla inställningar utom Http2 är standardvärdet `True` om tjänsten skapades den 1 april 2018 eller före den 1 april 2018 och `False` annat. Http2-inställningens standardvärde är `False`. Du kan inaktivera något av följande chiffer med hjälp av inställningarna `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Till exempel `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Standardvärdet är `true` för dem. Obs! Följande chiffer kan inte inaktiveras eftersom de krävs av interna plattformskomponenter: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256	ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus	Status för utvecklarportalen i den här API Management-tjänsten.	"Inaktiverad" "Aktiverad"
disableGateway	Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen i huvudregionen.	Bool
enableClientCertificate	Egenskapen är endast avsedd att användas för förbruknings-SKU-tjänsten. Detta framtvingar att ett klientcertifikat visas på varje begäran till gatewayen. Detta gör det också möjligt att autentisera certifikatet i principen på gatewayen.	Bool
hostnameConfigurations	Konfiguration av anpassat värdnamn för API Management-tjänsten.	HostnameConfiguration[]
legacyPortalStatus	Status för den äldre portalen i API Management-tjänsten.	"Inaktiverad" "Aktiverad"
natGatewayState	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.	"Inaktiverad" "Aktiverad"
notificationSenderEmail	E-postadress som meddelandet ska skickas från.	sträng Begränsningar: Maxlängd = 100
privateEndpointConnections	Lista över privata slutpunktsanslutningar för den här tjänsten.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Public Standard SKU IP V4-baserad IP-adress som ska associeras med distribuerad tjänst för virtuellt nätverk i regionen. Stöds endast för utvecklare och Premium SKU som distribueras i virtuellt nätverk.	sträng
publicNetworkAccess	Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat"	"Inaktiverad" "Aktiverad"
publisherEmail	E-post för utgivare.	sträng (krävs) Begränsningar: Maxlängd = 100
publisherName	Utgivarens namn.	sträng (krävs) Begränsningar: Maxlängd = 100
återställa	Ta bort Api Management-tjänsten om den tidigare var mjuk borttagen. Om den här flaggan anges och är inställd på Sant ignoreras alla andra egenskaper.	Bool
virtualNetworkConfiguration	Konfiguration av virtuellt nätverk för API Management-tjänsten.	VirtualNetworkConfiguration
virtualNetworkType	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"

AdditionalLocation

Namn	Beskrivning	Värde
disableGateway	Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen på den här ytterligare platsen.	Bool
plats	Platsnamnet för den ytterligare regionen mellan Azure Data Center-regioner.	sträng (krävs)
natGatewayState	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.	"Inaktiverad" "Aktiverad"
publicIpAddressId	Public Standard SKU IP V4-baserad IP-adress som ska associeras med distribuerad tjänst för virtuellt nätverk på platsen. Stöds endast för Premium SKU som distribueras i virtuellt nätverk.	sträng
Sku	SKU-egenskaper för API Management-tjänsten.	ApiManagementServiceSkuProperties (krävs)
virtualNetworkConfiguration	Konfiguration av virtuellt nätverk för platsen.	VirtualNetworkConfiguration
Zoner	En lista över tillgänglighetszoner som anger var resursen måste komma ifrån.	string[]

ApiManagementServiceSkuProperties

Namn	Beskrivning	Värde
kapacitet	SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). För SKU-kapacitet för förbrukning måste anges som 0.	int (krävs)
Namn	Namnet på SKU:n.	"Standard" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (krävs)

VirtualNetworkConfiguration

Namn	Beskrivning	Värde
subnetResourceId	Det fullständiga resurs-ID:t för ett undernät i ett virtuellt nätverk för att distribuera API Management-tjänsten i.	sträng Begränsningar: Mönster = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

ApiVersionConstraint

Namn	Beskrivning	Värde
minApiVersion	Begränsa API-anrop för kontrollplan till API Management-tjänsten med en version som är lika med eller nyare än det här värdet.	sträng

CertificateConfiguration

Namn	Beskrivning	Värde
intyg	Certifikatinformation.	CertificateInformation
certificatePassword	Certifikatlösenord.	sträng
encodedCertificate	Base64-kodat certifikat.	sträng
storeName	Certifikatarkivet System.Security.Cryptography.x509certificates.StoreName. Endast Rot- och CertificateAuthority är giltiga platser.	"CertificateAuthority" "Rot" (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)

ConfigurationApi

Namn	Beskrivning	Värde
legacyApi	Ange om det äldre konfigurations-API:et (v1) ska exponeras på API Management-tjänsten eller inte. Värdet är valfritt men måste vara Aktiverat eller Inaktiverat. Om "Inaktiverad" är äldre konfigurations-API (v1) inte tillgängligt för gatewayer med egen värd. Standardvärdet är "Aktiverat"	"Inaktiverad" "Aktiverad"

ApiManagementServiceBasePropertiesCustomProperties

Namn	Beskrivning	Värde
{anpassad egenskap}		sträng

HostnameConfiguration

Namn	Beskrivning	Värde
intyg	Certifikatinformation.	CertificateInformation
certificatePassword	Certifikatlösenord.	sträng
certificateSource	Certifikatkälla.	"BuiltIn" "Anpassad" "KeyVault" "Hanterad"
certificateStatus	Certifikatstatus.	"Slutförd" "Misslyckades" "InProgress"
defaultSslBinding	Ange true för att konfigurera certifikatet som är associerat med det här värdnamnet som standard-SSL-certifikat. Om en klient inte skickar SNI-huvudet blir det här certifikatet som kommer att utmanas. Egenskapen är användbar om en tjänst har flera anpassade värdnamn aktiverade och måste bestämma standard-SSL-certifikatet. Inställningen tillämpas endast på gatewayens värdnamnstyp.	Bool
encodedCertificate	Base64-kodat certifikat.	sträng
hostName	Värdnamn som ska konfigureras på Api Management-tjänsten.	sträng (krävs)
identityClientId	Klient-ID för system- eller användartilldelad hanterad identitet som genererats av Azure AD, som har GET-åtkomst till keyVault som innehåller SSL-certifikatet.	sträng
keyVaultId	Url till KeyVault-hemligheten som innehåller Ssl-certifikatet. Om absolut URL som innehåller version tillhandahålls fungerar inte automatisk uppdatering av SSL-certifikatet. Detta kräver att Api Management-tjänsten konfigureras med aka.ms/apimmsi. Hemligheten ska vara av typen application/x-pkcs12	sträng
negotiateClientCertificate	Ange true för att alltid förhandla om klientcertifikatet på värdnamnet. Standardvärdet är falskt.	Bool
typ	Typ av värdnamn.	"ConfigurationApi" "DeveloperPortal" "Hantering" "Portal" "Proxy" "Scm" (krävs)

RemotePrivateEndpointConnectionWrapper

Namn	Beskrivning	Värde
Id	Resurs-ID för privat slutpunktsanslutning	sträng
Namn	Namn på privat slutpunktsanslutning	sträng
Egenskaper	Resursegenskaper.	PrivateEndpointConnectionWrapperProperties
typ	Resurstyp för privat slutpunktsanslutning	sträng

PrivateEndpointConnectionWrapperProperties

Namn	Beskrivning	Värde
privateEndpoint	Resursen för den privata slutpunkten.	ArmIdWrapper
privateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.	PrivateLinkServiceConnectionState (krävs)

ArmIdWrapper

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

PrivateLinkServiceConnectionState

Namn	Beskrivning	Värde
actionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.	sträng
beskrivning	Orsak till godkännande/avvisande av anslutningen.	sträng
status	Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.	"Godkänd" "Väntar" "Avvisade"

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Beskrivning
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
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.
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.
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 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 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.
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 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 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 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 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.
Distribuera API Management till tillgänglighetszoner	Den här mallen skapar en premiuminstans av Azure API Management och distribueras till en tillgänglighetszon
Skapa en API Management-instans med hjälp av en mall	Den här mallen skapar en utvecklarinstans av Azure API Management
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.
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.
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.

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@2023-09-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          disableGateway = bool
          location = "string"
          natGatewayState = "string"
          publicIpAddressId = "string"
          sku = {
            capacity = int
            name = "string"
          }
          virtualNetworkConfiguration = {
            subnetResourceId = "string"
          }
          zones = [
            "string"
          ]
        }
      ]
      apiVersionConstraint = {
        minApiVersion = "string"
      }
      certificates = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          encodedCertificate = "string"
          storeName = "string"
        }
      ]
      configurationApi = {
        legacyApi = "string"
      }
      customProperties = {
        {customized property} = "string"
      }
      developerPortalStatus = "string"
      disableGateway = bool
      enableClientCertificate = bool
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          certificateSource = "string"
          certificateStatus = "string"
          defaultSslBinding = bool
          encodedCertificate = "string"
          hostName = "string"
          identityClientId = "string"
          keyVaultId = "string"
          negotiateClientCertificate = bool
          type = "string"
        }
      ]
      legacyPortalStatus = "string"
      natGatewayState = "string"
      notificationSenderEmail = "string"
      privateEndpointConnections = [
        {
          id = "string"
          name = "string"
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
          type = "string"
        }
      ]
      publicIpAddressId = "string"
      publicNetworkAccess = "string"
      publisherEmail = "string"
      publisherName = "string"
      restore = bool
      virtualNetworkConfiguration = {
        subnetResourceId = "string"
      }
      virtualNetworkType = "string"
    }
    zones = [
      "string"
    ]
    sku = {
      capacity = int
      name = "string"
    }
  })
}

Egenskapsvärden

tjänst

Namn	Beskrivning	Värde
typ	Resurstypen	"Microsoft.ApiManagement/service@2023-09-01-preview"
Namn	Resursnamnet	sträng (krävs) Teckengräns: 1–50 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. Resursnamnet måste vara unikt i Hela Azure.
plats	Resursplats.	sträng (krävs)
parent_id	Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen.	sträng (krävs)
Taggar	Resurstaggar.	Ordlista med taggnamn och värden.
Sku	SKU-egenskaper för API Management-tjänsten.	ApiManagementServiceSkuProperties (krävs)
identitet	Hanterad tjänstidentitet för Api Management-tjänsten.	ApiManagementServiceIdentity
Egenskaper	Egenskaper för API Management-tjänsten.	ApiManagementServiceProperties (krävs)
Zoner	En lista över tillgänglighetszoner som anger var resursen måste komma ifrån.	string[]

ApiManagementServiceIdentity

Namn	Beskrivning	Värde
typ	Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.	"SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (krävs)
identity_ids	Listan över användaridentiteter som är associerade med resursen. Användaridentiteten ordlistenyckelreferenser är ARM-resurs-ID:t i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	Matris med användaridentitets-ID:t.

ApiManagementServiceIdentityUserAssignedIdentiteter

Namn	Beskrivning	Värde
{anpassad egenskap}		UserIdentityProperties

UserIdentityProperties

Namn	Beskrivning	Värde
clientId	Klient-ID för användartilldelad identitet.	sträng
principalId	Huvud-ID för användartilldelad identitet.	sträng

ApiManagementServiceProperties

Namn	Beskrivning	Värde
additionalLocations	Ytterligare datacenterplatser för API Management-tjänsten.	AdditionalLocation[]
apiVersionConstraint	Kontrollplans-API:ets versionsvillkor för API Management-tjänsten.	ApiVersionConstraint
certifikaten	Lista över certifikat som måste installeras i API Management-tjänsten. Maximalt antal certifikat som stöds som kan installeras är 10.	CertificateConfiguration[]
configurationApi	Konfigurations-API-konfiguration för API Management-tjänsten.	ConfigurationApi
customProperties	Anpassade egenskaper för API Management-tjänsten. Om du anger `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` inaktiveras chiffer TLS_RSA_WITH_3DES_EDE_CBC_SHA för alla TLS(1.0, 1.1 och 1.2). Inställning `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` kan användas för att inaktivera bara TLS 1.1. Ange `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` kan användas för att inaktivera TLS 1.0 på en API Management-tjänst. Inställningen `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` kan användas för att inaktivera bara TLS 1.1 för kommunikation med serverdelar. Inställning `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` kan användas för att inaktivera TLS 1.0 för kommunikation med serverdelar. Ange `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` kan användas för att aktivera HTTP2-protokoll på en API Management-tjänst. Om du inte anger någon av dessa egenskaper för PATCH-åtgärden återställs utelämnade egenskapers värden till deras standardvärden. För alla inställningar utom Http2 är standardvärdet `True` om tjänsten skapades den 1 april 2018 eller före den 1 april 2018 och `False` annat. Http2-inställningens standardvärde är `False`. Du kan inaktivera något av följande chiffer med hjälp av inställningarna `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Till exempel `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Standardvärdet är `true` för dem. Obs! Följande chiffer kan inte inaktiveras eftersom de krävs av interna plattformskomponenter: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256	ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus	Status för utvecklarportalen i den här API Management-tjänsten.	"Inaktiverad" "Aktiverad"
disableGateway	Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen i huvudregionen.	Bool
enableClientCertificate	Egenskapen är endast avsedd att användas för förbruknings-SKU-tjänsten. Detta framtvingar att ett klientcertifikat visas på varje begäran till gatewayen. Detta gör det också möjligt att autentisera certifikatet i principen på gatewayen.	Bool
hostnameConfigurations	Konfiguration av anpassat värdnamn för API Management-tjänsten.	HostnameConfiguration[]
legacyPortalStatus	Status för den äldre portalen i API Management-tjänsten.	"Inaktiverad" "Aktiverad"
natGatewayState	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.	"Inaktiverad" "Aktiverad"
notificationSenderEmail	E-postadress som meddelandet ska skickas från.	sträng Begränsningar: Maxlängd = 100
privateEndpointConnections	Lista över privata slutpunktsanslutningar för den här tjänsten.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Public Standard SKU IP V4-baserad IP-adress som ska associeras med distribuerad tjänst för virtuellt nätverk i regionen. Stöds endast för utvecklare och Premium SKU som distribueras i virtuellt nätverk.	sträng
publicNetworkAccess	Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat"	"Inaktiverad" "Aktiverad"
publisherEmail	E-post för utgivare.	sträng (krävs) Begränsningar: Maxlängd = 100
publisherName	Utgivarens namn.	sträng (krävs) Begränsningar: Maxlängd = 100
återställa	Ta bort Api Management-tjänsten om den tidigare var mjuk borttagen. Om den här flaggan anges och är inställd på Sant ignoreras alla andra egenskaper.	Bool
virtualNetworkConfiguration	Konfiguration av virtuellt nätverk för API Management-tjänsten.	VirtualNetworkConfiguration
virtualNetworkType	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" "Intern" "Ingen"

AdditionalLocation

Namn	Beskrivning	Värde
disableGateway	Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen på den här ytterligare platsen.	Bool
plats	Platsnamnet för den ytterligare regionen mellan Azure Data Center-regioner.	sträng (krävs)
natGatewayState	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.	"Inaktiverad" "Aktiverad"
publicIpAddressId	Public Standard SKU IP V4-baserad IP-adress som ska associeras med distribuerad tjänst för virtuellt nätverk på platsen. Stöds endast för Premium SKU som distribueras i virtuellt nätverk.	sträng
Sku	SKU-egenskaper för API Management-tjänsten.	ApiManagementServiceSkuProperties (krävs)
virtualNetworkConfiguration	Konfiguration av virtuellt nätverk för platsen.	VirtualNetworkConfiguration
Zoner	En lista över tillgänglighetszoner som anger var resursen måste komma ifrån.	string[]

ApiManagementServiceSkuProperties

Namn	Beskrivning	Värde
kapacitet	SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). För SKU-kapacitet för förbrukning måste anges som 0.	int (krävs)
Namn	Namnet på SKU:n.	"Standard" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (krävs)

VirtualNetworkConfiguration

Namn	Beskrivning	Värde
subnetResourceId	Det fullständiga resurs-ID:t för ett undernät i ett virtuellt nätverk för att distribuera API Management-tjänsten i.	sträng Begränsningar: Mönster = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

ApiVersionConstraint

Namn	Beskrivning	Värde
minApiVersion	Begränsa API-anrop för kontrollplan till API Management-tjänsten med en version som är lika med eller nyare än det här värdet.	sträng

CertificateConfiguration

Namn	Beskrivning	Värde
intyg	Certifikatinformation.	CertificateInformation
certificatePassword	Certifikatlösenord.	sträng
encodedCertificate	Base64-kodat certifikat.	sträng
storeName	Certifikatarkivet System.Security.Cryptography.x509certificates.StoreName. Endast Rot- och CertificateAuthority är giltiga platser.	"CertificateAuthority" "Root" (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)

ConfigurationApi

Namn	Beskrivning	Värde
legacyApi	Ange om det äldre konfigurations-API:et (v1) ska exponeras på API Management-tjänsten eller inte. Värdet är valfritt men måste vara Aktiverat eller Inaktiverat. Om "Inaktiverad" är äldre konfigurations-API (v1) inte tillgängligt för gatewayer med egen värd. Standardvärdet är "Aktiverat"	"Inaktiverad" "Aktiverad"

ApiManagementServiceBasePropertiesCustomProperties

Namn	Beskrivning	Värde
{anpassad egenskap}		sträng

HostnameConfiguration

Namn	Beskrivning	Värde
intyg	Certifikatinformation.	CertificateInformation
certificatePassword	Certifikatlösenord.	sträng
certificateSource	Certifikatkälla.	"BuiltIn" "Anpassad" "KeyVault" "Hanterad"
certificateStatus	Certifikatstatus.	"Slutfört" "Misslyckades" "InProgress"
defaultSslBinding	Ange true för att konfigurera certifikatet som är associerat med det här värdnamnet som standard-SSL-certifikat. Om en klient inte skickar SNI-huvudet blir det här certifikatet som kommer att utmanas. Egenskapen är användbar om en tjänst har flera anpassade värdnamn aktiverade och måste bestämma standard-SSL-certifikatet. Inställningen tillämpas endast på gatewayens värdnamnstyp.	Bool
encodedCertificate	Base64-kodat certifikat.	sträng
hostName	Värdnamn som ska konfigureras på Api Management-tjänsten.	sträng (krävs)
identityClientId	Klient-ID för system- eller användartilldelad hanterad identitet som genererats av Azure AD, som har GET-åtkomst till keyVault som innehåller SSL-certifikatet.	sträng
keyVaultId	Url till KeyVault-hemligheten som innehåller Ssl-certifikatet. Om absolut URL som innehåller version tillhandahålls fungerar inte automatisk uppdatering av SSL-certifikatet. Detta kräver att Api Management-tjänsten konfigureras med aka.ms/apimmsi. Hemligheten ska vara av typen application/x-pkcs12	sträng
negotiateClientCertificate	Ange true för att alltid förhandla om klientcertifikatet på värdnamnet. Standardvärdet är falskt.	Bool
typ	Typ av värdnamn.	"ConfigurationApi" "DeveloperPortal" "Hantering" "Portal" "Proxy" "Scm" (krävs)

RemotePrivateEndpointConnectionWrapper

Namn	Beskrivning	Värde
Id	Resurs-ID för privat slutpunktsanslutning	sträng
Namn	Namn på privat slutpunktsanslutning	sträng
Egenskaper	Resursegenskaper.	PrivateEndpointConnectionWrapperProperties
typ	Resurstyp för privat slutpunktsanslutning	sträng

PrivateEndpointConnectionWrapperProperties

Namn	Beskrivning	Värde
privateEndpoint	Resursen för den privata slutpunkten.	ArmIdWrapper
privateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.	PrivateLinkServiceConnectionState (krävs)

ArmIdWrapper

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

PrivateLinkServiceConnectionState

Namn	Beskrivning	Värde
actionsRequired	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.	sträng
beskrivning	Orsak till godkännande/avvisande av anslutningen.	sträng
status	Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.	"Godkänd" "Väntar" "Avvisad"

Dela via

Microsoft.ApiManagement-tjänsten

Bicep-resursdefinition

Resursformat

Egenskapsvärden

tjänst

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentiteter

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Snabbstartsmallar

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

tjänst

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentiteter

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Snabbstartsmallar

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

tjänst

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentiteter

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Feedback

Ytterligare resurser