Služba Microsoft.ApiManagement

  • Článek

Definice prostředku Bicep

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

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-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
    {customized property}: 'string'
  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í

service

Název Description Hodnota
name Název prostředku string (povinné)

Omezení počtu znaků: 1–50

Platné znaky:
Alfanumerické znaky a pomlčky.

Začněte písmenem a končíte alfanumerickými znaky.

Název prostředku musí být v rámci Azure jedinečný.
location Umístění prostředku. string (povinné)
tags Značky prostředků. Slovník názvů a hodnot značek. Zobrazit značky v šablonách
Sku Vlastnosti skladové položky služby API Management. ApiManagementServiceSkuProperties (povinné)
identity Identita spravované služby služby Api Management ApiManagementServiceIdentity
properties Vlastnosti služby API Management. ApiManagementServiceProperties (povinné)
Zóny Seznam zón dostupnosti označující, odkud má prostředek pocházet. string[]

ApiManagementServiceIdentity

Název Description Hodnota
typ Typ identity použitý 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. 'Žádný'
'SystemAssigned'
SystemAssigned, UserAssigned
UserAssigned (povinné)
userAssignedIdentity Seznam identit uživatelů přidružených k prostředku. Identita uživatele
Odkazy na klíče slovníku budou ID prostředků ARM ve formátu :
/subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 ApiManagementServiceIdentityUserAssignedIdentity

ApiManagementServiceIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} Identita uživatele – vlastnosti

Identita uživatele – vlastnosti

Název Description 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

Název Description Hodnota
additionalLocations Další umístění datacentra služby API Management. AdditionalLocation[]
apiVersionConstraint Omezení verze rozhraní API řídicí roviny 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. Konfigurace certifikátu[]
configurationApi Konfigurace rozhraní API konfigurace služby API Management. ConfigurationApi
vlastní vlastnosti 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 můžete 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í pouze 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 obnoví hodnoty vynechaných vlastností na výchozí hodnoty. Pro všechna nastavení kromě Http2 je True výchozí hodnota, pokud byla služba vytvořená 1. dubna 2018 nebo dříve a False jinak. Výchozí hodnota nastavení HTTP2 je False.

Pomocí nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]můžete zakázat některou 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. Pří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 API Management službě Zakázáno
'Povoleno'
disableGateway Vlastnost platí jenom pro službu Api Management nasazenou na více místech. To se dá použít k zakázání brány v hlavní oblasti. bool
enableClientCertificate Vlastnost určená pouze k použití pro službu SKU Consumption. Tím se vynutí předložení klientského certifikátu při každém požadavku bráně. To také umožňuje ověřit certifikát v zásadách na bráně. bool
hostnameConfigurations Konfigurace vlastního názvu hostitele služby API Management. HostnameConfiguration[]
legacyPortalStatus Stav starší verze portálu ve službě API Management. Zakázáno
'Povoleno'
natGatewayState Vlastnost je možné použít k povolení služby NAT Gateway pro tuto službu API Management. Zakázáno
'Povoleno'
notificationSenderEmail Email adresu, ze které bude oznámení odesláno. řetězec
privateEndpointConnections Seznam připojení privátních koncových bodů této služby RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId IP adresa založená na veřejné SKU Standard IP verze 4, která se má přidružit k Virtual Network nasazené službě v dané oblasti. Podporováno pouze pro SKU Developer a Premium nasazené v Virtual Network. ř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 volitelná, ale pokud je předaná, musí být povolená nebo zakázaná. Pokud je zakázáno, privátní koncové body jsou výhradní metodou přístupu. Výchozí hodnota je Povoleno. Zakázáno
'Povoleno'
publisherEmail E-mail vydavatele. string (povinné)
publisherName Název vydavatele. string (povinné)
Obnovení Pokud byla služba Api Management Service dříve obnovitelně odstraněna, zrušte ji. Pokud je tento příznak zadaný a nastavený na Hodnotu True, budou všechny ostatní vlastnosti ignorovány. 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. None (výchozí hodnota) znamená, že služba API Management není součástí žádného Virtual Network. Externí znamená, že nasazení API Management je nastavené uvnitř Virtual Network, který má internetový koncový bod, a interní znamená, že API Management nasazení je nastaveno uvnitř Virtual Network, který má pouze intranetový koncový bod. 'Externí'
"Interní"
'Žádný'

AdditionalLocation

