Microsoft.ApiManagement hizmeti

Makale
12/21/2024

Bicep kaynak tanımı

Hizmet kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

kaynak grupları - Bkz. kaynak grubu dağıtım komutları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.ApiManagement/service@2024-06-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        disableGateway: bool
        location: 'string'
        natGatewayState: 'string'
        publicIpAddressId: 'string'
        sku: {
          capacity: int
          name: 'string'
        }
        virtualNetworkConfiguration: {
          subnetResourceId: 'string'
        }
        zones: [
          'string'
        ]
      }
    ]
    apiVersionConstraint: {
      minApiVersion: 'string'
    }
    certificates: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        encodedCertificate: 'string'
        storeName: 'string'
      }
    ]
    configurationApi: {
      legacyApi: 'string'
    }
    customProperties: {
      {customized property}: 'string'
    }
    developerPortalStatus: 'string'
    disableGateway: bool
    enableClientCertificate: bool
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        certificateSource: 'string'
        certificateStatus: 'string'
        defaultSslBinding: bool
        encodedCertificate: 'string'
        hostName: 'string'
        identityClientId: 'string'
        keyVaultId: 'string'
        negotiateClientCertificate: bool
        type: 'string'
      }
    ]
    legacyPortalStatus: 'string'
    natGatewayState: 'string'
    notificationSenderEmail: 'string'
    privateEndpointConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
        type: 'string'
      }
    ]
    publicIpAddressId: 'string'
    publicNetworkAccess: 'string'
    publisherEmail: 'string'
    publisherName: 'string'
    releaseChannel: 'string'
    restore: bool
    virtualNetworkConfiguration: {
      subnetResourceId: 'string'
    }
    virtualNetworkType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Özellik değerleri

AdditionalLocation

Ad	Açıklama	Değer
disableGateway	Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu, ağ geçidini bu ek konumda devre dışı bırakmak için kullanılabilir.	Bool
yer	Azure Veri merkezi bölgeleri arasındaki ek bölgenin konum adı.	dize (gerekli)
natGatewayState	Özellik, bu API Management hizmeti için NAT Gateway'i etkinleştirmek için kullanılabilir.	'Devre Dışı' 'Etkin'
publicIpAddressId	Genel Standart SKU IP V4 tabanlı IP adresi, konumda Sanal Ağ tarafından dağıtılan hizmetle ilişkilendirilecek. Yalnızca Sanal Ağ'da dağıtılan Premium SKU için desteklenir.	dizgi
Sku	API Management hizmetinin SKU özellikleri.	ApiManagementServiceSkuProperties (gerekli)
virtualNetworkConfiguration	Konum için sanal ağ yapılandırması.	VirtualNetworkConfiguration
Bölge	Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.	string[]

ApiManagementServiceBasePropertiesCustomProperties

Ad	Açıklama	Değer

ApiManagementServiceIdentity

Ad	Açıklama	Değer
tür	Kaynak için kullanılan kimlik türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.	'Hiçbiri' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (gerekli)
userAssignedIdentities	Kaynakla ilişkili kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlük anahtarı başvuruları şu biçimde ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Ad	Açıklama	Değer

ApiManagementServiceProperties

