Služba Microsoft.ApiManagement 2018-01-01

Článek
12/21/2024

nejnovější
2024-06-01-preview
2024-05-01
2023-09-01-preview
2023-05-01-preview
1. 3. 2023 ve verzi Preview
2022-09-01-preview
2022-08-01
2022-04-01-preview
12. 12. 2021 ve verzi Preview
2021-08-01
2021-04-01-preview
2021-01-01-preview
12. 12. 2020
2020-06-01-preview
12. 12. 2019
12. 12. 2019
1. 1. 2019
06. 6. 2018 ve verzi Preview
1. 1. 2018
03.03.2017
10. 10. 2016
2016-07-07

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@2018-01-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        location: 'string'
        sku: {
          capacity: int
          name: 'string'
        }
        virtualNetworkConfiguration: {
          subnetResourceId: 'string'
        }
      }
    ]
    certificates: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        encodedCertificate: 'string'
        storeName: 'string'
      }
    ]
    customProperties: {
      {customized property}: 'string'
    }
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        defaultSslBinding: bool
        encodedCertificate: 'string'
        hostName: 'string'
        keyVaultId: 'string'
        negotiateClientCertificate: bool
        type: 'string'
      }
    ]
    notificationSenderEmail: 'string'
    publisherEmail: 'string'
    publisherName: 'string'
    virtualNetworkConfiguration: {
      subnetResourceId: 'string'
    }
    virtualNetworkType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Hodnoty vlastností

AdditionalLocation

Jméno	Popis	Hodnota
umístění	Název umístění další oblasti mezi oblastmi Azure Data Center.	string (povinné)
sku	Vlastnosti skladové položky služby API Management	ApiManagementServiceSkuProperties (povinné)
virtualNetworkConfiguration	Konfigurace virtuální sítě pro umístění	virtualNetworkConfiguration

ApiManagementServiceBasePropertiesCustomProperties

Jméno	Popis	Hodnota

ApiManagementServiceIdentity

Jméno	Popis	Hodnota
typ	Typ identity. V současné době je jediným podporovaným typem SystemAssigned.	SystemAssigned (povinné)

ApiManagementServiceProperties

Jméno	Popis	Hodnota
additionalLocations	Další umístění datacenter služby API Management	AdditionalLocation[]
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[]
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 a nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` lze použít k zakázání protokolu TLS 1.0 ve službě API Management.	apiManagementServiceBasePropertiesCustomProperties
hostnameConfigurations	Vlastní konfigurace názvu hostitele služby API Management	Konfigurace názvu hostitele[]
notificationSenderEmail	E-mailová adresa, ze které se oznámení odešle.	řetězec Omezení: Maximální délka =
publisherEmail	E-mail vydavatele.	řetězec Omezení: Maximální délka = (povinné)
publisherName	Název vydavatele.	řetězec Omezení: Maximální délka = (povinné)
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ý)

ApiManagementServiceSkuProperties

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

Značky ApimResourceTags

Jméno	Popis	Hodnota

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é)

Konfigurace názvu hostitele

Jméno	Popis	Hodnota
certifikát	Informace o certifikátu	CertificateInformation
certificatePassword	Heslo certifikátu.	řetězec
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í se vztahuje pouze na typ názvu hostitele proxy serveru.	Bool
encodedCertificate	Kódovaný certifikát Base64	řetězec
hostName	Název hostitele pro konfiguraci ve službě Api Management.	string (povinné)
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 MSI. 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.	Správa Portál Proxy Scm (povinné)

Microsoft.ApiManagement/service

Jméno	Popis	Hodnota
identita	Identita spravované služby služby Api Management	ApiManagementServiceIdentity
umístění	Umístění prostředku	string (povinné)
Jméno	Název prostředku	řetězec Omezení: Minimální délka = 1 Maximální délka = 1 Model = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` (povinné)
vlastnosti	Vlastnosti služby API Management	apiManagementServiceProperties (povinné)
sku	Vlastnosti skladové položky služby API Management	ApiManagementServiceSkuProperties (povinné)
visačky	Značky prostředků	Slovník názvů a hodnot značek Viz Značky v šablonách

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/[^/]$`

Ukázky rychlého startu

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

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

Definice prostředku šablony ARM

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

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": "2018-01-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "location": "string",
        "sku": {
          "capacity": "int",
          "name": "string"
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "string"
        }
      }
    ],
    "certificates": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "encodedCertificate": "string",
        "storeName": "string"
      }
    ],
    "customProperties": {
      "{customized property}": "string"
    },
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "defaultSslBinding": "bool",
        "encodedCertificate": "string",
        "hostName": "string",
        "keyVaultId": "string",
        "negotiateClientCertificate": "bool",
        "type": "string"
      }
    ],
    "notificationSenderEmail": "string",
    "publisherEmail": "string",
    "publisherName": "string",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "string"
    },
    "virtualNetworkType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Hodnoty vlastností

AdditionalLocation

Jméno	Popis	Hodnota
umístění	Název umístění další oblasti mezi oblastmi Azure Data Center.	string (povinné)
sku	Vlastnosti skladové položky služby API Management	ApiManagementServiceSkuProperties (povinné)
virtualNetworkConfiguration	Konfigurace virtuální sítě pro umístění	virtualNetworkConfiguration

ApiManagementServiceBasePropertiesCustomProperties

Jméno	Popis	Hodnota

ApiManagementServiceIdentity

Jméno	Popis	Hodnota
typ	Typ identity. V současné době je jediným podporovaným typem SystemAssigned.	SystemAssigned (povinné)

ApiManagementServiceProperties

Jméno	Popis	Hodnota
additionalLocations	Další umístění datacenter služby API Management	AdditionalLocation[]
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[]
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 a nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` lze použít k zakázání protokolu TLS 1.0 ve službě API Management.	apiManagementServiceBasePropertiesCustomProperties
hostnameConfigurations	Vlastní konfigurace názvu hostitele služby API Management	Konfigurace názvu hostitele[]
notificationSenderEmail	E-mailová adresa, ze které se oznámení odešle.	řetězec Omezení: Maximální délka =
publisherEmail	E-mail vydavatele.	řetězec Omezení: Maximální délka = (povinné)
publisherName	Název vydavatele.	řetězec Omezení: Maximální délka = (povinné)
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ý)