Název Description Hodnota
disableGateway Vlastnost platí jenom pro službu Api Management nasazenou na více místech. Můžete ho použít k zakázání brány v tomto dalším umístění. bool
location Název umístění další oblasti mezi oblastmi datacentra Azure. string (povinné)
natGatewayState Vlastnost je možné 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 IP v4, která se má přidružit k Virtual Network nasazené službě v umístění. Podporuje se pouze pro SKU Premium nasazené v Virtual Network. řetězec
Sku Vlastnosti skladové položky služby API Management. ApiManagementServiceSkuProperties (povinné)
virtualNetworkConfiguration Konfigurace virtuální sítě pro umístění Konfigurace virtuální sítě
Zóny Seznam zón dostupnosti označující, odkud má prostředek pocházet. string[]

ApiManagementServiceSkuProperties

Název Description Hodnota
capacity Kapacita skladové položky (počet nasazených jednotek skladové položky). Pro skladovou položku Consumption musí být kapacita zadána jako 0. int (povinné)
name Název skladové položky. 'Základní'
BasicV2
'Consumption'
Vývojář
'Izolovaný'
Premium
'Standardní'
StandardV2 (povinné)

Konfigurace virtuální sítě

Název Description Hodnota
subnetResourceId Úplné ID prostředku podsítě ve virtuální síti pro nasazení API Management služby. řetězec

ApiVersionConstraint

Název Description Hodnota
minApiVersion Omezte volání rozhraní API řídicí roviny na službu API Management s verzí, která je stejná nebo novější než tato hodnota. řetězec

Konfigurace certifikátu

Název Description Hodnota
certifikát Informace o certifikátu. Informace o certifikátu
certificatePassword Heslo certifikátu. řetězec
encodedCertificate Certifikát s kódováním Base64. řetězec
Storename Umístění úložiště certifikátů System.Security.Cryptography.x509certificates.StoreName. Platnými umístěními jsou pouze root a CertificateAuthority. 'CertificateAuthority'
Root (povinné)

Informace o certifikátu

Název Description Hodnota
Vypršení platnosti 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é)
Miniatura Kryptografický otisk certifikátu string (povinné)

ConfigurationApi

Název Description Hodnota
legacyApi Označuje, jestli má být ve službě API Management zveřejněné starší verze rozhraní Configuration API (v1). Hodnota je nepovinná, ale musí být Povolená nebo Zakázaná. Pokud je zakázáno, starší verze rozhraní API pro konfiguraci (v1) nebude pro brány v místním prostředí k dispozici. Výchozí hodnota je Povoleno. Zakázáno
Povoleno

ApiManagementServiceBasePropertiesCustomProperties

Název Description Hodnota
{přizpůsobená vlastnost} řetězec

Konfigurace názvu hostitele

Název Description Hodnota
certifikát Informace o certifikátu. Informace o certifikátu
certificatePassword Heslo certifikátu. řetězec
zdroj certifikátu Zdroj certifikátu. 'BuiltIn'
'Vlastní'
'KeyVault'
Spravováno
certificateStatus Stav certifikátu. Dokončeno
Chyba
"Probíhající"
defaultSslBinding Zadejte true, aby se certifikát přidružený k tomuto názvu hostitele nastavil jako výchozí certifikát SSL. Pokud klient neodešle hlavičku SNI, bude to certifikát, který bude zpochybněn. Vlastnost je užitečná, pokud má služba povolených více vlastních názvů hostitelů a potřebuje rozhodnout o výchozím certifikátu SSL. Nastavení se použilo pouze pro typ názvu hostitele brány. bool
encodedCertificate Certifikát s kódováním Base64. řetězec
Hostname Název hostitele, který se má nakonfigurovat ve službě Api Management. string (povinné)
id identityClientId Id 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
ID trezoru klíčů Adresa URL tajného klíče služby Key Vault obsahující certifikát SSL. Pokud zadáte absolutní adresu URL obsahující verzi, nebude automatická aktualizace certifikátu SSL fungovat. To vyžaduje, aby služba API Management byla nakonfigurovaná s aka.ms/apimmsi. Tajný klíč by měl být typu application/x-pkcs12. řetězec
negotiateClientCertificate Pokud chcete vždy vyjednat klientský certifikát na názvu hostitele, zadejte true. Výchozí hodnota je false. bool
typ Typ názvu hostitele 'ConfigurationApi'
'DeveloperPortal'
"Správa"
'Portál'
Proxy server
Scm (povinné)

RemotePrivateEndpointConnectionWrapper

