Delen via

Microsoft.ApiManagement-service

  • Artikel

Bicep-resourcedefinitie

Het resourcetype van de service kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor 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-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'
  ]
}

Eigenschapswaarden

dienst

Naam Beschrijving Waarde
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-50

Geldige tekens:
Alfanumerieke en afbreekstreepjes.

Begin met letter en eindig met alfanumeriek.

De resourcenaam moet uniek zijn in Azure.
plaats Resourcelocatie. tekenreeks (vereist)
Tags Resourcetags. Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
Sku SKU-eigenschappen van de API Management-service. ApiManagementServiceSkuProperties (vereist)
identiteit Beheerde service-identiteit van de Api Management-service. ApiManagementServiceIdentity-
Eigenschappen 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 wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None 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
Verwijzingen naar woordenlijstsleutels zijn ARM-resource-id's in de vorm:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde
{aangepaste eigenschap} UserIdentityProperties-

UserIdentityProperties

Naam Beschrijving Waarde
clientId De client-id van de door de gebruiker toegewezen identiteit. snaar
principalId De principal-id van de door de gebruiker toegewezen identiteit. snaar

ApiManagementServiceProperties

Naam Beschrijving Waarde
additionalLocations Aanvullende datacenterlocaties van de API Management-service. AdditionalLocation[]
apiVersionConstraint Besturingselementvlak api's versiebeperking 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.
Als u Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 instelt, worden de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA voor alle TLS(1.0, 1.1 en 1.2) uitgeschakeld.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen voor communicatie met back-ends.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen voor communicatie met back-ends.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan worden gebruikt om het HTTP2-protocol in te schakelen voor een API Management-service.
Als u geen van deze eigenschappen opgeeft tijdens de PATCH-bewerking, worden de waarden van de weggelaten eigenschappen teruggezet op de standaardwaarden. Voor alle instellingen behalve Http2 wordt de standaardwaarde True als de service is gemaakt op of vóór 1 april 2018 en anders False. 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 deze waarden.
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		 ApiManagementServiceBasePropertiesCustomProperties
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. Bool
enableClientCertificate De eigenschap is alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Hiermee wordt afgedwongen dat een clientcertificaat wordt weergegeven bij elke aanvraag voor de gateway. Hiermee kunt u ook het certificaat verifiëren in het beleid op de gateway. Bool
hostnameConfigurations Aangepaste hostnaamconfiguratie van de API Management-service. HostnameConfiguration[]
legacyPortalStatus Status van verouderde portal in de API Management-service. 'Uitgeschakeld'
'Ingeschakeld'
natGatewayState De eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service. 'Uitgeschakeld'
'Ingeschakeld'
notificationSenderEmail E-mailadres van waaruit de melding wordt verzonden. snaar

Beperkingen:
Maximale lengte = 100
privateEndpointConnections Lijst met privé-eindpuntverbindingen van deze service. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Openbare standaard-SKU IP V4 gebaseerd IP-adres dat moet worden gekoppeld aan de service Virtual Network geïmplementeerd in de regio. Alleen ondersteund voor ontwikkelaars en Premium-SKU's die worden geïmplementeerd in Virtual Network. snaar
publicNetworkAccess Of openbare eindpunttoegang wel of niet is toegestaan voor deze API Management-service. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als deze optie is uitgeschakeld, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld 'Uitgeschakeld'
'Ingeschakeld'
publisherEmail E-mail van Publisher. tekenreeks (vereist)

Beperkingen:
Maximale lengte = 100
publisherName Naam van uitgever. tekenreeks (vereist)

Beperkingen:
Maximale lengte = 100
herstellen De Api Management-service ongedaan maken als deze eerder voorlopig is verwijderd. Als deze vlag is opgegeven en is ingesteld op Waar, worden alle andere eigenschappen genegeerd. Bool
virtualNetworkConfiguration Configuratie van virtueel netwerk van de API Management-service. VirtualNetworkConfiguration-
virtualNetworkType Het type VPN waarin de API Management-service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een virtueel netwerk, extern betekent dat de API Management-implementatie is ingesteld binnen een virtueel netwerk met een internetgericht eindpunt en intern betekent dat de API Management-implementatie alleen is ingesteld in een virtueel netwerk met alleen een intranetgericht eindpunt. '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. Bool
plaats De locatienaam van de extra regio tussen Azure Data Center-regio's. tekenreeks (vereist)
natGatewayState De eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service. 'Uitgeschakeld'
'Ingeschakeld'
publicIpAddressId Openbare standaard-SKU IP V4 gebaseerd IP-adres dat moet worden gekoppeld aan de service virtual network geïmplementeerd op de locatie. Alleen ondersteund voor Premium SKU die wordt geïmplementeerd in Virtual Network. snaar
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
capaciteit Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU). Voor verbruiks-SKU-capaciteit moet worden opgegeven als 0. int (vereist)
naam Naam van de SKU. 'Standaard'
WorkspaceGatewayPremium
WorkspaceGatewayStandard (vereist)

