Microsoft.ApiManagement-service

Bicep-resourcedefinitie

Het serviceresourcetype kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/serviceresource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.ApiManagement/service@2023-03-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  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: {}
    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'
  ]
}

Eigenschapswaarden

service

Naam Beschrijving Waarde
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-50

Geldige tekens:
Alfanumerieken en afbreekstreepjes.

Begin met letter en eindig met alfanumeriek.

De resourcenaam moet uniek zijn in Azure.
location Resourcelocatie. tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku SKU-eigenschappen van de API Management-service. ApiManagementServiceSkuProperties (vereist)
identity Beheerde service-identiteit van de Api Management-service. ApiManagementServiceIdentity
properties Eigenschappen van de API Management-service. ApiManagementServiceProperties (vereist)
Zones Een lijst met beschikbaarheidszones die aangeven waar de resource vandaan moet komen. tekenreeks[]

ApiManagementServiceIdentity

Naam Beschrijving Waarde
type Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned, UserAssigned' omvat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. 'Geen'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' (vereist)
userAssignedIdentities De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De gebruikersidentiteit
Sleutelverwijzingen in woordenlijst zijn ARM-resource-id's in de vorm:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
object

ApiManagementServiceProperties

Naam Beschrijving Waarde
additionalLocations Aanvullende datacenterlocaties van de API Management-service. AdditionalLocation[]
apiVersionConstraint Versiebeperking besturingsvlak-API's voor de API Management-service. ApiVersionConstraint
certificaten Lijst met certificaten die moeten worden geïnstalleerd in de API Management-service. Maximaal 10 ondersteunde certificaten die kunnen worden geïnstalleerd. CertificateConfiguration[]
configurationApi Configuratie-API-configuratie van de API Management-service. ConfigurationApi
Customproperties Aangepaste eigenschappen van de API Management-service.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 schakelt de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA uit voor alle TLS(1.0, 1.1 en 1.2).
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen voor communicatie met back-ends.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen voor communicatie met back-ends.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan worden gebruikt om het HTTP2-protocol in te schakelen op een API Management-service.
Als u een van deze eigenschappen niet opgeeft in patchbewerking, worden de waarden van de weggelaten eigenschappen opnieuw ingesteld op de standaardwaarden. Voor alle instellingen behalve Http2 is True de standaardwaarde als de service is gemaakt op of vóór 1 april 2018 en False anders. De standaardwaarde van http2-instelling is False.

U kunt een van de volgende coderingen uitschakelen met behulp van instellingen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: 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. Bijvoorbeeld Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: :false. De standaardwaarde is true voor hen.
Opmerking: de volgende coderingen kunnen niet worden uitgeschakeld omdat ze vereist zijn voor interne platformonderdelen: 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
object
developerPortalStatus Status van ontwikkelaarsportal in deze API Management-service. 'Uitgeschakeld'
Ingeschakeld
disableGateway De eigenschap is alleen geldig voor een API Management-service die op meerdere locaties is geïmplementeerd. Dit kan worden gebruikt om de gateway in de hoofdregio uit te schakelen. booleaans
enableClientCertificate De eigenschap is alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Hiermee dwingt u af dat er een clientcertificaat wordt weergegeven bij elke aanvraag voor de gateway. Hierdoor kan het certificaat ook worden geverifieerd in het beleid op de gateway. booleaans
hostnameConfigurations Aangepaste hostnaamconfiguratie van de API Management-service. HostnameConfiguration[]
legacyPortalStatus Status van verouderde portal in de API Management-service. 'Uitgeschakeld'
Ingeschakeld
natGatewayState Eigenschap kan worden gebruikt om NAT-gateway in te schakelen voor deze API Management-service. 'Uitgeschakeld'
Ingeschakeld
notificationSenderEmail Email adres van waaruit de melding wordt verzonden. tekenreeks
privateEndpointConnections Lijst met privé-eindpuntverbindingen van deze service. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Ip-adres op basis van openbare standaard-SKU V4 dat moet worden gekoppeld aan Virtual Network geïmplementeerde service in de regio. Wordt alleen ondersteund voor ontwikkelaars en Premium-SKU's die worden geïmplementeerd in Virtual Network. tekenreeks
publicNetworkAccess Of openbare eindpunttoegang is toegestaan voor deze API Management-service. De waarde is optioneel, maar als deze wordt doorgegeven, moet deze 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als 'Uitgeschakeld' is, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld 'Uitgeschakeld'
Ingeschakeld
publisherEmail E-mailadres van uitgever. tekenreeks (vereist)
publisherName Naam van uitgever. tekenreeks (vereist)
De pagina Restore Verwijder de API Management-service ongedaan als deze eerder voorlopig is verwijderd. Als deze vlag is opgegeven en is ingesteld op Waar, worden alle andere eigenschappen genegeerd. booleaans
virtualNetworkConfiguration Configuratie van het virtuele netwerk van de API Management-service. VirtualNetworkConfiguration
virtualNetworkType Het type VPN waarin API Management service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een Virtual Network, extern betekent dat de API Management-implementatie is ingesteld binnen een Virtual Network met een internetgericht eindpunt en Intern betekent dat API Management implementatie wordt ingesteld binnen een Virtual Network alleen een intranetgericht eindpunt heeft. Extern
'Intern'
'Geen'

AdditionalLocation