Ad	Açıklama	Değer
additionalLocations	API Management hizmetinin ek veri merkezi konumları.	AdditionalLocation[]
apiVersionConstraint	API Management hizmeti için Denetim Düzlemi API'leri sürüm kısıtlaması.	ApiVersionConstraint
Sertifika	API Management hizmetinde yüklenmesi gereken Sertifikaların listesi. Yüklenebilen desteklenen en fazla sertifika 10'dur.	CertificateConfiguration[]
configurationApi	API Management hizmetinin yapılandırma API yapılandırması.	ConfigurationApi
customProperties	API Management hizmetinin özel özellikleri. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` ayarı tüm TLS(1.0, 1.1 ve 1.2) için şifreleme TLS_RSA_WITH_3DES_EDE_CBC_SHA devre dışı bırakır. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` ayarı yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` ayarlama, API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` ayarı, arka uçlarla iletişimde yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` ayarı, arka uçlarla yapılan iletişimlerde TLS 1.0'ı devre dışı bırakmak için kullanılabilir. `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` ayarı, BIR API Management hizmetinde HTTP2 protokollerini etkinleştirmek için kullanılabilir. PATCH işleminde bu özelliklerden herhangi birinin belirtilmemesi, atlanmış özelliklerin değerlerini varsayılan değerlerine sıfırlar. Http2 dışındaki tüm ayarlar için, hizmet 1 Nisan 2018 tarihinde veya öncesinde oluşturulduysa ve `True` değilse varsayılan değer `False`. Http2 ayarının varsayılan değeri `False`. Aşağıdaki şifrelerden herhangi birini `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`ayarları kullanarak devre dışı bırakabilirsiniz: 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. Örneğin, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Varsayılan değer onlar için `true`. Not: İç platform bileşenleri için gerekli olduğundan aşağıdaki şifreler devre dışı bırakılamaz: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256	ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus	Bu API Management hizmetindeki geliştirici portalının durumu.	'Devre Dışı' 'Etkin'
disableGateway	Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu, ana bölgede ağ geçidini devre dışı bırakmak için kullanılabilir.	Bool
enableClientCertificate	Özellik yalnızca Tüketim SKU Hizmeti için kullanılacaktır. Bu, ağ geçidine yapılan her istekte bir istemci sertifikasının sunulmasını zorlar. Bu, ağ geçidindeki ilkede sertifikanın kimliğini doğrulama olanağı da sağlar.	Bool
hostnameConfigurations	API Management hizmetinin özel ana bilgisayar adı yapılandırması.	HostnameConfiguration[]
legacyPortalStatus	API Management hizmetindeki eski portalın durumu.	'Devre Dışı' 'Etkin'
natGatewayState	Özellik, bu API Management hizmeti için NAT Gateway'i etkinleştirmek için kullanılabilir.	'Devre Dışı' 'Etkin'
notificationSenderEmail	Bildirimin gönderileceği e-posta adresi.	dizgi Kısıtlama -ları: Maksimum uzunluk =
privateEndpointConnections	Bu hizmetin Özel Uç Nokta Bağlantılarının listesi.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Bölgede Sanal Ağ ile dağıtılan hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağda dağıtılan Geliştirici ve Premium SKU için desteklenir.	dizgi
publicNetworkAccess	Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise özel uç noktalar özel erişim yöntemidir. Varsayılan değer 'Etkin'	'Devre Dışı' 'Etkin'
publisherEmail	Yayımcı e-postası.	dizgi Kısıtlama -ları: Maksimum uzunluk = (gerekli)
publisherName	Yayımcı adı.	dizgi Kısıtlama -ları: Maksimum uzunluk = (gerekli)
releaseChannel	Bu API Management hizmetinin Yayın Kanalı.	'Varsayılan' 'Önizleme' 'Kararlı'
geri yüklemek	Daha önce geçici olarak silinmişse Api Management Hizmeti'nin geri alma işlemini kaldırın. Bu bayrak belirtilirse ve True olarak ayarlanırsa diğer tüm özellikler yoksayılır.	Bool
virtualNetworkConfiguration	API Management hizmetinin sanal ağ yapılandırması.	VirtualNetworkConfiguration
virtualNetworkType	API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağın parçası olmadığı anlamına gelir; Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı ve İç, API Management dağıtımının yalnızca Intranet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı anlamına gelir.	'Dış' 'İç' 'Hiçbiri'

ApiManagementServiceSkuProperties

Ad	Açıklama	Değer
kapasite	SKU'nun kapasitesi (SKU'nun dağıtılan birim sayısı). Tüketim SKU'su kapasitesi 0 olarak belirtilmelidir.	int (gerekli)
ad	Sku'nun adı.	'Temel' 'BasicV2' 'Tüketim' 'Geliştirici' 'Yalıtılmış' 'Premium' 'Standart' 'StandardV2' (gerekli)

ApimResourceTags

Ad	Açıklama	Değer

ApiVersionConstraint

Ad	Açıklama	Değer
minApiVersion	Api Management hizmetine yapılan denetim düzlemi API çağrılarını bu değere eşit veya bundan daha yeni bir sürümle sınırlayın.	dizgi

ArmIdWrapper

Ad	Açıklama	Değer

CertificateConfiguration

Ad	Açıklama	Değer
sertifika	Sertifika bilgileri.	CertificateInformation
certificatePassword	Sertifika Parolası.	dizgi
encodedCertificate	Base64 Kodlanmış sertifika.	dizgi
storeName	System.Security.Cryptography.x509certificates.StoreName sertifika deposu konumu. Yalnızca Kök ve CertificateAuthority geçerli konumlardır.	'CertificateAuthority' 'Kök' (gerekli)

CertificateInformation

Ad	Açıklama	Değer
Bitiş	Sertifikanın son kullanma tarihi. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen `yyyy-MM-ddTHH:mm:ssZ`.	dize (gerekli)
Konu	Sertifikanın konusu.	dize (gerekli)
Parmak izi	Sertifikanın parmak izi.	dize (gerekli)

ConfigurationApi

Ad	Açıklama	Değer
legacyApi	API Management hizmetinde eski Yapılandırma API'sinin (v1) kullanıma açılıp sunulmayacağının göstergesi. Değer isteğe bağlıdır ancak 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise, şirket içinde barındırılan ağ geçitleri için eski Yapılandırma API'si (v1) kullanılamaz. Varsayılan değer 'Etkin'	'Devre Dışı' 'Etkin'

HostnameConfiguration

Ad	Açıklama	Değer
sertifika	Sertifika bilgileri.	CertificateInformation
certificatePassword	Sertifika Parolası.	dizgi
certificateSource	Sertifika Kaynağı.	'Yerleşik' 'Özel' 'KeyVault' 'Yönetilen'
certificateStatus	Sertifika Durumu.	'Tamamlandı' 'Başarısız' 'InProgress'
defaultSslBinding	Bu Konak adıyla ilişkili sertifikayı Varsayılan SSL Sertifikası olarak ayarlamak için true değerini belirtin. bir istemci SNI üst bilgisini göndermezse, bu sorgulanacak sertifika olacaktır. Özelliği, bir hizmetin birden çok özel ana bilgisayar adı etkinleştirilmişse ve varsayılan ssl sertifikasına karar vermesi gerekiyorsa kullanışlıdır. Ayar yalnızca ağ geçidi Ana Bilgisayar Adı Türüne uygulanır.	Bool
encodedCertificate	Base64 Kodlanmış sertifika.	dizgi
hostName	Api Management hizmetinde yapılandırılan ana bilgisayar adı.	dize (gerekli)
identityClientId	Azure AD tarafından oluşturulan ve SSL sertifikasını içeren keyVault anahtarına GET erişimi olan Sistem veya Kullanıcı Tarafından Atanan Yönetilen kimlik clientId değeri.	dizgi
keyVaultId	Ssl Sertifikasını içeren KeyVault Gizli Dizisi url'si. Sürüm içeren mutlak Url sağlanırsa ssl sertifikasının otomatik olarak güncelleştirilmesi çalışmaz. Bunun için Api Management hizmetinin aka.ms/apimmsi ile yapılandırılması gerekir. Gizli dizi application/x-pkcs12 türünde olmalıdır	dizgi
negotiateClientCertificate	Ana bilgisayar adında istemci sertifikası üzerinde her zaman anlaşmak için true değerini belirtin. Varsayılan Değer false'tur.	Bool
tür	Ana bilgisayar adı türü.	'ConfigurationApi' 'DeveloperPortal' 'Yönetim' 'Portal' 'Proxy' 'Scm' (gerekli)

Microsoft.ApiManagement/service

Ad	Açıklama	Değer
kimlik	Api Management hizmetinin yönetilen hizmet kimliği.	ApiManagementServiceIdentity
yer	Kaynak konumu.	dize (gerekli)
ad	Kaynak adı	dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 1 Desen = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` (gerekli)
Özellikler	API Management hizmetinin özellikleri.	ApiManagementServiceProperties (gerekli)
Sku	API Management hizmetinin SKU özellikleri.	ApiManagementServiceSkuProperties (gerekli)
Etiketler	Kaynak etiketleri	Etiket adları ve değerleri sözlüğü. Bkz. şablonlardaki Etiketleri
Bölge	Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.	string[]

PrivateEndpointConnectionWrapperProperties

Ad	Açıklama	Değer
privateEndpoint	Özel uç noktanın kaynağı.	ArmIdWrapper
privateLinkServiceConnectionState	Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.	PrivateLinkServiceConnectionState (gerekli)

PrivateLinkServiceConnectionState

Ad	Açıklama	Değer
actionsRequired	Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.	dizgi
Açıklama	Bağlantının onaylanması/reddedilmesinin nedeni.	dizgi
durum	Bağlantının hizmet sahibi tarafından Onaylanıp Reddedildiğini/Kaldırıldığını gösterir.	'Onaylandı' 'Beklemede' 'Reddedildi'

