Služba Microsoft.ApiManagement

Článek
07/24/2024

nejnovější
2023-09-01-preview
2022-08-01
2021-08-01

Definice prostředku Bicep

Typ prostředku služby je možné nasadit s operacemi, které cílí:

skupiny prostředků – viz příkazy nasazení skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

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@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'
  ]
}

Hodnoty vlastností

služba

Jméno	Popis	Hodnota
Jméno	Název prostředku	string (povinné) Limit znaků: 1–50 Platné znaky: Alfanumerické znaky a spojovníky Začněte písmenem a končit alfanumerickými znaky. Název prostředku musí být v Rámci Azure jedinečný.
umístění	Umístění prostředku	string (povinné)
visačky	Značky prostředků	Slovník názvů a hodnot značek Viz Značky v šablonách
sku	Vlastnosti skladové položky služby API Management	ApiManagementServiceSkuProperties (povinné)
identita	Identita spravované služby služby Api Management	ApiManagementServiceIdentity
vlastnosti	Vlastnosti služby API Management	apiManagementServiceProperties (povinné)
zóny	Seznam zón dostupnosti označující, odkud prostředek musí pocházet.	string[]

ApiManagementServiceIdentity

Jméno	Popis	Hodnota
typ	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.	None (Žádný) SystemAssigned SystemAssigned, UserAssigned UserAssigned (povinné)
userAssignedIdentities	Seznam identit uživatelů přidružených k prostředku. Identita uživatele Odkazy na klíč slovníku budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	apiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Jméno	Popis	Hodnota
{přizpůsobená vlastnost}		userIdentityProperties

UserIdentityProperties

Jméno	Popis	Hodnota
clientId	ID klienta identity přiřazené uživatelem.	řetězec
principalId	ID objektu zabezpečení identity přiřazené uživatelem.	řetězec

ApiManagementServiceProperties

Jméno	Popis	Hodnota
additionalLocations	Další umístění datacenter služby API Management	AdditionalLocation[]
apiVersionConstraint	Omezení verze APIS roviny řízení pro službu API Management	ApiVersionConstraint
certifikáty	Seznam certifikátů, které je potřeba nainstalovat ve službě API Management Maximální počet podporovaných certifikátů, které je možné nainstalovat, je 10.	CertificateConfiguration[]
configurationApi	Konfigurace rozhraní API konfigurace služby API Management	ConfigurationApi
customProperties	Vlastní vlastnosti služby API Management Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` zakáže šifrovací TLS_RSA_WITH_3DES_EDE_CBC_SHA pro všechny protokoly TLS(1.0, 1.1 a 1.2). Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` lze použít k zakázání pouze protokolu TLS 1.1. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` lze použít k zakázání protokolu TLS 1.0 ve službě API Management. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` lze použít k zakázání jenom protokolu TLS 1.1 pro komunikaci s back-endy. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` lze použít k zakázání protokolu TLS 1.0 pro komunikaci s back-endy. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` lze použít k povolení protokolu HTTP2 ve službě API Management. Nezadání žádné z těchto vlastností v operaci PATCH resetuje hodnoty vynechaných vlastností na výchozí hodnoty. Pro všechna nastavení kromě Http2 je výchozí hodnota `True`, pokud byla služba vytvořena 1. dubna 2018 a `False` jinak. Výchozí hodnota nastavení Http2 je `False`. Pomocí `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`nastavení můžete zakázat kteroukoli z následujících šifer: 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. Například `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Výchozí hodnota je `true` pro ně. Poznámka: Následující šifry nelze zakázat, protože jsou vyžadovány interními komponentami platformy: 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	Stav portálu pro vývojáře v této službě API Management	Zakázáno Povoleno
disableGateway	Vlastnost platí pouze pro službu Api Management nasazenou ve více umístěních. To se dá použít k zakázání brány v hlavní oblasti.	Bool
enableClientCertificate	Vlastnost má být použita pouze pro službu SKU Consumption. To vynucuje, aby se klientský certifikát zobrazoval na každém požadavku bráně. To také umožňuje ověřit certifikát v zásadách brány.	Bool
hostnameConfigurations	Vlastní konfigurace názvu hostitele služby API Management	Konfigurace názvu hostitele[]
legacyPortalStatus	Stav starší verze portálu ve službě API Management	Zakázáno Povoleno
natGatewayState	Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.	Zakázáno Povoleno
notificationSenderEmail	E-mailová adresa, ze které se oznámení odešle.	řetězec Omezení: Maximální délka = 100
privateEndpointConnections	Seznam připojení privátních koncových bodů této služby	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	IP adresa založená na veřejné standardní SKU V4, která se má přidružit k nasazené službě virtuální sítě v dané oblasti. Podporuje se jenom pro SKU Pro vývojáře a Premium nasazené ve virtuální síti.	řetězec
publicNetworkAccess	Určuje, jestli je pro tuto službu API Management povolený přístup k veřejnému koncovému bodu. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, privátní koncové body jsou výhradní metodou přístupu. Výchozí hodnota je Enabled	Zakázáno Povoleno
publisherEmail	E-mail vydavatele.	string (povinné) Omezení: Maximální délka = 100
publisherName	Název vydavatele.	string (povinné) Omezení: Maximální délka = 100
obnovit	Pokud byla dříve obnovitelně odstraněna, zrušte odstranění služby Api Management. Pokud je tento příznak zadaný a nastaví se na Hodnotu True, budou ignorovány všechny ostatní vlastnosti.	Bool
virtualNetworkConfiguration	Konfigurace virtuální sítě služby API Management	virtualNetworkConfiguration
virtualNetworkType	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ý)

AdditionalLocation

Jméno	Popis	Hodnota
disableGateway	Vlastnost platí pouze pro službu Api Management nasazenou ve více umístěních. Tuto možnost můžete použít k zakázání brány v tomto dalším umístění.	Bool
umístění	Název umístění další oblasti mezi oblastmi Azure Data Center.	string (povinné)
natGatewayState	Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.	Zakázáno Povoleno
publicIpAddressId	IP adresa založená na veřejné standardní SKU V4, která se má přidružit k nasazené službě virtuální sítě v umístění. Podporuje se jenom nasazení skladové položky Premium ve virtuální síti.	řetězec
sku	Vlastnosti skladové položky služby API Management	ApiManagementServiceSkuProperties (povinné)
virtualNetworkConfiguration	Konfigurace virtuální sítě pro umístění	virtualNetworkConfiguration
zóny	Seznam zón dostupnosti označující, odkud prostředek musí pocházet.	string[]

ApiManagementServiceSkuProperties

Jméno	Popis	Hodnota
kapacita	Kapacita skladové položky (počet nasazených jednotek skladové položky). Pro kapacitu skladové položky Consumption musí být zadána jako 0.	int (povinné)
Jméno	Název skladové položky.	"Standardní" WorkspaceGatewayPremium WorkspaceGatewayStandard (povinné)

VirtualNetworkConfiguration

Jméno	Popis	Hodnota
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/[^/]$`