Naam Beschrijving Waarde
disableGateway De eigenschap is alleen geldig voor een API Management-service die op meerdere locaties is geïmplementeerd. Dit kan worden gebruikt om de gateway op deze extra locatie uit te schakelen. booleaans
location De locatienaam van de extra regio tussen Azure Data Center-regio's. tekenreeks (vereist)
natGatewayState Eigenschap kan worden gebruikt om NAT-gateway in te schakelen voor deze API Management-service. 'Uitgeschakeld'
Ingeschakeld
publicIpAddressId Ip-adres V4 van de openbare standaard-SKU dat moet worden gekoppeld aan Virtual Network geïmplementeerde service op de locatie. Wordt alleen ondersteund voor Premium SKU die wordt geïmplementeerd in Virtual Network. tekenreeks
sku SKU-eigenschappen van de API Management-service. ApiManagementServiceSkuProperties (vereist)
virtualNetworkConfiguration Configuratie van virtueel netwerk voor de locatie. VirtualNetworkConfiguration
Zones Een lijst met beschikbaarheidszones die aangeeft waar de resource vandaan moet komen. tekenreeks[]

ApiManagementServiceSkuProperties

Naam Beschrijving Waarde
capacity Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU). Voor Verbruik SKU-capaciteit moet worden opgegeven als 0. int (vereist)
naam Naam van de SKU. 'Basic'
'Verbruik'
'Ontwikkelaar'
'Geïsoleerd'
'Premium'
'Standaard' (vereist)

VirtualNetworkConfiguration

Naam Beschrijving Waarde
subnetResourceId De volledige resource-id van een subnet in een virtueel netwerk om de API Management-service in te implementeren. tekenreeks

ApiVersionConstraint

Naam Beschrijving Waarde
minApiVersion Beperk API-aanroepen van besturingsvlak tot API Management service met een versie die gelijk is aan of hoger is dan deze waarde. tekenreeks

CertificateConfiguration

Naam Beschrijving Waarde
certificaat Certificaatgegevens. CertificateInformation
certificatePassword Certificaatwachtwoord. tekenreeks
encodedCertificate Base64-gecodeerd certificaat. tekenreeks
storeName De locatie van het certificaatarchief System.Security.Cryptography.x509certificates.StoreName. Alleen Root en CertificateAuthority zijn geldige locaties. 'CertificateAuthority'
'Root' (vereist)

CertificateInformation

Naam Beschrijving Waarde
Verstrijken Vervaldatum van het certificaat. De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard. tekenreeks (vereist)
onderwerp Onderwerp van het certificaat. tekenreeks (vereist)
Vingerafdruk Vingerafdruk van het certificaat. tekenreeks (vereist)

ConfigurationApi

Naam Beschrijving Waarde
legacyApi Indicatie of de verouderde configuratie-API (v1) moet worden weergegeven op de API Management-service. De waarde is optioneel, maar moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als 'uitgeschakeld' is, is de verouderde configuratie-API (v1) niet beschikbaar voor zelf-hostende gateways. De standaardwaarde is Ingeschakeld 'Uitgeschakeld'
Ingeschakeld

HostnaamConfiguratie

Naam Beschrijving Waarde
certificaat Certificaatgegevens. CertificateInformation
certificatePassword Certificaatwachtwoord. tekenreeks
certificateSource Certificaatbron. 'BuiltIn'
'Aangepast'
'KeyVault'
'Beheerd'
certificateStatus Certificaatstatus. 'Voltooid'
'Mislukt'
'InProgress'
defaultSslBinding Geef true op om het certificaat dat aan deze hostnaam is gekoppeld in te stellen als het standaard-SSL-certificaat. Als een client de SNI-header niet verzendt, is dit het certificaat dat wordt aangevochten. De eigenschap is handig als voor een service meerdere aangepaste hostnamen zijn ingeschakeld en het standaard SSL-certificaat moet worden bepaald. De instelling wordt alleen toegepast op het hostnaamtype van de gateway. booleaans
encodedCertificate Base64-gecodeerd certificaat. tekenreeks
Hostname Hostnaam die moet worden geconfigureerd in de API Management-service. tekenreeks (vereist)
identityClientId ClientId van door het systeem of door de gebruiker toegewezen beheerde identiteit zoals gegenereerd door Azure AD, die get-toegang heeft tot de keyVault die het SSL-certificaat bevat. tekenreeks
keyVaultId URL naar het KeyVault-geheim met het SSL-certificaat. Als er een absolute URL met versie wordt opgegeven, werkt het automatisch bijwerken van het SSL-certificaat niet. Hiervoor moet de Api Management-service worden geconfigureerd met aka.ms/apimmsi. Het geheim moet van het type application/x-pkcs12 zijn tekenreeks
negotiateClientCertificate Geef true op om altijd te onderhandelen over het clientcertificaat op de hostnaam. De standaardwaarde is onwaar. booleaans
type Type hostnaam. 'ConfigurationApi'
'DeveloperPortal'
'Beheer'
'Portal'
'Proxy'
'Scm' (vereist)

RemotePrivateEndpointConnectionWrapper

Naam Beschrijving Waarde
id Resource-id van privé-eindpuntverbinding tekenreeks
naam Naam van privé-eindpuntverbinding tekenreeks
properties Resource-eigenschappen. PrivateEndpointConnectionWrapperEigenschappen
type Resourcetype privé-eindpuntverbinding tekenreeks

PrivateEndpointConnectionWrapperEigenschappen