RemotePrivateEndpointConnectionWrapper

Ad	Açıklama	Değer
Kimliği	Özel Uç Nokta bağlantı kaynak kimliği	dizgi
ad	Özel Uç Nokta Bağlantı Adı	dizgi
Özellikler	Kaynak özellikleri.	PrivateEndpointConnectionWrapperProperties
tür	Özel Uç Nokta Bağlantı Kaynak Türü	dizgi

UserIdentityProperties

Ad	Açıklama	Değer
clientId	Kullanıcı tarafından atanan kimliğin istemci kimliği.	dizgi
principalId	Kullanıcı tarafından atanan kimliğin asıl kimliği.	dizgi

VirtualNetworkConfiguration

Ad	Açıklama	Değer
subnetResourceId	API Management hizmetinin dağıtılacağı sanal ağdaki bir alt ağın tam kaynak kimliği.	dizgi Kısıtlama -ları: Desen = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

Hızlı başlangıç örnekleri

Aşağıdaki hızlı başlangıç örnekleri bu kaynak türünü dağıtır.

Bicep Dosyası	Açıklama
İç API Management ve Web App ile Application Gateway	Application Gateway, İnternet trafiğini Azure Web App'te barındırılan bir web API'sine hizmet veren bir sanal ağ (iç mod) API Management örneğine yönlendirir.
Çok bölgeli Premium katman API Management örneği oluşturma	Bu şablon, ek konumlar içeren bir API Management örneğinin nasıl oluşturulacağını gösterir. Birincil konum, kaynak grubunun konumuyla aynıdır. Ek konumlar için şablon NorthCentralUs ve Doğu ABD2'yi gösterir. Birincil konum ek konumlardan farklı olmalıdır.
MSI Kimliği sahip bir API Management örneği oluşturma	Bu şablon, MSI Kimliğine sahip bir Azure API Management geliştirici örneği oluşturur
Şablon kullanarak API Management örneği oluşturma	Bu şablon Azure API Management'ın geliştirici örneğini oluşturur
Özel uç nokta ile API Management hizmeti oluşturma	Bu şablon, API Management hizmetini sanal ağa maruz bırakarak bir API Management hizmeti, bir sanal ağ ve özel uç nokta oluşturur.
KeyVault SSL ile API Management hizmeti oluşturma	Bu şablon, Kullanıcı Tarafından Atanan Kimlik ile yapılandırılmış bir API Management hizmeti dağıtır. KeyVault'tan SSL sertifikası getirmek için bu kimliği kullanır ve her 4 saatte bir denetleyerek bu sertifikayı güncel tutar.
App Gateway ile İç Sanal Ağda API Management Oluşturma	Bu şablon, Azure Application Gateway tarafından korunan özel bir ağda Azure API Management örneği oluşturma adımlarını gösterir.
genel IP ile dış sanal ağda API Management'ı dağıtma	Bu şablon, dış modda sanal ağınızın alt ağı içindeki Premium katmanında Azure API Management örneğinin nasıl oluşturulacağını ve alt ağda önerilen NSG kurallarının nasıl yapılandıracağını gösterir. Örnek iki kullanılabilirlik alanına dağıtılır. Şablon ayrıca aboneliğinizden bir genel IP adresi de yapılandırıyor.
genel IP ile API Management'ı iç sanal ağda dağıtma	Bu şablon, iç modda sanal ağınızın alt ağı içindeki Premium katmanında Azure API Management örneğinin nasıl oluşturulacağını ve alt ağda önerilen NSG kurallarının nasıl yapılandıracağını gösterir. Örnek iki kullanılabilirlik alanına dağıtılır. Şablon ayrıca aboneliğinizden bir genel IP adresi de yapılandırıyor.
API Management'ı Kullanılabilirlik Alanlarına Dağıtma	Bu şablon, Azure API Management'ın premium bir örneğini oluşturur ve bir Kullanılabilirlik Alanına dağıtır
Api Management'ı Dış Azure Cache for Redis ile Dağıtma	Bu şablon, Dış Redis için Azure Cache örneğini API Management dış önbelleği olarak kullanarak Tüketim katmanında Azure API Management örneğinin nasıl oluşturulacağını gösterir.
API Management kaynağı ile Front Door Standard/Premium	Bu şablon bir Front Door Premium ve API Management örneği oluşturur ve trafiğin Front Door kaynağından geldiğini doğrulamak için bir NSG ve genel API Management ilkesi kullanır.

ARM şablonu kaynak tanımı

Hizmet kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

kaynak grupları - Bkz. kaynak grubu dağıtım komutları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": "bool",
        "location": "string",
        "natGatewayState": "string",
        "publicIpAddressId": "string",
        "sku": {
          "capacity": "int",
          "name": "string"
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "string"
        },
        "zones": [ "string" ]
      }
    ],
    "apiVersionConstraint": {
      "minApiVersion": "string"
    },
    "certificates": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "encodedCertificate": "string",
        "storeName": "string"
      }
    ],
    "configurationApi": {
      "legacyApi": "string"
    },
    "customProperties": {
      "{customized property}": "string"
    },
    "developerPortalStatus": "string",
    "disableGateway": "bool",
    "enableClientCertificate": "bool",
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "certificateSource": "string",
        "certificateStatus": "string",
        "defaultSslBinding": "bool",
        "encodedCertificate": "string",
        "hostName": "string",
        "identityClientId": "string",
        "keyVaultId": "string",
        "negotiateClientCertificate": "bool",
        "type": "string"
      }
    ],
    "legacyPortalStatus": "string",
    "natGatewayState": "string",
    "notificationSenderEmail": "string",
    "privateEndpointConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        },
        "type": "string"
      }
    ],
    "publicIpAddressId": "string",
    "publicNetworkAccess": "string",
    "publisherEmail": "string",
    "publisherName": "string",
    "releaseChannel": "string",
    "restore": "bool",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "string"
    },
    "virtualNetworkType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Özellik değerleri

AdditionalLocation