ApiVersionConstraint

Jméno	Popis	Hodnota
minApiVersion	Omezte volání rozhraní API řídicí roviny do služby API Management s verzí rovnající se nebo novější než tato hodnota.	řetězec

CertificateConfiguration

Jméno	Popis	Hodnota
certifikát	Informace o certifikátu	CertificateInformation
certificatePassword	Heslo certifikátu.	řetězec
encodedCertificate	Kódovaný certifikát Base64	řetězec
storeName	Umístění úložiště certifikátů System.Security.Cryptography.x509certificates.StoreName. Platná umístění jsou pouze root a CertificateAuthority.	CertificateAuthority Root (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é)

ConfigurationApi

Jméno	Popis	Hodnota
legacyApi	Indikuje, jestli má být ve službě API Management zpřístupněno starší verze konfiguračního rozhraní API (v1). Hodnota je nepovinná, ale musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, starší verze rozhraní API konfigurace (v1) nebude k dispozici pro brány v místním prostředí. Výchozí hodnota je Enabled	Zakázáno Povoleno

ApiManagementServiceBasePropertiesCustomProperties

Jméno	Popis	Hodnota
{přizpůsobená vlastnost}		řetězec

Konfigurace názvu hostitele

Jméno	Popis	Hodnota
certifikát	Informace o certifikátu	CertificateInformation
certificatePassword	Heslo certifikátu.	řetězec
certificateSource	Zdroj certifikátu.	'BuiltIn' Vlastní KeyVault Spravovaná
certificateStatus	Stav certifikátu.	Dokončeno Chyba InProgress
defaultSslBinding	Zadejte hodnotu true pro nastavení certifikátu přidruženého k tomuto názvu hostitele jako výchozího certifikátu SSL. Pokud klient neodešle hlavičku SNI, bude to certifikát, který bude vyzván. Tato vlastnost je užitečná, pokud má služba povolených více vlastních názvů hostitelů a musí se rozhodnout o výchozím certifikátu SSL. Nastavení použité pouze pro typ názvu hostitele brány.	Bool
encodedCertificate	Kódovaný certifikát Base64	řetězec
hostName	Název hostitele pro konfiguraci ve službě Api Management.	string (povinné)
identityClientId	ID klienta spravované identity přiřazené systémem nebo uživatelem vygenerované službou Azure AD, který má přístup GET ke službě keyVault obsahující certifikát SSL.	řetězec
keyVaultId	Adresa URL tajného klíče služby KeyVault obsahující certifikát SSL. Pokud je k dispozici absolutní adresa URL obsahující verzi, automatická aktualizace certifikátu SSL nebude fungovat. To vyžaduje, aby služba Api Management byla nakonfigurovaná s aka.ms/apimmsi. Tajný kód by měl být typu application/x-pkcs12	řetězec
negotiateClientCertificate	Zadejte true pro vždy vyjednání klientského certifikátu na názvu hostitele. Výchozí hodnota je false.	Bool
typ	Typ názvu hostitele.	ConfigurationApi DeveloperPortal Správa Portál Proxy Scm (povinné)