Název Description Hodnota
id ID prostředku připojení privátního koncového bodu řetězec
name Název připojení privátního koncového bodu řetězec
properties Vlastnosti prostředku. PrivateEndpointConnectionWrapperProperties
typ Typ prostředku připojení privátního koncového bodu řetězec

PrivateEndpointConnectionWrapperProperties

Název Description Hodnota
privátní koncový bod Prostředek privátního koncového bodu. ArmIdWrapper
privateLinkServiceConnectionState Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem. PrivateLinkServiceConnectionState (povinné)

ArmIdWrapper

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.

PrivateLinkServiceConnectionState

Název Description Hodnota
ActionsRequired Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce. řetězec
description Důvod schválení nebo zamítnutí připojení. řetězec
status Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby. Schváleno
Čeká na vyřízení
"Zamítnuto"

Šablony pro rychlý start

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

Template (Šablona) Description
Vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity.
Nasazení API Management s externím Azure Cache for Redis

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci Azure API Management na úrovni Consumption s externí instancí Azure Cache for Redis jako API Management externí mezipamětí.
Nasazení API Management v externí virtuální síti s veřejnou IP adresou

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci Azure API Management na úrovni Premium v rámci podsítě vaší virtuální sítě v externím režimu a nakonfigurovat v této podsíti doporučená pravidla skupiny zabezpečení sítě. Instance se nasadí do dvou zón dostupnosti. Šablona také nakonfiguruje veřejnou IP adresu z vašeho předplatného.
Vytvoření instance API Management s vlastními názvy hostitelů

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci Azure API Management s vlastním názvem hostitele pro portál a několika vlastními názvy hostitelů pro proxy server.
Vytvoření API Management v interní virtuální síti se službou App Gateway

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci Azure API Management v privátní síti chráněné Azure Application Gateway.
Nasazení API Management v interní virtuální síti s veřejnou IP adresou

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci Azure API Management na úrovni Premium v rámci podsítě vaší virtuální sítě v interním režimu a nakonfigurovat doporučená pravidla skupiny zabezpečení sítě 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 API Management s identitou MSI

Nasazení do Azure		 Tato šablona vytvoří instanci azure API Management pro vývojáře s identitou MSI.
Vytvoření instance úrovně Premium s více oblastmi API Management

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci API Management s dalšími umístěními. Primární umístění je stejné jako umístění skupiny prostředků. U dalších umístění se v šabloně zobrazují 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í API Management s vlastním proxy ssl pomocí KeyVaultu

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci 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 z KeyVaultu

Nasazení do Azure		 Tato šablona nasadí službu API Management nakonfigurovanou pomocí identity přiřazené uživatelem. Tuto identitu používá k načtení certifikátu SSL ze služby KeyVault a aktualizuje ho kontrolou každé 4 hodiny.
Vytvoření a monitorování API Management instance

Nasazení do Azure		 Tato šablona vytvoří instanci služby Azure API Management a pracovního prostoru služby Log Analytics a nastaví monitorování služby API Management pomocí Log Analytics.
Vytvoření služby API Management s privátním koncovým bodem

Nasazení do Azure		 Tato šablona vytvoří službu API Management, virtuální síť a privátní koncový bod, které službu API Management zpřístupní virtuální síti.
Nasazení API Management do Zóny dostupnosti

Nasazení do Azure		 Tato šablona vytvoří instanci Azure API Management Premium a nasadí ji do zóny dostupnosti.
Vytvoření instance API Management pomocí šablony

Nasazení do Azure		 Tato šablona vytvoří instanci azure API Management pro vývojáře.
Front Door Standard/Premium s API Management původem

Nasazení do Azure		 Tato šablona vytvoří instanci služby Front Door Premium a API Management a pomocí skupiny zabezpečení sítě a zásad globálního API Management ověří, že provoz prošel zdrojem služby Front Door.
Vytvoření služby Azure Front Door před Azure API Management

Nasazení do Azure		 Tato ukázka ukazuje, jak používat Službu Azure Front Door jako globální nástroj pro vyrovnávání zatížení před Azure API Management.
Application Gateway s interními API Management a webovou aplikací

Nasazení do Azure		 Application Gateway směrování internetového provozu do virtuální sítě (interního režimu) API Management instance, 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í na:

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í kód JSON.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
    "{customized property}": "string"
  "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í

service

Název Description Hodnota
typ Typ prostředku Microsoft.ApiManagement/service
apiVersion Verze rozhraní API prostředků '2023-05-01-preview'
name Název prostředku string (povinné)

