Microsoft.ApiManagement-Dienst

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

Eigenschaftswerte

Dienst

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

PrivateLinkServiceConnectionState

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone	Beschreibung
Erstellen einer API-Verwaltungsinstanz und aller Unterressourcen mithilfe von Vorlagen	Diese Vorlage veranschaulicht, wie Sie einen API-Verwaltungsdienst erstellen und Unterentitäten konfigurieren.
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.
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.
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 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 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.
Erstellen einer API-Verwaltungsinstanz mit MSI Identity	Diese Vorlage erstellt eine Entwicklerinstanz von Azure API Management mit einer MSI-Identität
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 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 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 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.
Bereitstellen der API-Verwaltung in Verfügbarkeitszonen	Diese Vorlage erstellt eine Premiuminstanz von Azure API Management und stellt sie in einer Verfügbarkeitszone bereit.
Erstellen einer API-Verwaltungsinstanz mithilfe einer Vorlage	Diese Vorlage erstellt eine Entwicklerinstanz von Azure API Management
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.
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.
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.

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

Eigenschaftswerte

Dienst

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

PrivateLinkServiceConnectionState

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone	Beschreibung
Erstellen einer API-Verwaltungsinstanz und aller Unterressourcen mithilfe von Vorlagen	Diese Vorlage veranschaulicht, wie Sie einen API-Verwaltungsdienst erstellen und Unterentitäten konfigurieren.
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.
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.
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 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 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.
Erstellen einer API-Verwaltungsinstanz mit MSI Identity	Diese Vorlage erstellt eine Entwicklerinstanz von Azure API Management mit einer MSI-Identität
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 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 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 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.
Bereitstellen der API-Verwaltung in Verfügbarkeitszonen	Diese Vorlage erstellt eine Premiuminstanz von Azure API Management und stellt sie in einer Verfügbarkeitszone bereit.
Erstellen einer API-Verwaltungsinstanz mithilfe einer Vorlage	Diese Vorlage erstellt eine Entwicklerinstanz von Azure API Management
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.
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.
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.

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

Eigenschaftswerte

Dienst

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

PrivateLinkServiceConnectionState