ApiManagementServiceSkuProperties

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

Značky ApimResourceTags

Jméno	Popis	Hodnota

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é)

Konfigurace názvu hostitele

Jméno	Popis	Hodnota
certifikát	Informace o certifikátu	CertificateInformation
certificatePassword	Heslo certifikátu.	řetězec
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í se vztahuje pouze na typ názvu hostitele proxy serveru.	Bool
encodedCertificate	Kódovaný certifikát Base64	řetězec
hostName	Název hostitele pro konfiguraci ve službě Api Management.	string (povinné)
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 MSI. 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.	Správa Portál Proxy Scm (povinné)

Microsoft.ApiManagement/service

Jméno	Popis	Hodnota
apiVersion	Verze rozhraní API	'2018-01-01'
identita	Identita spravované služby služby Api Management	ApiManagementServiceIdentity
umístění	Umístění prostředku	string (povinné)
Jméno	Název prostředku	řetězec Omezení: Minimální délka = 1 Maximální délka = 1 Model = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` (povinné)
vlastnosti	Vlastnosti služby API Management	apiManagementServiceProperties (povinné)
sku	Vlastnosti skladové položky služby API Management	ApiManagementServiceSkuProperties (povinné)
visačky	Značky prostředků	Slovník názvů a hodnot značek Viz Značky v šablonách
typ	Typ prostředku	Microsoft.ApiManagement/service

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/[^/]$`

Šablony pro rychlý start

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

Šablona	Popis
Application Gateway s interní službou API Management a webovou aplikací nasazení	Služba Application Gateway směruje internetový provoz do instance služby API Management (interní režim), která obsluhuje webové rozhraní API hostované ve webové aplikaci Azure.
Vytvoření instance SLUŽBY API Management s více oblastmi úrovně Premium nasazení	Tato šablona ukazuje, jak vytvořit instanci služby API Management s dalšími umístěními. Primární umístění je stejné jako umístění skupiny prostředků. V případě dalších umístění se v šabloně zobrazí oblasti NorthCentralUs a USA – východ 2. Primární umístění by se mělo lišit od dalších umístění.
vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony nasazení	Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity.
vytvoření instance služby API Management s identitou MSI nasazení	Tato šablona vytvoří instanci vývojáře služby Azure API Management s identitou MSI.
Vytvoření instance služby API Management pomocí šablony nasazení	Tato šablona vytvoří instanci vývojáře služby Azure API Management.
vytvoření instance služby API Management s vlastními názvy hostitelů nasazení	Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management s vlastním názvem hostitele pro portál a více vlastních názvů hostitelů pro proxy server.
vytvoření služby API Management s privátním koncovým bodem nasazení	Tato šablona vytvoří službu API Management, virtuální síť a privátní koncový bod, které službu API Management zpřístupňuje virtuální síti.
vytvoření služby API Management s protokolem SSL ze služby KeyVault nasazení	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 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.
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 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.
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.
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.
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.
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.
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.

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@2018-01-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          location = "string"
          sku = {
            capacity = int
            name = "string"
          }
          virtualNetworkConfiguration = {
            subnetResourceId = "string"
          }
        }
      ]
      certificates = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          encodedCertificate = "string"
          storeName = "string"
        }
      ]
      customProperties = {
        {customized property} = "string"
      }
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          defaultSslBinding = bool
          encodedCertificate = "string"
          hostName = "string"
          keyVaultId = "string"
          negotiateClientCertificate = bool
          type = "string"
        }
      ]
      notificationSenderEmail = "string"
      publisherEmail = "string"
      publisherName = "string"
      virtualNetworkConfiguration = {
        subnetResourceId = "string"
      }
      virtualNetworkType = "string"
    }
  })
}