Naam Beschrijving Waarde
privateEndpoint De resource van het privé-eindpunt. ArmIdWrapper
privateLinkServiceConnectionState Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider. PrivateLinkServiceConnectionState (vereist)

ArmIdWrapper

Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.

PrivateLinkServiceConnectionState

Naam Beschrijving Waarde
actionsRequired Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates voor de consument vereisen. tekenreeks
beschrijving De reden voor goedkeuring/afwijzing van de verbinding. tekenreeks
status Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service. 'Goedgekeurd'
'In behandeling'
'Geweigerd'

Snelstartsjablonen

Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.

Template Beschrijving
Exemplaar van API Management en alle subresources maken met behulp van sjabloon

Implementeren op Azure
Deze sjabloon laat zien hoe u een API Management-service maakt en subentiteiten configureert
API Management implementeren met een externe Azure Cache voor Redis

Implementeren op Azure
Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de verbruikslaag met een extern Azure Cache voor Redis-exemplaar als de API Management externe cache.
API Management implementeren in een extern VNet met een openbaar IP-adres

Implementeren op Azure
Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de Premium-laag binnen het subnet van uw virtuele netwerk in de externe modus en aanbevolen NSG-regels configureert op het subnet. Het exemplaar wordt geïmplementeerd in twee beschikbaarheidszones. De sjabloon configureert ook een openbaar IP-adres van uw abonnement.
Een API Management-exemplaar maken met aangepaste hostnamen

Implementeren op Azure
Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt met een aangepaste hostnaam voor de portal en meerdere aangepaste hostnamen voor de proxy
Maak API Management in een intern VNet met App Gateway

Implementeren op Azure
Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in een particulier netwerk dat wordt beveiligd door Azure Application Gateway.
Implementeer API Management in een intern VNet met een openbaar IP-adres

Implementeren op Azure
Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de Premium-laag binnen het subnet van uw virtuele netwerk in de interne modus en aanbevolen NSG-regels configureert op het subnet. Het exemplaar wordt geïmplementeerd in twee beschikbaarheidszones. De sjabloon configureert ook een openbaar IP-adres van uw abonnement.
Een API Management-exemplaar met MSI-identiteit maken

Implementeren op Azure
Met deze sjabloon maakt u een ontwikkelaarsexemplaar van Azure API Management met een MSI-identiteit
Een API Management-exemplaar van de Premium-laag voor meerdere regio's maken

Implementeren op Azure
Deze sjabloon laat zien hoe u een API Management-exemplaar met extra locaties maakt. De primaire locatie is hetzelfde als de locatie van de resourcegroep. Voor extra locaties toont de sjabloon NorthCentralUs en US - oost2. De primaire locatie moet afwijken van andere locaties.
Maak API Management met aangepaste proxy-SSL met KeyVault

Implementeren op Azure
In deze sjabloon ziet u hoe u een exemplaar van Azure API Management maakt en een aangepaste hostnaam voor de proxy configureert met een SSL-certificaat vanuit keyvault.
Een API Management service maken met SSL vanuit KeyVault

Implementeren op Azure
Met deze sjabloon wordt een API Management-service geïmplementeerd die is geconfigureerd met een door de gebruiker toegewezen identiteit. Deze identiteit wordt gebruikt om het SSL-certificaat op te halen uit KeyVault en wordt bijgewerkt door elke 4 uur te controleren.
API Management-exemplaar maken en bewaken

Implementeren op Azure
Met deze sjabloon maakt u een exemplaar van de Azure API Management-service en een Log Analytics-werkruimte en stelt u bewaking in voor uw API Management-service met Log Analytics
Een API Management-service met een privé-eindpunt maken

Implementeren op Azure
Met deze sjabloon maakt u een API Management-service, een virtueel netwerk en een privé-eindpunt dat de API Management-service beschikbaar maakt voor het virtuele netwerk.
API Management implementeren in Beschikbaarheidszones

Implementeren op Azure
Met deze sjabloon wordt een Premium-exemplaar van Azure API Management gemaakt en geïmplementeerd in een beschikbaarheidszone
Een API Management-exemplaar maken met behulp van een sjabloon

Implementeren op Azure
Met deze sjabloon wordt een ontwikkelaarsexemplaren van Azure API Management
Front Door Standard/Premium met API Management origin

Implementeren op Azure
Met deze sjabloon maakt u een Front Door Premium- en een API Management-exemplaar en maakt u gebruik van een NSG- en globaal API Management-beleid om te valideren dat verkeer via de oorsprong van Front Door is gekomen.
Azure Front Door maken vóór Azure API Management

Implementeren op Azure
In dit voorbeeld ziet u hoe u Azure Front Door gebruikt als een globale load balancer vóór Azure API Management.
Application Gateway met interne API Management en web-app

Implementeren op Azure
Application Gateway het routeren van internetverkeer naar een virtueel netwerk (interne modus) API Management exemplaar van een web-API die wordt gehost in een Azure-web-app.

Resourcedefinitie van ARM-sjabloon

Het serviceresourcetype kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/serviceresource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "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": {},
    "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" ]
}

Eigenschapswaarden

service

Naam Beschrijving Waarde
type Het resourcetype 'Microsoft.ApiManagement/service'
apiVersion De resource-API-versie '2023-03-01-preview'
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-50

Geldige tekens:
Alfanumeriek en afbreekstreepjes.

Begin met letter en eindig met alfanumeriek.