Ad	Açıklama	Değer
disableGateway	Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu, ağ geçidini bu ek konumda devre dışı bırakmak için kullanılabilir.	Bool
yer	Azure Veri merkezi bölgeleri arasındaki ek bölgenin konum adı.	dize (gerekli)
natGatewayState	Özellik, bu API Management hizmeti için NAT Gateway'i etkinleştirmek için kullanılabilir.	'Devre Dışı' 'Etkin'
publicIpAddressId	Genel Standart SKU IP V4 tabanlı IP adresi, konumda Sanal Ağ tarafından dağıtılan hizmetle ilişkilendirilecek. Yalnızca Sanal Ağ'da dağıtılan Premium SKU için desteklenir.	dizgi
Sku	API Management hizmetinin SKU özellikleri.	ApiManagementServiceSkuProperties (gerekli)
virtualNetworkConfiguration	Konum için sanal ağ yapılandırması.	VirtualNetworkConfiguration
Bölge	Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.	string[]

ApiManagementServiceBasePropertiesCustomProperties

Ad	Açıklama	Değer

ApiManagementServiceIdentity

Ad	Açıklama	Değer
tür	Kaynak için kullanılan kimlik türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.	'Hiçbiri' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (gerekli)
userAssignedIdentities	Kaynakla ilişkili kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlük anahtarı başvuruları şu biçimde ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Ad	Açıklama	Değer

ApiManagementServiceProperties

Ad	Açıklama	Değer
additionalLocations	API Management hizmetinin ek veri merkezi konumları.	AdditionalLocation[]
apiVersionConstraint	API Management hizmeti için Denetim Düzlemi API'leri sürüm kısıtlaması.	ApiVersionConstraint
Sertifika	API Management hizmetinde yüklenmesi gereken Sertifikaların listesi. Yüklenebilen desteklenen en fazla sertifika 10'dur.	CertificateConfiguration[]
configurationApi	API Management hizmetinin yapılandırma API yapılandırması.	ConfigurationApi
customProperties	API Management hizmetinin özel özellikleri. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` ayarı tüm TLS(1.0, 1.1 ve 1.2) için şifreleme TLS_RSA_WITH_3DES_EDE_CBC_SHA devre dışı bırakır. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` ayarı yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` ayarlama, API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` ayarı, arka uçlarla iletişimde yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` ayarı, arka uçlarla yapılan iletişimlerde TLS 1.0'ı devre dışı bırakmak için kullanılabilir. `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` ayarı, BIR API Management hizmetinde HTTP2 protokollerini etkinleştirmek için kullanılabilir. PATCH işleminde bu özelliklerden herhangi birinin belirtilmemesi, atlanmış özelliklerin değerlerini varsayılan değerlerine sıfırlar. Http2 dışındaki tüm ayarlar için, hizmet 1 Nisan 2018 tarihinde veya öncesinde oluşturulduysa ve `True` değilse varsayılan değer `False`. Http2 ayarının varsayılan değeri `False`. Aşağıdaki şifrelerden herhangi birini `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`ayarları kullanarak devre dışı bırakabilirsiniz: 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. Örneğin, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Varsayılan değer onlar için `true`. Not: İç platform bileşenleri için gerekli olduğundan aşağıdaki şifreler devre dışı bırakılamaz: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256	ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus	Bu API Management hizmetindeki geliştirici portalının durumu.	'Devre Dışı' 'Etkin'
disableGateway	Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu, ana bölgede ağ geçidini devre dışı bırakmak için kullanılabilir.	Bool
enableClientCertificate	Özellik yalnızca Tüketim SKU Hizmeti için kullanılacaktır. Bu, ağ geçidine yapılan her istekte bir istemci sertifikasının sunulmasını zorlar. Bu, ağ geçidindeki ilkede sertifikanın kimliğini doğrulama olanağı da sağlar.	Bool
hostnameConfigurations	API Management hizmetinin özel ana bilgisayar adı yapılandırması.	HostnameConfiguration[]
legacyPortalStatus	API Management hizmetindeki eski portalın durumu.	'Devre Dışı' 'Etkin'
natGatewayState	Özellik, bu API Management hizmeti için NAT Gateway'i etkinleştirmek için kullanılabilir.	'Devre Dışı' 'Etkin'
notificationSenderEmail	Bildirimin gönderileceği e-posta adresi.	dizgi Kısıtlama -ları: Maksimum uzunluk =
privateEndpointConnections	Bu hizmetin Özel Uç Nokta Bağlantılarının listesi.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Bölgede Sanal Ağ ile dağıtılan hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağda dağıtılan Geliştirici ve Premium SKU için desteklenir.	dizgi
publicNetworkAccess	Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise özel uç noktalar özel erişim yöntemidir. Varsayılan değer 'Etkin'	'Devre Dışı' 'Etkin'
publisherEmail	Yayımcı e-postası.	dizgi Kısıtlama -ları: Maksimum uzunluk = (gerekli)
publisherName	Yayımcı adı.	dizgi Kısıtlama -ları: Maksimum uzunluk = (gerekli)
releaseChannel	Bu API Management hizmetinin Yayın Kanalı.	'Varsayılan' 'Önizleme' 'Kararlı'
geri yüklemek	Daha önce geçici olarak silinmişse Api Management Hizmeti'nin geri alma işlemini kaldırın. Bu bayrak belirtilirse ve True olarak ayarlanırsa diğer tüm özellikler yoksayılır.	Bool
virtualNetworkConfiguration	API Management hizmetinin sanal ağ yapılandırması.	VirtualNetworkConfiguration
virtualNetworkType	API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağın parçası olmadığı anlamına gelir; Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı ve İç, API Management dağıtımının yalnızca Intranet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı anlamına gelir.	'Dış' 'İç' 'Hiçbiri'

ApiManagementServiceSkuProperties

Ad	Açıklama	Değer
kapasite	SKU'nun kapasitesi (SKU'nun dağıtılan birim sayısı). Tüketim SKU'su kapasitesi 0 olarak belirtilmelidir.	int (gerekli)
ad	Sku'nun adı.	'Temel' 'BasicV2' 'Tüketim' 'Geliştirici' 'Yalıtılmış' 'Premium' 'Standart' 'StandardV2' (gerekli)

ApimResourceTags

Ad	Açıklama	Değer

ApiVersionConstraint

Ad	Açıklama	Değer
minApiVersion	Api Management hizmetine yapılan denetim düzlemi API çağrılarını bu değere eşit veya bundan daha yeni bir sürümle sınırlayın.	dizgi

ArmIdWrapper

Ad	Açıklama	Değer

CertificateConfiguration

Ad	Açıklama	Değer
sertifika	Sertifika bilgileri.	CertificateInformation
certificatePassword	Sertifika Parolası.	dizgi
encodedCertificate	Base64 Kodlanmış sertifika.	dizgi
storeName	System.Security.Cryptography.x509certificates.StoreName sertifika deposu konumu. Yalnızca Kök ve CertificateAuthority geçerli konumlardır.	'CertificateAuthority' 'Kök' (gerekli)

CertificateInformation

Ad	Açıklama	Değer
Bitiş	Sertifikanın son kullanma tarihi. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen `yyyy-MM-ddTHH:mm:ssZ`.	dize (gerekli)
Konu	Sertifikanın konusu.	dize (gerekli)
Parmak izi	Sertifikanın parmak izi.	dize (gerekli)

ConfigurationApi

Ad	Açıklama	Değer
legacyApi	API Management hizmetinde eski Yapılandırma API'sinin (v1) kullanıma açılıp sunulmayacağının göstergesi. Değer isteğe bağlıdır ancak 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise, şirket içinde barındırılan ağ geçitleri için eski Yapılandırma API'si (v1) kullanılamaz. Varsayılan değer 'Etkin'	'Devre Dışı' 'Etkin'

HostnameConfiguration

Ad	Açıklama	Değer
sertifika	Sertifika bilgileri.	CertificateInformation
certificatePassword	Sertifika Parolası.	dizgi
certificateSource	Sertifika Kaynağı.	'Yerleşik' 'Özel' 'KeyVault' 'Yönetilen'
certificateStatus	Sertifika Durumu.	'Tamamlandı' 'Başarısız' 'InProgress'
defaultSslBinding	Bu Konak adıyla ilişkili sertifikayı Varsayılan SSL Sertifikası olarak ayarlamak için true değerini belirtin. bir istemci SNI üst bilgisini göndermezse, bu sorgulanacak sertifika olacaktır. Özelliği, bir hizmetin birden çok özel ana bilgisayar adı etkinleştirilmişse ve varsayılan ssl sertifikasına karar vermesi gerekiyorsa kullanışlıdır. Ayar yalnızca ağ geçidi Ana Bilgisayar Adı Türüne uygulanır.	Bool
encodedCertificate	Base64 Kodlanmış sertifika.	dizgi
hostName	Api Management hizmetinde yapılandırılan ana bilgisayar adı.	dize (gerekli)
identityClientId	Azure AD tarafından oluşturulan ve SSL sertifikasını içeren keyVault anahtarına GET erişimi olan Sistem veya Kullanıcı Tarafından Atanan Yönetilen kimlik clientId değeri.	dizgi
keyVaultId	Ssl Sertifikasını içeren KeyVault Gizli Dizisi url'si. Sürüm içeren mutlak Url sağlanırsa ssl sertifikasının otomatik olarak güncelleştirilmesi çalışmaz. Bunun için Api Management hizmetinin aka.ms/apimmsi ile yapılandırılması gerekir. Gizli dizi application/x-pkcs12 türünde olmalıdır	dizgi
negotiateClientCertificate	Ana bilgisayar adında istemci sertifikası üzerinde her zaman anlaşmak için true değerini belirtin. Varsayılan Değer false'tur.	Bool
tür	Ana bilgisayar adı türü.	'ConfigurationApi' 'DeveloperPortal' 'Yönetim' 'Portal' 'Proxy' 'Scm' (gerekli)

Microsoft.ApiManagement/service

Ad	Açıklama	Değer
apiVersion	API sürümü	'2024-06-01-preview'
kimlik	Api Management hizmetinin yönetilen hizmet kimliği.	ApiManagementServiceIdentity
yer	Kaynak konumu.	dize (gerekli)
ad	Kaynak adı	dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 1 Desen = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` (gerekli)
Özellikler	API Management hizmetinin özellikleri.	ApiManagementServiceProperties (gerekli)
Sku	API Management hizmetinin SKU özellikleri.	ApiManagementServiceSkuProperties (gerekli)
Etiketler	Kaynak etiketleri	Etiket adları ve değerleri sözlüğü. Bkz. şablonlardaki Etiketleri
tür	Kaynak türü	'Microsoft.ApiManagement/service'
Bölge	Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.	string[]