Hodnoty vlastností

AdditionalLocation

Jméno	Popis	Hodnota
umístění	Název umístění další oblasti mezi oblastmi Azure Data Center.	string (povinné)
sku	Vlastnosti skladové položky služby API Management	ApiManagementServiceSkuProperties (povinné)
virtualNetworkConfiguration	Konfigurace virtuální sítě pro umístění	virtualNetworkConfiguration

ApiManagementServiceBasePropertiesCustomProperties

Jméno	Popis	Hodnota

ApiManagementServiceIdentity

Jméno	Popis	Hodnota
typ	Typ identity. V současné době je jediným podporovaným typem SystemAssigned.	SystemAssigned (povinné)

ApiManagementServiceProperties

Jméno	Popis	Hodnota
additionalLocations	Další umístění datacenter služby API Management	AdditionalLocation[]
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[]
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 a nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` lze použít k zakázání protokolu TLS 1.0 ve službě API Management.	apiManagementServiceBasePropertiesCustomProperties
hostnameConfigurations	Vlastní konfigurace názvu hostitele služby API Management	Konfigurace názvu hostitele[]
notificationSenderEmail	E-mailová adresa, ze které se oznámení odešle.	řetězec Omezení: Maximální délka =
publisherEmail	E-mail vydavatele.	řetězec Omezení: Maximální délka = (povinné)
publisherName	Název vydavatele.	řetězec Omezení: Maximální délka = (povinné)
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ý)

ApiManagementServiceSkuProperties

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

Značky ApimResourceTags

Jméno	Popis	Hodnota

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é)

Konfigurace názvu hostitele

Jméno	Popis	Hodnota
certifikát	Informace o certifikátu	CertificateInformation
certificatePassword	Heslo certifikátu.	řetězec
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í se vztahuje pouze na typ názvu hostitele proxy serveru.	Bool
encodedCertificate	Kódovaný certifikát Base64	řetězec
hostName	Název hostitele pro konfiguraci ve službě Api Management.	string (povinné)
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 MSI. 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.	Správa Portál Proxy Scm (povinné)

Microsoft.ApiManagement/service

Jméno	Popis	Hodnota
identita	Identita spravované služby služby Api Management	ApiManagementServiceIdentity
umístění	Umístění prostředku	string (povinné)
Jméno	Název prostředku	řetězec Omezení: Minimální délka = 1 Maximální délka = 1 Model = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` (povinné)
vlastnosti	Vlastnosti služby API Management	apiManagementServiceProperties (povinné)
sku	Vlastnosti skladové položky služby API Management	ApiManagementServiceSkuProperties (povinné)
visačky	Značky prostředků	Slovník názvů a hodnot značek
typ	Typ prostředku	Microsoft.ApiManagement/service@2018-01-01

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/[^/]$`

Sdílet prostřednictvím

Služba Microsoft.ApiManagement 2018-01-01

Definice prostředku Bicep

Formát prostředku

Hodnoty vlastností

AdditionalLocation

ApiManagementServiceBasePropertiesCustomProperties

ApiManagementServiceIdentity

ApiManagementServiceProperties

ApiManagementServiceSkuProperties

Značky ApimResourceTags

CertificateConfiguration

CertificateInformation

Konfigurace názvu hostitele

Microsoft.ApiManagement/service

VirtualNetworkConfiguration

Ukázky rychlého startu

Definice prostředku šablony ARM

Formát prostředku

Hodnoty vlastností

AdditionalLocation

ApiManagementServiceBasePropertiesCustomProperties

ApiManagementServiceIdentity

ApiManagementServiceProperties

ApiManagementServiceSkuProperties

Značky ApimResourceTags

CertificateConfiguration

CertificateInformation

Konfigurace názvu hostitele

Microsoft.ApiManagement/service

VirtualNetworkConfiguration

Šablony pro rychlý start

Definice prostředku Terraformu (poskytovatel AzAPI)

Formát prostředku

Hodnoty vlastností

AdditionalLocation

ApiManagementServiceBasePropertiesCustomProperties

ApiManagementServiceIdentity

ApiManagementServiceProperties

ApiManagementServiceSkuProperties

Značky ApimResourceTags

CertificateConfiguration

CertificateInformation

Konfigurace názvu hostitele

Microsoft.ApiManagement/service

VirtualNetworkConfiguration

Váš názor

Další materiály