Microsoft.ApiManagement hizmeti 2022-08-01
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 aşağıdaki Bicep'i şablonunuza ekleyin.
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'
]
}
Özellik değerleri
hizmet
Ad | Açıklama | Değer |
---|---|---|
name | Kaynak adı | dize (gerekli) Karakter sınırı: 1-50 Geçerli karakterler: Alfasayısallar ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. Kaynak adı Azure genelinde benzersiz olmalıdır. |
location | Kaynak konumu. | dize (gerekli) |
etiketler | Kaynak etiketleri. | Etiket adlarının ve değerlerinin sözlüğü. Bkz. Şablonlardaki etiketler |
Sku | API Management hizmetinin SKU özellikleri. | ApiManagementServiceSkuProperties (gerekli) |
identity | Api Management hizmetinin yönetilen hizmet kimliği. | ApiManagementServiceIdentity |
properties | API Management hizmetinin özellikleri. | ApiManagementServiceProperties (gerekli) |
Bölge | Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi. | dize[] |
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 kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır. | 'Yok' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (gerekli) |
userAssignedIdentities | Kaynakla ilişkilendirilmiş 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 |
---|---|---|
{özelleştirilmiş özellik} | UserIdentityProperties |
UserIdentityProperties
Ad | Açıklama | Değer |
---|---|---|
clientId | Kullanıcı tarafından atanan kimliğin istemci kimliği. | string |
principalId | Kullanıcı tarafından atanan kimliğin asıl kimliği. | string |
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 |
sertifikalar | API Management hizmetinde yüklenmesi gereken Sertifikaların listesi. Yüklenebilen desteklenen en yüksek sertifika sayısı 10'dur. | CertificateConfiguration[] |
Özelözellikler | API Management hizmetinin özel özellikleri. Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 , tüm TLS(1.0, 1.1 ve 1.2) için şifre TLS_RSA_WITH_3DES_EDE_CBC_SHA devre dışı bırakır.Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir.Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 , bir API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir.Arka uçlarla iletişimde yalnızca TLS 1.1'i devre dışı bırakmak için ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kullanılabilir.Arka uçlarla iletişimde TLS 1.0'ı devre dışı bırakmak için ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kullanılabilir.Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 , 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 varsayılan değer, hizmetin 1 Nisan 2018 tarihinde veya öncesinde oluşturulmuş olması ve False aksi halde olmasıdırTrue . Http2 ayarının varsayılan değeri şeklindedir False .Ayarları Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name] kullanarak aşağıdaki şifrelemelerden herhangi birini 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 true içindir.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 |
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ı zorunlu kılabilir. 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[] |
natGatewayState | Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir. | 'Devre Dışı' 'Etkin' |
notificationSenderEmail | Bildirimin gönderileceği adresi Email. | string |
privateEndpointConnections | Bu hizmetin Özel Uç Nokta Bağlantılarının listesi. | RemotePrivateEndpointConnectionWrapper[] |
publicIpAddressId | Bölgede dağıtılan Sanal Ağ hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağ'de dağıtılan Geliştirici ve Premium SKU için desteklenir. | string |
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ı. | dize (gerekli) |
publisherName | Yayımcı adı. | dize (gerekli) |
geri yükleme | Önceden geçici olarak silinmişse Api Management Hizmeti'nin silinmesini geri alma. 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ğ parçası olmadığı, Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı, İç ise API Management dağıtımının bir içinde ayarlandığı anlamına gelir Sanal Ağ yalnızca İntranet'e Yönelik Uç Noktası vardır. | 'Dış' 'İç' 'Yok' |
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 ek konumda ağ geçidini devre dışı bırakmak için kullanılabilir. | bool |
location | Azure Veri merkezi bölgeleri arasındaki ek bölgenin konum adı. | dize (gerekli) |
natGatewayState | Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir. | 'Devre Dışı' 'Etkin' |
publicIpAddressId | Konumda dağıtılan Sanal Ağ hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağ'de dağıtılan Premium SKU için desteklenir. | string |
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[] |
ApiManagementServiceSkuProperties
Ad | Açıklama | Değer |
---|---|---|
capacity | SKU'nun kapasitesi (SKU'nun dağıtılan birim sayısı). Tüketim için SKU kapasitesi 0 olarak belirtilmelidir. | int (gerekli) |
name | Sku'nun adı. | 'Temel' 'Tüketim' 'Geliştirici' 'Yalıtılmış' 'Premium' 'Standart' (gerekli) |
VirtualNetworkConfiguration
Ad | Açıklama | Değer |
---|---|---|
subnetResourceId | API Management hizmetinin dağıtılacağı sanal ağdaki bir alt ağın tam kaynak kimliği. | string |
ApiVersionConstraint
Ad | Açıklama | Değer |
---|---|---|
minApiVersion | Denetim düzlemi API çağrılarını bu değere eşit veya bundan daha yeni bir sürüme sahip API Management hizmetiyle sınırlayın. | string |
CertificateConfiguration
Ad | Açıklama | Değer |
---|---|---|
sertifika | Sertifika bilgileri. | CertificateInformation |
certificatePassword | Sertifika Parolası. | string |
encodedCertificate | Base64 Kodlanmış sertifika. | string |
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: yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtildiği gibi. |
dize (gerekli) |
Konu | Sertifikanın konusu. | dize (gerekli) |
Parmak izi | Sertifikanın parmak izi. | dize (gerekli) |
ApiManagementServiceBasePropertiesCustomProperties
Ad | Açıklama | Değer |
---|---|---|
{özelleştirilmiş özellik} | string |
HostnameConfiguration
Ad | Açıklama | Değer |
---|---|---|
sertifika | Sertifika bilgileri. | CertificateInformation |
certificatePassword | Sertifika Parolası. | string |
certificateSource | Sertifika Kaynağı. | 'Yerleşik' 'Özel' 'KeyVault' 'Yönetilen' |
certificateStatus | Sertifika Durumu. | 'Tamamlandı' 'Başarısız' 'InProgress' |
defaultSslBinding | Bu Konak Adı ile 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 yararlıdır. Ayar yalnızca ağ geçidi Ana Bilgisayar Adı Türüne uygulanır. | bool |
encodedCertificate | Base64 Kodlanmış sertifika. | string |
Hostname | Api Management hizmetinde yapılandırılan ana bilgisayar adı. | dize (gerekli) |
identityClientId | ssl sertifikasını içeren keyVault'a GET erişimi olan Azure AD tarafından oluşturulan Sistem veya Kullanıcı Tarafından Atanan Yönetilen kimlik clientId değeri. | string |
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 | string |
negotiateClientCertificate | Ana bilgisayar adında her zaman istemci sertifikası anlaşması yapmak için true değerini belirtin. Varsayılan Değer false'tur. | bool |
tür | Ana bilgisayar adı türü. | 'DeveloperPortal' 'Yönetim' 'Portal' 'Proxy' 'Scm' (gerekli) |
RemotePrivateEndpointConnectionWrapper
Ad | Açıklama | Değer |
---|---|---|
kimlik | Özel Uç Nokta bağlantı kaynak kimliği | string |
name | Özel Uç Nokta Bağlantı Adı | string |
properties | Kaynak özellikleri. | PrivateEndpointConnectionWrapperProperties |
tür | Özel Uç Nokta Bağlantı Kaynak Türü | 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) |
ArmIdWrapper
Bu nesne dağıtım sırasında ayarlanacağı herhangi bir özellik içermiyor. Tüm özellikler ReadOnly'dır.
PrivateLinkServiceConnectionState
Ad | Açıklama | Değer |
---|---|---|
actionsRequired | Hizmet sağlayıcısında yapılan değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti. | string |
açıklama | Bağlantının onay/reddedilme nedeni. | string |
durum | Bağlantının hizmet sahibi tarafından Onaylanıp Reddedildiğini/Kaldırıldığını gösterir. | 'Onaylandı' 'Beklemede' 'Reddedildi' |
Hızlı başlangıç şablonları
Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.
Şablon | Description |
---|---|
Şablon kullanarak bir API Management örneği ve alt kaynaklarını oluşturma |
Bu şablonda API Management hizmeti oluşturma ve alt varlıkları yapılandırma işlemleri gösterilmektedir |
Dış Redis için Azure Cache ile API Management dağıtma |
Bu şablon, Dış önbellek olarak dış Redis için Azure Cache örneğiyle Tüketim katmanında Azure API Management örneğin API Management in nasıl oluşturulacağı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ği oluşturmayı ve alt ağda önerilen NSG kurallarını yapılandırmayı 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. |
Özel konak adlarıyla API Management örneği oluşturma |
Bu şablonda portal için özel ana bilgisayar adı ve ara sunucu için birden çok özel ana bilgisayar adı ile Azure API Management örneğinin nasıl oluşturulacağı gösterilmektedir |
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 iç sanal ağda API Management dağıtma |
Bu şablon, iç modda sanal ağınızın alt ağı içindeki Premium katmanında Azure API Management örneği oluşturmayı ve alt ağda önerilen NSG kurallarını yapılandırmayı 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. |
MSI Kimliğine sahip bir API Management örneği oluşturma |
Bu şablon, MSI Kimliğine sahip bir Azure API Management geliştirici örneği oluşturur |
Çok bölgeli Premium katman API Management örneği oluşturma |
Bu şablonda ek konumlara sahip bir API Management örneğinin nasıl oluşturulacağı gösterilmektedir. 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. |
KeyVault kullanarak özel proxy ssl ile API Management oluşturma |
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 işlemleri gösterilmektedir. |
KeyVault'tan 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ını 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 |
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 |
Özel uç nokta ile API Management hizmeti oluşturma |
Bu şablon bir API Management hizmeti, bir sanal ağ ve API Management hizmetini sanal ağa gösteren özel bir uç nokta oluşturur. |
API Management Kullanılabilirlik Alanları dağıtma |
Bu şablon, Azure API Management'nin premium bir örneğini oluşturur ve bir Kullanılabilirlik Alanına dağıtır |
Şablon kullanarak API Management örneği oluşturma |
Bu şablon Azure API Management geliştirici örneği oluşturur |
API Management kaynağı olan 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. |
Azure API Management önünde Azure Front Door oluşturma |
Bu örnekte, Azure Front Door'un Azure API Management önünde küresel yük dengeleyici olarak nasıl kullanılacağı gösterilmektedir. |
İç API Management ve Web Uygulaması ile Application Gateway |
Application Gateway İnternet trafiğini azure web uygulamasında barındırılan bir web API'sine hizmet veren sanal ağa (iç mod) API Management bir örneğe yönlendirme. |
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": "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" ]
}
Özellik değerleri
hizmet
Ad | Açıklama | Değer |
---|---|---|
tür | Kaynak türü | 'Microsoft.ApiManagement/service' |
apiVersion | Kaynak API'sinin sürümü | '2022-08-01' |
name | Kaynak adı | dize (gerekli) Karakter sınırı: 1-50 Geçerli karakterler: Alfasayısallar ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. Kaynak adı Azure genelinde benzersiz olmalıdır. |
location | Kaynak konumu. | dize (gerekli) |
etiketler | Kaynak etiketleri. | Etiket adlarının ve değerlerinin sözlüğü. Bkz. Şablonlardaki etiketler |
Sku | API Management hizmetinin SKU özellikleri. | ApiManagementServiceSkuProperties (gerekli) |
identity | Api Management hizmetinin yönetilen hizmet kimliği. | ApiManagementServiceIdentity |
properties | API Management hizmetinin özellikleri. | ApiManagementServiceProperties (gerekli) |
Bölge | Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi. | dize[] |
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 kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır. | 'Yok' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (gerekli) |
userAssignedIdentities | Kaynakla ilişkilendirilmiş 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 |
---|---|---|
{özelleştirilmiş özellik} | UserIdentityProperties |
UserIdentityProperties
Ad | Açıklama | Değer |
---|---|---|
clientId | Kullanıcı tarafından atanan kimliğin istemci kimliği. | string |
principalId | Kullanıcı tarafından atanan kimliğin asıl kimliği. | string |
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 |
sertifikalar | API Management hizmetine yüklenmesi gereken Sertifikaların listesi. Yüklenebilen desteklenen en fazla sertifika sayısı 10'dur. | CertificateConfiguration[] |
Özelözellikler | API Management hizmetinin özel özellikleri. Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 , tüm TLS(1.0, 1.1 ve 1.2) için şifre TLS_RSA_WITH_3DES_EDE_CBC_SHA devre dışı bırakır.Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir.Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 , bir API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir.Arka uçlarla iletişimde yalnızca TLS 1.1'i devre dışı bırakmak için ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kullanılabilir.Arka uçlarla iletişimde TLS 1.0'ı devre dışı bırakmak için ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kullanılabilir.Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 , 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 varsayılan değer, hizmetin 1 Nisan 2018 tarihinde veya öncesinde oluşturulmuş olması ve False aksi halde olmasıdırTrue . Http2 ayarının varsayılan değeri şeklindedir False .Ayarları Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name] kullanarak aşağıdaki şifrelemelerden herhangi birini 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 true içindir.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 |
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ı zorunlu kılabilir. 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[] |
natGatewayState | Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir. | 'Devre Dışı' 'Etkin' |
notificationSenderEmail | Bildirimin gönderileceği adresi Email. | string |
privateEndpointConnections | Bu hizmetin Özel Uç Nokta Bağlantılarının listesi. | RemotePrivateEndpointConnectionWrapper[] |
publicIpAddressId | Bölgede dağıtılan Sanal Ağ hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağ'de dağıtılan Geliştirici ve Premium SKU için desteklenir. | string |
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ı. | dize (gerekli) |
publisherName | Yayımcı adı. | dize (gerekli) |
geri yükleme | Önceden geçici olarak silinmişse Api Management Hizmeti'nin silinmesini geri alma. 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ğ parçası olmadığı, Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı, İç ise API Management dağıtımının bir içinde ayarlandığı anlamına gelir Sanal Ağ yalnızca İntranet'e Yönelik Uç Noktası vardır. | 'Dış' 'İç' 'Yok' |
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 ek konumda ağ geçidini devre dışı bırakmak için kullanılabilir. | bool |
location | Azure Veri merkezi bölgeleri arasındaki ek bölgenin konum adı. | dize (gerekli) |
natGatewayState | Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir. | 'Devre Dışı' 'Etkin' |
publicIpAddressId | Konumda dağıtılan Sanal Ağ hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca premium SKU'nun Sanal Ağ dağıtılması için desteklenir. | string |
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. | dize[] |
ApiManagementServiceSkuProperties
Ad | Açıklama | Değer |
---|---|---|
capacity | SKU'nun kapasitesi (SKU'nun dağıtılan birim sayısı). Tüketim için SKU kapasitesi 0 olarak belirtilmelidir. | int (gerekli) |
name | Sku'nun adı. | 'Temel' 'Tüketim' 'Geliştirici' 'Yalıtılmış' 'Premium' 'Standart' (gerekli) |
VirtualNetworkConfiguration
Ad | Açıklama | Değer |
---|---|---|
subnetResourceId | API Management hizmetinin dağıtılacağı sanal ağdaki bir alt ağın tam kaynak kimliği. | string |
ApiVersionConstraint
Ad | Açıklama | Değer |
---|---|---|
minApiVersion | Denetim düzlemi API çağrılarını bu değere eşit veya bundan daha yeni bir sürüme sahip API Management hizmetiyle sınırlayın. | string |
CertificateConfiguration
Ad | Açıklama | Değer |
---|---|---|
sertifika | Sertifika bilgileri. | CertificateInformation |
certificatePassword | Sertifika Parolası. | string |
encodedCertificate | Base64 Kodlanmış sertifika. | string |
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: yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtildiği gibi. |
dize (gerekli) |
Konu | Sertifikanın konusu. | dize (gerekli) |
Parmak izi | Sertifikanın parmak izi. | dize (gerekli) |
ApiManagementServiceBasePropertiesCustomProperties
Ad | Açıklama | Değer |
---|---|---|
{özelleştirilmiş özellik} | string |
HostnameConfiguration
Ad | Açıklama | Değer |
---|---|---|
sertifika | Sertifika bilgileri. | CertificateInformation |
certificatePassword | Sertifika Parolası. | string |
certificateSource | Sertifika Kaynağı. | 'Yerleşik' 'Özel' 'KeyVault' 'Yönetilen' |
certificateStatus | Sertifika Durumu. | 'Tamamlandı' 'Başarısız' 'InProgress' |
defaultSslBinding | Bu Konak Adı ile 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 yararlıdır. Ayar yalnızca ağ geçidi Ana Bilgisayar Adı Türüne uygulanır. | bool |
encodedCertificate | Base64 Kodlanmış sertifika. | string |
Hostname | Api Management hizmetinde yapılandırılan ana bilgisayar adı. | dize (gerekli) |
identityClientId | ssl sertifikasını içeren keyVault'a GET erişimi olan Azure AD tarafından oluşturulan Sistem veya Kullanıcı Tarafından Atanan Yönetilen kimlik clientId değeri. | string |
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 | string |
negotiateClientCertificate | Ana bilgisayar adında her zaman istemci sertifikası anlaşması yapmak için true değerini belirtin. Varsayılan Değer false'tur. | bool |
tür | Ana bilgisayar adı türü. | 'DeveloperPortal' 'Yönetim' 'Portal' 'Proxy' 'Scm' (gerekli) |
RemotePrivateEndpointConnectionWrapper
Ad | Açıklama | Değer |
---|---|---|
kimlik | Özel Uç Nokta bağlantı kaynak kimliği | string |
name | Özel Uç Nokta Bağlantı Adı | string |
properties | Kaynak özellikleri. | PrivateEndpointConnectionWrapperProperties |
tür | Özel Uç Nokta Bağlantı Kaynak Türü | 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) |
ArmIdWrapper
Bu nesne dağıtım sırasında ayarlanacağı herhangi bir özellik içermiyor. Tüm özellikler ReadOnly'dır.
PrivateLinkServiceConnectionState
Ad | Açıklama | Değer |
---|---|---|
actionsRequired | Hizmet sağlayıcısında yapılan değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti. | string |
açıklama | Bağlantının onay/reddedilme nedeni. | string |
durum | Bağlantının hizmet sahibi tarafından Onaylanıp Reddedildiğini/Kaldırıldığını gösterir. | 'Onaylandı' 'Beklemede' 'Reddedildi' |
Hızlı başlangıç şablonları
Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.
Şablon | Description |
---|---|
Şablon kullanarak bir API Management örneği ve alt kaynaklarını oluşturma |
Bu şablonda API Management hizmeti oluşturma ve alt varlıkları yapılandırma işlemleri gösterilmektedir |
Dış Redis için Azure Cache ile API Management dağıtma |
Bu şablon, Dış önbellek olarak dış Redis için Azure Cache örneğiyle Tüketim katmanında Azure API Management örneğin API Management in nasıl oluşturulacağı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ği oluşturmayı ve alt ağda önerilen NSG kurallarını yapılandırmayı 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. |
Özel konak adlarıyla API Management örneği oluşturma |
Bu şablonda portal için özel ana bilgisayar adı ve ara sunucu için birden çok özel ana bilgisayar adı ile Azure API Management örneğinin nasıl oluşturulacağı gösterilmektedir |
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 iç sanal ağda API Management dağıtma |
Bu şablon, iç modda sanal ağınızın alt ağındaki Premium katmanında Azure API Management örneği oluşturmayı ve alt ağda önerilen NSG kurallarını yapılandırmayı gösterir. Örnek iki kullanılabilirlik alanına dağıtılır. Şablon ayrıca aboneliğinizden bir genel IP adresi yapılandırıyor. |
MSI Kimliğine sahip bir API Management örneği oluşturma |
Bu şablon, MSI Kimliğine sahip bir Azure API Management geliştirici örneği oluşturur |
Çok bölgeli Premium katmanı API Management örneği oluşturma |
Bu şablon, ek konumlarla bir API Management örneğinin nasıl oluşturulacağını gösterir. Birincil konum, kaynak grubunun konumuyla aynıdır. Ek konumlar için şablonda NorthCentralUs ve Doğu ABD2 gösterilir. Birincil konum ek konumlardan farklı olmalıdır. |
KeyVault kullanarak özel proxy ssl ile API Management oluşturma |
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 işlemleri gösterilmektedir. |
KeyVault'tan 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 sertifikayı güncel tutar. |
API Management örneği oluşturma ve izleme |
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 |
Özel uç nokta ile API Management hizmeti oluşturma |
Bu şablon bir API Management hizmeti, sanal ağ ve API Management hizmetini sanal ağa gösteren özel uç nokta oluşturur. |
Kullanılabilirlik Alanları'a API Management dağıtma |
Bu şablon Azure API Management premium örneğini oluşturur ve Kullanılabilirlik Alanına dağıtır |
Şablon kullanarak API Management örneği oluşturma |
Bu şablon Azure API Management geliştirici örneği oluşturur |
API Management çıkış noktası 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. |
Azure API Management önünde Azure Front Door oluşturma |
Bu örnekte Azure Front Door'un Azure API Management önünde genel yük dengeleyici olarak nasıl kullanılacağı gösterilmektedir. |
İç API Management ve Web Uygulaması 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ğa (iç mod) API Management bir örneğe yönlendirme. |
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@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"
}
})
}
Özellik değerleri
hizmet
Ad | Açıklama | Değer |
---|---|---|
tür | Kaynak türü | "Microsoft.ApiManagement/service@2022-08-01" |
name | Kaynak adı | dize (gerekli) Karakter sınırı: 1-50 Geçerli karakterler: Alfasayısal değerler ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. Kaynak adı Azure genelinde benzersiz olmalıdır. |
location | Kaynak konumu. | dize (gerekli) |
parent_id | Bir kaynak grubuna dağıtmak için bu kaynak grubunun kimliğini kullanın. | dize (gerekli) |
etiketler | Kaynak etiketleri. | Etiket adlarının ve değerlerinin sözlüğü. |
Sku | API Management hizmetinin SKU özellikleri. | ApiManagementServiceSkuProperties (gerekli) |
identity | Api Management hizmetinin yönetilen hizmet kimliği. | ApiManagementServiceIdentity |
properties | API Management hizmetinin özellikleri. | ApiManagementServiceProperties (gerekli) |
Bölge | Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi. | string[] |
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. | "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (gerekli) |
identity_ids | Kaynakla ilişkili kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlük anahtarı başvuruları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
Kullanıcı kimliği kimlikleri dizisi. |
ApiManagementServiceIdentityUserAssignedIdentities
Ad | Açıklama | Değer |
---|---|---|
{özelleştirilmiş özellik} | UserIdentityProperties |
UserIdentityProperties
Ad | Açıklama | Değer |
---|---|---|
clientId | Kullanıcı tarafından atanan kimliğin istemci kimliği. | string |
principalId | Kullanıcı tarafından atanan kimliğin asıl kimliği. | string |
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 |
sertifikalar | API Management hizmetine yüklenmesi gereken Sertifikaların listesi. Yüklenebilen desteklenen en fazla sertifika sayısı 10'dur. | CertificateConfiguration[] |
Özelözellikler | API Management hizmetinin özel özellikleri. Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 , tüm TLS(1.0, 1.1 ve 1.2) için şifre TLS_RSA_WITH_3DES_EDE_CBC_SHA devre dışı bırakır.Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir.Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 , bir API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir.Arka uçlarla iletişimde yalnızca TLS 1.1'i devre dışı bırakmak için ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kullanılabilir.Arka uçlarla iletişimde TLS 1.0'ı devre dışı bırakmak için ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kullanılabilir.Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 , 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 varsayılan değer, hizmetin 1 Nisan 2018 tarihinde veya öncesinde oluşturulmuş olması ve False aksi halde olmasıdırTrue . Http2 ayarının varsayılan değeri şeklindedir False .Ayarları Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name] kullanarak aşağıdaki şifrelemelerden herhangi birini 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 true içindir.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 |
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ı zorunlu kılabilir. 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[] |
natGatewayState | Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir. | "Devre dışı" "Etkin" |
notificationSenderEmail | Bildirimin gönderileceği adresi Email. | string |
privateEndpointConnections | Bu hizmetin Özel Uç Nokta Bağlantılarının listesi. | RemotePrivateEndpointConnectionWrapper[] |
publicIpAddressId | Bölgede dağıtılan Sanal Ağ hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağ'de dağıtılan Geliştirici ve Premium SKU için desteklenir. | string |
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ı. | dize (gerekli) |
publisherName | Yayımcı adı. | dize (gerekli) |
geri yükleme | Önceden geçici olarak silinmişse Api Management Hizmeti'nin silinmesini geri alma. 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ğ parçası olmadığı, Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı, İç ise API Management dağıtımının bir içinde ayarlandığı anlamına gelir Sanal Ağ yalnızca İntranet'e Yönelik Uç Noktası vardır. | "Dış" "İç" "Hiçbiri" |
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 ek konumda ağ geçidini devre dışı bırakmak için kullanılabilir. | bool |
location | Azure Veri merkezi bölgeleri arasındaki ek bölgenin konum adı. | dize (gerekli) |
natGatewayState | Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir. | "Devre dışı" "Etkin" |
publicIpAddressId | Konumda dağıtılan Sanal Ağ hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağ'de dağıtılan Premium SKU için desteklenir. | string |
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[] |
ApiManagementServiceSkuProperties
Ad | Açıklama | Değer |
---|---|---|
capacity | SKU'nun kapasitesi (SKU'nun dağıtılan birim sayısı). Tüketim için SKU kapasitesi 0 olarak belirtilmelidir. | int (gerekli) |
name | Sku'nun adı. | "Temel" "Tüketim" "Geliştirici" "Yalıtılmış" "Premium" "Standart" (gerekli) |
VirtualNetworkConfiguration
Ad | Açıklama | Değer |
---|---|---|
subnetResourceId | API Management hizmetinin dağıtılacağı sanal ağdaki bir alt ağın tam kaynak kimliği. | string |
ApiVersionConstraint
Ad | Açıklama | Değer |
---|---|---|
minApiVersion | Denetim düzlemi API çağrılarını bu değere eşit veya bundan daha yeni bir sürüme sahip API Management hizmetiyle sınırlayın. | string |
CertificateConfiguration
Ad | Açıklama | Değer |
---|---|---|
sertifika | Sertifika bilgileri. | CertificateInformation |
certificatePassword | Sertifika Parolası. | string |
kodlanmışCertificate | Base64 Kodlanmış sertifika. | string |
Storename | System.Security.Cryptography.x509certificates.StoreName sertifika deposu konumu. Yalnızca Root 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: yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtildiği gibi. |
dize (gerekli) |
Konu | Sertifikanın konusu. | dize (gerekli) |
Parmak izi | Sertifikanın parmak izi. | dize (gerekli) |
ApiManagementServiceBasePropertiesCustomProperties
Ad | Açıklama | Değer |
---|---|---|
{özelleştirilmiş özellik} | string |
HostnameConfiguration
Ad | Açıklama | Değer |
---|---|---|
sertifika | Sertifika bilgileri. | CertificateInformation |
certificatePassword | Sertifika Parolası. | string |
certificateSource | Sertifika Kaynağı. | "BuiltIn" "Özel" "KeyVault" "Yönetilen" |
certificateStatus | Sertifika Durumu. | "Tamamlandı" "Başarısız" "InProgress" |
defaultSslBinding | Bu Ana Bilgisayar Adı ile 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ı etkinse 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 |
kodlanmışCertificate | Base64 Kodlanmış sertifika. | string |
Hostname | Api Management hizmetinde yapılandırılan konak adı. | dize (gerekli) |
identityClientId | ssl sertifikasını içeren keyVault'a GET erişimi olan Azure AD tarafından oluşturulan Sistem veya Kullanıcı Tarafından Atanan Yönetilen kimlik clientId değeri. | string |
keyVaultId | Ssl Sertifikasını içeren KeyVault Gizli Dizisinin 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 | string |
negotiateClientCertificate | Ana bilgisayar adında her zaman istemci sertifikası anlaşması yapmak için true değerini belirtin. Varsayılan Değer false'tur. | bool |
tür | Ana bilgisayar adı türü. | "DeveloperPortal" "Yönetim" "Portal" "Proxy" "Scm" (gerekli) |
RemotePrivateEndpointConnectionWrapper
Ad | Açıklama | Değer |
---|---|---|
kimlik | Özel Uç Nokta bağlantı kaynak kimliği | string |
name | Özel Uç Nokta Bağlantı Adı | string |
properties | Kaynak özellikleri. | PrivateEndpointConnectionWrapperProperties |
tür | Özel Uç Nokta Bağlantısı Kaynak Türü | 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) |
ArmIdWrapper
Bu nesne dağıtım sırasında ayarlanacağı herhangi bir özellik içermez. Tüm özellikler Salt Okunur'dır.
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. | string |
açıklama | Bağlantının onay/reddedilme nedeni. | string |
durum | Bağlantının hizmet sahibi tarafından Onaylanıp Reddedildiğini/Kaldırıldığını gösterir. | "Onaylandı" "Beklemede" "Reddedildi" |