VirtualNetworkConfiguration

Naam Beschrijving Waarde
subnetResourceId De volledige resource-id van een subnet in een virtueel netwerk waarin de API Management-service wordt geïmplementeerd. snaar

Beperkingen:
Patroon = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

ApiVersionConstraint

Naam Beschrijving Waarde
minApiVersion Beperk API-aanroepen naar API Management-service met een versie die gelijk is aan of hoger is dan deze waarde. snaar

CertificateConfiguration

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

CertificateInformation

Naam Beschrijving Waarde
Verstrijken Vervaldatum van het certificaat. De datum voldoet aan de volgende indeling: 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) al dan niet moet worden weergegeven in de API Management-service. Waarde is optioneel, maar moet zijn ingeschakeld of uitgeschakeld. Als 'Uitgeschakeld' is, is verouderde configuratie-API (v1) niet beschikbaar voor zelf-hostende gateways. De standaardwaarde is Ingeschakeld 'Uitgeschakeld'
'Ingeschakeld'

ApiManagementServiceBasePropertiesCustomProperties

Naam Beschrijving Waarde
{aangepaste eigenschap} snaar

HostnameConfiguration

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

RemotePrivateEndpointConnectionWrapper

Naam Beschrijving Waarde
legitimatiebewijs Resource-id voor privé-eindpuntverbinding snaar
naam Naam van privé-eindpuntverbinding snaar
Eigenschappen Resource-eigenschappen. PrivateEndpointConnectionWrapperProperties-
type Resourcetype voor privé-eindpuntverbinding snaar

PrivateEndpointConnectionWrapperProperties

Naam Beschrijving Waarde
privateEndpoint De resource van het privé-eindpunt. ArmIdWrapper
privateLinkServiceConnectionState Een verzameling informatie over de status van de verbinding tussen serviceconsumer en 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 dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen. snaar
beschrijving De reden voor goedkeuring/afwijzing van de verbinding. snaar
status Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service. 'Goedgekeurd'
'In behandeling'
'Geweigerd'

Quickstart-sjablonen

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

Sjabloon Beschrijving
Een API Management-exemplaar en alle subbronnen maken met behulp van sjabloon-

implementeren in 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 in Azure 		Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de verbruikslaag met een extern Exemplaar van Azure Cache voor Redis als de externe API Management-cache.
API Management implementeren in een extern VNet met openbare IP-

implementeren in 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. Met de sjabloon wordt ook een openbaar IP-adres van uw abonnement geconfigureerd.
Een API Management-exemplaar maken met aangepaste hostnamen

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

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

implementeren in 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. Met de sjabloon wordt ook een openbaar IP-adres van uw abonnement geconfigureerd.
Een API Management-exemplaar maken met MSI Identity

implementeren in Azure 		Met deze sjabloon maakt u een ontwikkelaarsexemplaren van Azure API Management met een MSI-identiteit
Een API Management-exemplaar met meerdere regio's maken

implementeren in Azure 		Deze sjabloon laat zien hoe u een API Management-exemplaar maakt met extra locaties. De primaire locatie is hetzelfde als de locatie van de resourcegroep. Voor extra locaties toont de sjabloon NorthCentralUs en VS - oost2. De primaire locatie moet afwijken van extra locaties.
API Management maken met aangepaste proxy ssl met behulp van KeyVault

implementeren in Azure 		Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt en aangepaste hostnaam configureert voor proxy met ssl-certificaat vanuit keyvault.
Een API Management-service maken met SSL vanuit KeyVault

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

implementeren in 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 maken met een privé-eindpunt

implementeren in 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 in Azure 		Met deze sjabloon maakt u een Premium-exemplaar van Azure API Management en implementeert u deze in een beschikbaarheidszone
Een API Management-exemplaar maken met behulp van een sjabloon