Limit počtu znaků: 1–50

Platné znaky:
Alfanumerické znaky a spojovníky.

Začněte písmenem a končite alfanumerickými číslicemi.

Název prostředku musí být v rámci Azure jedinečný.
location Umístění prostředku. string (povinné)
tags Značky prostředků. Slovník názvů značek a hodnot. Viz Značky v šablonách
Sku Vlastnosti skladové položky služby API Management. ApiManagementServiceSkuProperties (povinné)
identity Identita spravované služby služby Api Management ApiManagementServiceIdentity
properties Vlastnosti služby API Management. ApiManagementServiceProperties (povinné)
Zóny Seznam zón dostupnosti označující, odkud má prostředek pocházet. string[]

ApiManagementServiceIdentity

Název Description Hodnota
typ Typ identity použité 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. 'Žádný'
'SystemAssigned'
SystemAssigned, UserAssigned
UserAssigned (povinné)
userAssignedIdentity Seznam identit uživatelů přidružených k prostředku. Identita uživatele
Odkazy na klíče slovníku budou ID prostředků ARM ve formátu :
/subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 ApiManagementServiceIdentityUserAssignedIdentity

ApiManagementServiceIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} Identita uživatele – vlastnosti

Identita uživatele – vlastnosti

Název Description 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

Název Description Hodnota
additionalLocations Další umístění datacentra služby API Management. AdditionalLocation[]
apiVersionConstraint Omezení verze rozhraní API řídicí roviny 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. Konfigurace certifikátu[]
configurationApi Konfigurace rozhraní API konfigurace služby API Management. ConfigurationApi
vlastní vlastnosti Vlastní vlastnosti služby API Management.
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 zakáže šifrové 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 se dá 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í pouze 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 se dá použít k povolení protokolu HTTP2 ve službě API Management.
Nezadání žádné z těchto vlastností v operaci PATCH obnoví výchozí hodnoty vynechaných vlastností. Pro všechna nastavení kromě Http2 je výchozí hodnota, pokud byla True služba vytvořena 1. dubna 2018 nebo dříve a False jinak. Výchozí hodnota nastavení HTTP2 je False.

Pomocí nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]můžete zakázat libovolnou 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 je platná jenom 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 určená pouze k použití pro službu consumption SKU. Tím se vynutí předložení klientského certifikátu bráně při každém požadavku. To také umožňuje ověřit certifikát v zásadách na bráně. bool
název hostiteleKonfigurace Konfigurace vlastního názvu hostitele služby API Management. HostnameConfiguration[]
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
oznámeníSenderEmail Email adresu, ze které se oznámení odešle. řetězec
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 IP v4, která se má přidružit k Virtual Network nasazené službě v dané oblasti. Podporuje se pouze pro SKU Developer a Premium nasazené v Virtual Network. řetězec
publicNetworkAccess Určuje, jestli je pro tuto službu API Management povolený přístup z veřejného koncového bodu. Hodnota je volitelná, ale pokud je předaná, musí být Povolená nebo Zakázaná. Pokud je zakázáno, privátní koncové body jsou výhradní metodou přístupu. Výchozí hodnota je Povoleno. Zakázáno
Povoleno
vydavatelE-mail E-mail vydavatele. string (povinné)
publisherName Název vydavatele. string (povinné)
Obnovení Zrušte odstranění služby Api Management, pokud byla dříve obnovitelně odstraněna. Pokud je tento příznak zadaný a nastavený na Hodnotu True, budou všechny ostatní vlastnosti ignorovány. bool
virtualNetworkConfiguration Konfigurace virtuální sítě služby API Management. Konfigurace virtuální sítě
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ého Virtual Network, externí znamená, že nasazení API Management je nastavené uvnitř Virtual Network má internetový koncový bod, a interní znamená, že API Management nasazení se nastaví uvnitř Virtual Network, který má pouze intranetový koncový bod. 'Externí'
"Interní"
'Žádný'

AdditionalLocation

Název Description Hodnota
disableGateway Vlastnost je platná jenom 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 tomto dalším umístění. bool
location Název umístění další oblasti mezi oblastmi datacentra Azure. 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 IP v4, která se má přidružit k Virtual Network nasazené službě v umístění. Podporuje se pouze pro skladovou položku Premium nasazenou v Virtual Network. řetězec
Sku Vlastnosti skladové položky služby API Management. ApiManagementServiceSkuProperties (povinné)
virtualNetworkConfiguration Konfigurace virtuální sítě pro umístění Konfigurace virtuální sítě
Zóny Seznam zón dostupnosti označující, odkud má prostředek pocházet. string[]

