Microsoft.ApiManagement-Dienst 2017-03-01
- neueste
- 2024-06-01-Preview-
- 2024-05-01
- 2023-09-01-Preview-
- 2023-05-01-Preview-
- 2023-03-01-Preview-
- 2022-09-01-Preview-
- 2022-08-01
- 2022-04-01-Vorschau-
- 2021-12-01-Preview-
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-Preview-
- 2020-12-01
- 2020-06-01-Preview-
- 2019-12-01
- 2019-12-01-Preview-
- 2019-01-01
- 2018-06-01-Preview-
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep-Ressourcendefinition
Der Dienstressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/Service-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service@2017-03-01' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
additionalLocations: [
{
location: 'string'
sku: {
capacity: int
name: 'string'
}
virtualNetworkConfiguration: {
subnetResourceId: 'string'
}
}
]
certificates: [
{
certificatePassword: 'string'
encodedCertificate: 'string'
storeName: 'string'
}
]
customProperties: {
{customized property}: 'string'
}
hostnameConfigurations: [
{
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'
}
}
Eigenschaftswerte
AdditionalLocation
| Name | Beschreibung | Wert |
|---|---|---|
| Ort | Der Standortname der zusätzlichen Region zwischen Azure Data Center-Regionen. | Zeichenfolge (erforderlich) |
| Sku | SKU-Eigenschaften des API-Verwaltungsdiensts. | ApiManagementServiceSkuProperties (erforderlich) |
| virtualNetworkConfiguration | Konfiguration des virtuellen Netzwerks für den Speicherort. | VirtualNetworkConfiguration- |
ApiManagementServiceBasePropertiesCustomProperties
| Name | Beschreibung | Wert |
|---|
ApiManagementServiceIdentity
| Name | Beschreibung | Wert |
|---|---|---|
| Art | Der Identitätstyp. Derzeit ist der einzige unterstützte Typ "SystemAssigned". | 'SystemAssigned' (erforderlich) |
ApiManagementServiceProperties
| Name | Beschreibung | Wert |
|---|---|---|
| additionalLocations | Zusätzliche Rechenzentrumsspeicherorte des API-Verwaltungsdiensts. | AdditionalLocation-[] |
| Atteste | Liste der Zertifikate, die im API-Verwaltungsdienst installiert werden müssen. Maximal unterstützte Zertifikate, die installiert werden können, sind 10. | CertificateConfiguration-[] |
| customProperties | Benutzerdefinierte Eigenschaften des API-Verwaltungsdiensts. Durch festlegen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 wird die Verschlüsselung TLS_RSA_WITH_3DES_EDE_CBC_SHA für alle TLS(1.0, 1.1 und 1.2) deaktiviert. Das Festlegen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kann verwendet werden, um nur TLS 1.1 zu deaktivieren und Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 zum Deaktivieren von TLS 1.0 für einen API-Verwaltungsdienst verwendet werden können. |
ApiManagementServiceBasePropertiesCustomProperties |
| hostnameConfigurations | Benutzerdefinierte Hostnamenkonfiguration des API-Verwaltungsdiensts. | HostnameConfiguration[] |
| notificationSenderEmail | E-Mail-Adresse, von der die Benachrichtigung gesendet wird. | Schnur Zwänge: Max. Länge = |
| publisherEmail | Publisher-E-Mail. | Schnur Zwänge: Max. Länge = (erforderlich) |
| publisherName | Herausgebername. | Schnur Zwänge: Max. Länge = (erforderlich) |
| virtualNetworkConfiguration | Virtuelle Netzwerkkonfiguration des API-Verwaltungsdiensts. | VirtualNetworkConfiguration- |
| virtualNetworkType | Der Typ des VPN, in dem der API-Verwaltungsdienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API-Verwaltungsdienst nicht Teil eines virtuellen Netzwerks ist, extern bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das über einen internetgerichteten Endpunkt verfügt, und "Intern" bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das nur über einen Intranet-Endpunkt verfügt. | 'Extern' "Intern" 'None' |
ApiManagementServiceSkuProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Fassungsvermögen | Kapazität der SKU (Anzahl der bereitgestellten Einheiten der SKU). Der Standardwert ist 1. | Int |
| Name | Name der Sku. | "Einfach" "Entwickler" "Premium" "Standard" (erforderlich) |
ApimResourceTags
| Name | Beschreibung | Wert |
|---|
CertificateConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| certificatePassword | Zertifikatkennwort. | Schnur |
| encodedCertificate | Base64-Codiertes Zertifikat. | Schnur |
| storeName | Der lokale Zertifikatspeicherort. Nur Stamm- und Zertifikatautorität sind gültige Speicherorte. | "CertificateAuthority" 'Root' (erforderlich) |
HostnameConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| certificatePassword | Zertifikatkennwort. | Schnur |
| defaultSslBinding | Geben Sie true an, um das diesem Hostnamen zugeordnete Zertifikat als Standard-SSL-Zertifikat einzurichten. Wenn ein Client den SNI-Header nicht sendet, ist dies das Zertifikat, das herausfordert wird. Die Eigenschaft ist nützlich, wenn ein Dienst mehrere benutzerdefinierte Hostnamen aktiviert hat und es für das Standard-SSL-Zertifikat entscheiden muss. Die Einstellung wurde nur auf den Proxy-Hostnamentyp angewendet. | Bool |
| encodedCertificate | Base64-Codiertes Zertifikat. | Schnur |
| hostName | Hostname, der für den API-Verwaltungsdienst konfiguriert werden soll. | Zeichenfolge (erforderlich) |
| keyVaultId | Url zum Schlüsselschlüsselschlüssel, der das Ssl-Zertifikat enthält. Wenn absolute URL mit Version bereitgestellt wird, funktioniert die automatische Aktualisierung des SSL-Zertifikats nicht. Dazu muss der API-Verwaltungsdienst mit MSI konfiguriert werden. Der geheime Schlüssel sollte vom Typ anwendung/x-pkcs12 sein. | Schnur |
| negotiateClientCertificate | Geben Sie true an, um das Clientzertifikat immer auf dem Hostnamen auszuhandeln. Der Standardwert ist "false". | Bool |
| Art | Hostnamentyp. | "Management" 'Portal' 'Proxy' 'Scm' (erforderlich) |
Microsoft.ApiManagement/service
| Name | Beschreibung | Wert |
|---|---|---|
| Identität | Verwaltete Dienstidentität des API-Verwaltungsdiensts. | ApiManagementServiceIdentity- |
| Ort | Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (erforderlich) |
| Eigenschaften | Eigenschaften des API-Verwaltungsdiensts. | ApiManagementServiceProperties (erforderlich) |
| Sku | SKU-Eigenschaften des API-Verwaltungsdiensts. | ApiManagementServiceSkuProperties (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
VirtualNetworkConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| subnetResourceId | Die vollständige Ressourcen-ID eines Subnetzes in einem virtuellen Netzwerk, in dem der API-Verwaltungsdienst bereitgestellt wird. | Schnur Zwänge: Pattern = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$ |
Schnellstartbeispiele
Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.
| Bicep-Datei | Beschreibung |
|---|---|
| Anwendungsgateway mit interner API-Verwaltung und Web App- | Das Anwendungsgateway routingt Internetdatenverkehr an eine API-Verwaltungsinstanz für virtuelle Netzwerke (interner Modus), die eine in einer Azure Web App gehostete Web-API verwendet. |
| Erstellen einer Mehrregion-API-Verwaltungsinstanz auf mehreren Ebenen | Diese Vorlage veranschaulicht, wie Sie eine API-Verwaltungsinstanz mit zusätzlichen Speicherorten erstellen. Der primäre Speicherort ist identisch mit dem Speicherort der Ressourcengruppe. Für weitere Speicherorte zeigt die Vorlage "NorthCentralUs" und "East US2". Der primäre Speicherort sollte sich von zusätzlichen Speicherorten unterscheiden. |
| Erstellen einer API-Verwaltungsinstanz mit MSI Identity | Diese Vorlage erstellt eine Entwicklerinstanz von Azure API Management mit einer MSI-Identität |
| Erstellen einer API-Verwaltungsinstanz mithilfe einer Vorlage | Diese Vorlage erstellt eine Entwicklerinstanz von Azure API Management |
| Erstellen eines API-Verwaltungsdiensts mit einem privaten Endpunkt | Diese Vorlage erstellt einen API-Verwaltungsdienst, ein virtuelles Netzwerk und einen privaten Endpunkt, der den API-Verwaltungsdienst für das virtuelle Netzwerk bereitstellt. |
| Erstellen eines API-Verwaltungsdiensts mit SSL von KeyVault | Diese Vorlage stellt einen API-Verwaltungsdienst bereit, der mit der vom Benutzer zugewiesenen Identität konfiguriert ist. Sie verwendet diese Identität, um SSL-Zertifikat von KeyVault abzurufen und es alle 4 Stunden zu aktualisieren. |
| Erstellen der API-Verwaltung im internen VNet mit App-Gateway- | Diese Vorlage veranschaulicht, wie Sie eine Instanz von Azure API Management in einem privaten Netzwerk erstellen, das durch Azure Application Gateway geschützt ist. |
| Bereitstellen der API-Verwaltung im externen VNet mit öffentlichem IP- | Diese Vorlage veranschaulicht, wie Sie eine Instanz von Azure API Management auf der Premium-Ebene im Subnetz Ihres virtuellen Netzwerks im externen Modus erstellen und empfohlene NSG-Regeln für das Subnetz konfigurieren. Die Instanz wird in zwei Verfügbarkeitszonen bereitgestellt. Die Vorlage konfiguriert außerdem eine öffentliche IP-Adresse aus Ihrem Abonnement. |
| Bereitstellen der API-Verwaltung im internen VNet mit öffentlichem IP- | Diese Vorlage veranschaulicht, wie Sie eine Instanz von Azure API Management auf der Premium-Ebene im subnetz Ihres virtuellen Netzwerks im internen Modus erstellen und empfohlene NSG-Regeln für das Subnetz konfigurieren. Die Instanz wird in zwei Verfügbarkeitszonen bereitgestellt. Die Vorlage konfiguriert außerdem eine öffentliche IP-Adresse aus Ihrem Abonnement. |
| Bereitstellen der API-Verwaltung in Verfügbarkeitszonen | Diese Vorlage erstellt eine Premiuminstanz von Azure API Management und stellt sie in einer Verfügbarkeitszone bereit. |
| Bereitstellen der API-Verwaltung mit einem externen Azure-Cache für Redis | Diese Vorlage veranschaulicht, wie Eine Instanz von Azure API Management auf der Verbrauchsebene mit einem externen Azure-Cache für Redis-Instanz als externer API-Verwaltungscache erstellt wird. |
| Front Door Standard/Premium mit API-Management-Ursprung | Diese Vorlage erstellt eine Front Door Premium- und eine API-Verwaltungsinstanz und verwendet eine NSG- und globale API-Verwaltungsrichtlinie, um zu überprüfen, ob der Datenverkehr über den Front Door-Ursprung erfolgt ist. |
ARM-Vorlagenressourcendefinition
Der Dienstressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/Service-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service",
"apiVersion": "2017-03-01",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"additionalLocations": [
{
"location": "string",
"sku": {
"capacity": "int",
"name": "string"
},
"virtualNetworkConfiguration": {
"subnetResourceId": "string"
}
}
],
"certificates": [
{
"certificatePassword": "string",
"encodedCertificate": "string",
"storeName": "string"
}
],
"customProperties": {
"{customized property}": "string"
},
"hostnameConfigurations": [
{
"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"
}
}
Eigenschaftswerte
AdditionalLocation
| Name | Beschreibung | Wert |
|---|---|---|
| Ort | Der Standortname der zusätzlichen Region zwischen Azure Data Center-Regionen. | Zeichenfolge (erforderlich) |
| Sku | SKU-Eigenschaften des API-Verwaltungsdiensts. | ApiManagementServiceSkuProperties (erforderlich) |
| virtualNetworkConfiguration | Konfiguration des virtuellen Netzwerks für den Speicherort. | VirtualNetworkConfiguration- |
ApiManagementServiceBasePropertiesCustomProperties
| Name | Beschreibung | Wert |
|---|
ApiManagementServiceIdentity
| Name | Beschreibung | Wert |
|---|---|---|
| Art | Der Identitätstyp. Derzeit ist der einzige unterstützte Typ "SystemAssigned". | 'SystemAssigned' (erforderlich) |
ApiManagementServiceProperties
| Name | Beschreibung | Wert |
|---|---|---|
| additionalLocations | Zusätzliche Rechenzentrumsspeicherorte des API-Verwaltungsdiensts. | AdditionalLocation-[] |
| Atteste | Liste der Zertifikate, die im API-Verwaltungsdienst installiert werden müssen. Maximal unterstützte Zertifikate, die installiert werden können, sind 10. | CertificateConfiguration-[] |
| customProperties | Benutzerdefinierte Eigenschaften des API-Verwaltungsdiensts. Durch festlegen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 wird die Verschlüsselung TLS_RSA_WITH_3DES_EDE_CBC_SHA für alle TLS(1.0, 1.1 und 1.2) deaktiviert. Das Festlegen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kann verwendet werden, um nur TLS 1.1 zu deaktivieren und Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 zum Deaktivieren von TLS 1.0 für einen API-Verwaltungsdienst verwendet werden können. |
ApiManagementServiceBasePropertiesCustomProperties |
| hostnameConfigurations | Benutzerdefinierte Hostnamenkonfiguration des API-Verwaltungsdiensts. | HostnameConfiguration[] |
| notificationSenderEmail | E-Mail-Adresse, von der die Benachrichtigung gesendet wird. | Schnur Zwänge: Max. Länge = |
| publisherEmail | Publisher-E-Mail. | Schnur Zwänge: Max. Länge = (erforderlich) |
| publisherName | Herausgebername. | Schnur Zwänge: Max. Länge = (erforderlich) |
| virtualNetworkConfiguration | Virtuelle Netzwerkkonfiguration des API-Verwaltungsdiensts. | VirtualNetworkConfiguration- |
| virtualNetworkType | Der Typ des VPN, in dem der API-Verwaltungsdienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API-Verwaltungsdienst nicht Teil eines virtuellen Netzwerks ist, extern bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das über einen internetgerichteten Endpunkt verfügt, und "Intern" bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das nur über einen Intranet-Endpunkt verfügt. | 'Extern' "Intern" 'None' |
ApiManagementServiceSkuProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Fassungsvermögen | Kapazität der SKU (Anzahl der bereitgestellten Einheiten der SKU). Der Standardwert ist 1. | Int |
| Name | Name der Sku. | "Einfach" "Entwickler" "Premium" "Standard" (erforderlich) |
ApimResourceTags
| Name | Beschreibung | Wert |
|---|
CertificateConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| certificatePassword | Zertifikatkennwort. | Schnur |
| encodedCertificate | Base64-Codiertes Zertifikat. | Schnur |
| storeName | Der lokale Zertifikatspeicherort. Nur Stamm- und Zertifikatautorität sind gültige Speicherorte. | "CertificateAuthority" 'Root' (erforderlich) |
HostnameConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| certificatePassword | Zertifikatkennwort. | Schnur |
| defaultSslBinding | Geben Sie true an, um das diesem Hostnamen zugeordnete Zertifikat als Standard-SSL-Zertifikat einzurichten. Wenn ein Client den SNI-Header nicht sendet, ist dies das Zertifikat, das herausfordert wird. Die Eigenschaft ist nützlich, wenn ein Dienst mehrere benutzerdefinierte Hostnamen aktiviert hat und es für das Standard-SSL-Zertifikat entscheiden muss. Die Einstellung wurde nur auf den Proxy-Hostnamentyp angewendet. | Bool |
| encodedCertificate | Base64-Codiertes Zertifikat. | Schnur |
| hostName | Hostname, der für den API-Verwaltungsdienst konfiguriert werden soll. | Zeichenfolge (erforderlich) |
| keyVaultId | Url zum Schlüsselschlüsselschlüssel, der das Ssl-Zertifikat enthält. Wenn absolute URL mit Version bereitgestellt wird, funktioniert die automatische Aktualisierung des SSL-Zertifikats nicht. Dazu muss der API-Verwaltungsdienst mit MSI konfiguriert werden. Der geheime Schlüssel sollte vom Typ anwendung/x-pkcs12 sein. | Schnur |
| negotiateClientCertificate | Geben Sie true an, um das Clientzertifikat immer auf dem Hostnamen auszuhandeln. Der Standardwert ist "false". | Bool |
| Art | Hostnamentyp. | "Management" 'Portal' 'Proxy' 'Scm' (erforderlich) |
Microsoft.ApiManagement/service
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | '2017-03-01' |
| Identität | Verwaltete Dienstidentität des API-Verwaltungsdiensts. | ApiManagementServiceIdentity- |
| Ort | Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (erforderlich) |
| Eigenschaften | Eigenschaften des API-Verwaltungsdiensts. | ApiManagementServiceProperties (erforderlich) |
| Sku | SKU-Eigenschaften des API-Verwaltungsdiensts. | ApiManagementServiceSkuProperties (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service" |
VirtualNetworkConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| subnetResourceId | Die vollständige Ressourcen-ID eines Subnetzes in einem virtuellen Netzwerk, in dem der API-Verwaltungsdienst bereitgestellt wird. | Schnur Zwänge: Pattern = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$ |
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
| Schablone | Beschreibung |
|---|---|
Anwendungsgateway mit interner API-Verwaltung und Web App-
|
Das Anwendungsgateway routingt Internetdatenverkehr an eine API-Verwaltungsinstanz für virtuelle Netzwerke (interner Modus), die eine in einer Azure Web App gehostete Web-API verwendet. |
|
Erstellen einer Mehrregion-API-Verwaltungsinstanz auf mehreren Ebenen
|
Diese Vorlage veranschaulicht, wie Sie eine API-Verwaltungsinstanz mit zusätzlichen Speicherorten erstellen. Der primäre Speicherort ist identisch mit dem Speicherort der Ressourcengruppe. Für weitere Speicherorte zeigt die Vorlage "NorthCentralUs" und "East US2". Der primäre Speicherort sollte sich von zusätzlichen Speicherorten unterscheiden. |
|
Erstellen einer API-Verwaltungsinstanz und aller Unterressourcen mithilfe von Vorlagen
|
Diese Vorlage veranschaulicht, wie Sie einen API-Verwaltungsdienst erstellen und Unterentitäten konfigurieren. |
|
Erstellen einer API-Verwaltungsinstanz mit MSI Identity
|
Diese Vorlage erstellt eine Entwicklerinstanz von Azure API Management mit einer MSI-Identität |
|
Erstellen einer API-Verwaltungsinstanz mithilfe einer Vorlage
|
Diese Vorlage erstellt eine Entwicklerinstanz von Azure API Management |
|
Erstellen einer API-Verwaltungsinstanz mit benutzerdefinierten Hostnamen
|
Diese Vorlage veranschaulicht das Erstellen einer Instanz von Azure API Management mit benutzerdefiniertem Hostnamen für Portal und mehreren benutzerdefinierten Hostnamen für Proxys |
|
Erstellen eines API-Verwaltungsdiensts mit einem privaten Endpunkt
|
Diese Vorlage erstellt einen API-Verwaltungsdienst, ein virtuelles Netzwerk und einen privaten Endpunkt, der den API-Verwaltungsdienst für das virtuelle Netzwerk bereitstellt. |
|
Erstellen eines API-Verwaltungsdiensts mit SSL von KeyVault
|
Diese Vorlage stellt einen API-Verwaltungsdienst bereit, der mit der vom Benutzer zugewiesenen Identität konfiguriert ist. Sie verwendet diese Identität, um SSL-Zertifikat von KeyVault abzurufen und es alle 4 Stunden zu aktualisieren. |
|
Erstellen und Überwachen der API-Verwaltungsinstanz
|
Diese Vorlage erstellt eine Instanz des Azure API-Verwaltungsdiensts und des Log Analytics-Arbeitsbereichs und richtet die Überwachung für Ihren API-Verwaltungsdienst mit Log Analytics ein. |
|
Erstellen der API-Verwaltung im internen VNet mit App-Gateway-
|
Diese Vorlage veranschaulicht, wie Sie eine Instanz von Azure API Management in einem privaten Netzwerk erstellen, das durch Azure Application Gateway geschützt ist. |
|
Erstellen der API-Verwaltung mit benutzerdefiniertem Proxy-SSL mithilfe von KeyVault-
|
Diese Vorlage veranschaulicht, wie Sie eine Instanz von Azure API Management erstellen und benutzerdefinierten Hostnamen für Proxy mit SSL-Zertifikat von keyvault konfigurieren. |
|
Erstellen von Azure Front Door vor der Azure API Management-
|
In diesem Beispiel wird die Verwendung von Azure Front Door als globaler Lastenausgleich vor der Azure-API-Verwaltung veranschaulicht. |
|
Bereitstellen der API-Verwaltung im externen VNet mit öffentlichem IP-
|
Diese Vorlage veranschaulicht, wie Sie eine Instanz von Azure API Management auf der Premium-Ebene im Subnetz Ihres virtuellen Netzwerks im externen Modus erstellen und empfohlene NSG-Regeln für das Subnetz konfigurieren. Die Instanz wird in zwei Verfügbarkeitszonen bereitgestellt. Die Vorlage konfiguriert außerdem eine öffentliche IP-Adresse aus Ihrem Abonnement. |
|
Bereitstellen der API-Verwaltung im internen VNet mit öffentlichem IP-
|
Diese Vorlage veranschaulicht, wie Sie eine Instanz von Azure API Management auf der Premium-Ebene im subnetz Ihres virtuellen Netzwerks im internen Modus erstellen und empfohlene NSG-Regeln für das Subnetz konfigurieren. Die Instanz wird in zwei Verfügbarkeitszonen bereitgestellt. Die Vorlage konfiguriert außerdem eine öffentliche IP-Adresse aus Ihrem Abonnement. |
|
Bereitstellen der API-Verwaltung in Verfügbarkeitszonen
|
Diese Vorlage erstellt eine Premiuminstanz von Azure API Management und stellt sie in einer Verfügbarkeitszone bereit. |
|
Bereitstellen der API-Verwaltung mit einem externen Azure-Cache für Redis
|
Diese Vorlage veranschaulicht, wie Eine Instanz von Azure API Management auf der Verbrauchsebene mit einem externen Azure-Cache für Redis-Instanz als externer API-Verwaltungscache erstellt wird. |
|
Front Door Standard/Premium mit API-Management-Ursprung
|
Diese Vorlage erstellt eine Front Door Premium- und eine API-Verwaltungsinstanz und verwendet eine NSG- und globale API-Verwaltungsrichtlinie, um zu überprüfen, ob der Datenverkehr über den Front Door-Ursprung erfolgt ist. |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Dienstressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/Service-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service@2017-03-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 = [
{
certificatePassword = "string"
encodedCertificate = "string"
storeName = "string"
}
]
customProperties = {
{customized property} = "string"
}
hostnameConfigurations = [
{
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"
}
})
}
Eigenschaftswerte
AdditionalLocation
| Name | Beschreibung | Wert |
|---|---|---|
| Ort | Der Standortname der zusätzlichen Region zwischen Azure Data Center-Regionen. | Zeichenfolge (erforderlich) |
| Sku | SKU-Eigenschaften des API-Verwaltungsdiensts. | ApiManagementServiceSkuProperties (erforderlich) |
| virtualNetworkConfiguration | Konfiguration des virtuellen Netzwerks für den Speicherort. | VirtualNetworkConfiguration- |
ApiManagementServiceBasePropertiesCustomProperties
| Name | Beschreibung | Wert |
|---|
ApiManagementServiceIdentity
| Name | Beschreibung | Wert |
|---|---|---|
| Art | Der Identitätstyp. Derzeit ist der einzige unterstützte Typ "SystemAssigned". | 'SystemAssigned' (erforderlich) |
ApiManagementServiceProperties
| Name | Beschreibung | Wert |
|---|---|---|
| additionalLocations | Zusätzliche Rechenzentrumsspeicherorte des API-Verwaltungsdiensts. | AdditionalLocation-[] |
| Atteste | Liste der Zertifikate, die im API-Verwaltungsdienst installiert werden müssen. Maximal unterstützte Zertifikate, die installiert werden können, sind 10. | CertificateConfiguration-[] |
| customProperties | Benutzerdefinierte Eigenschaften des API-Verwaltungsdiensts. Durch festlegen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 wird die Verschlüsselung TLS_RSA_WITH_3DES_EDE_CBC_SHA für alle TLS(1.0, 1.1 und 1.2) deaktiviert. Das Festlegen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kann verwendet werden, um nur TLS 1.1 zu deaktivieren und Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 zum Deaktivieren von TLS 1.0 für einen API-Verwaltungsdienst verwendet werden können. |
ApiManagementServiceBasePropertiesCustomProperties |
| hostnameConfigurations | Benutzerdefinierte Hostnamenkonfiguration des API-Verwaltungsdiensts. | HostnameConfiguration[] |
| notificationSenderEmail | E-Mail-Adresse, von der die Benachrichtigung gesendet wird. | Schnur Zwänge: Max. Länge = |
| publisherEmail | Publisher-E-Mail. | Schnur Zwänge: Max. Länge = (erforderlich) |
| publisherName | Herausgebername. | Schnur Zwänge: Max. Länge = (erforderlich) |
| virtualNetworkConfiguration | Virtuelle Netzwerkkonfiguration des API-Verwaltungsdiensts. | VirtualNetworkConfiguration- |
| virtualNetworkType | Der Typ des VPN, in dem der API-Verwaltungsdienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API-Verwaltungsdienst nicht Teil eines virtuellen Netzwerks ist, extern bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das über einen internetgerichteten Endpunkt verfügt, und "Intern" bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das nur über einen Intranet-Endpunkt verfügt. | 'Extern' "Intern" 'None' |
ApiManagementServiceSkuProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Fassungsvermögen | Kapazität der SKU (Anzahl der bereitgestellten Einheiten der SKU). Der Standardwert ist 1. | Int |
| Name | Name der Sku. | "Einfach" "Entwickler" "Premium" "Standard" (erforderlich) |
ApimResourceTags
| Name | Beschreibung | Wert |
|---|
CertificateConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| certificatePassword | Zertifikatkennwort. | Schnur |
| encodedCertificate | Base64-Codiertes Zertifikat. | Schnur |
| storeName | Der lokale Zertifikatspeicherort. Nur Stamm- und Zertifikatautorität sind gültige Speicherorte. | "CertificateAuthority" 'Root' (erforderlich) |
HostnameConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| certificatePassword | Zertifikatkennwort. | Schnur |
| defaultSslBinding | Geben Sie true an, um das diesem Hostnamen zugeordnete Zertifikat als Standard-SSL-Zertifikat einzurichten. Wenn ein Client den SNI-Header nicht sendet, ist dies das Zertifikat, das herausfordert wird. Die Eigenschaft ist nützlich, wenn ein Dienst mehrere benutzerdefinierte Hostnamen aktiviert hat und es für das Standard-SSL-Zertifikat entscheiden muss. Die Einstellung wurde nur auf den Proxy-Hostnamentyp angewendet. | Bool |
| encodedCertificate | Base64-Codiertes Zertifikat. | Schnur |
| hostName | Hostname, der für den API-Verwaltungsdienst konfiguriert werden soll. | Zeichenfolge (erforderlich) |
| keyVaultId | Url zum Schlüsselschlüsselschlüssel, der das Ssl-Zertifikat enthält. Wenn absolute URL mit Version bereitgestellt wird, funktioniert die automatische Aktualisierung des SSL-Zertifikats nicht. Dazu muss der API-Verwaltungsdienst mit MSI konfiguriert werden. Der geheime Schlüssel sollte vom Typ anwendung/x-pkcs12 sein. | Schnur |
| negotiateClientCertificate | Geben Sie true an, um das Clientzertifikat immer auf dem Hostnamen auszuhandeln. Der Standardwert ist "false". | Bool |
| Art | Hostnamentyp. | "Management" 'Portal' 'Proxy' 'Scm' (erforderlich) |
Microsoft.ApiManagement/service
| Name | Beschreibung | Wert |
|---|---|---|
| Identität | Verwaltete Dienstidentität des API-Verwaltungsdiensts. | ApiManagementServiceIdentity- |
| Ort | Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (erforderlich) |
| Eigenschaften | Eigenschaften des API-Verwaltungsdiensts. | ApiManagementServiceProperties (erforderlich) |
| Sku | SKU-Eigenschaften des API-Verwaltungsdiensts. | ApiManagementServiceSkuProperties (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service@2017-03-01" |
VirtualNetworkConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| subnetResourceId | Die vollständige Ressourcen-ID eines Subnetzes in einem virtuellen Netzwerk, in dem der API-Verwaltungsdienst bereitgestellt wird. | Schnur Zwänge: Pattern = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$ |