Microsoft.ApiManagement-tjänsten 2022-08-01
Bicep-resursdefinition
Tjänstresurstypen kan distribueras med åtgärder som mål:
- Resursgrupper – Se kommandon för resursgruppsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service@2022-08-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
{customized property}: 'string'
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'
}
]
customProperties: {
{customized property}: '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'
}
]
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'
]
}
Egenskapsvärden
tjänst
Name | Beskrivning | Värde |
---|---|---|
name | Resursnamnet | sträng (krävs) Teckengräns: 1–50 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. Resursnamnet måste vara unikt i Hela Azure. |
location | Resursplats. | sträng (krävs) |
tags | Resurstaggar. | Ordlista med taggnamn och värden. Se Taggar i mallar |
sku | SKU-egenskaper för API Management-tjänsten. | ApiManagementServiceSkuProperties (krävs) |
identity | Hanterad tjänstidentitet för Api Management-tjänsten. | ApiManagementServiceIdentity |
properties | Egenskaper för API Management-tjänsten. | ApiManagementServiceProperties (krävs) |
Zoner | En lista över tillgänglighetszoner som anger var resursen måste komma ifrån. | string[] |
ApiManagementServiceIdentity
Name | Beskrivning | Värde |
---|---|---|
typ | Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. | "Ingen" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (krävs) |
userAssignedIdentities | Listan över användaridentiteter som är associerade med resursen. Användaridentiteten ordlistenyckelreferenser är ARM-resurs-ID:t i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
ApiManagementServiceIdentityUserAssignedIdentiteter |
ApiManagementServiceIdentityUserAssignedIdentiteter
Name | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | UserIdentityProperties |
UserIdentityProperties
Name | Beskrivning | Värde |
---|---|---|
ClientID | Klient-ID för användartilldelad identitet. | sträng |
principalId | Huvud-ID för användartilldelad identitet. | sträng |
ApiManagementServiceProperties
Name | Beskrivning | Värde |
---|---|---|
additionalLocations | Ytterligare datacenterplatser för API Management-tjänsten. | AdditionalLocation[] |
apiVersionConstraint | Kontrollplans-API:ets versionsbegränsning för API Management-tjänsten. | ApiVersionConstraint |
certifikat | Lista över certifikat som måste installeras i API Management-tjänsten. Maximalt antal certifikat som stöds och som kan installeras är 10. | CertificateConfiguration[] |
customProperties | Anpassade egenskaper för API Management-tjänsten. Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 inaktiverar chiffer TLS_RSA_WITH_3DES_EDE_CBC_SHA för alla TLS(1.0, 1.1 och 1.2).Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan användas för att inaktivera bara TLS 1.1.Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan användas för att inaktivera TLS 1.0 på en API Management tjänst.Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kan användas för att inaktivera bara TLS 1.1 för kommunikation med serverdelar.Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan användas för att inaktivera TLS 1.0 för kommunikation med serverdelar.Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan användas för att aktivera HTTP2-protokoll på en API Management-tjänst.Om du inte anger någon av de här egenskaperna för PATCH-åtgärden återställs egenskapernas värden till standardvärdena. För alla inställningar utom Http2 är True standardvärdet om tjänsten skapades den 1 april 2018 eller tidigare än den 1 april 2018.False Http2-inställningens standardvärde är False .Du kan inaktivera något av följande chiffer med hjälp av inställningarna 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. Till exempel Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256 :false . Standardvärdet är true för dem.Obs! Följande chiffer kan inte inaktiveras eftersom de krävs av interna plattformskomponenter: 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 |
disableGateway | Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen i huvudregionen. | boolesk |
enableClientCertificate | Egenskapen är endast avsedd att användas för förbruknings-SKU-tjänsten. Detta framtvingar att ett klientcertifikat visas på varje begäran till gatewayen. Detta gör det också möjligt att autentisera certifikatet i principen på gatewayen. | boolesk |
hostnameConfigurations | Konfiguration av anpassat värdnamn för API Management-tjänsten. | HostnameConfiguration[] |
natGatewayState | Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten. | "Inaktiverad" "Aktiverad" |
notificationSenderEmail | Email adress som meddelandet ska skickas från. | sträng |
privateEndpointConnections | Lista över privata slutpunktsanslutningar för den här tjänsten. | RemotePrivateEndpointConnectionWrapper[] |
publicIpAddressId | Public Standard SKU IP V4-baserad IP-adress som ska associeras med Virtual Network distribuerade tjänsten i regionen. Stöds endast för utvecklare och Premium SKU som distribueras i Virtual Network. | sträng |
publicNetworkAccess | Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat" | "Inaktiverad" "Aktiverad" |
publisherEmail | E-post för utgivare. | sträng (krävs) |
publisherName | Utgivarens namn. | sträng (krävs) |
återställ | Ta bort Api Management-tjänsten om den tidigare togs bort mjukt. Om den här flaggan har angetts och angetts till Sant ignoreras alla andra egenskaper. | boolesk |
virtualNetworkConfiguration | Konfiguration av virtuella nätverk för API Management-tjänsten. | VirtualNetworkConfiguration |
virtualNetworkType | Den typ av VPN som API Management tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i någon Virtual Network, externt innebär att API Management-distributionen har konfigurerats i en Virtual Network med en Internetuppkopplad slutpunkt och intern innebär att API Management distributionen konfigureras i en Virtual Network endast har en intranätuppkopplad slutpunkt. | "Extern" "Intern" "Ingen" |
AdditionalLocation
Name | Beskrivning | Värde |
---|---|---|
disableGateway | Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen på den här ytterligare platsen. | boolesk |
location | Platsnamnet för den ytterligare regionen mellan Azure Data Center-regioner. | sträng (krävs) |
natGatewayState | Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten. | "Inaktiverad" "Aktiverad" |
publicIpAddressId | Public Standard SKU IP V4-baserad IP-adress som ska associeras med Virtual Network distribuerad tjänst på platsen. Stöds endast för Premium SKU som distribueras i Virtual Network. | sträng |
sku | SKU-egenskaper för API Management-tjänsten. | ApiManagementServiceSkuProperties (krävs) |
virtualNetworkConfiguration | Konfiguration av virtuellt nätverk för platsen. | VirtualNetworkConfiguration |
Zoner | En lista över tillgänglighetszoner som anger var resursen behöver komma ifrån. | string[] |
ApiManagementServiceSkuProperties
Name | Beskrivning | Värde |
---|---|---|
capacity | SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). För SKU-kapacitet för förbrukning måste anges som 0. | int (obligatoriskt) |
name | Namnet på SKU:n. | "Grundläggande" "Förbrukning" "Utvecklare" "Isolerad" "Premium" "Standard" (obligatoriskt) |
VirtualNetworkConfiguration
Name | Beskrivning | Värde |
---|---|---|
subnetResourceId | Det fullständiga resurs-ID:t för ett undernät i ett virtuellt nätverk för att distribuera API Management-tjänsten i. | sträng |
ApiVersionConstraint
Name | Beskrivning | Värde |
---|---|---|
minApiVersion | Begränsa API-anrop på kontrollplanet till API Management tjänst med en version som är lika med eller nyare än det här värdet. | sträng |
CertificateConfiguration
Name | Beskrivning | Värde |
---|---|---|
certifikat | Certifikatinformation. | CertificateInformation |
certificatePassword | Certifikatlösenord. | sträng |
encodedCertificate | Base64-kodat certifikat. | sträng |
storeName | Certifikatarkivet System.Security.Cryptography.x509certificates.StoreName. Endast Root och CertificateAuthority är giltiga platser. | "CertificateAuthority" "Rot" (obligatoriskt) |
CertificateInformation
Name | Beskrivning | Värde |
---|---|---|
Utgången | Certifikatets förfallodatum. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden. |
sträng (krävs) |
ämne | Certifikatets ämne. | sträng (krävs) |
Stämpel | Tumavtryck för certifikatet. | sträng (krävs) |
ApiManagementServiceBasePropertiesCustomProperties
Name | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | sträng |
HostnameConfiguration
Name | Beskrivning | Värde |
---|---|---|
certifikat | Certifikatinformation. | CertificateInformation |
certificatePassword | Certifikatlösenord. | sträng |
certificateSource | Certifikatkälla. | "BuiltIn" "Anpassad" "KeyVault" "Hanterad" |
certificateStatus | Certifikatstatus. | "Slutfört" "Misslyckades" "InProgress" |
defaultSslBinding | Ange true för att konfigurera certifikatet som är associerat med det här värdnamnet som standard-SSL-certifikat. Om en klient inte skickar SNI-huvudet är detta certifikatet som kommer att utmanas. Egenskapen är användbar om flera anpassade värdnamn är aktiverade för en tjänst och den måste bestämma standard-SSL-certifikatet. Inställningen tillämpas endast på gatewayens värdnamnstyp. | boolesk |
encodedCertificate | Base64-kodat certifikat. | sträng |
Värdnamn | Värdnamn som ska konfigureras på Api Management-tjänsten. | sträng (krävs) |
identityClientId | ClientId för system- eller användartilldelad hanterad identitet som genereras av Azure AD, som har GET-åtkomst till keyVault som innehåller SSL-certifikatet. | sträng |
keyVaultId | URL till KeyVault-hemligheten som innehåller SSL-certifikatet. Om absolut URL som innehåller version anges fungerar inte automatisk uppdatering av SSL-certifikatet. Detta kräver att Api Management-tjänsten konfigureras med aka.ms/apimmsi. Hemligheten ska vara av typen application/x-pkcs12 | sträng |
negotiateClientCertificate | Ange true för att alltid förhandla om klientcertifikatet på värdnamnet. Standardvärdet är false. | boolesk |
typ | Typ av värdnamn. | "DeveloperPortal" "Hantering" "Portal" "Proxy" "Scm" (krävs) |
RemotePrivateEndpointConnectionWrapper
Name | Beskrivning | Värde |
---|---|---|
id | Resurs-ID för privat slutpunktsanslutning | sträng |
name | Namn på privat slutpunktsanslutning | sträng |
properties | Resursegenskaper. | PrivateEndpointConnectionWrapperProperties |
typ | Resurstyp för privat slutpunktsanslutning | sträng |
PrivateEndpointConnectionWrapperProperties
Name | Beskrivning | Värde |
---|---|---|
privateEndpoint | Resursen för den privata slutpunkten. | ArmIdWrapper |
privateLinkServiceConnectionState | En samling information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören. | PrivateLinkServiceConnectionState (krävs) |
ArmIdWrapper
Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.
PrivateLinkServiceConnectionState
Name | Beskrivning | Värde |
---|---|---|
actionsRequired | Ett meddelande som anger om ändringar i tjänstleverantören kräver uppdateringar på konsumenten. | sträng |
beskrivning | Anledningen till att anslutningen godkänns/avvisas. | sträng |
status | Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare. | "Godkänd" "Väntar" "Avvisad" |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Description |
---|---|
Skapa en API Management-instans och alla underresurser med hjälp av mallen |
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter |
Distribuera API Management med en extern Azure Cache for Redis |
Den här mallen visar hur du skapar en instans av Azure API Management på förbrukningsnivån med en extern Azure Cache for Redis instans som API Management extern cache. |
Distribuera API Management i ett externt virtuellt nätverk med offentlig IP-adress |
Den här mallen visar hur du skapar en instans av Azure API Management på Premium-nivån i det virtuella nätverkets undernät i externt läge och konfigurerar rekommenderade NSG-regler i undernätet. Instansen distribueras till två tillgänglighetszoner. Mallen konfigurerar också en offentlig IP-adress från din prenumeration. |
Skapa en API Management-instans med anpassade värdnamn |
Den här mallen visar hur du skapar en instans av Azure API Management med anpassat värdnamn för portalen och flera anpassade värdnamn för proxy |
Skapa API Management i internt virtuellt nätverk med App Gateway |
Den här mallen visar hur du skapar en instans av Azure API Management i ett privat nätverk som skyddas av Azure Application Gateway. |
Distribuera API Management i ett internt virtuellt nätverk med offentlig IP-adress |
Den här mallen visar hur du skapar en instans av Azure API Management på Premium-nivån i det virtuella nätverkets undernät i internt läge och konfigurerar rekommenderade NSG-regler i undernätet. Instansen distribueras till två tillgänglighetszoner. Mallen konfigurerar också en offentlig IP-adress från din prenumeration. |
Skapa en API Management-instans med MSI-identitet |
Den här mallen skapar en utvecklarinstans av Azure API Management med en MSI-identitet |
Skapa en Premium-nivå för flera regioner API Management-instans |
Den här mallen visar hur du skapar en API Management-instans med ytterligare platser. Den primära platsen är samma som platsen för resursgruppen. För ytterligare platser visar mallen NorthCentralUs och EAST US2. Den primära platsen bör skilja sig från ytterligare platser. |
Skapa API Management med anpassad proxy-SSL med KeyVault |
Den här mallen visar hur du skapar en instans av Azure API Management och konfigurerar anpassat värdnamn för proxy med SSL-certifikat från keyvault. |
Skapa en API Management-tjänst med SSL från KeyVault |
Den här mallen distribuerar en API Management-tjänst som konfigurerats med användartilldelad identitet. Den använder den här identiteten för att hämta SSL-certifikat från KeyVault och håller den uppdaterad genom att kontrollera var fjärde timme. |
Skapa och övervaka API Management instans |
Den här mallen skapar en instans av Azure API Management-tjänsten och Log Analytics-arbetsytan och konfigurerar övervakning för din API Management-tjänst med Log Analytics |
Skapa en API Management-tjänst med en privat slutpunkt |
Den här mallen skapar en API Management tjänst, ett virtuellt nätverk och en privat slutpunkt som exponerar API Management-tjänsten för det virtuella nätverket. |
Distribuera API Management till Tillgänglighetszoner |
Den här mallen skapar en Premium-instans av Azure API Management och distribueras till en tillgänglighetszon |
Skapa en API Management-instans med hjälp av en mall |
Den här mallen skapar en utvecklarinstans av Azure API Management |
Front Door Standard/Premium med API Management ursprung |
Den här mallen skapar en Front Door Premium och en API Management-instans och använder en NSG och en global API Management-princip för att verifiera att trafiken har kommit via Front Door-ursprunget. |
Skapa Azure Front Door framför Azure API Management |
Det här exemplet visar hur du använder Azure Front Door som global lastbalanserare framför Azure API Management. |
Application Gateway med interna API Management och webbappar |
Application Gateway att dirigera Internettrafik till ett virtuellt nätverk (internt läge) API Management instans som betjänar ett webb-API som finns i en Azure-webbapp. |
Resursdefinition för ARM-mall
Tjänstresurstypen kan distribueras med åtgärder som mål:
- Resursgrupper – Se kommandon för resursgruppsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service",
"apiVersion": "2022-08-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"{customized property}": "string"
"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"
}
],
"customProperties": {
"{customized property}": "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"
}
],
"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" ]
}
Egenskapsvärden
tjänst
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service" |
apiVersion | Resurs-API-versionen | '2022-08-01' |
name | Resursnamnet | sträng (krävs) Teckengräns: 1–50 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. Resursnamnet måste vara unikt i Hela Azure. |
location | Resursplats. | sträng (krävs) |
tags | Resurstaggar. | Ordlista med taggnamn och värden. Se Taggar i mallar |
sku | SKU-egenskaper för API Management-tjänsten. | ApiManagementServiceSkuProperties (krävs) |
identity | Hanterad tjänstidentitet för Api Management-tjänsten. | ApiManagementServiceIdentity |
properties | Egenskaper för API Management-tjänsten. | ApiManagementServiceProperties (krävs) |
Zoner | En lista över tillgänglighetszoner som anger var resursen måste komma ifrån. | string[] |
ApiManagementServiceIdentity
Name | Beskrivning | Värde |
---|---|---|
typ | Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. | "Ingen" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (krävs) |
userAssignedIdentities | Listan över användaridentiteter som är associerade med resursen. Användaridentiteten ordlistenyckelreferenser är ARM-resurs-ID:t i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
ApiManagementServiceIdentityUserAssignedIdentiteter |
ApiManagementServiceIdentityUserAssignedIdentiteter
Name | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | UserIdentityProperties |
UserIdentityProperties
Name | Beskrivning | Värde |
---|---|---|
ClientID | Klient-ID för användartilldelad identitet. | sträng |
principalId | Huvud-ID för användartilldelad identitet. | sträng |
ApiManagementServiceProperties
Name | Beskrivning | Värde |
---|---|---|
additionalLocations | Ytterligare datacenterplatser för API Management-tjänsten. | AdditionalLocation[] |
apiVersionConstraint | Kontrollplans-API:ets versionsbegränsning för API Management-tjänsten. | ApiVersionConstraint |
certifikat | Lista över certifikat som måste installeras i API Management-tjänsten. Maximalt antal certifikat som stöds som kan installeras är 10. | CertificateConfiguration[] |
customProperties | Anpassade egenskaper för API Management-tjänsten. Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 inaktiverar chiffer TLS_RSA_WITH_3DES_EDE_CBC_SHA för alla TLS(1.0, 1.1 och 1.2).Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan användas för att inaktivera bara TLS 1.1.Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan användas för att inaktivera TLS 1.0 på en API Management tjänst.Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kan användas för att inaktivera bara TLS 1.1 för kommunikation med serverdelar.Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan användas för att inaktivera TLS 1.0 för kommunikation med serverdelar.Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan användas för att aktivera HTTP2-protokoll på en API Management-tjänst.Om du inte anger någon av de här egenskaperna för PATCH-åtgärden återställs egenskapernas värden till standardvärdena. För alla inställningar utom Http2 är True standardvärdet om tjänsten skapades den 1 april 2018 eller tidigare än den 1 april 2018.False Http2-inställningens standardvärde är False .Du kan inaktivera något av följande chiffer med hjälp av inställningarna 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. Till exempel Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256 :false . Standardvärdet är true för dem.Obs! Följande chiffer kan inte inaktiveras eftersom de krävs av interna plattformskomponenter: 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 |
disableGateway | Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen i huvudregionen. | boolesk |
enableClientCertificate | Egenskapen är endast avsedd att användas för förbruknings-SKU-tjänsten. Detta framtvingar att ett klientcertifikat visas på varje begäran till gatewayen. Detta gör det också möjligt att autentisera certifikatet i principen på gatewayen. | boolesk |
hostnameConfigurations | Konfiguration av anpassat värdnamn för API Management-tjänsten. | HostnameConfiguration[] |
natGatewayState | Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten. | "Inaktiverad" "Aktiverad" |
notificationSenderEmail | Email adress som meddelandet ska skickas från. | sträng |
privateEndpointConnections | Lista över privata slutpunktsanslutningar för den här tjänsten. | RemotePrivateEndpointConnectionWrapper[] |
publicIpAddressId | Public Standard SKU IP V4-baserad IP-adress som ska associeras med Virtual Network distribuerade tjänsten i regionen. Stöds endast för utvecklare och Premium SKU som distribueras i Virtual Network. | sträng |
publicNetworkAccess | Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat" | "Inaktiverad" "Aktiverad" |
publisherEmail | E-post för utgivare. | sträng (krävs) |
publisherName | Utgivarens namn. | sträng (krävs) |
återställ | Ta bort Api Management-tjänsten om den tidigare togs bort mjukt. Om den här flaggan har angetts och angetts till Sant ignoreras alla andra egenskaper. | boolesk |
virtualNetworkConfiguration | Konfiguration av virtuella nätverk för API Management-tjänsten. | VirtualNetworkConfiguration |
virtualNetworkType | Den typ av VPN som API Management tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i någon Virtual Network, externt innebär att API Management-distributionen har konfigurerats i en Virtual Network med en Internetuppkopplad slutpunkt och intern innebär att API Management distributionen konfigureras i en Virtual Network endast har en intranätuppkopplad slutpunkt. | "Extern" "Intern" "Ingen" |
AdditionalLocation
Name | Beskrivning | Värde |
---|---|---|
disableGateway | Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen på den här ytterligare platsen. | boolesk |
location | Platsnamnet för den ytterligare regionen mellan Azure Data Center-regioner. | sträng (krävs) |
natGatewayState | Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten. | "Inaktiverad" "Aktiverad" |
publicIpAddressId | Public Standard SKU IP V4-baserad IP-adress som ska associeras med Virtual Network distribuerade tjänsten på platsen. Stöds endast för Premium SKU som distribueras i Virtual Network. | sträng |
sku | SKU-egenskaper för API Management-tjänsten. | ApiManagementServiceSkuProperties (krävs) |
virtualNetworkConfiguration | Konfiguration av virtuellt nätverk för platsen. | VirtualNetworkConfiguration |
Zoner | En lista över tillgänglighetszoner som anger var resursen måste komma ifrån. | string[] |
ApiManagementServiceSkuProperties
Name | Beskrivning | Värde |
---|---|---|
capacity | SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). För SKU-kapacitet för förbrukning måste anges som 0. | int (obligatoriskt) |
name | Namnet på SKU:n. | "Grundläggande" "Förbrukning" "Utvecklare" "Isolerad" "Premium" "Standard" (obligatoriskt) |
VirtualNetworkConfiguration
Name | Beskrivning | Värde |
---|---|---|
subnetResourceId | Det fullständiga resurs-ID:t för ett undernät i ett virtuellt nätverk för att distribuera API Management-tjänsten i. | sträng |
ApiVersionConstraint
Name | Beskrivning | Värde |
---|---|---|
minApiVersion | Begränsa API-anrop på kontrollplanet till API Management tjänst med en version som är lika med eller nyare än det här värdet. | sträng |
CertificateConfiguration
Name | Beskrivning | Värde |
---|---|---|
certifikat | Certifikatinformation. | CertificateInformation |
certificatePassword | Certifikatlösenord. | sträng |
encodedCertificate | Base64-kodat certifikat. | sträng |
storeName | Certifikatarkivet System.Security.Cryptography.x509certificates.StoreName. Endast Root och CertificateAuthority är giltiga platser. | "CertificateAuthority" "Rot" (obligatoriskt) |
CertificateInformation
Name | Beskrivning | Värde |
---|---|---|
Utgången | Certifikatets förfallodatum. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden. |
sträng (krävs) |
ämne | Certifikatets ämne. | sträng (krävs) |
Stämpel | Tumavtryck för certifikatet. | sträng (krävs) |
ApiManagementServiceBasePropertiesCustomProperties
Name | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | sträng |
HostnameConfiguration
Name | Beskrivning | Värde |
---|---|---|
certifikat | Certifikatinformation. | CertificateInformation |
certificatePassword | Certifikatlösenord. | sträng |
certificateSource | Certifikatkälla. | "BuiltIn" "Anpassad" "KeyVault" "Hanterad" |
certificateStatus | Certifikatstatus. | "Slutfört" "Misslyckades" "InProgress" |
defaultSslBinding | Ange true för att konfigurera certifikatet som är associerat med det här värdnamnet som standard-SSL-certifikat. Om en klient inte skickar SNI-huvudet är detta certifikatet som kommer att utmanas. Egenskapen är användbar om en tjänst har flera anpassade värdnamn aktiverade och måste bestämma standard-SSL-certifikatet. Inställningen tillämpas endast på gatewayens värdnamnstyp. | boolesk |
encodedCertificate | Base64-kodat certifikat. | sträng |
Värdnamn | Värdnamn som ska konfigureras på Api Management-tjänsten. | sträng (krävs) |
identityClientId | ClientId för system- eller användartilldelad hanterad identitet som genereras av Azure AD, som har GET-åtkomst till keyVault som innehåller SSL-certifikatet. | sträng |
keyVaultId | Url till KeyVault-hemligheten som innehåller Ssl-certifikatet. Om absolut URL som innehåller version tillhandahålls fungerar inte automatisk uppdatering av SSL-certifikatet. Detta kräver att Api Management-tjänsten konfigureras med aka.ms/apimmsi. Hemligheten ska vara av typen application/x-pkcs12 | sträng |
negotiateClientCertificate | Ange true för att alltid förhandla om klientcertifikatet på värdnamnet. Standardvärdet är falskt. | boolesk |
typ | Typ av värdnamn. | "DeveloperPortal" "Hantering" "Portal" "Proxy" "Scm" (krävs) |
RemotePrivateEndpointConnectionWrapper
Name | Beskrivning | Värde |
---|---|---|
id | Resurs-ID för privat slutpunktsanslutning | sträng |
name | Anslutningsnamn för privat slutpunkt | sträng |
properties | Resursegenskaper. | PrivateEndpointConnectionWrapperEgenskaper |
typ | Resurstyp för privat slutpunktsanslutning | sträng |
PrivateEndpointConnectionWrapperEgenskaper
Name | Beskrivning | Värde |
---|---|---|
privateEndpoint | Resursen för den privata slutpunkten. | ArmIdWrapper |
privateLinkServiceConnectionState | En samling med information om tillståndet för anslutningen mellan tjänstekonsumenten och leverantören. | PrivateLinkServiceConnectionState (krävs) |
ArmIdWrapper
Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.
PrivateLinkServiceConnectionState
Name | Beskrivning | Värde |
---|---|---|
actionsRequired | Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten. | sträng |
beskrivning | Anledningen till godkännande/avvisande av anslutningen. | sträng |
status | Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare. | "Godkänd" "Väntar" "Avvisad" |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Description |
---|---|
Skapa en API Management-instans och alla underresurser med hjälp av mallen |
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter |
Distribuera API Management med en extern Azure Cache for Redis |
Den här mallen visar hur du skapar en instans av Azure API Management på förbrukningsnivån med en extern Azure Cache for Redis instans som API Management extern cache. |
Distribuera API Management i externa virtuella nätverk med offentlig IP-adress |
Den här mallen visar hur du skapar en instans av Azure API Management på Premium-nivån i det virtuella nätverkets undernät i externt läge och konfigurerar rekommenderade NSG-regler i undernätet. Instansen distribueras till två tillgänglighetszoner. Mallen konfigurerar också en offentlig IP-adress från din prenumeration. |
Skapa en API Management-instans med anpassade värdnamn |
Den här mallen visar hur du skapar en instans av Azure API Management med anpassat värdnamn för portalen och flera anpassade värdnamn för proxy |
Skapa API Management i internt virtuellt nätverk med App Gateway |
Den här mallen visar hur du skapar en instans av Azure API Management i ett privat nätverk som skyddas av Azure Application Gateway. |
Distribuera API Management i internt virtuellt nätverk med offentlig IP-adress |
Den här mallen visar hur du skapar en instans av Azure API Management på Premium-nivån i det virtuella nätverkets undernät i internt läge och konfigurerar rekommenderade NSG-regler i undernätet. Instansen distribueras till två tillgänglighetszoner. Mallen konfigurerar också en offentlig IP-adress från din prenumeration. |
Skapa en API Management-instans med MSI-identitet |
Den här mallen skapar en utvecklarinstans av Azure API Management med en MSI-identitet |
Skapa en Premium-nivå för flera regioner API Management instans |
Den här mallen visar hur du skapar en API Management-instans med ytterligare platser. Den primära platsen är samma som platsen för resursgruppen. För ytterligare platser visar mallen NorthCentralUs och USA, östra 2. Den primära platsen bör skilja sig från ytterligare platser. |
Skapa API Management med anpassad proxy-ssl med KeyVault |
Den här mallen visar hur du skapar en instans av Azure API Management och konfigurerar anpassat värdnamn för proxy med ssl-certifikat från keyvault. |
Skapa en API Management-tjänst med SSL från KeyVault |
Den här mallen distribuerar en API Management tjänst som konfigurerats med användartilldelad identitet. Den använder den här identiteten för att hämta SSL-certifikat från KeyVault och håller den uppdaterad genom att kontrollera var fjärde timme. |
Skapa och övervaka API Management instans |
Den här mallen skapar en instans av Azure API Management-tjänsten och Log Analytics-arbetsytan och konfigurerar övervakning för din API Management-tjänst med Log Analytics |
Skapa en API Management tjänst med en privat slutpunkt |
Den här mallen skapar en API Management tjänst, ett virtuellt nätverk och en privat slutpunkt som exponerar API Management-tjänsten för det virtuella nätverket. |
Distribuera API Management till Tillgänglighetszoner |
Den här mallen skapar en premiuminstans av Azure API Management och distribueras till en tillgänglighetszon |
Skapa en API Management-instans med hjälp av en mall |
Den här mallen skapar en utvecklarinstans av Azure API Management |
Front Door Standard/Premium med API Management ursprung |
Den här mallen skapar en Front Door Premium och en API Management-instans och använder en NSG och en global API Management-princip för att verifiera att trafiken har kommit via Front Door-ursprunget. |
Skapa Azure Front Door framför Azure API Management |
Det här exemplet visar hur du använder Azure Front Door som global lastbalanserare framför Azure API Management. |
Application Gateway med interna API Management och webbappar |
Application Gateway att dirigera Internettrafik till ett virtuellt nätverk (internt läge) API Management instans som betjänar ett webb-API som finns i en Azure-webbapp. |
Resursdefinition för Terraform (AzAPI-provider)
Tjänstresurstypen kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service@2022-08-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
{customized property} = "string"
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"
}
]
customProperties = {
{customized property} = "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"
}
]
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"
}
})
}
Egenskapsvärden
tjänst
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service@2022-08-01" |
name | Resursnamnet | sträng (krävs) Teckengräns: 1–50 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. Resursnamnet måste vara unikt i Hela Azure. |
location | Resursplats. | sträng (krävs) |
parent_id | Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. | sträng (krävs) |
tags | Resurstaggar. | Ordlista med taggnamn och värden. |
sku | SKU-egenskaper för API Management-tjänsten. | ApiManagementServiceSkuProperties (krävs) |
identity | Hanterad tjänstidentitet för API Management-tjänsten. | ApiManagementServiceIdentity |
properties | Egenskaper för API Management-tjänsten. | ApiManagementServiceProperties (krävs) |
Zoner | En lista över tillgänglighetszoner som anger var resursen behöver komma ifrån. | string[] |
ApiManagementServiceIdentity
Name | Beskrivning | Värde |
---|---|---|
typ | Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort eventuella identiteter från tjänsten. | "SystemTilldelade" "SystemAssigned, UserAssigned" "UserAssigned" (krävs) |
identity_ids | Listan över användaridentiteter som är associerade med resursen. Användaridentiteten ordlistenyckelreferenser är ARM-resurs-ID:t i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
Matris med användaridentitets-ID:t. |
ApiManagementServiceIdentityUserAssignedIdentiteter
Name | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | UserIdentityProperties |
UserIdentityProperties
Name | Beskrivning | Värde |
---|---|---|
ClientID | Klient-ID för användartilldelad identitet. | sträng |
principalId | Huvud-ID för användartilldelad identitet. | sträng |
ApiManagementServiceProperties
Name | Beskrivning | Värde |
---|---|---|
additionalLocations | Ytterligare datacenterplatser för API Management-tjänsten. | AdditionalLocation[] |
apiVersionConstraint | Kontrollplans-API:ets versionsbegränsning för API Management-tjänsten. | ApiVersionConstraint |
certifikat | Lista över certifikat som måste installeras i API Management-tjänsten. Maximalt antal certifikat som stöds och som kan installeras är 10. | CertificateConfiguration[] |
customProperties | Anpassade egenskaper för API Management-tjänsten. Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 inaktiverar chiffer TLS_RSA_WITH_3DES_EDE_CBC_SHA för alla TLS(1.0, 1.1 och 1.2).Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan användas för att inaktivera bara TLS 1.1.Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan användas för att inaktivera TLS 1.0 på en API Management-tjänst.Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kan användas för att inaktivera endast TLS 1.1 för kommunikation med serverdelar.Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan användas för att inaktivera TLS 1.0 för kommunikation med serverdelar.Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan användas för att aktivera HTTP2-protokoll på en API Management-tjänst.Om du inte anger någon av dessa egenskaper för PATCH-åtgärden återställs utelämnade egenskapers värden till standardvärdena. För alla inställningar utom Http2 är True standardvärdet om tjänsten skapades den 1 april 2018 eller tidigare än den 1 april 2018 och False annars. Http2-inställningens standardvärde är False .Du kan inaktivera något av följande chiffer med hjälp av inställningarna 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. Till exempel Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256 :false . Standardvärdet är true för dem.Obs! Följande chiffer kan inte inaktiveras eftersom de krävs av interna plattformskomponenter: 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 |
disableGateway | Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen i huvudregionen. | boolesk |
enableClientCertificate | Egenskapen är endast avsedd att användas för förbruknings-SKU-tjänsten. Detta framtvingar att ett klientcertifikat visas på varje begäran till gatewayen. Detta gör det också möjligt att autentisera certifikatet i principen på gatewayen. | boolesk |
hostnameConfigurations | Anpassad värdnamnskonfiguration för API Management-tjänsten. | HostnameConfiguration[] |
natGatewayState | Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten. | "Inaktiverad" "Aktiverad" |
notificationSenderEmail | Email adress som meddelandet ska skickas från. | sträng |
privateEndpointConnections | Lista över privata slutpunktsanslutningar för den här tjänsten. | RemotePrivateEndpointConnectionWrapper[] |
publicIpAddressId | Public Standard SKU IP V4-baserad IP-adress som ska associeras med Virtual Network distribuerade tjänsten i regionen. Stöds endast för utvecklare och Premium SKU som distribueras i Virtual Network. | sträng |
publicNetworkAccess | Om offentlig slutpunktsåtkomst tillåts för den här API Management tjänsten eller inte. Värdet är valfritt, men om det skickas måste det vara Aktiverat eller Inaktiverat. Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat" | "Inaktiverad" "Aktiverad" |
publisherEmail | E-postutfärdare. | sträng (krävs) |
publisherName | Utgivarens namn. | sträng (krävs) |
återställ | Ta bort Api Management-tjänsten om den tidigare har tagits bort mjukt. Om den här flaggan har angetts och angetts till Sant ignoreras alla andra egenskaper. | boolesk |
virtualNetworkConfiguration | Konfiguration av virtuellt nätverk för API Management-tjänsten. | VirtualNetworkConfiguration |
virtualNetworkType | Den typ av VPN som API Management-tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i någon Virtual Network, extern innebär att API Management-distributionen har konfigurerats i en Virtual Network med en Internetuppkopplad slutpunkt och intern innebär att API Management distributionen konfigureras i en Virtual Network endast har en intranätuppkopplad slutpunkt. | "Externt" "Intern" "Ingen" |
AdditionalLocation
Name | Beskrivning | Värde |
---|---|---|
disableGateway | Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen på den här ytterligare platsen. | boolesk |
location | Platsnamnet för den ytterligare regionen bland Azure-datacenterregioner. | sträng (krävs) |
natGatewayState | Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten. | "Inaktiverad" "Aktiverad" |
publicIpAddressId | Public Standard SKU IP V4-baserad IP-adress som ska associeras med Virtual Network distribuerade tjänsten på platsen. Stöds endast för Premium SKU som distribueras i Virtual Network. | sträng |
sku | SKU-egenskaper för API Management-tjänsten. | ApiManagementServiceSkuProperties (krävs) |
virtualNetworkConfiguration | Konfiguration av virtuellt nätverk för platsen. | VirtualNetworkConfiguration |
Zoner | En lista över tillgänglighetszoner som anger var resursen måste komma ifrån. | string[] |
ApiManagementServiceSkuProperties
Name | Beskrivning | Värde |
---|---|---|
capacity | SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). För SKU-kapacitet för förbrukning måste anges som 0. | int (obligatoriskt) |
name | Namnet på SKU:n. | "Grundläggande" "Förbrukning" "Utvecklare" "Isolerad" "Premium" "Standard" (obligatoriskt) |
VirtualNetworkConfiguration
Name | Beskrivning | Värde |
---|---|---|
subnetResourceId | Det fullständiga resurs-ID:t för ett undernät i ett virtuellt nätverk för att distribuera API Management-tjänsten i. | sträng |
ApiVersionConstraint
Name | Beskrivning | Värde |
---|---|---|
minApiVersion | Begränsa API-anrop på kontrollplanet till API Management tjänst med en version som är lika med eller nyare än det här värdet. | sträng |
CertificateConfiguration
Name | Beskrivning | Värde |
---|---|---|
certifikat | Certifikatinformation. | CertificateInformation |
certificatePassword | Certifikatlösenord. | sträng |
encodedCertificate | Base64-kodat certifikat. | sträng |
storeName | Certifikatarkivet System.Security.Cryptography.x509certificates.StoreName. Endast Root och CertificateAuthority är giltiga platser. | "CertificateAuthority" "Root" (krävs) |
CertificateInformation
Name | Beskrivning | Värde |
---|---|---|
Utgången | Certifikatets förfallodatum. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden. |
sträng (krävs) |
ämne | Certifikatets ämne. | sträng (krävs) |
Stämpel | Tumavtryck för certifikatet. | sträng (krävs) |
ApiManagementServiceBasePropertiesCustomProperties
Name | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | sträng |
HostnameConfiguration
Name | Beskrivning | Värde |
---|---|---|
certifikat | Certifikatinformation. | CertificateInformation |
certificatePassword | Certifikatlösenord. | sträng |
certificateSource | Certifikatkälla. | "BuiltIn" "Anpassad" "KeyVault" "Hanterad" |
certificateStatus | Certifikatstatus. | "Slutfört" "Misslyckades" "InProgress" |
defaultSslBinding | Ange true för att konfigurera certifikatet som är associerat med det här värdnamnet som standard-SSL-certifikat. Om en klient inte skickar SNI-huvudet är detta certifikatet som kommer att utmanas. Egenskapen är användbar om en tjänst har flera anpassade värdnamn aktiverade och måste bestämma standard-SSL-certifikatet. Inställningen tillämpas endast på gatewayens värdnamnstyp. | boolesk |
encodedCertificate | Base64-kodat certifikat. | sträng |
Värdnamn | Värdnamn som ska konfigureras på Api Management-tjänsten. | sträng (krävs) |
identityClientId | ClientId för system- eller användartilldelad hanterad identitet som genereras av Azure AD, som har GET-åtkomst till keyVault som innehåller SSL-certifikatet. | sträng |
keyVaultId | Url till KeyVault-hemligheten som innehåller Ssl-certifikatet. Om absolut URL som innehåller version tillhandahålls fungerar inte automatisk uppdatering av SSL-certifikatet. Detta kräver att Api Management-tjänsten konfigureras med aka.ms/apimmsi. Hemligheten ska vara av typen application/x-pkcs12 | sträng |
negotiateClientCertificate | Ange true för att alltid förhandla om klientcertifikatet på värdnamnet. Standardvärdet är falskt. | boolesk |
typ | Typ av värdnamn. | "DeveloperPortal" "Hantering" "Portal" "Proxy" "Scm" (krävs) |
RemotePrivateEndpointConnectionWrapper
Name | Beskrivning | Värde |
---|---|---|
id | Resurs-ID för privat slutpunktsanslutning | sträng |
name | Anslutningsnamn för privat slutpunkt | sträng |
properties | Resursegenskaper. | PrivateEndpointConnectionWrapperEgenskaper |
typ | Resurstyp för privat slutpunktsanslutning | sträng |
PrivateEndpointConnectionWrapperEgenskaper
Name | Beskrivning | Värde |
---|---|---|
privateEndpoint | Resursen för den privata slutpunkten. | ArmIdWrapper |
privateLinkServiceConnectionState | En samling med information om tillståndet för anslutningen mellan tjänstekonsumenten och leverantören. | PrivateLinkServiceConnectionState (krävs) |
ArmIdWrapper
Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.
PrivateLinkServiceConnectionState
Name | Beskrivning | Värde |
---|---|---|
actionsRequired | Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten. | sträng |
beskrivning | Anledningen till godkännande/avvisande av anslutningen. | sträng |
status | Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare. | "Godkänd" "Väntar" "Avvisad" |