RemotePrivateEndpointConnectionWrapper

Jméno	Popis	Hodnota
id	ID prostředku připojení privátního koncového bodu	řetězec
Jméno	Název připojení privátního koncového bodu	řetězec
vlastnosti	Vlastnosti prostředku.	privateEndpointConnectionWrapperProperties
typ	Typ prostředku připojení privátního koncového bodu	řetězec

PrivateEndpointConnectionWrapperProperties

Jméno	Popis	Hodnota
privateEndpoint	Prostředek privátního koncového bodu.	ArmIdWrapper
privateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.	PrivateLinkServiceConnectionState (povinné)

ArmIdWrapper

Tento objekt neobsahuje žádné vlastnosti, které se mají nastavit během nasazení. Všechny vlastnosti jsou Jen pro čtení.

PrivateLinkServiceConnectionState

Jméno	Popis	Hodnota
ActionsRequired	Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.	řetězec
popis	Důvod schválení nebo zamítnutí připojení.	řetězec
stav	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.	"Schváleno" Čeká na vyřízení Odmítnuto

Šablony pro rychlý start

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

Šablona	Popis
vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony nasazení	Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity.
nasazení služby API Management s externí službou Azure Cache for Redis nasazení	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.
Nasazení služby API Management v externí virtuální síti s veřejnými IP nasazení	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.
vytvoření instance služby API Management s vlastními názvy hostitelů nasazení	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 v interní virtuální síti s služby App Gateway nasazení	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 interní virtuální síti s veřejnými IP nasazení	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.
vytvoření instance služby API Management s identitou MSI nasazení	Tato šablona vytvoří instanci vývojáře služby Azure API Management s identitou MSI.
Vytvoření instance SLUŽBY API Management s více oblastmi úrovně Premium nasazení	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í služby API Management s vlastním ssl proxy pomocí služby KeyVault nasazení	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 API Management s protokolem SSL ze služby KeyVault nasazení	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í	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 s privátním koncovým bodem nasazení	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.
nasazení služby API Management do zón dostupnosti nasazení	Tato šablona vytvoří instanci služby Azure API Management úrovně Premium a nasadí ji do zóny dostupnosti.
Vytvoření instance služby API Management pomocí šablony nasazení	Tato šablona vytvoří instanci vývojáře služby Azure API Management.
služby Front Door Standard/Premium s původu služby API Management nasazení	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.
vytvoření služby Azure Front Door před službou Azure API Management nasazení	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.
Application Gateway s interní službou API Management a webovou aplikací nasazení	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.

Definice prostředku šablony ARM

Typ prostředku služby je možné nasadit s operacemi, které cílí:

skupiny prostředků – viz příkazy nasazení skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

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": "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" ]
}

Hodnoty vlastností

služba

Jméno	Popis	Hodnota
typ	Typ prostředku	Microsoft.ApiManagement/service
apiVersion	Verze rozhraní API prostředku	2023-09-01-preview
Jméno	Název prostředku	string (povinné) Limit znaků: 1–50 Platné znaky: Alfanumerické znaky a spojovníky Začněte písmenem a končit alfanumerickými znaky. Název prostředku musí být v Rámci Azure jedinečný.
umístění	Umístění prostředku	string (povinné)
visačky	Značky prostředků	Slovník názvů a hodnot značek Viz Značky v šablonách
sku	Vlastnosti skladové položky služby API Management	ApiManagementServiceSkuProperties (povinné)
identita	Identita spravované služby služby Api Management	ApiManagementServiceIdentity
vlastnosti	Vlastnosti služby API Management	apiManagementServiceProperties (povinné)
zóny	Seznam zón dostupnosti označující, odkud prostředek musí pocházet.	string[]

ApiManagementServiceIdentity