PrivateEndpointConnectionWrapperProperties

Ad	Açıklama	Değer
privateEndpoint	Özel uç noktanın kaynağı.	ArmIdWrapper
privateLinkServiceConnectionState	Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.	PrivateLinkServiceConnectionState (gerekli)

PrivateLinkServiceConnectionState

Ad	Açıklama	Değer
actionsRequired	Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.	dizgi
Açıklama	Bağlantının onaylanması/reddedilmesinin nedeni.	dizgi
durum	Bağlantının hizmet sahibi tarafından Onaylanıp Reddedildiğini/Kaldırıldığını gösterir.	'Onaylandı' 'Beklemede' 'Reddedildi'

RemotePrivateEndpointConnectionWrapper

Ad	Açıklama	Değer
Kimliği	Özel Uç Nokta bağlantı kaynak kimliği	dizgi
ad	Özel Uç Nokta Bağlantı Adı	dizgi
Özellikler	Kaynak özellikleri.	PrivateEndpointConnectionWrapperProperties
tür	Özel Uç Nokta Bağlantı Kaynak Türü	dizgi

UserIdentityProperties

Ad	Açıklama	Değer
clientId	Kullanıcı tarafından atanan kimliğin istemci kimliği.	dizgi
principalId	Kullanıcı tarafından atanan kimliğin asıl kimliği.	dizgi

VirtualNetworkConfiguration