ApiManagementServiceSkuProperties

Název Description Hodnota
capacity Kapacita skladové položky (počet nasazených jednotek skladové položky). Pro skladovou položku Consumption musí být kapacita zadána jako 0. int (povinné)
name Název skladové položky. 'Základní'
BasicV2
'Consumption'
Vývojář
'Izolovaný'
Premium
'Standardní'
StandardV2 (povinné)

Konfigurace virtuální sítě

Název Description Hodnota
subnetResourceId Úplné ID prostředku podsítě ve virtuální síti pro nasazení API Management služby. řetězec

ApiVersionConstraint

Název Description Hodnota
minApiVersion Omezte volání rozhraní API řídicí roviny na službu API Management s verzí, která je stejná nebo novější než tato hodnota. řetězec

Konfigurace certifikátu

Název Description Hodnota
certifikát Informace o certifikátu. Informace o certifikátu
certificatePassword Heslo certifikátu. řetězec
encodedCertificate Certifikát s kódováním Base64. řetězec
Storename Umístění úložiště certifikátů System.Security.Cryptography.x509certificates.StoreName. Platnými umístěními jsou pouze root a CertificateAuthority. 'CertificateAuthority'
Root (povinné)

Informace o certifikátu

Název Description Hodnota
Vypršení platnosti 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é)
Miniatura Kryptografický otisk certifikátu string (povinné)

ConfigurationApi

Název Description Hodnota
legacyApi Označuje, jestli má být ve službě API Management zveřejněné starší verze rozhraní Configuration API (v1). Hodnota je nepovinná, ale musí být Povolená nebo Zakázaná. Pokud je zakázáno, starší verze rozhraní API pro konfiguraci (v1) nebude pro brány v místním prostředí k dispozici. Výchozí hodnota je Povoleno. Zakázáno
Povoleno

ApiManagementServiceBasePropertiesCustomProperties

Název Description Hodnota
{přizpůsobená vlastnost} řetězec

Konfigurace názvu hostitele

Název Description Hodnota
certifikát Informace o certifikátu. Informace o certifikátu
certificatePassword Heslo certifikátu. řetězec
zdroj certifikátu Zdroj certifikátu. 'BuiltIn'
'Vlastní'
'KeyVault'
Spravováno
certificateStatus Stav certifikátu. Dokončeno
Chyba
"Probíhající"
defaultSslBinding Zadejte true, aby se certifikát přidružený k tomuto názvu hostitele nastavil jako výchozí certifikát SSL. Pokud klient neodešle hlavičku SNI, bude to certifikát, který bude zpochybněn. Vlastnost je užitečná, pokud má služba povolených více vlastních názvů hostitelů a potřebuje rozhodnout o výchozím certifikátu SSL. Nastavení se použilo pouze pro typ názvu hostitele brány. bool
encodedCertificate Certifikát s kódováním Base64. řetězec
Hostname Název hostitele, který se má nakonfigurovat ve službě Api Management. string (povinné)
id identityClientId Id 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
ID trezoru klíčů Adresa URL tajného klíče služby Key Vault obsahující certifikát SSL. Pokud zadáte absolutní adresu URL obsahující verzi, nebude automatická aktualizace certifikátu SSL fungovat. To vyžaduje, aby služba API Management byla nakonfigurovaná s aka.ms/apimmsi. Tajný klíč by měl být typu application/x-pkcs12. řetězec
negotiateClientCertificate Pokud chcete vždy vyjednat klientský certifikát na názvu hostitele, zadejte true. Výchozí hodnota je false. bool
typ Typ názvu hostitele 'ConfigurationApi'
'DeveloperPortal'
"Správa"
'Portál'
Proxy server
Scm (povinné)

RemotePrivateEndpointConnectionWrapper

Název Description Hodnota
id ID prostředku připojení privátního koncového bodu řetězec
name Název připojení privátního koncového bodu řetězec
properties Vlastnosti prostředku. PrivateEndpointConnectionWrapperProperties
typ Typ prostředku připojení privátního koncového bodu řetězec

PrivateEndpointConnectionWrapperProperties

Název Description Hodnota
privátní koncový bod Prostředek privátního koncového bodu. ArmIdWrapper
privateLinkServiceConnectionState Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem. PrivateLinkServiceConnectionState (povinné)