Jméno	Popis	Hodnota
typ	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.	None (Žádný) SystemAssigned SystemAssigned, UserAssigned UserAssigned (povinné)
userAssignedIdentities	Seznam identit uživatelů přidružených k prostředku. Identita uživatele Odkazy na klíč slovníku budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	apiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Jméno	Popis	Hodnota
{přizpůsobená vlastnost}		userIdentityProperties

UserIdentityProperties

Jméno	Popis	Hodnota
clientId	ID klienta identity přiřazené uživatelem.	řetězec
principalId	ID objektu zabezpečení identity přiřazené uživatelem.	řetězec

ApiManagementServiceProperties

Jméno	Popis	Hodnota
additionalLocations	Další umístění datacenter služby API Management	AdditionalLocation[]
apiVersionConstraint	Omezení verze APIS roviny řízení pro službu API Management	ApiVersionConstraint
certifikáty	Seznam certifikátů, které je potřeba nainstalovat ve službě API Management Maximální počet podporovaných certifikátů, které je možné nainstalovat, je 10.	CertificateConfiguration[]
configurationApi	Konfigurace rozhraní API konfigurace služby API Management	ConfigurationApi
customProperties	Vlastní vlastnosti služby API Management Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` zakáže šifrovací TLS_RSA_WITH_3DES_EDE_CBC_SHA pro všechny protokoly TLS(1.0, 1.1 a 1.2). Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` lze použít k zakázání pouze protokolu TLS 1.1. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` lze použít k zakázání protokolu TLS 1.0 ve službě API Management. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` lze použít k zakázání jenom protokolu TLS 1.1 pro komunikaci s back-endy. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` lze použít k zakázání protokolu TLS 1.0 pro komunikaci s back-endy. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` lze použít k povolení protokolu HTTP2 ve službě API Management. Nezadání žádné z těchto vlastností v operaci PATCH resetuje hodnoty vynechaných vlastností na výchozí hodnoty. Pro všechna nastavení kromě Http2 je výchozí hodnota `True`, pokud byla služba vytvořena 1. dubna 2018 a `False` jinak. Výchozí hodnota nastavení Http2 je `False`. Pomocí `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`nastavení můžete zakázat kteroukoli z následujících šifer: 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. Například `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Výchozí hodnota je `true` pro ně. Poznámka: Následující šifry nelze zakázat, protože jsou vyžadovány interními komponentami platformy: 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	Stav portálu pro vývojáře v této službě API Management	Zakázáno Povoleno
disableGateway	Vlastnost platí pouze pro službu Api Management nasazenou ve více umístěních. To se dá použít k zakázání brány v hlavní oblasti.	Bool
enableClientCertificate	Vlastnost má být použita pouze pro službu SKU Consumption. To vynucuje, aby se klientský certifikát zobrazoval na každém požadavku bráně. To také umožňuje ověřit certifikát v zásadách brány.	Bool
hostnameConfigurations	Vlastní konfigurace názvu hostitele služby API Management	Konfigurace názvu hostitele[]
legacyPortalStatus	Stav starší verze portálu ve službě API Management	Zakázáno Povoleno
natGatewayState	Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.	Zakázáno Povoleno
notificationSenderEmail	E-mailová adresa, ze které se oznámení odešle.	řetězec Omezení: Maximální délka = 100
privateEndpointConnections	Seznam připojení privátních koncových bodů této služby	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	IP adresa založená na veřejné standardní SKU V4, která se má přidružit k nasazené službě virtuální sítě v dané oblasti. Podporuje se jenom pro SKU Pro vývojáře a Premium nasazené ve virtuální síti.	řetězec
publicNetworkAccess	Určuje, jestli je pro tuto službu API Management povolený přístup k veřejnému koncovému bodu. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, privátní koncové body jsou výhradní metodou přístupu. Výchozí hodnota je Enabled	Zakázáno Povoleno
publisherEmail	E-mail vydavatele.	string (povinné) Omezení: Maximální délka = 100
publisherName	Název vydavatele.	string (povinné) Omezení: Maximální délka = 100
obnovit	Pokud byla dříve obnovitelně odstraněna, zrušte odstranění služby Api Management. Pokud je tento příznak zadaný a nastaví se na Hodnotu True, budou ignorovány všechny ostatní vlastnosti.	Bool
virtualNetworkConfiguration	Konfigurace virtuální sítě služby API Management	virtualNetworkConfiguration
virtualNetworkType	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ý)

AdditionalLocation

Jméno	Popis	Hodnota
disableGateway	Vlastnost platí pouze pro službu Api Management nasazenou ve více umístěních. Tuto možnost můžete použít k zakázání brány v tomto dalším umístění.	Bool
umístění	Název umístění další oblasti mezi oblastmi Azure Data Center.	string (povinné)
natGatewayState	Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.	Zakázáno Povoleno
publicIpAddressId	IP adresa založená na veřejné standardní SKU V4, která se má přidružit k nasazené službě virtuální sítě v umístění. Podporuje se jenom nasazení skladové položky Premium ve virtuální síti.	řetězec
sku	Vlastnosti skladové položky služby API Management	ApiManagementServiceSkuProperties (povinné)
virtualNetworkConfiguration	Konfigurace virtuální sítě pro umístění	virtualNetworkConfiguration
zóny	Seznam zón dostupnosti označující, odkud prostředek musí pocházet.	string[]

ApiManagementServiceSkuProperties

Jméno	Popis	Hodnota
kapacita	Kapacita skladové položky (počet nasazených jednotek skladové položky). Pro kapacitu skladové položky Consumption musí být zadána jako 0.	int (povinné)
Jméno	Název skladové položky.	"Standardní" WorkspaceGatewayPremium WorkspaceGatewayStandard (povinné)

VirtualNetworkConfiguration

Jméno	Popis	Hodnota
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/[^/]$`