Ad	Açıklama	Değer
subnetResourceId	API Management hizmetinin dağıtılacağı sanal ağdaki bir alt ağın tam kaynak kimliği.	dizgi Kısıtlama -ları: Desen = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon	Açıklama
İç API Management ve Web App ile Application Gateway dağıtım	Application Gateway, İnternet trafiğini Azure Web App'te barındırılan bir web API'sine hizmet veren bir sanal ağ (iç mod) API Management örneğine yönlendirir.
Çok bölgeli Premium katman API Management örneği oluşturma dağıtım	Bu şablon, ek konumlar içeren bir API Management örneğinin nasıl oluşturulacağını gösterir. Birincil konum, kaynak grubunun konumuyla aynıdır. Ek konumlar için şablon NorthCentralUs ve Doğu ABD2'yi gösterir. Birincil konum ek konumlardan farklı olmalıdır.
Şablon kullanarak API Management örneği ve tüm alt kaynakları oluşturma dağıtım	Bu şablon, API Management hizmeti oluşturma ve alt varlıkları yapılandırma adımlarını gösterir
MSI Kimliği sahip bir API Management örneği oluşturma dağıtım	Bu şablon, MSI Kimliğine sahip bir Azure API Management geliştirici örneği oluşturur
Şablon kullanarak API Management örneği oluşturma dağıtım	Bu şablon Azure API Management'ın geliştirici örneğini oluşturur
Özel konak adlarıyla API Management örneği oluşturma dağıtım	Bu şablonda portal için özel konak adı ve ara sunucu için birden çok özel konak adı ile Azure API Management örneğinin nasıl oluşturulacağı gösterilmektedir
Özel uç nokta ile API Management hizmeti oluşturma dağıtım	Bu şablon, API Management hizmetini sanal ağa maruz bırakarak bir API Management hizmeti, bir sanal ağ ve özel uç nokta oluşturur.
KeyVault SSL ile API Management hizmeti oluşturma dağıtım	Bu şablon, Kullanıcı Tarafından Atanan Kimlik ile yapılandırılmış bir API Management hizmeti dağıtır. KeyVault'tan SSL sertifikası getirmek için bu kimliği kullanır ve her 4 saatte bir denetleyerek bu sertifikayı güncel tutar.
API Management örneği oluşturma ve izleme dağıtım	Bu şablon, Azure API Management hizmetinin ve Log Analytics çalışma alanının bir örneğini oluşturur ve Log Analytics ile API Management hizmetiniz için izlemeyi ayarlar
App Gateway ile İç Sanal Ağda API Management Oluşturma dağıtım	Bu şablon, Azure Application Gateway tarafından korunan özel bir ağda Azure API Management örneği oluşturma adımlarını gösterir.
KeyVault kullanarak özel proxy ssl ile API Management oluşturma dağıtım	Bu şablonda Azure API Management örneği oluşturma ve keyvault'tan ssl sertifikası ile ara sunucu için özel ana bilgisayar adı yapılandırma adımları gösterilmektedir.
Azure API Management önünde Azure Front Door oluşturma dağıtım	Bu örnek, Azure API Management'ın önünde genel yük dengeleyici olarak Azure Front Door'un nasıl kullanılacağını gösterir.
genel IP ile dış sanal ağda API Management'ı dağıtma dağıtım	Bu şablon, dış modda sanal ağınızın alt ağı içindeki Premium katmanında Azure API Management örneğinin nasıl oluşturulacağını ve alt ağda önerilen NSG kurallarının nasıl yapılandıracağını gösterir. Örnek iki kullanılabilirlik alanına dağıtılır. Şablon ayrıca aboneliğinizden bir genel IP adresi de yapılandırıyor.
genel IP ile API Management'ı iç sanal ağda dağıtma dağıtım	Bu şablon, iç modda sanal ağınızın alt ağı içindeki Premium katmanında Azure API Management örneğinin nasıl oluşturulacağını ve alt ağda önerilen NSG kurallarının nasıl yapılandıracağını gösterir. Örnek iki kullanılabilirlik alanına dağıtılır. Şablon ayrıca aboneliğinizden bir genel IP adresi de yapılandırıyor.
API Management'ı Kullanılabilirlik Alanlarına Dağıtma dağıtım	Bu şablon, Azure API Management'ın premium bir örneğini oluşturur ve bir Kullanılabilirlik Alanına dağıtır
Api Management'ı Dış Azure Cache for Redis ile Dağıtma dağıtım	Bu şablon, Dış Redis için Azure Cache örneğini API Management dış önbelleği olarak kullanarak Tüketim katmanında Azure API Management örneğinin nasıl oluşturulacağını gösterir.
API Management kaynağı ile Front Door Standard/Premium dağıtım	Bu şablon bir Front Door Premium ve API Management örneği oluşturur ve trafiğin Front Door kaynağından geldiğini doğrulamak için bir NSG ve genel API Management ilkesi kullanır.

Terraform (AzAPI sağlayıcısı) kaynak tanımı

Hizmet kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

Kaynak grupları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2024-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"
          natGatewayState = "string"
          publicIpAddressId = "string"
          sku = {
            capacity = int
            name = "string"
          }
          virtualNetworkConfiguration = {
            subnetResourceId = "string"
          }
          zones = [
            "string"
          ]
        }
      ]
      apiVersionConstraint = {
        minApiVersion = "string"
      }
      certificates = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          encodedCertificate = "string"
          storeName = "string"
        }
      ]
      configurationApi = {
        legacyApi = "string"
      }
      customProperties = {
        {customized property} = "string"
      }
      developerPortalStatus = "string"
      disableGateway = bool
      enableClientCertificate = bool
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          certificateSource = "string"
          certificateStatus = "string"
          defaultSslBinding = bool
          encodedCertificate = "string"
          hostName = "string"
          identityClientId = "string"
          keyVaultId = "string"
          negotiateClientCertificate = bool
          type = "string"
        }
      ]
      legacyPortalStatus = "string"
      natGatewayState = "string"
      notificationSenderEmail = "string"
      privateEndpointConnections = [
        {
          id = "string"
          name = "string"
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
          type = "string"
        }
      ]
      publicIpAddressId = "string"
      publicNetworkAccess = "string"
      publisherEmail = "string"
      publisherName = "string"
      releaseChannel = "string"
      restore = bool
      virtualNetworkConfiguration = {
        subnetResourceId = "string"
      }
      virtualNetworkType = "string"
    }
  })
}

Özellik değerleri

AdditionalLocation

Ad	Açıklama	Değer
disableGateway	Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu, ağ geçidini bu ek konumda devre dışı bırakmak için kullanılabilir.	Bool
yer	Azure Veri merkezi bölgeleri arasındaki ek bölgenin konum adı.	dize (gerekli)
natGatewayState	Özellik, bu API Management hizmeti için NAT Gateway'i etkinleştirmek için kullanılabilir.	'Devre Dışı' 'Etkin'
publicIpAddressId	Genel Standart SKU IP V4 tabanlı IP adresi, konumda Sanal Ağ tarafından dağıtılan hizmetle ilişkilendirilecek. Yalnızca Sanal Ağ'da dağıtılan Premium SKU için desteklenir.	dizgi
Sku	API Management hizmetinin SKU özellikleri.	ApiManagementServiceSkuProperties (gerekli)
virtualNetworkConfiguration	Konum için sanal ağ yapılandırması.	VirtualNetworkConfiguration
Bölge	Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.	string[]

ApiManagementServiceBasePropertiesCustomProperties

Ad	Açıklama	Değer

ApiManagementServiceIdentity