ArmIdWrapper

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.

PrivateLinkServiceConnectionState

Název Description Hodnota
ActionsRequired Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce. řetězec
description Důvod schválení nebo zamítnutí připojení. řetězec
status Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby. Schváleno
Čeká na vyřízení
"Zamítnuto"

Šablony pro rychlý start

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

Template (Šablona) Description
Vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity.
Nasazení API Management s externím Azure Cache for Redis

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci Azure API Management na úrovni Consumption s externí instancí Azure Cache for Redis jako API Management externí mezipamětí.
Nasazení API Management v externí virtuální síti s veřejnou IP adresou

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci Azure API Management na úrovni Premium v rámci podsítě vaší virtuální sítě v externím režimu a nakonfigurovat v této podsíti doporučená pravidla skupiny zabezpečení sítě. Instance se nasadí do dvou zón dostupnosti. Šablona také nakonfiguruje veřejnou IP adresu z vašeho předplatného.
Vytvoření instance API Management s vlastními názvy hostitelů

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci Azure API Management s vlastním názvem hostitele pro portál a několika vlastními názvy hostitelů pro proxy server.
Vytvoření API Management v interní virtuální síti se službou App Gateway

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci Azure API Management v privátní síti chráněné Azure Application Gateway.
Nasazení API Management v interní virtuální síti s veřejnou IP adresou

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

Nasazení do Azure		 Tato šablona vytvoří instanci azure API Management vývojáře s identitou MSI.
Vytvoření instance API Management úrovně Premium ve více oblastech

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci API Management s dalšími umístěními. Primární umístění je stejné jako umístění skupiny prostředků. U dalších umístění se v šabloně zobrazí Usa – sever a USA – východ 2. Primární umístění by se mělo lišit od dalších umístění.
Vytvoření API Management s využitím ssl vlastního proxy serveru pomocí služby KeyVault

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit instanci Azure API Management a nakonfigurovat vlastní název hostitele pro proxy server s certifikátem SSL z trezoru klíčů.
Vytvoření služby API Management s protokolem SSL ze služby KeyVault

Nasazení do Azure		 Tato šablona nasadí službu API Management s nakonfigurovanou identitou přiřazenou uživatelem. Tuto identitu používá k načtení certifikátu SSL ze služby KeyVault a aktualizuje ho kontrolou každé 4 hodiny.
Vytvoření a monitorování API Management instance

Nasazení do Azure		 Tato šablona vytvoří instanci služby Azure API Management a pracovního prostoru služby Log Analytics a nastaví monitorování služby API Management pomocí Log Analytics.
Vytvoření služby API Management s privátním koncovým bodem

Nasazení do Azure		 Tato šablona vytvoří službu API Management, virtuální síť a privátní koncový bod, které službu API Management zpřístupní virtuální síti.
Nasazení API Management do Zóny dostupnosti

Nasazení do Azure		 Tato šablona vytvoří prémiovou instanci Azure API Management a nasadí ji do zóny dostupnosti.
Vytvoření instance API Management pomocí šablony

Nasazení do Azure		 Tato šablona vytvoří instanci azure API Management pro vývojáře.
Front Door Standard/Premium s API Management původem

Nasazení do Azure		 Tato šablona vytvoří instanci služby Front Door Premium a API Management a pomocí skupiny zabezpečení sítě a globálních zásad API Management ověří, že provoz prošel zdrojem služby Front Door.
Vytvoření služby Azure Front Door před azure API Management

Nasazení do Azure		 Tato ukázka ukazuje použití služby Azure Front Door jako globálního nástroje pro vyrovnávání zatížení před azure API Management.
Application Gateway s interními API Management a webovou aplikací

Nasazení do Azure		 Application Gateway směrování internetového provozu do virtuální sítě (v interním režimu) API Management instance, která obsluhuje webové rozhraní API hostované ve webové aplikaci Azure.

Definice prostředku Terraform (poskytovatel AzAPI)

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

  • 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-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
    {customized property} = "string"
  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í

service

Název Description Hodnota
typ Typ prostředku Microsoft.ApiManagement/service@2023-05-01-preview
name Název prostředku string (povinné)

Omezení počtu znaků: 1–50

Platné znaky:
Alfanumerické znaky a pomlčky.

Začněte písmenem a končíte alfanumerickými znaky.