ApiVersionConstraint

Jméno	Popis	Hodnota
minApiVersion	Omezte volání rozhraní API řídicí roviny do služby API Management s verzí rovnající se nebo novější než tato hodnota.	řetězec

CertificateConfiguration

Jméno	Popis	Hodnota
certifikát	Informace o certifikátu	CertificateInformation
certificatePassword	Heslo certifikátu.	řetězec
encodedCertificate	Kódovaný certifikát Base64	řetězec
storeName	Umístění úložiště certifikátů System.Security.Cryptography.x509certificates.StoreName. Platná umístění jsou pouze root a CertificateAuthority.	CertificateAuthority Root (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é)

ConfigurationApi

Jméno	Popis	Hodnota
legacyApi	Indikuje, jestli má být ve službě API Management zpřístupněno starší verze konfiguračního rozhraní API (v1). Hodnota je nepovinná, ale musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, starší verze rozhraní API konfigurace (v1) nebude k dispozici pro brány v místním prostředí. Výchozí hodnota je Enabled	Zakázáno Povoleno

ApiManagementServiceBasePropertiesCustomProperties

Jméno	Popis	Hodnota
{přizpůsobená vlastnost}		řetězec

Konfigurace názvu hostitele

Jméno	Popis	Hodnota
certifikát	Informace o certifikátu	CertificateInformation
certificatePassword	Heslo certifikátu.	řetězec
certificateSource	Zdroj certifikátu.	'BuiltIn' Vlastní KeyVault Spravovaná
certificateStatus	Stav certifikátu.	Dokončeno Chyba InProgress
defaultSslBinding	Zadejte hodnotu true pro nastavení certifikátu přidruženého k tomuto názvu hostitele jako výchozího certifikátu SSL. Pokud klient neodešle hlavičku SNI, bude to certifikát, který bude vyzván. Tato vlastnost je užitečná, pokud má služba povolených více vlastních názvů hostitelů a musí se rozhodnout o výchozím certifikátu SSL. Nastavení použité pouze pro typ názvu hostitele brány.	Bool
encodedCertificate	Kódovaný certifikát Base64	řetězec
hostName	Název hostitele pro konfiguraci ve službě Api Management.	string (povinné)
identityClientId	ID klienta spravované identity přiřazené systémem nebo uživatelem vygenerované službou Azure AD, který má přístup GET ke službě keyVault obsahující certifikát SSL.	řetězec
keyVaultId	Adresa URL tajného klíče služby KeyVault obsahující certifikát SSL. Pokud je k dispozici absolutní adresa URL obsahující verzi, automatická aktualizace certifikátu SSL nebude fungovat. To vyžaduje, aby služba Api Management byla nakonfigurovaná s aka.ms/apimmsi. Tajný kód by měl být typu application/x-pkcs12	řetězec
negotiateClientCertificate	Zadejte true pro vždy vyjednání klientského certifikátu na názvu hostitele. Výchozí hodnota je false.	Bool
typ	Typ názvu hostitele.	ConfigurationApi DeveloperPortal Správa Portál Proxy Scm (povinné)

RemotePrivateEndpointConnectionWrapper

Jméno	Popis	Hodnota
id	ID prostředku připojení privátního koncového bodu	řetězec
Jméno	Název připojení privátního koncového bodu	řetězec
vlastnosti	Vlastnosti prostředku.	privateEndpointConnectionWrapperProperties
typ	Typ prostředku připojení privátního koncového bodu	řetězec