De resourcenaam moet uniek zijn in Azure.
location Resourcelocatie. tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku SKU-eigenschappen van de API Management-service. ApiManagementServiceSkuProperties (vereist)
identity Beheerde service-identiteit van de API Management-service. ApiManagementServiceIdentity
properties Eigenschappen van de API Management-service. ApiManagementServiceProperties (vereist)
Zones Een lijst met beschikbaarheidszones die aangeeft waar de resource vandaan moet komen. tekenreeks[]

ApiManagementServiceIdentity

Naam Beschrijving Waarde
type Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned, UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. 'Geen'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' (vereist)
userAssignedIdentities De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De gebruikersidentiteit
Sleutelverwijzingen in de woordenlijst zijn ARM-resource-id's in de vorm:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
object

ApiManagementServiceProperties

Naam Beschrijving Waarde
additionalLocations Aanvullende datacenterlocaties van de API Management-service. AdditionalLocation[]
apiVersionConstraint Versiebeperking besturingsvlak-API's voor de API Management-service. ApiVersionConstraint
certificaten Lijst met certificaten die moeten worden geïnstalleerd in de API Management-service. Het maximum aantal ondersteunde certificaten dat kan worden geïnstalleerd is 10. CertificateConfiguration[]
configurationApi Configuratie-API-configuratie van de API Management-service. ConfigurationApi
Customproperties Aangepaste eigenschappen van de API Management-service.
Met deze instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 wordt de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA uitgeschakeld voor alle TLS(1.0, 1.1 en 1.2).
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen.
De instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service.
De instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen voor communicatie met back-ends.
De instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen voor communicatie met back-ends.
De instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan worden gebruikt om het HTTP2-protocol in te schakelen op een API Management-service.
Als u geen van deze eigenschappen opgeeft tijdens de PATCH-bewerking, worden de waarden van de weggelaten eigenschappen opnieuw ingesteld op de standaardwaarden. Voor alle instellingen behalve Http2 is True de standaardwaarde als de service is gemaakt op of vóór 1 april 2018 en False anders. De standaardwaarde van de http2-instelling is False.

U kunt een van de volgende coderingen uitschakelen met behulp van instellingen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: 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. Bijvoorbeeld Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: :false. De standaardwaarde is true voor hen.
Opmerking: de volgende coderingen kunnen niet worden uitgeschakeld omdat ze vereist zijn voor interne platformonderdelen: 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
object
developerPortalStatus Status van ontwikkelaarsportal in deze API Management-service. 'Uitgeschakeld'
Ingeschakeld
disableGateway De eigenschap is alleen geldig voor een API Management-service die op meerdere locaties is geïmplementeerd. Dit kan worden gebruikt om de gateway in de hoofdregio uit te schakelen. booleaans
enableClientCertificate De eigenschap is alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Hiermee dwingt u af dat er een clientcertificaat wordt weergegeven bij elke aanvraag voor de gateway. Hierdoor kan het certificaat ook worden geverifieerd in het beleid op de gateway. booleaans
hostnameConfigurations Aangepaste hostnaamconfiguratie van de API Management-service. HostnameConfiguration[]
legacyPortalStatus Status van verouderde portal in de API Management-service. 'Uitgeschakeld'
Ingeschakeld
natGatewayState Eigenschap kan worden gebruikt om NAT-gateway in te schakelen voor deze API Management-service. 'Uitgeschakeld'
Ingeschakeld
notificationSenderEmail Email adres van waaruit de melding wordt verzonden. tekenreeks
privateEndpointConnections Lijst met privé-eindpuntverbindingen van deze service. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Ip-adres op basis van openbare standaard-SKU V4 dat moet worden gekoppeld aan Virtual Network geïmplementeerde service in de regio. Wordt alleen ondersteund voor ontwikkelaars en Premium-SKU's die worden geïmplementeerd in Virtual Network. tekenreeks
publicNetworkAccess Of openbare eindpunttoegang is toegestaan voor deze API Management-service. De waarde is optioneel, maar als deze wordt doorgegeven, moet deze 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als 'Uitgeschakeld' is, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld 'Uitgeschakeld'
Ingeschakeld
publisherEmail E-mailadres van uitgever. tekenreeks (vereist)
publisherName Naam van uitgever. tekenreeks (vereist)
De pagina Restore Verwijder de API Management-service ongedaan als deze eerder voorlopig is verwijderd. Als deze vlag is opgegeven en is ingesteld op Waar, worden alle andere eigenschappen genegeerd. booleaans
virtualNetworkConfiguration Configuratie van het virtuele netwerk van de API Management-service. VirtualNetworkConfiguration
virtualNetworkType Het type VPN waarin API Management service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een Virtual Network, extern betekent dat de API Management-implementatie is ingesteld binnen een Virtual Network met een internetgericht eindpunt en Intern betekent dat API Management implementatie wordt ingesteld binnen een Virtual Network alleen een intranetgericht eindpunt heeft. Extern
'Intern'
'Geen'

AdditionalLocation