implementeren in Azure 		Met deze sjabloon maakt u een ontwikkelaarsexemplaren van Azure API Management
Front Door Standard/Premium met API Management-oorsprong

implementeren in Azure 		Met deze sjabloon maakt u een Front Door Premium en een API Management-exemplaar en gebruikt u een NSG- en globaal API Management-beleid om te valideren dat verkeer afkomstig is van de Front Door-oorsprong.
Azure Front Door maken vóór Azure API Management

implementeren in Azure 		In dit voorbeeld ziet u hoe u Azure Front Door gebruikt als een globale load balancer voor Azure API Management.
Application Gateway met interne API Management en Web App

implementeren in Azure 		Application Gateway: internetverkeer routeren naar een API Management-exemplaar van een virtueel netwerk (interne modus) dat een web-API services die wordt gehost in een Azure-web-app.

Resourcedefinitie van ARM-sjabloon

Het resourcetype van de service kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor 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-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" ]
}

Eigenschapswaarden

dienst

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

Tekenlimiet: 1-50

Geldige tekens:
Alfanumerieke en afbreekstreepjes.

Begin met letter en eindig met alfanumeriek.

De resourcenaam moet uniek zijn in Azure.
plaats Resourcelocatie. tekenreeks (vereist)
Tags Resourcetags. Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
Sku SKU-eigenschappen van de API Management-service. ApiManagementServiceSkuProperties (vereist)
identiteit Beheerde service-identiteit van de Api Management-service. ApiManagementServiceIdentity-
Eigenschappen 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 wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None 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
Verwijzingen naar woordenlijstsleutels zijn ARM-resource-id's in de vorm:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde
{aangepaste eigenschap} UserIdentityProperties-

UserIdentityProperties

Naam Beschrijving Waarde
clientId De client-id van de door de gebruiker toegewezen identiteit. snaar
principalId De principal-id van de door de gebruiker toegewezen identiteit. snaar

ApiManagementServiceProperties

Naam Beschrijving Waarde
additionalLocations Aanvullende datacenterlocaties van de API Management-service. AdditionalLocation[]
apiVersionConstraint Besturingselementvlak api's versiebeperking 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.
Als u Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 instelt, worden de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA voor alle TLS(1.0, 1.1 en 1.2) uitgeschakeld.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen voor communicatie met back-ends.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen voor communicatie met back-ends.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan worden gebruikt om het HTTP2-protocol in te schakelen voor een API Management-service.
Als u geen van deze eigenschappen opgeeft tijdens de PATCH-bewerking, worden de waarden van de weggelaten eigenschappen teruggezet op de standaardwaarden. Voor alle instellingen behalve Http2 wordt de standaardwaarde True als de service is gemaakt op of vóór 1 april 2018 en anders False. 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 deze waarden.
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		 ApiManagementServiceBasePropertiesCustomProperties
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. Bool
enableClientCertificate De eigenschap is alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Hiermee wordt afgedwongen dat een clientcertificaat wordt weergegeven bij elke aanvraag voor de gateway. Hiermee kunt u ook het certificaat verifiëren in het beleid op de gateway. Bool
hostnameConfigurations Aangepaste hostnaamconfiguratie van de API Management-service. HostnameConfiguration[]
legacyPortalStatus Status van verouderde portal in de API Management-service. 'Uitgeschakeld'
'Ingeschakeld'
natGatewayState De eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service. 'Uitgeschakeld'
'Ingeschakeld'
notificationSenderEmail E-mailadres van waaruit de melding wordt verzonden. snaar

Beperkingen:
Maximale lengte = 100
privateEndpointConnections Lijst met privé-eindpuntverbindingen van deze service. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Openbare standaard-SKU IP V4 gebaseerd IP-adres dat moet worden gekoppeld aan de service Virtual Network geïmplementeerd in de regio. Alleen ondersteund voor ontwikkelaars en Premium-SKU's die worden geïmplementeerd in Virtual Network. snaar
publicNetworkAccess Of openbare eindpunttoegang wel of niet is toegestaan voor deze API Management-service. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als deze optie is uitgeschakeld, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld 'Uitgeschakeld'
'Ingeschakeld'
publisherEmail E-mail van Publisher. tekenreeks (vereist)

Beperkingen:
Maximale lengte = 100
publisherName Naam van uitgever. tekenreeks (vereist)