PrivateEndpointConnectionWrapperProperties

Jméno	Popis	Hodnota
privateEndpoint	Prostředek privátního koncového bodu.	ArmIdWrapper
privateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.	PrivateLinkServiceConnectionState (povinné)

ArmIdWrapper

Tento objekt neobsahuje žádné vlastnosti, které se mají nastavit během nasazení. Všechny vlastnosti jsou Jen pro čtení.

PrivateLinkServiceConnectionState

Jméno	Popis	Hodnota
ActionsRequired	Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.	řetězec
popis	Důvod schválení nebo zamítnutí připojení.	řetězec
stav	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.	"Schváleno" Čeká na vyřízení Odmítnuto

Šablony pro rychlý start

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

Šablona	Popis
vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony nasazení	Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity.
nasazení služby API Management s externí službou Azure Cache for Redis nasazení	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.
Nasazení služby API Management v externí virtuální síti s veřejnými IP nasazení	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.
vytvoření instance služby API Management s vlastními názvy hostitelů nasazení	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 v interní virtuální síti s služby App Gateway nasazení	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 interní virtuální síti s veřejnými IP nasazení	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.
vytvoření instance služby API Management s identitou MSI nasazení	Tato šablona vytvoří instanci vývojáře služby Azure API Management s identitou MSI.
Vytvoření instance SLUŽBY API Management s více oblastmi úrovně Premium nasazení	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í služby API Management s vlastním ssl proxy pomocí služby KeyVault nasazení	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 API Management s protokolem SSL ze služby KeyVault nasazení	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í	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 s privátním koncovým bodem nasazení	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.
nasazení služby API Management do zón dostupnosti nasazení	Tato šablona vytvoří instanci služby Azure API Management úrovně Premium a nasadí ji do zóny dostupnosti.
Vytvoření instance služby API Management pomocí šablony nasazení	Tato šablona vytvoří instanci vývojáře služby Azure API Management.
služby Front Door Standard/Premium s původu služby API Management nasazení	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.
vytvoření služby Azure Front Door před službou Azure API Management nasazení	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.
Application Gateway s interní službou API Management a webovou aplikací nasazení	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.

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@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"
    }
  })
}

Hodnoty vlastností

služba

Jméno	Popis	Hodnota
typ	Typ prostředku	Microsoft.ApiManagement/service@2023-09-01-preview
Jméno	Název prostředku	string (povinné) Limit znaků: 1–50 Platné znaky: Alfanumerické znaky a spojovníky Začněte písmenem a končit alfanumerickými znaky. Název prostředku musí být v Rámci Azure jedinečný.
umístění	Umístění prostředku	string (povinné)
parent_id	K nasazení do skupiny prostředků použijte ID této skupiny prostředků.	string (povinné)
visačky	Značky prostředků	Slovník názvů a hodnot značek
sku	Vlastnosti skladové položky služby API Management	ApiManagementServiceSkuProperties (povinné)
identita	Identita spravované služby služby Api Management	ApiManagementServiceIdentity
vlastnosti	Vlastnosti služby API Management	apiManagementServiceProperties (povinné)
zóny	Seznam zón dostupnosti označující, odkud prostředek musí pocházet.	string[]

ApiManagementServiceIdentity

Jméno	Popis	Hodnota
typ	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.	"SystemAssigned" "SystemAssigned, UserAssigned" UserAssigned (povinné)
identity_ids	Seznam identit uživatelů přidružených k prostředku. Identita uživatele Odkazy na klíč slovníku budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	Pole ID identit uživatele

ApiManagementServiceIdentityUserAssignedIdentities

Jméno	Popis	Hodnota
{přizpůsobená vlastnost}		userIdentityProperties

UserIdentityProperties

Jméno	Popis	Hodnota
clientId	ID klienta identity přiřazené uživatelem.	řetězec
principalId	ID objektu zabezpečení identity přiřazené uživatelem.	řetězec

ApiManagementServiceProperties