Naam Beschrijving Waarde
disableGateway De eigenschap is alleen geldig voor een API Management-service die op meerdere locaties is geïmplementeerd. Dit kan worden gebruikt om de gateway op deze extra locatie uit te schakelen. booleaans
location De locatienaam van de extra regio tussen Azure Data Center-regio's. tekenreeks (vereist)
natGatewayState Eigenschap kan worden gebruikt om NAT-gateway in te schakelen voor deze API Management-service. 'Uitgeschakeld'
Ingeschakeld
publicIpAddressId Ip-adres V4 van de openbare standaard-SKU dat moet worden gekoppeld aan Virtual Network geïmplementeerde service op de locatie. Wordt alleen ondersteund voor Premium SKU die wordt geïmplementeerd in Virtual Network. tekenreeks
sku SKU-eigenschappen van de API Management-service. ApiManagementServiceSkuProperties (vereist)
virtualNetworkConfiguration Configuratie van virtueel netwerk voor de locatie. VirtualNetworkConfiguration
Zones Een lijst met beschikbaarheidszones die aangeeft waar de resource vandaan moet komen. tekenreeks[]

ApiManagementServiceSkuProperties

Naam Beschrijving Waarde
capacity Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU). Voor Verbruik SKU-capaciteit moet worden opgegeven als 0. int (vereist)
naam Naam van de SKU. 'Basic'
'Verbruik'
'Ontwikkelaar'
'Geïsoleerd'
Premium
Standaard (vereist)

VirtualNetworkConfiguration

Naam Beschrijving Waarde
subnetResourceId De volledige resource-id van een subnet in een virtueel netwerk om de API Management-service in te implementeren. tekenreeks

ApiVersionConstraint

Naam Beschrijving Waarde
minApiVersion Beperk API-aanroepen van besturingsvlak naar API Management-service met een versie die gelijk is aan of nieuwer is dan deze waarde. tekenreeks

CertificateConfiguration

Naam Beschrijving Waarde
certificaat Certificaatgegevens. Certificaatinformatie
certificatePassword Certificaatwachtwoord. tekenreeks
encodedCertificate Base64-gecodeerd certificaat. tekenreeks
storeName De locatie van het certificaatarchief System.Security.Cryptography.x509certificates.StoreName. Alleen Root en CertificateAuthority zijn geldige locaties. 'CertificateAuthority'
'Root' (vereist)

Certificaatinformatie

Naam Beschrijving Waarde
Verstrijken Vervaldatum van het certificaat. De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard. tekenreeks (vereist)
onderwerp Onderwerp van het certificaat. tekenreeks (vereist)
Vingerafdruk Vingerafdruk van het certificaat. tekenreeks (vereist)

ConfigurationApi

Naam Beschrijving Waarde
legacyApi Indicatie of de verouderde configuratie-API (v1) moet worden weergegeven op de API Management-service. De waarde is optioneel, maar moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als 'uitgeschakeld' is, is verouderde configuratie-API (v1) niet beschikbaar voor zelf-hostende gateways. De standaardwaarde is Ingeschakeld 'Uitgeschakeld'
Ingeschakeld

HostnaamConfiguratie

Naam Beschrijving Waarde
certificaat Certificaatgegevens. Certificaatinformatie
certificatePassword Certificaatwachtwoord. tekenreeks
certificateSource Certificaatbron. 'BuiltIn'
'Aangepast'
'KeyVault'
'Beheerd'
certificateStatus Certificaatstatus. 'Voltooid'
'Mislukt'
'InProgress'
defaultSslBinding Geef true op om het certificaat dat is gekoppeld aan deze hostnaam in te stellen als het standaard-SSL-certificaat. Als een client de SNI-header niet verzendt, is dit het certificaat dat wordt aangevochten. De eigenschap is handig als voor een service meerdere aangepaste hostnamen zijn ingeschakeld en deze moet beslissen over het standaard SSL-certificaat. De instelling wordt alleen toegepast op het hostnaamtype van de gateway. booleaans
encodedCertificate Base64-gecodeerd certificaat. tekenreeks
Hostname Hostnaam die moet worden geconfigureerd in de API Management-service. tekenreeks (vereist)
identityClientId ClientId van door het systeem of door de gebruiker toegewezen beheerde identiteit zoals gegenereerd door Azure AD, die GET-toegang heeft tot de keyVault die het SSL-certificaat bevat. tekenreeks
keyVaultId URL naar het KeyVault-geheim met het SSL-certificaat. Als absolute URL met versie is opgegeven, werkt het automatisch bijwerken van het SSL-certificaat niet. Hiervoor moet de API Management-service worden geconfigureerd met aka.ms/apimmsi. Het geheim moet van het type application/x-pkcs12 zijn tekenreeks
negotiateClientCertificate Geef waar op om altijd te onderhandelen over het clientcertificaat op de hostnaam. De standaardwaarde is false. booleaans
type Hostnaamtype. 'ConfigurationApi'
'DeveloperPortal'
'Beheer'
'Portal'
Proxy
'Scm' (vereist)

RemotePrivateEndpointConnectionWrapper

Naam Beschrijving Waarde
id Resource-id van privé-eindpuntverbinding tekenreeks
naam Naam van privé-eindpuntverbinding tekenreeks
properties Resource-eigenschappen. PrivateEndpointConnectionWrapperProperties
type Resourcetype privé-eindpuntverbinding tekenreeks

PrivateEndpointConnectionWrapperProperties

Naam Beschrijving Waarde
privateEndpoint De resource van het privé-eindpunt. ArmIdWrapper
privateLinkServiceConnectionState Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider. PrivateLinkServiceConnectionState (vereist)

ArmIdWrapper

Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.

PrivateLinkServiceConnectionState

