Microsoft.ApiManagement-service 2020-06-01-preview
- meest recente
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview-
- 2023-03-01-preview-
- 2022-09-01-preview-
- 2022-08-01
- 2022-04-01-preview-
- 2021-12-01-preview-
- 2021-08-01
- 2021-04-01-preview-
- 2021-01-01-preview-
- 2020-12-01
- 2020-06-01-preview-
- 2019-12-01
- 2019-12-01-preview-
- 2019-01-01
- 2018-06-01-preview-
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep-resourcedefinitie
Het resourcetype van de service kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van 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 Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.ApiManagement/service@2020-06-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
location: 'string'
name: 'string'
properties: {
additionalLocations: [
{
disableGateway: bool
location: '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'
}
]
customProperties: {
{customized property}: 'string'
}
disableGateway: bool
enableClientCertificate: bool
hostnameConfigurations: [
{
certificate: {
expiry: 'string'
subject: 'string'
thumbprint: 'string'
}
certificatePassword: 'string'
defaultSslBinding: bool
encodedCertificate: 'string'
hostName: 'string'
identityClientId: 'string'
keyVaultId: 'string'
negotiateClientCertificate: bool
type: 'string'
}
]
notificationSenderEmail: 'string'
publisherEmail: 'string'
publisherName: 'string'
restore: bool
virtualNetworkConfiguration: {
subnetResourceId: 'string'
}
virtualNetworkType: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
zones: [
'string'
]
}
Eigenschapswaarden
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) |
| 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[] |
ApiManagementServiceBasePropertiesCustomProperties
| Naam | Beschrijving | Waarde |
|---|
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 |
|---|
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[] |
| 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: volgende coderingen kunnen niet worden uitgeschakeld omdat ze zijn vereist voor interne onderdelen van Azure CloudService: 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,TLS_RSA_WITH_AES_256_GCM_SHA384 |
ApiManagementServiceBasePropertiesCustomProperties |
| 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[] |
| notificationSenderEmail | E-mailadres van waaruit de melding wordt verzonden. | snaar Beperkingen: Maximale lengte = |
| publisherEmail | E-mail van Publisher. | snaar Beperkingen: Maximale lengte = (vereist) |
| publisherName | Naam van uitgever. | snaar Beperkingen: Maximale lengte = (vereist) |
| 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' |
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. | 'Basis' 'Verbruik' 'Ontwikkelaar' 'Geïsoleerd' 'Premium' 'Standaard' (vereist) |
ApimResourceTags
| Naam | Beschrijving | Waarde |
|---|
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) |
HostnameConfiguration
| Naam | Beschrijving | Waarde |
|---|---|---|
| certificaat | Certificaatgegevens. | CertificateInformation- |
| certificatePassword | Certificaatwachtwoord. | snaar |
| 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 type proxyhostnaam. | 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. | 'DeveloperPortal' 'Beheer' 'Portal' 'Proxy' 'Scm' (vereist) |
Microsoft.ApiManagement/service
| Naam | Beschrijving | Waarde |
|---|---|---|
| identiteit | Beheerde service-identiteit van de Api Management-service. | ApiManagementServiceIdentity- |
| plaats | Resourcelocatie. | tekenreeks (vereist) |
| naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 Patroon = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (vereist) |
| Eigenschappen | Eigenschappen van de API Management-service. | ApiManagementServiceProperties (vereist) |
| Sku | SKU-eigenschappen van de API Management-service. | ApiManagementServiceSkuProperties (vereist) |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
| Zones | Een lijst met beschikbaarheidszones die aangeeft waar de resource vandaan moet komen. | tekenreeks[] |
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 |
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/[^/]*$ |
Quickstart-voorbeelden
In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.
| Bicep-bestand | Beschrijving |
|---|---|
| Application Gateway met interne API Management en Web App | 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. |
| Een API Management-exemplaar met meerdere regio's maken | 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. |
| Een API Management-exemplaar maken met MSI Identity | Met deze sjabloon maakt u een ontwikkelaarsexemplaren van Azure API Management met een MSI-identiteit |
| Een API Management-exemplaar maken met behulp van een sjabloon | Met deze sjabloon maakt u een ontwikkelaarsexemplaren van Azure API Management |
| Een API Management-service maken met een privé-eindpunt | 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. |
| Een API Management-service maken met SSL vanuit KeyVault | 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 maken in intern VNet met App Gateway- | 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 extern VNet met openbare IP- | 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. |
| API Management implementeren in een intern VNet met openbare IP- | 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. |
| API Management implementeren in beschikbaarheidszones | Met deze sjabloon maakt u een Premium-exemplaar van Azure API Management en implementeert u deze in een beschikbaarheidszone |
| API Management implementeren met een externe Azure Cache voor Redis- | 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. |
| Front Door Standard/Premium met API Management-oorsprong | 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. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype van de service kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van 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 JSON toe aan uw sjabloon.
{
"type": "Microsoft.ApiManagement/service",
"apiVersion": "2020-06-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"location": "string",
"properties": {
"additionalLocations": [
{
"disableGateway": "bool",
"location": "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"
}
],
"customProperties": {
"{customized property}": "string"
},
"disableGateway": "bool",
"enableClientCertificate": "bool",
"hostnameConfigurations": [
{
"certificate": {
"expiry": "string",
"subject": "string",
"thumbprint": "string"
},
"certificatePassword": "string",
"defaultSslBinding": "bool",
"encodedCertificate": "string",
"hostName": "string",
"identityClientId": "string",
"keyVaultId": "string",
"negotiateClientCertificate": "bool",
"type": "string"
}
],
"notificationSenderEmail": "string",
"publisherEmail": "string",
"publisherName": "string",
"restore": "bool",
"virtualNetworkConfiguration": {
"subnetResourceId": "string"
},
"virtualNetworkType": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
},
"zones": [ "string" ]
}
Eigenschapswaarden
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) |
| 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[] |
ApiManagementServiceBasePropertiesCustomProperties
| Naam | Beschrijving | Waarde |
|---|
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 |
|---|
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[] |
| 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: volgende coderingen kunnen niet worden uitgeschakeld omdat ze zijn vereist voor interne onderdelen van Azure CloudService: 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,TLS_RSA_WITH_AES_256_GCM_SHA384 |
ApiManagementServiceBasePropertiesCustomProperties |
| 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[] |
| notificationSenderEmail | E-mailadres van waaruit de melding wordt verzonden. | snaar Beperkingen: Maximale lengte = |
| publisherEmail | E-mail van Publisher. | snaar Beperkingen: Maximale lengte = (vereist) |
| publisherName | Naam van uitgever. | snaar Beperkingen: Maximale lengte = (vereist) |
| 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' |
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. | 'Basis' 'Verbruik' 'Ontwikkelaar' 'Geïsoleerd' 'Premium' 'Standaard' (vereist) |
ApimResourceTags
| Naam | Beschrijving | Waarde |
|---|
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) |
HostnameConfiguration
| Naam | Beschrijving | Waarde |
|---|---|---|
| certificaat | Certificaatgegevens. | CertificateInformation- |
| certificatePassword | Certificaatwachtwoord. | snaar |
| 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 type proxyhostnaam. | 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. | 'DeveloperPortal' 'Beheer' 'Portal' 'Proxy' 'Scm' (vereist) |
Microsoft.ApiManagement/service
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiVersion | De API-versie | '2020-06-01-preview' |
| identiteit | Beheerde service-identiteit van de Api Management-service. | ApiManagementServiceIdentity- |
| plaats | Resourcelocatie. | tekenreeks (vereist) |
| naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 Patroon = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (vereist) |
| Eigenschappen | Eigenschappen van de API Management-service. | ApiManagementServiceProperties (vereist) |
| Sku | SKU-eigenschappen van de API Management-service. | ApiManagementServiceSkuProperties (vereist) |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
| type | Het resourcetype | 'Microsoft.ApiManagement/service' |
| Zones | Een lijst met beschikbaarheidszones die aangeeft waar de resource vandaan moet komen. | tekenreeks[] |
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 |
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/[^/]*$ |
Quickstart-sjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
| Sjabloon | Beschrijving |
|---|---|
Application Gateway met interne API Management en Web App
|
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. |
|
Een API Management-exemplaar met meerdere regio's maken
|
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. |
|
Een API Management-exemplaar en alle subbronnen maken met behulp van sjabloon-
|
Deze sjabloon laat zien hoe u een API Management-service maakt en subentiteiten configureert |
|
Een API Management-exemplaar maken met MSI Identity
|
Met deze sjabloon maakt u een ontwikkelaarsexemplaren van Azure API Management met een MSI-identiteit |
|
Een API Management-exemplaar maken met behulp van een sjabloon
|
Met deze sjabloon maakt u een ontwikkelaarsexemplaren van Azure API Management |
|
Een API Management-exemplaar maken met aangepaste hostnamen
|
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 |
|
Een API Management-service maken met een privé-eindpunt
|
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. |
|
Een API Management-service maken met SSL vanuit KeyVault
|
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
|
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 |
|
API Management maken in intern VNet met App Gateway-
|
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 maken met aangepaste proxy ssl met behulp van KeyVault
|
Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt en aangepaste hostnaam configureert voor proxy met ssl-certificaat vanuit keyvault. |
|
Azure Front Door maken vóór Azure API Management
|
In dit voorbeeld ziet u hoe u Azure Front Door gebruikt als een globale load balancer voor Azure API Management. |
|
API Management implementeren in een extern VNet met openbare IP-
|
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. |
|
API Management implementeren in een intern VNet met openbare IP-
|
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. |
|
API Management implementeren in beschikbaarheidszones
|
Met deze sjabloon maakt u een Premium-exemplaar van Azure API Management en implementeert u deze in een beschikbaarheidszone |
|
API Management implementeren met een externe Azure Cache voor Redis-
|
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. |
|
Front Door Standard/Premium met API Management-oorsprong
|
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. |
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@2020-06-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
zones = [
"string"
]
body = jsonencode({
properties = {
additionalLocations = [
{
disableGateway = bool
location = "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"
}
]
customProperties = {
{customized property} = "string"
}
disableGateway = bool
enableClientCertificate = bool
hostnameConfigurations = [
{
certificate = {
expiry = "string"
subject = "string"
thumbprint = "string"
}
certificatePassword = "string"
defaultSslBinding = bool
encodedCertificate = "string"
hostName = "string"
identityClientId = "string"
keyVaultId = "string"
negotiateClientCertificate = bool
type = "string"
}
]
notificationSenderEmail = "string"
publisherEmail = "string"
publisherName = "string"
restore = bool
virtualNetworkConfiguration = {
subnetResourceId = "string"
}
virtualNetworkType = "string"
}
})
}
Eigenschapswaarden
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) |
| 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[] |
ApiManagementServiceBasePropertiesCustomProperties
| Naam | Beschrijving | Waarde |
|---|
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 |
|---|
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[] |
| 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: volgende coderingen kunnen niet worden uitgeschakeld omdat ze zijn vereist voor interne onderdelen van Azure CloudService: 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,TLS_RSA_WITH_AES_256_GCM_SHA384 |
ApiManagementServiceBasePropertiesCustomProperties |
| 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[] |
| notificationSenderEmail | E-mailadres van waaruit de melding wordt verzonden. | snaar Beperkingen: Maximale lengte = |
| publisherEmail | E-mail van Publisher. | snaar Beperkingen: Maximale lengte = (vereist) |
| publisherName | Naam van uitgever. | snaar Beperkingen: Maximale lengte = (vereist) |
| 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' |
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. | 'Basis' 'Verbruik' 'Ontwikkelaar' 'Geïsoleerd' 'Premium' 'Standaard' (vereist) |
ApimResourceTags
| Naam | Beschrijving | Waarde |
|---|
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) |
HostnameConfiguration
| Naam | Beschrijving | Waarde |
|---|---|---|
| certificaat | Certificaatgegevens. | CertificateInformation- |
| certificatePassword | Certificaatwachtwoord. | snaar |
| 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 type proxyhostnaam. | 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. | 'DeveloperPortal' 'Beheer' 'Portal' 'Proxy' 'Scm' (vereist) |
Microsoft.ApiManagement/service
| Naam | Beschrijving | Waarde |
|---|---|---|
| identiteit | Beheerde service-identiteit van de Api Management-service. | ApiManagementServiceIdentity- |
| plaats | Resourcelocatie. | tekenreeks (vereist) |
| naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 Patroon = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (vereist) |
| Eigenschappen | Eigenschappen van de API Management-service. | ApiManagementServiceProperties (vereist) |
| Sku | SKU-eigenschappen van de API Management-service. | ApiManagementServiceSkuProperties (vereist) |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. |
| type | Het resourcetype | "Microsoft.ApiManagement/service@2020-06-01-preview" |
| Zones | Een lijst met beschikbaarheidszones die aangeeft waar de resource vandaan moet komen. | tekenreeks[] |
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 |
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/[^/]*$ |