Jméno	Popis	Hodnota
additionalLocations	Další umístění datacenter služby API Management	AdditionalLocation[]
apiVersionConstraint	Omezení verze APIS roviny řízení pro službu API Management	ApiVersionConstraint
certifikáty	Seznam certifikátů, které je potřeba nainstalovat ve službě API Management Maximální počet podporovaných certifikátů, které je možné nainstalovat, je 10.	CertificateConfiguration[]
configurationApi	Konfigurace rozhraní API konfigurace služby API Management	ConfigurationApi
customProperties	Vlastní vlastnosti služby API Management Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` zakáže šifrovací TLS_RSA_WITH_3DES_EDE_CBC_SHA pro všechny protokoly TLS(1.0, 1.1 a 1.2). Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` lze použít k zakázání pouze protokolu TLS 1.1. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` lze použít k zakázání protokolu TLS 1.0 ve službě API Management. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` lze použít k zakázání jenom protokolu TLS 1.1 pro komunikaci s back-endy. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` lze použít k zakázání protokolu TLS 1.0 pro komunikaci s back-endy. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` lze použít k povolení protokolu HTTP2 ve službě API Management. Nezadání žádné z těchto vlastností v operaci PATCH resetuje hodnoty vynechaných vlastností na výchozí hodnoty. Pro všechna nastavení kromě Http2 je výchozí hodnota `True`, pokud byla služba vytvořena 1. dubna 2018 a `False` jinak. Výchozí hodnota nastavení Http2 je `False`. Pomocí `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`nastavení můžete zakázat kteroukoli z následujících šifer: 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. Například `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Výchozí hodnota je `true` pro ně. Poznámka: Následující šifry nelze zakázat, protože jsou vyžadovány interními komponentami platformy: 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	Stav portálu pro vývojáře v této službě API Management	"Zakázáno" "Povoleno"
disableGateway	Vlastnost platí pouze pro službu Api Management nasazenou ve více umístěních. To se dá použít k zakázání brány v hlavní oblasti.	Bool
enableClientCertificate	Vlastnost má být použita pouze pro službu SKU Consumption. To vynucuje, aby se klientský certifikát zobrazoval na každém požadavku bráně. To také umožňuje ověřit certifikát v zásadách brány.	Bool
hostnameConfigurations	Vlastní konfigurace názvu hostitele služby API Management	Konfigurace názvu hostitele[]
legacyPortalStatus	Stav starší verze portálu ve službě API Management	"Zakázáno" "Povoleno"
natGatewayState	Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.	"Zakázáno" "Povoleno"
notificationSenderEmail	E-mailová adresa, ze které se oznámení odešle.	řetězec Omezení: Maximální délka = 100
privateEndpointConnections	Seznam připojení privátních koncových bodů této služby	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	IP adresa založená na veřejné standardní SKU V4, která se má přidružit k nasazené službě virtuální sítě v dané oblasti. Podporuje se jenom pro SKU Pro vývojáře a Premium nasazené ve virtuální síti.	řetězec
publicNetworkAccess	Určuje, jestli je pro tuto službu API Management povolený přístup k veřejnému koncovému bodu. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, privátní koncové body jsou výhradní metodou přístupu. Výchozí hodnota je Enabled	"Zakázáno" "Povoleno"
publisherEmail	E-mail vydavatele.	string (povinné) Omezení: Maximální délka = 100
publisherName	Název vydavatele.	string (povinné) Omezení: Maximální délka = 100
obnovit	Pokud byla dříve obnovitelně odstraněna, zrušte odstranění služby Api Management. Pokud je tento příznak zadaný a nastaví se na Hodnotu True, budou ignorovány všechny ostatní vlastnosti.	Bool
virtualNetworkConfiguration	Konfigurace virtuální sítě služby API Management	virtualNetworkConfiguration
virtualNetworkType	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í" "Žádný"

AdditionalLocation

Jméno	Popis	Hodnota
disableGateway	Vlastnost platí pouze pro službu Api Management nasazenou ve více umístěních. Tuto možnost můžete použít k zakázání brány v tomto dalším umístění.	Bool
umístění	Název umístění další oblasti mezi oblastmi Azure Data Center.	string (povinné)
natGatewayState	Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.	"Zakázáno" "Povoleno"
publicIpAddressId	IP adresa založená na veřejné standardní SKU V4, která se má přidružit k nasazené službě virtuální sítě v umístění. Podporuje se jenom nasazení skladové položky Premium ve virtuální síti.	řetězec
sku	Vlastnosti skladové položky služby API Management	ApiManagementServiceSkuProperties (povinné)
virtualNetworkConfiguration	Konfigurace virtuální sítě pro umístění	virtualNetworkConfiguration
zóny	Seznam zón dostupnosti označující, odkud prostředek musí pocházet.	string[]

ApiManagementServiceSkuProperties

Jméno	Popis	Hodnota
kapacita	Kapacita skladové položky (počet nasazených jednotek skladové položky). Pro kapacitu skladové položky Consumption musí být zadána jako 0.	int (povinné)
Jméno	Název skladové položky.	"Standardní" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (povinné)

VirtualNetworkConfiguration

Jméno	Popis	Hodnota
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/[^/]$`

ApiVersionConstraint

Jméno	Popis	Hodnota
minApiVersion	Omezte volání rozhraní API řídicí roviny do služby API Management s verzí rovnající se nebo novější než tato hodnota.	řetězec