Název prostředku musí být v rámci Azure jedinečný.
location 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é)
tags Značky prostředků. Slovník názvů a hodnot značek.
Sku Vlastnosti skladové položky služby API Management. ApiManagementServiceSkuProperties (povinné)
identity Identita spravované služby služby Api Management ApiManagementServiceIdentity
properties Vlastnosti služby API Management. ApiManagementServiceProperties (povinné)
Zóny Seznam zón dostupnosti označující, odkud má prostředek pocházet. string[]

ApiManagementServiceIdentity

Název Description Hodnota
typ Typ identity použitý 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íče slovníku budou ID prostředků ARM ve formátu :
/subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 Pole ID identit uživatelů

ApiManagementServiceIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} Identita uživatele – vlastnosti

Identita uživatele – vlastnosti

Název Description 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

Název Description Hodnota
additionalLocations Další umístění datacentra služby API Management. AdditionalLocation[]
apiVersionConstraint Omezení verze rozhraní API řídicí roviny 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. Konfigurace certifikátu[]
configurationApi Konfigurace rozhraní API konfigurace služby API Management. ConfigurationApi
vlastní vlastnosti Vlastní vlastnosti služby API Management.
Nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 zakáže šifrové 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 se dá 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í pouze 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 se dá použít k povolení protokolu HTTP2 ve službě API Management.
Nezadání žádné z těchto vlastností v operaci PATCH obnoví výchozí hodnoty vynechaných vlastností. Pro všechna nastavení kromě Http2 je výchozí hodnota, pokud byla True služba vytvořena 1. dubna 2018 nebo dříve a False jinak. Výchozí hodnota nastavení HTTP2 je False.

Pomocí nastavení Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]můžete zakázat libovolnou 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 API Management službě "Zakázáno"
"Povoleno"
disableGateway Vlastnost platí jenom pro službu Api Management nasazenou na více místech. To se dá použít k zakázání brány v hlavní oblasti. bool
enableClientCertificate Vlastnost určená pouze k použití pro službu SKU Consumption. Tím se vynutí předložení klientského certifikátu při každém požadavku bráně. To také umožňuje ověřit certifikát v zásadách na bráně. bool
hostnameConfigurations Konfigurace vlastního názvu hostitele služby API Management. HostnameConfiguration[]
legacyPortalStatus Stav starší verze portálu ve službě API Management. "Zakázáno"
"Povoleno"
natGatewayState Vlastnost je možné použít k povolení služby NAT Gateway pro tuto službu API Management. "Zakázáno"
"Povoleno"
notificationSenderEmail Email adresu, ze které bude oznámení odesláno. řetězec
privateEndpointConnections Seznam připojení privátních koncových bodů této služby RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId IP adresa založená na veřejné SKU Standard IP verze 4, která se má přidružit k Virtual Network nasazené službě v dané oblasti. Podporováno pouze pro SKU Developer a Premium nasazené v Virtual Network. ř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 volitelná, ale pokud je předaná, musí být povolená nebo zakázaná. Pokud je zakázáno, privátní koncové body jsou výhradní metodou přístupu. Výchozí hodnota je Povoleno. "Zakázáno"
"Povoleno"
publisherEmail E-mail vydavatele. string (povinné)
publisherName Název vydavatele. string (povinné)
Obnovení Pokud byla služba Api Management Service dříve obnovitelně odstraněna, zrušte ji. Pokud je tento příznak zadaný a nastavený na Hodnotu True, budou všechny ostatní vlastnosti ignorovány. 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. None (výchozí hodnota) znamená, že služba API Management není součástí žádného Virtual Network. Externí znamená, že nasazení API Management je nastavené uvnitř Virtual Network, který má internetový koncový bod, a interní znamená, že API Management nasazení je nastaveno uvnitř Virtual Network, který má pouze intranetový koncový bod. "Externí"
"Interní"
"Žádné"

AdditionalLocation

Název Description Hodnota
disableGateway Vlastnost platí jenom pro službu Api Management nasazenou na více místech. Můžete ho použít k zakázání brány v tomto dalším umístění. bool
location Název umístění další oblasti mezi oblastmi datacentra Azure. string (povinné)
natGatewayState Vlastnost je možné 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 IP v4, která se má přidružit k Virtual Network nasazené službě v umístění. Podporuje se pouze pro SKU Premium nasazené v Virtual Network. ř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 má prostředek pocházet. string[]

ApiManagementServiceSkuProperties