Beperkingen:
Maximale lengte = 100
herstellen De Api Management-service ongedaan maken als deze eerder voorlopig is verwijderd. Als deze vlag is opgegeven en is ingesteld op Waar, worden alle andere eigenschappen genegeerd. Bool
virtualNetworkConfiguration Configuratie van virtueel netwerk van de API Management-service. VirtualNetworkConfiguration-
virtualNetworkType Het type VPN waarin de API Management-service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een virtueel netwerk, extern betekent dat de API Management-implementatie is ingesteld binnen een virtueel netwerk met een internetgericht eindpunt en intern betekent dat de API Management-implementatie alleen is ingesteld in een virtueel netwerk met alleen een intranetgericht eindpunt. '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. Bool
plaats De locatienaam van de extra regio tussen Azure Data Center-regio's. tekenreeks (vereist)
natGatewayState De eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service. 'Uitgeschakeld'
'Ingeschakeld'
publicIpAddressId Openbare standaard-SKU IP V4 gebaseerd IP-adres dat moet worden gekoppeld aan de service virtual network geïmplementeerd op de locatie. Alleen ondersteund voor Premium SKU die wordt geïmplementeerd in Virtual Network. snaar
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
capaciteit Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU). Voor verbruiks-SKU-capaciteit moet worden opgegeven als 0. int (vereist)
naam Naam van de SKU. 'Standaard'
WorkspaceGatewayPremium
WorkspaceGatewayStandard (vereist)

VirtualNetworkConfiguration

Naam Beschrijving Waarde
subnetResourceId De volledige resource-id van een subnet in een virtueel netwerk waarin de API Management-service wordt geïmplementeerd. snaar

Beperkingen:
Patroon = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

ApiVersionConstraint

Naam Beschrijving Waarde
minApiVersion Beperk API-aanroepen naar API Management-service met een versie die gelijk is aan of hoger is dan deze waarde. snaar

CertificateConfiguration

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

CertificateInformation

Naam Beschrijving Waarde
Verstrijken Vervaldatum van het certificaat. De datum voldoet aan de volgende indeling: 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) al dan niet moet worden weergegeven in de API Management-service. Waarde is optioneel, maar moet zijn ingeschakeld of uitgeschakeld. Als 'Uitgeschakeld' is, is verouderde configuratie-API (v1) niet beschikbaar voor zelf-hostende gateways. De standaardwaarde is Ingeschakeld 'Uitgeschakeld'
'Ingeschakeld'

ApiManagementServiceBasePropertiesCustomProperties

Naam Beschrijving Waarde
{aangepaste eigenschap} snaar

HostnameConfiguration

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

RemotePrivateEndpointConnectionWrapper

Naam Beschrijving Waarde
legitimatiebewijs Resource-id voor privé-eindpuntverbinding snaar
naam Naam van privé-eindpuntverbinding snaar
Eigenschappen Resource-eigenschappen. PrivateEndpointConnectionWrapperProperties-
type Resourcetype voor privé-eindpuntverbinding snaar

PrivateEndpointConnectionWrapperProperties

Naam Beschrijving Waarde
privateEndpoint De resource van het privé-eindpunt. ArmIdWrapper
privateLinkServiceConnectionState Een verzameling informatie over de status van de verbinding tussen serviceconsumer en 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 dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen. snaar
beschrijving De reden voor goedkeuring/afwijzing van de verbinding. snaar
status Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service. 'Goedgekeurd'
'In behandeling'
'Geweigerd'

Quickstart-sjablonen

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

Sjabloon Beschrijving
Een API Management-exemplaar en alle subbronnen maken met behulp van sjabloon-

implementeren in 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 in Azure 		Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de verbruikslaag met een extern Exemplaar van Azure Cache voor Redis als de externe API Management-cache.
API Management implementeren in een extern VNet met openbare IP-

implementeren in 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. Met de sjabloon wordt ook een openbaar IP-adres van uw abonnement geconfigureerd.
Een API Management-exemplaar maken met aangepaste hostnamen

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

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

implementeren in 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. Met de sjabloon wordt ook een openbaar IP-adres van uw abonnement geconfigureerd.
Een API Management-exemplaar maken met MSI Identity

implementeren in Azure 		Met deze sjabloon maakt u een ontwikkelaarsexemplaren van Azure API Management met een MSI-identiteit
Een API Management-exemplaar met meerdere regio's maken