Ad	Açıklama	Değer
tür	Kaynak için kullanılan kimlik türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.	'Hiçbiri' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (gerekli)
userAssignedIdentities	Kaynakla ilişkili kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlük anahtarı başvuruları şu biçimde ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Ad	Açıklama	Değer

ApiManagementServiceProperties

Ad	Açıklama	Değer
additionalLocations	API Management hizmetinin ek veri merkezi konumları.	AdditionalLocation[]
apiVersionConstraint	API Management hizmeti için Denetim Düzlemi API'leri sürüm kısıtlaması.	ApiVersionConstraint
Sertifika	API Management hizmetinde yüklenmesi gereken Sertifikaların listesi. Yüklenebilen desteklenen en fazla sertifika 10'dur.	CertificateConfiguration[]
configurationApi	API Management hizmetinin yapılandırma API yapılandırması.	ConfigurationApi
customProperties	API Management hizmetinin özel özellikleri. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` ayarı tüm TLS(1.0, 1.1 ve 1.2) için şifreleme TLS_RSA_WITH_3DES_EDE_CBC_SHA devre dışı bırakır. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` ayarı yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` ayarlama, API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` ayarı, arka uçlarla iletişimde yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir. `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` ayarı, arka uçlarla yapılan iletişimlerde TLS 1.0'ı devre dışı bırakmak için kullanılabilir. `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` ayarı, BIR API Management hizmetinde HTTP2 protokollerini etkinleştirmek için kullanılabilir. PATCH işleminde bu özelliklerden herhangi birinin belirtilmemesi, atlanmış özelliklerin değerlerini varsayılan değerlerine sıfırlar. Http2 dışındaki tüm ayarlar için, hizmet 1 Nisan 2018 tarihinde veya öncesinde oluşturulduysa ve `True` değilse varsayılan değer `False`. Http2 ayarının varsayılan değeri `False`. Aşağıdaki şifrelerden herhangi birini `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`ayarları kullanarak devre dışı bırakabilirsiniz: 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. Örneğin, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Varsayılan değer onlar için `true`. Not: İç platform bileşenleri için gerekli olduğundan aşağıdaki şifreler devre dışı bırakılamaz: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256	ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus	Bu API Management hizmetindeki geliştirici portalının durumu.	'Devre Dışı' 'Etkin'
disableGateway	Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu, ana bölgede ağ geçidini devre dışı bırakmak için kullanılabilir.	Bool
enableClientCertificate	Özellik yalnızca Tüketim SKU Hizmeti için kullanılacaktır. Bu, ağ geçidine yapılan her istekte bir istemci sertifikasının sunulmasını zorlar. Bu, ağ geçidindeki ilkede sertifikanın kimliğini doğrulama olanağı da sağlar.	Bool
hostnameConfigurations	API Management hizmetinin özel ana bilgisayar adı yapılandırması.	HostnameConfiguration[]
legacyPortalStatus	API Management hizmetindeki eski portalın durumu.	'Devre Dışı' 'Etkin'
natGatewayState	Özellik, bu API Management hizmeti için NAT Gateway'i etkinleştirmek için kullanılabilir.	'Devre Dışı' 'Etkin'
notificationSenderEmail	Bildirimin gönderileceği e-posta adresi.	dizgi Kısıtlama -ları: Maksimum uzunluk =
privateEndpointConnections	Bu hizmetin Özel Uç Nokta Bağlantılarının listesi.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Bölgede Sanal Ağ ile dağıtılan hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağda dağıtılan Geliştirici ve Premium SKU için desteklenir.	dizgi
publicNetworkAccess	Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise özel uç noktalar özel erişim yöntemidir. Varsayılan değer 'Etkin'	'Devre Dışı' 'Etkin'
publisherEmail	Yayımcı e-postası.	dizgi Kısıtlama -ları: Maksimum uzunluk = (gerekli)
publisherName	Yayımcı adı.	dizgi Kısıtlama -ları: Maksimum uzunluk = (gerekli)
releaseChannel	Bu API Management hizmetinin Yayın Kanalı.	'Varsayılan' 'Önizleme' 'Kararlı'
geri yüklemek	Daha önce geçici olarak silinmişse Api Management Hizmeti'nin geri alma işlemini kaldırın. Bu bayrak belirtilirse ve True olarak ayarlanırsa diğer tüm özellikler yoksayılır.	Bool
virtualNetworkConfiguration	API Management hizmetinin sanal ağ yapılandırması.	VirtualNetworkConfiguration
virtualNetworkType	API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağın parçası olmadığı anlamına gelir; Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı ve İç, API Management dağıtımının yalnızca Intranet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı anlamına gelir.	'Dış' 'İç' 'Hiçbiri'

ApiManagementServiceSkuProperties

Ad	Açıklama	Değer
kapasite	SKU'nun kapasitesi (SKU'nun dağıtılan birim sayısı). Tüketim SKU'su kapasitesi 0 olarak belirtilmelidir.	int (gerekli)
ad	Sku'nun adı.	'Temel' 'BasicV2' 'Tüketim' 'Geliştirici' 'Yalıtılmış' 'Premium' 'Standart' 'StandardV2' (gerekli)

ApimResourceTags

Ad	Açıklama	Değer

ApiVersionConstraint

Ad	Açıklama	Değer
minApiVersion	Api Management hizmetine yapılan denetim düzlemi API çağrılarını bu değere eşit veya bundan daha yeni bir sürümle sınırlayın.	dizgi

ArmIdWrapper

Ad	Açıklama	Değer

CertificateConfiguration

Ad	Açıklama	Değer
sertifika	Sertifika bilgileri.	CertificateInformation
certificatePassword	Sertifika Parolası.	dizgi
encodedCertificate	Base64 Kodlanmış sertifika.	dizgi
storeName	System.Security.Cryptography.x509certificates.StoreName sertifika deposu konumu. Yalnızca Kök ve CertificateAuthority geçerli konumlardır.	'CertificateAuthority' 'Kök' (gerekli)

CertificateInformation

Ad	Açıklama	Değer
Bitiş	Sertifikanın son kullanma tarihi. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen `yyyy-MM-ddTHH:mm:ssZ`.	dize (gerekli)
Konu	Sertifikanın konusu.	dize (gerekli)
Parmak izi	Sertifikanın parmak izi.	dize (gerekli)

ConfigurationApi