Naam Beschrijving Waarde
actionsRequired Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates van de consument vereisen. tekenreeks
beschrijving De reden voor goedkeuring/afwijzing van de verbinding. tekenreeks
status Hiermee wordt aangegeven of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service. 'Goedgekeurd'
'In behandeling'
'Geweigerd'

Snelstartsjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Template Beschrijving
Exemplaar van API Management en alle subresources maken met behulp van sjabloon

Implementeren op Azure
Deze sjabloon laat zien hoe u een API Management-service maakt en subentiteiten configureert
API Management implementeren met een externe Azure Cache voor Redis

Implementeren op Azure
Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de laag Verbruik met een extern Azure Cache voor Redis-exemplaar als de API Management externe cache.
API Management implementeren in een extern VNet met een openbaar IP-adres

Implementeren op Azure
Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de Premium-laag binnen het subnet van uw virtuele netwerk in de externe modus en aanbevolen NSG-regels voor het subnet configureert. Het exemplaar wordt geïmplementeerd in twee beschikbaarheidszones. De sjabloon configureert ook een openbaar IP-adres van uw abonnement.
Een API Management-exemplaar met aangepaste hostnamen maken

Implementeren op Azure
Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt met een aangepaste hostnaam voor de portal en meerdere aangepaste hostnamen voor proxy
API Management maken in een intern VNet met App Gateway

Implementeren op Azure
Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in een particulier netwerk dat wordt beveiligd door Azure Application Gateway.
Implementeer API Management in een intern VNet met een openbaar IP-adres

Implementeren op Azure
Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de Premium-laag binnen het subnet van uw virtuele netwerk in de interne modus en aanbevolen NSG-regels configureert op het subnet. Het exemplaar wordt geïmplementeerd in twee beschikbaarheidszones. De sjabloon configureert ook een openbaar IP-adres van uw abonnement.
Een API Management-exemplaar met MSI-identiteit maken

Implementeren op Azure
Met deze sjabloon maakt u een ontwikkelaarsexemplaar van Azure API Management met een MSI-identiteit
Een API Management-exemplaar van de Premium-laag voor meerdere regio's maken

Implementeren op Azure
Deze sjabloon laat zien hoe u een API Management-exemplaar met extra locaties maakt. De primaire locatie is hetzelfde als de locatie van de resourcegroep. Voor extra locaties toont de sjabloon NorthCentralUs en US - oost2. De primaire locatie moet afwijken van andere locaties.
Maak API Management met aangepaste proxy-SSL met KeyVault

Implementeren op Azure
In deze sjabloon ziet u hoe u een exemplaar van Azure API Management maakt en een aangepaste hostnaam voor de proxy configureert met een SSL-certificaat vanuit keyvault.
Een API Management service maken met SSL vanuit KeyVault

Implementeren op Azure
Met deze sjabloon wordt een API Management-service geïmplementeerd die is geconfigureerd met door de gebruiker toegewezen identiteit. Deze identiteit wordt gebruikt om het SSL-certificaat op te halen uit KeyVault en het wordt bijgewerkt door elke 4 uur te controleren.
API Management-exemplaar maken en bewaken

Implementeren op Azure
Met deze sjabloon maakt u een exemplaar van de Azure API Management-service en Log Analytics-werkruimte en stelt u bewaking in voor uw API Management-service met Log Analytics
Een API Management-service met een privé-eindpunt maken

Implementeren op Azure
Met deze sjabloon maakt u een API Management-service, een virtueel netwerk en een privé-eindpunt dat de API Management-service beschikbaar maakt voor het virtuele netwerk.
API Management implementeren in Beschikbaarheidszones

Implementeren op Azure
Met deze sjabloon wordt een Premium-exemplaar van Azure API Management gemaakt en geïmplementeerd in een beschikbaarheidszone
Een API Management-exemplaar maken met behulp van een sjabloon

Implementeren op Azure
Met deze sjabloon maakt u een ontwikkelaarsexemplaar van Azure API Management
Front Door Standard/Premium met API Management origin

Implementeren op Azure
Met deze sjabloon maakt u een Front Door Premium- en een API Management-exemplaar en maakt u gebruik van een NSG en globaal API Management-beleid om te controleren of verkeer via de oorsprong van Front Door is gekomen.
Azure Front Door maken vóór Azure API Management

Implementeren op Azure
In dit voorbeeld ziet u hoe u Azure Front Door gebruikt als een globale load balancer vóór Azure API Management.
Application Gateway met interne API Management en web-app

Implementeren op Azure
Application Gateway het routeren van internetverkeer naar een virtueel netwerk (interne modus) API Management exemplaar waarmee een web-API wordt gehost in een Azure-web-app.

Terraform-resourcedefinitie (AzAPI-provider)

Het serviceresourcetype kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/serviceresource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2023-03-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 = {}
      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"
    }
  })
}

Eigenschapswaarden

service

Naam Beschrijving Waarde
type Het resourcetype "Microsoft.ApiManagement/service@2023-03-01-preview"
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-50

Geldige tekens:
Alfanumerieken en afbreekstreepjes.

Begin met letter en eindig met alfanumeriek.

De resourcenaam moet uniek zijn in Azure.
location Resourcelocatie. tekenreeks (vereist)
parent_id Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden.
sku SKU-eigenschappen van de API Management-service. ApiManagementServiceSkuProperties (vereist)
identity Beheerde service-identiteit van de Api Management-service. ApiManagementServiceIdentity
properties Eigenschappen van de API Management-service. ApiManagementServiceProperties (vereist)
Zones Een lijst met beschikbaarheidszones die aangeven waar de resource vandaan moet komen. tekenreeks[]