implementeren in Azure 		Deze sjabloon laat zien hoe u een API Management-exemplaar maakt met extra locaties. De primaire locatie is hetzelfde als de locatie van de resourcegroep. Voor extra locaties toont de sjabloon NorthCentralUs en VS - oost2. De primaire locatie moet afwijken van extra locaties.
API Management maken met aangepaste proxy ssl met behulp van KeyVault

implementeren in Azure 		Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt en aangepaste hostnaam configureert voor proxy met ssl-certificaat vanuit keyvault.
Een API Management-service maken met SSL vanuit KeyVault

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

implementeren in 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 maken met een privé-eindpunt

implementeren in 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 in Azure 		Met deze sjabloon maakt u een Premium-exemplaar van Azure API Management en implementeert u deze in een beschikbaarheidszone
Een API Management-exemplaar maken met behulp van een sjabloon

implementeren in Azure 		Met deze sjabloon maakt u een ontwikkelaarsexemplaren van Azure API Management
Front Door Standard/Premium met API Management-oorsprong

implementeren in Azure 		Met deze sjabloon maakt u een Front Door Premium en een API Management-exemplaar en gebruikt u een NSG- en globaal API Management-beleid om te valideren dat verkeer afkomstig is van de Front Door-oorsprong.
Azure Front Door maken vóór Azure API Management

implementeren in Azure 		In dit voorbeeld ziet u hoe u Azure Front Door gebruikt als een globale load balancer voor Azure API Management.
Application Gateway met interne API Management en Web App

implementeren in Azure 		Application Gateway: internetverkeer routeren naar een API Management-exemplaar van een virtueel netwerk (interne modus) dat een web-API services die wordt gehost in een Azure-web-app.

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype van de service kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • resourcegroepen

Zie logboek wijzigenvoor 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-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"
    }
  })
}

Eigenschapswaarden

dienst

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

Tekenlimiet: 1-50

Geldige tekens:
Alfanumerieke en afbreekstreepjes.

Begin met letter en eindig met alfanumeriek.

De resourcenaam moet uniek zijn in Azure.
plaats 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)
identiteit Beheerde service-identiteit van de Api Management-service. ApiManagementServiceIdentity-
Eigenschappen 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 wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None 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
Verwijzingen naar woordenlijstsleutels zijn ARM-resource-id's in de vorm:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 Matrix van id's van gebruikersidentiteit.

ApiManagementServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde
{aangepaste eigenschap} UserIdentityProperties-

UserIdentityProperties

Naam Beschrijving Waarde
clientId De client-id van de door de gebruiker toegewezen identiteit. snaar
principalId De principal-id van de door de gebruiker toegewezen identiteit. snaar

ApiManagementServiceProperties

Naam Beschrijving Waarde
additionalLocations Aanvullende datacenterlocaties van de API Management-service. AdditionalLocation[]
apiVersionConstraint Besturingselementvlak api's versiebeperking 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.
Als u Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 instelt, worden de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA voor alle TLS(1.0, 1.1 en 1.2) uitgeschakeld.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen voor communicatie met back-ends.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen voor communicatie met back-ends.
Het instellen van Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan worden gebruikt om het HTTP2-protocol in te schakelen voor een API Management-service.
Als u geen van deze eigenschappen opgeeft tijdens de PATCH-bewerking, worden de waarden van de weggelaten eigenschappen teruggezet op de standaardwaarden. Voor alle instellingen behalve Http2 wordt de standaardwaarde True als de service is gemaakt op of vóór 1 april 2018 en anders False. 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 deze waarden.
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		 ApiManagementServiceBasePropertiesCustomProperties
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. Bool
enableClientCertificate De eigenschap is alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Hiermee wordt afgedwongen dat een clientcertificaat wordt weergegeven bij elke aanvraag voor de gateway. Hiermee kunt u ook het certificaat verifiëren in het beleid op de gateway. Bool
hostnameConfigurations Aangepaste hostnaamconfiguratie van de API Management-service. HostnameConfiguration[]
legacyPortalStatus Status van verouderde portal in de API Management-service. "Uitgeschakeld"
"Ingeschakeld"
natGatewayState De eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service. "Uitgeschakeld"
"Ingeschakeld"
notificationSenderEmail E-mailadres van waaruit de melding wordt verzonden. snaar