Ad	Açıklama	Değer
legacyApi	API Management hizmetinde eski Yapılandırma API'sinin (v1) kullanıma açılıp sunulmayacağının göstergesi. Değer isteğe bağlıdır ancak 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise, şirket içinde barındırılan ağ geçitleri için eski Yapılandırma API'si (v1) kullanılamaz. Varsayılan değer 'Etkin'	'Devre Dışı' 'Etkin'

HostnameConfiguration

Ad	Açıklama	Değer
sertifika	Sertifika bilgileri.	CertificateInformation
certificatePassword	Sertifika Parolası.	dizgi
certificateSource	Sertifika Kaynağı.	'Yerleşik' 'Özel' 'KeyVault' 'Yönetilen'
certificateStatus	Sertifika Durumu.	'Tamamlandı' 'Başarısız' 'InProgress'
defaultSslBinding	Bu Konak adıyla ilişkili sertifikayı Varsayılan SSL Sertifikası olarak ayarlamak için true değerini belirtin. bir istemci SNI üst bilgisini göndermezse, bu sorgulanacak sertifika olacaktır. Özelliği, bir hizmetin birden çok özel ana bilgisayar adı etkinleştirilmişse ve varsayılan ssl sertifikasına karar vermesi gerekiyorsa kullanışlıdır. Ayar yalnızca ağ geçidi Ana Bilgisayar Adı Türüne uygulanır.	Bool
encodedCertificate	Base64 Kodlanmış sertifika.	dizgi
hostName	Api Management hizmetinde yapılandırılan ana bilgisayar adı.	dize (gerekli)
identityClientId	Azure AD tarafından oluşturulan ve SSL sertifikasını içeren keyVault anahtarına GET erişimi olan Sistem veya Kullanıcı Tarafından Atanan Yönetilen kimlik clientId değeri.	dizgi
keyVaultId	Ssl Sertifikasını içeren KeyVault Gizli Dizisi url'si. Sürüm içeren mutlak Url sağlanırsa ssl sertifikasının otomatik olarak güncelleştirilmesi çalışmaz. Bunun için Api Management hizmetinin aka.ms/apimmsi ile yapılandırılması gerekir. Gizli dizi application/x-pkcs12 türünde olmalıdır	dizgi
negotiateClientCertificate	Ana bilgisayar adında istemci sertifikası üzerinde her zaman anlaşmak için true değerini belirtin. Varsayılan Değer false'tur.	Bool
tür	Ana bilgisayar adı türü.	'ConfigurationApi' 'DeveloperPortal' 'Yönetim' 'Portal' 'Proxy' 'Scm' (gerekli)

Microsoft.ApiManagement/service

Ad	Açıklama	Değer
kimlik	Api Management hizmetinin yönetilen hizmet kimliği.	ApiManagementServiceIdentity
yer	Kaynak konumu.	dize (gerekli)
ad	Kaynak adı	dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 1 Desen = `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` (gerekli)
Özellikler	API Management hizmetinin özellikleri.	ApiManagementServiceProperties (gerekli)
Sku	API Management hizmetinin SKU özellikleri.	ApiManagementServiceSkuProperties (gerekli)
Etiketler	Kaynak etiketleri	Etiket adları ve değerleri sözlüğü.
tür	Kaynak türü	"Microsoft.ApiManagement/service@2024-06-01-preview"
Bölge	Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.	string[]

PrivateEndpointConnectionWrapperProperties

Ad	Açıklama	Değer
privateEndpoint	Özel uç noktanın kaynağı.	ArmIdWrapper
privateLinkServiceConnectionState	Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.	PrivateLinkServiceConnectionState (gerekli)

PrivateLinkServiceConnectionState

Ad	Açıklama	Değer
actionsRequired	Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.	dizgi
Açıklama	Bağlantının onaylanması/reddedilmesinin nedeni.	dizgi
durum	Bağlantının hizmet sahibi tarafından Onaylanıp Reddedildiğini/Kaldırıldığını gösterir.	'Onaylandı' 'Beklemede' 'Reddedildi'

RemotePrivateEndpointConnectionWrapper

Ad	Açıklama	Değer
Kimliği	Özel Uç Nokta bağlantı kaynak kimliği	dizgi
ad	Özel Uç Nokta Bağlantı Adı	dizgi
Özellikler	Kaynak özellikleri.	PrivateEndpointConnectionWrapperProperties
tür	Özel Uç Nokta Bağlantı Kaynak Türü	dizgi

UserIdentityProperties

Ad	Açıklama	Değer
clientId	Kullanıcı tarafından atanan kimliğin istemci kimliği.	dizgi
principalId	Kullanıcı tarafından atanan kimliğin asıl kimliği.	dizgi

VirtualNetworkConfiguration

Ad	Açıklama	Değer
subnetResourceId	API Management hizmetinin dağıtılacağı sanal ağdaki bir alt ağın tam kaynak kimliği.	dizgi Kısıtlama -ları: Desen = `^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$`

Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti

Bicep kaynak tanımı

Kaynak biçimi

Özellik değerleri

AdditionalLocation

ApiManagementServiceBasePropertiesCustomProperties

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceProperties

ApiManagementServiceSkuProperties

ApimResourceTags

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

ConfigurationApi

HostnameConfiguration

Microsoft.ApiManagement/service

PrivateEndpointConnectionWrapperProperties

PrivateLinkServiceConnectionState

RemotePrivateEndpointConnectionWrapper

UserIdentityProperties

VirtualNetworkConfiguration

Hızlı başlangıç örnekleri

ARM şablonu kaynak tanımı

Kaynak biçimi

Özellik değerleri

AdditionalLocation

ApiManagementServiceBasePropertiesCustomProperties

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceProperties

ApiManagementServiceSkuProperties

ApimResourceTags

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

ConfigurationApi

HostnameConfiguration

Microsoft.ApiManagement/service

PrivateEndpointConnectionWrapperProperties

PrivateLinkServiceConnectionState

RemotePrivateEndpointConnectionWrapper

UserIdentityProperties

VirtualNetworkConfiguration

Hızlı başlangıç şablonları

Terraform (AzAPI sağlayıcısı) kaynak tanımı

Kaynak biçimi

Özellik değerleri

AdditionalLocation

ApiManagementServiceBasePropertiesCustomProperties

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceProperties

ApiManagementServiceSkuProperties

ApimResourceTags

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

ConfigurationApi

HostnameConfiguration

Microsoft.ApiManagement/service

PrivateEndpointConnectionWrapperProperties

PrivateLinkServiceConnectionState

RemotePrivateEndpointConnectionWrapper

UserIdentityProperties

VirtualNetworkConfiguration

Geri Bildirim

Ek kaynaklar