ApiManagementServiceIdentity

Naam Beschrijving Waarde
type Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned, UserAssigned' omvat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. "SystemAssigned"
"SystemAssigned, UserAssigned"
'UserAssigned' (vereist)
identity_ids De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De gebruikersidentiteit
Sleutelverwijzingen in woordenlijst zijn ARM-resource-id's in de vorm:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Matrix met gebruikersidentiteits-id's.

ApiManagementServiceProperties

Naam Beschrijving Waarde
additionalLocations Aanvullende datacenterlocaties van de API Management-service. AdditionalLocation[]
apiVersionConstraint Versiebeperking besturingsvlak-API's voor de API Management-service. ApiVersionConstraint
certificaten Lijst met certificaten die moeten worden geïnstalleerd in de API Management-service. Het maximum aantal ondersteunde certificaten dat kan worden geïnstalleerd is 10. CertificateConfiguration[]
configurationApi Configuratie-API-configuratie van de API Management-service. ConfigurationApi
Customproperties Aangepaste eigenschappen van de API Management-service.
Met deze instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 wordt de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA uitgeschakeld voor alle TLS(1.0, 1.1 en 1.2).
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen.
De instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service.
De instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen voor communicatie met back-ends.
De instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen voor communicatie met back-ends.
De instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan worden gebruikt om het HTTP2-protocol in te schakelen op een API Management-service.
Als u geen van deze eigenschappen opgeeft tijdens de PATCH-bewerking, worden de waarden van de weggelaten eigenschappen opnieuw ingesteld op de standaardwaarden. Voor alle instellingen behalve Http2 is True de standaardwaarde als de service is gemaakt op of vóór 1 april 2018 en False anders. De standaardwaarde van de http2-instelling is False.

U kunt een van de volgende coderingen uitschakelen met behulp van instellingen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: 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. Bijvoorbeeld Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: :false. De standaardwaarde is true voor hen.
Opmerking: de volgende coderingen kunnen niet worden uitgeschakeld omdat ze vereist zijn voor interne platformonderdelen: 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
object
developerPortalStatus Status van ontwikkelaarsportal in deze API Management-service. "Uitgeschakeld"
"Ingeschakeld"
disableGateway De eigenschap is alleen geldig voor een API Management-service die op meerdere locaties is geïmplementeerd. Dit kan worden gebruikt om de gateway in de hoofdregio uit te schakelen. booleaans
enableClientCertificate De eigenschap is alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Hiermee dwingt u af dat er een clientcertificaat wordt weergegeven bij elke aanvraag voor de gateway. Hierdoor kan het certificaat ook worden geverifieerd in het beleid op de gateway. booleaans
hostnameConfigurations Aangepaste hostnaamconfiguratie van de API Management-service. HostnameConfiguration[]
legacyPortalStatus Status van verouderde portal in de API Management-service. "Uitgeschakeld"
"Ingeschakeld"
natGatewayState Eigenschap kan worden gebruikt om NAT-gateway in te schakelen voor deze API Management-service. "Uitgeschakeld"
"Ingeschakeld"
notificationSenderEmail Email adres van waaruit de melding wordt verzonden. tekenreeks
privateEndpointConnections Lijst met privé-eindpuntverbindingen van deze service. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Ip-adres op basis van openbare standaard-SKU V4 dat moet worden gekoppeld aan Virtual Network geïmplementeerde service in de regio. Wordt alleen ondersteund voor ontwikkelaars en Premium-SKU's die worden geïmplementeerd in Virtual Network. tekenreeks
publicNetworkAccess Of openbare eindpunttoegang is toegestaan voor deze API Management-service. De waarde is optioneel, maar als deze wordt doorgegeven, moet deze 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als 'Uitgeschakeld' is, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld "Uitgeschakeld"
"Ingeschakeld"
publisherEmail E-mailadres van uitgever. tekenreeks (vereist)
publisherName Naam van uitgever. tekenreeks (vereist)
De pagina Restore Verwijder de API Management-service ongedaan als deze eerder voorlopig is verwijderd. Als deze vlag is opgegeven en is ingesteld op Waar, worden alle andere eigenschappen genegeerd. booleaans
virtualNetworkConfiguration Configuratie van het virtuele netwerk van de API Management-service. VirtualNetworkConfiguration
virtualNetworkType Het type VPN waarin API Management service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een Virtual Network, extern betekent dat de API Management-implementatie is ingesteld binnen een Virtual Network met een internetgericht eindpunt en Intern betekent dat API Management implementatie wordt ingesteld binnen een Virtual Network alleen een intranetgericht eindpunt heeft. "Extern"
"Intern"
"Geen"

AdditionalLocation

Naam Beschrijving Waarde
disableGateway De eigenschap is alleen geldig voor een API Management-service die op meerdere locaties is geïmplementeerd. Dit kan worden gebruikt om de gateway op deze extra locatie uit te schakelen. booleaans
location De locatienaam van de extra regio tussen Azure Data Center-regio's. tekenreeks (vereist)
natGatewayState Eigenschap kan worden gebruikt om NAT-gateway in te schakelen voor deze API Management-service. "Uitgeschakeld"
"Ingeschakeld"
publicIpAddressId Ip-adres V4 van de openbare standaard-SKU dat moet worden gekoppeld aan Virtual Network geïmplementeerde service op de locatie. Wordt alleen ondersteund voor Premium SKU die wordt geïmplementeerd in Virtual Network. tekenreeks
sku SKU-eigenschappen van de API Management-service. ApiManagementServiceSkuProperties (vereist)
virtualNetworkConfiguration Configuratie van virtueel netwerk voor de locatie. VirtualNetworkConfiguration
Zones Een lijst met beschikbaarheidszones die aangeeft waar de resource vandaan moet komen. tekenreeks[]