CertificateConfiguration

Jméno	Popis	Hodnota
certifikát	Informace o certifikátu	CertificateInformation
certificatePassword	Heslo certifikátu.	řetězec
encodedCertificate	Kódovaný certifikát Base64	řetězec
storeName	Umístění úložiště certifikátů System.Security.Cryptography.x509certificates.StoreName. Platná umístění jsou pouze root a CertificateAuthority.	"CertificateAuthority" Root (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é)

ConfigurationApi

Jméno	Popis	Hodnota
legacyApi	Indikuje, jestli má být ve službě API Management zpřístupněno starší verze konfiguračního rozhraní API (v1). Hodnota je nepovinná, ale musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, starší verze rozhraní API konfigurace (v1) nebude k dispozici pro brány v místním prostředí. Výchozí hodnota je Enabled	"Zakázáno" "Povoleno"

ApiManagementServiceBasePropertiesCustomProperties

Jméno	Popis	Hodnota
{přizpůsobená vlastnost}		řetězec

Konfigurace názvu hostitele

Jméno	Popis	Hodnota
certifikát	Informace o certifikátu	CertificateInformation
certificatePassword	Heslo certifikátu.	řetězec
certificateSource	Zdroj certifikátu.	"BuiltIn" "Vlastní" "KeyVault" "Spravováno"
certificateStatus	Stav certifikátu.	"Dokončeno" Chyba InProgress
defaultSslBinding	Zadejte hodnotu true pro nastavení certifikátu přidruženého k tomuto názvu hostitele jako výchozího certifikátu SSL. Pokud klient neodešle hlavičku SNI, bude to certifikát, který bude vyzván. Tato vlastnost je užitečná, pokud má služba povolených více vlastních názvů hostitelů a musí se rozhodnout o výchozím certifikátu SSL. Nastavení použité pouze pro typ názvu hostitele brány.	Bool
encodedCertificate	Kódovaný certifikát Base64	řetězec
hostName	Název hostitele pro konfiguraci ve službě Api Management.	string (povinné)
identityClientId	ID klienta spravované identity přiřazené systémem nebo uživatelem vygenerované službou Azure AD, který má přístup GET ke službě keyVault obsahující certifikát SSL.	řetězec
keyVaultId	Adresa URL tajného klíče služby KeyVault obsahující certifikát SSL. Pokud je k dispozici absolutní adresa URL obsahující verzi, automatická aktualizace certifikátu SSL nebude fungovat. To vyžaduje, aby služba Api Management byla nakonfigurovaná s aka.ms/apimmsi. Tajný kód by měl být typu application/x-pkcs12	řetězec
negotiateClientCertificate	Zadejte true pro vždy vyjednání klientského certifikátu na názvu hostitele. Výchozí hodnota je false.	Bool
typ	Typ názvu hostitele.	"ConfigurationApi" DeveloperPortal "Správa" "Portál" "Proxy" "Scm" (povinné)

RemotePrivateEndpointConnectionWrapper

Jméno	Popis	Hodnota
id	ID prostředku připojení privátního koncového bodu	řetězec
Jméno	Název připojení privátního koncového bodu	řetězec
vlastnosti	Vlastnosti prostředku.	privateEndpointConnectionWrapperProperties
typ	Typ prostředku připojení privátního koncového bodu	řetězec

PrivateEndpointConnectionWrapperProperties

Jméno	Popis	Hodnota
privateEndpoint	Prostředek privátního koncového bodu.	ArmIdWrapper
privateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.	PrivateLinkServiceConnectionState (povinné)

ArmIdWrapper

Tento objekt neobsahuje žádné vlastnosti, které se mají nastavit během nasazení. Všechny vlastnosti jsou Jen pro čtení.

PrivateLinkServiceConnectionState

Jméno	Popis	Hodnota
ActionsRequired	Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.	řetězec
popis	Důvod schválení nebo zamítnutí připojení.	řetězec
stav	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.	"Schváleno" "Čeká na vyřízení" "Odmítnuto"

Sdílet prostřednictvím

Služba Microsoft.ApiManagement

Definice prostředku Bicep

Formát prostředku

Hodnoty vlastností

služba

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

Konfigurace názvu hostitele

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Šablony pro rychlý start

Definice prostředku šablony ARM

Formát prostředku

Hodnoty vlastností

služba

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

Konfigurace názvu hostitele

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Šablony pro rychlý start

Definice prostředku Terraformu (poskytovatel AzAPI)

Formát prostředku

Hodnoty vlastností

služba

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

Konfigurace názvu hostitele

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Váš názor

Další materiály