Název Description Hodnota
capacity Kapacita skladové položky (počet nasazených jednotek skladové položky). U položky Consumption musí být kapacita skladové položky zadána jako 0. int (povinné)
name Název skladové položky "Základní"
"BasicV2"
"Spotřeba"
"Vývojář"
"Izolovaný"
"Premium"
"Standardní"
StandardV2 (povinné)

Konfigurace virtuální sítě

Název Description Hodnota
subnetResourceId Úplné ID prostředku podsítě ve virtuální síti pro nasazení API Management služby. řetězec

ApiVersionConstraint

Název Description Hodnota
minApiVersion Omezte volání rozhraní API řídicí roviny na službu API Management s verzí, která je stejná nebo novější než tato hodnota. řetězec

Konfigurace certifikátu

Název Description Hodnota
certifikát Informace o certifikátu. Informace o certifikátu
certificatePassword Heslo certifikátu. řetězec
encodedCertificate Certifikát s kódováním Base64. řetězec
Storename Umístění úložiště certifikátů System.Security.Cryptography.x509certificates.StoreName. Platnými umístěními jsou pouze root a CertificateAuthority. "CertificateAuthority"
"Kořen" (povinné)

Informace o certifikátu

Název Description Hodnota
Vypršení platnosti 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é)
Miniatura Kryptografický otisk certifikátu string (povinné)

ConfigurationApi

Název Description Hodnota
legacyApi Označuje, jestli má být ve službě API Management zveřejněné starší verze rozhraní Configuration API (v1). Hodnota je nepovinná, ale musí být Povolená nebo Zakázaná. Pokud je zakázáno, starší verze rozhraní API pro konfiguraci (v1) nebude pro brány v místním prostředí k dispozici. Výchozí hodnota je Povoleno. "Zakázáno"
"Povoleno"

ApiManagementServiceBasePropertiesCustomProperties

Název Description Hodnota
{přizpůsobená vlastnost} řetězec

Konfigurace názvu hostitele

Název Description Hodnota
certifikát Informace o certifikátu. Informace o certifikátu
certificatePassword Heslo certifikátu. řetězec
zdroj certifikátu Zdroj certifikátu. "BuiltIn"
"Vlastní"
"KeyVault"
"Spravované"
certificateStatus Stav certifikátu. "Dokončeno"
Chyba
"Probíhající"
defaultSslBinding Zadejte true, aby se certifikát přidružený k tomuto názvu hostitele nastavil jako výchozí certifikát SSL. Pokud klient neodešle hlavičku SNI, bude to certifikát, který bude zpochybněn. Vlastnost je užitečná, pokud má služba povolených více vlastních názvů hostitelů a potřebuje rozhodnout o výchozím certifikátu SSL. Nastavení se použilo pouze pro typ názvu hostitele brány. bool
encodedCertificate Certifikát s kódováním Base64. řetězec
Hostname Název hostitele, který se má nakonfigurovat ve službě Api Management. string (povinné)
id identityClientId Id 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
ID trezoru klíčů Adresa URL tajného klíče služby Key Vault obsahující certifikát SSL. Pokud zadáte absolutní adresu URL obsahující verzi, nebude automatická aktualizace certifikátu SSL fungovat. To vyžaduje, aby služba API Management byla nakonfigurovaná s aka.ms/apimmsi. Tajný klíč by měl být typu application/x-pkcs12. řetězec
negotiateClientCertificate Pokud chcete vždy vyjednat klientský certifikát na názvu hostitele, zadejte true. Výchozí hodnota je false. bool
typ Typ názvu hostitele "ConfigurationApi"
"Portál pro vývojáře"
"Správa"
"Portál"
"Proxy"
"Scm" (povinné)

RemotePrivateEndpointConnectionWrapper

Název Description Hodnota
id ID prostředku připojení privátního koncového bodu řetězec
name Název připojení privátního koncového bodu řetězec
properties Vlastnosti prostředku. PrivateEndpointConnectionWrapperProperties
typ Typ prostředku připojení privátního koncového bodu řetězec

PrivateEndpointConnectionWrapperProperties

Název Description Hodnota
privátní koncový bod Prostředek privátního koncového bodu. ArmIdWrapper
privateLinkServiceConnectionState Kolekce informací o stavu připojení mezi příjemcem služby a poskytovatelem. PrivateLinkServiceConnectionState (povinné)

ArmIdWrapper

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.

PrivateLinkServiceConnectionState

Název Description Hodnota
ActionsRequired Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce. řetězec
description Důvod schválení nebo zamítnutí připojení. řetězec
status Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby. "Schváleno"
"Čeká na vyřízení"
"Zamítnuto"