ApiManagementServiceSkuProperties

Naam Beschrijving Waarde
capacity Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU). Voor Verbruik SKU-capaciteit moet worden opgegeven als 0. int (vereist)
naam Naam van de SKU. "Basis"
"Verbruik"
"Ontwikkelaar"
"Geïsoleerd"
"Premium"
"Standaard" (vereist)

VirtualNetworkConfiguration

Naam Beschrijving Waarde
subnetResourceId De volledige resource-id van een subnet in een virtueel netwerk om de API Management-service in te implementeren. tekenreeks

ApiVersionConstraint

Naam Beschrijving Waarde
minApiVersion Beperk API-aanroepen van besturingsvlak naar API Management-service met een versie die gelijk is aan of nieuwer is dan deze waarde. tekenreeks

CertificateConfiguration

Naam Beschrijving Waarde
certificaat Certificaatgegevens. Certificaatinformatie
certificatePassword Certificaatwachtwoord. tekenreeks
encodedCertificate Base64-gecodeerd certificaat. tekenreeks
storeName De locatie van het certificaatarchief System.Security.Cryptography.x509certificates.StoreName. Alleen Root en CertificateAuthority zijn geldige locaties. "CertificateAuthority"
"Root" (vereist)

Certificaatinformatie

Naam Beschrijving Waarde
Verstrijken Vervaldatum van het certificaat. De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard. tekenreeks (vereist)
onderwerp Onderwerp van het certificaat. tekenreeks (vereist)
Vingerafdruk Vingerafdruk van het certificaat. tekenreeks (vereist)

ConfigurationApi

Naam Beschrijving Waarde
legacyApi Indicatie of de verouderde configuratie-API (v1) moet worden weergegeven op de API Management-service. De waarde is optioneel, maar moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als 'uitgeschakeld' is, is verouderde configuratie-API (v1) niet beschikbaar voor zelf-hostende gateways. De standaardwaarde is Ingeschakeld "Uitgeschakeld"
"Ingeschakeld"

HostnaamConfiguratie

Naam Beschrijving Waarde
certificaat Certificaatgegevens. CertificateInformation
certificatePassword Certificaatwachtwoord. tekenreeks
certificateSource Certificaatbron. "Ingebouwd"
"Aangepast"
"KeyVault"
"Beheerd"
certificateStatus Certificaatstatus. "Voltooid"
"Mislukt"
"InProgress"
defaultSslBinding Geef true op om het certificaat dat aan deze hostnaam is gekoppeld in te stellen als het standaard-SSL-certificaat. Als een client de SNI-header niet verzendt, is dit het certificaat dat wordt aangevochten. De eigenschap is handig als voor een service meerdere aangepaste hostnamen zijn ingeschakeld en het standaard SSL-certificaat moet worden bepaald. De instelling wordt alleen toegepast op het hostnaamtype van de gateway. booleaans
encodedCertificate Base64-gecodeerd certificaat. tekenreeks
Hostname Hostnaam die moet worden geconfigureerd in de API Management-service. tekenreeks (vereist)
identityClientId ClientId van door het systeem of door de gebruiker toegewezen beheerde identiteit zoals gegenereerd door Azure AD, die get-toegang heeft tot de keyVault die het SSL-certificaat bevat. tekenreeks
keyVaultId URL naar het KeyVault-geheim met het SSL-certificaat. Als er een absolute URL met versie wordt opgegeven, werkt het automatisch bijwerken van het SSL-certificaat niet. Hiervoor moet de Api Management-service worden geconfigureerd met aka.ms/apimmsi. Het geheim moet van het type application/x-pkcs12 zijn tekenreeks
negotiateClientCertificate Geef true op om altijd te onderhandelen over het clientcertificaat op de hostnaam. De standaardwaarde is onwaar. booleaans
type Type hostnaam. "ConfigurationApi"
"DeveloperPortal"
"Beheer"
"Portal"
"Proxy"
"Scm" (vereist)

RemotePrivateEndpointConnectionWrapper

Naam Beschrijving Waarde
id Resource-id van privé-eindpuntverbinding tekenreeks
naam Naam van privé-eindpuntverbinding tekenreeks
properties Resource-eigenschappen. PrivateEndpointConnectionWrapperEigenschappen
type Resourcetype privé-eindpuntverbinding tekenreeks

PrivateEndpointConnectionWrapperEigenschappen

Naam Beschrijving Waarde
privateEndpoint De resource van het privé-eindpunt. ArmIdWrapper
privateLinkServiceConnectionState Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider. PrivateLinkServiceConnectionState (vereist)

ArmIdWrapper

Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.

PrivateLinkServiceConnectionState

Naam Beschrijving Waarde
actionsRequired Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates voor de consument vereisen. tekenreeks
beschrijving De reden voor goedkeuring/afwijzing van de verbinding. tekenreeks
status Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service. "Goedgekeurd"
"In behandeling"
"Geweigerd"