Beperkingen:
Maximale lengte = 100
privateEndpointConnections Lijst met privé-eindpuntverbindingen van deze service. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Openbare standaard-SKU IP V4 gebaseerd IP-adres dat moet worden gekoppeld aan de service Virtual Network geïmplementeerd in de regio. Alleen ondersteund voor ontwikkelaars en Premium-SKU's die worden geïmplementeerd in Virtual Network. snaar
publicNetworkAccess Of openbare eindpunttoegang wel of niet is toegestaan voor deze API Management-service. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als deze optie is uitgeschakeld, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld "Uitgeschakeld"
"Ingeschakeld"
publisherEmail E-mail van Publisher. tekenreeks (vereist)

Beperkingen:
Maximale lengte = 100
publisherName Naam van uitgever. tekenreeks (vereist)

Beperkingen:
Maximale lengte = 100
herstellen De Api Management-service ongedaan maken als deze eerder voorlopig is verwijderd. Als deze vlag is opgegeven en is ingesteld op Waar, worden alle andere eigenschappen genegeerd. Bool
virtualNetworkConfiguration Configuratie van virtueel netwerk van de API Management-service. VirtualNetworkConfiguration-
virtualNetworkType Het type VPN waarin de API Management-service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een virtueel netwerk, extern betekent dat de API Management-implementatie is ingesteld binnen een virtueel netwerk met een internetgericht eindpunt en intern betekent dat de API Management-implementatie alleen is ingesteld in een virtueel netwerk met alleen een intranetgericht eindpunt. "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. Bool
plaats De locatienaam van de extra regio tussen Azure Data Center-regio's. tekenreeks (vereist)
natGatewayState De eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service. "Uitgeschakeld"
"Ingeschakeld"
publicIpAddressId Openbare standaard-SKU IP V4 gebaseerd IP-adres dat moet worden gekoppeld aan de service virtual network geïmplementeerd op de locatie. Alleen ondersteund voor Premium SKU die wordt geïmplementeerd in Virtual Network. snaar
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
capaciteit Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU). Voor verbruiks-SKU-capaciteit moet worden opgegeven als 0. int (vereist)
naam Naam van de SKU. "Standaard"
"WorkspaceGatewayPremium"
WorkspaceGatewayStandard (vereist)

VirtualNetworkConfiguration

Naam Beschrijving Waarde
subnetResourceId De volledige resource-id van een subnet in een virtueel netwerk waarin de API Management-service wordt geïmplementeerd. snaar

Beperkingen:
Patroon = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

ApiVersionConstraint

Naam Beschrijving Waarde
minApiVersion Beperk API-aanroepen naar API Management-service met een versie die gelijk is aan of hoger is dan deze waarde. snaar

CertificateConfiguration

Naam Beschrijving Waarde
certificaat Certificaatgegevens. CertificateInformation-
certificatePassword Certificaatwachtwoord. snaar
encodedCertificate Base64 Gecodeerd certificaat. snaar
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 indeling: 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) al dan niet moet worden weergegeven in de API Management-service. Waarde is optioneel, maar moet zijn ingeschakeld of uitgeschakeld. Als 'Uitgeschakeld' is, is verouderde configuratie-API (v1) niet beschikbaar voor zelf-hostende gateways. De standaardwaarde is Ingeschakeld "Uitgeschakeld"
"Ingeschakeld"

ApiManagementServiceBasePropertiesCustomProperties

Naam Beschrijving Waarde
{aangepaste eigenschap} snaar

HostnameConfiguration

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

RemotePrivateEndpointConnectionWrapper

Naam Beschrijving Waarde
legitimatiebewijs Resource-id voor privé-eindpuntverbinding snaar
naam Naam van privé-eindpuntverbinding snaar
Eigenschappen Resource-eigenschappen. PrivateEndpointConnectionWrapperProperties-
type Resourcetype voor privé-eindpuntverbinding snaar

PrivateEndpointConnectionWrapperProperties

Naam Beschrijving Waarde
privateEndpoint De resource van het privé-eindpunt. ArmIdWrapper
privateLinkServiceConnectionState Een verzameling informatie over de status van de verbinding tussen serviceconsumer en 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 dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen. snaar
beschrijving De reden voor goedkeuring/afwijzing van de verbinding. snaar
status Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service. "Goedgekeurd"
"In behandeling"
"Geweigerd"