Layanan Microsoft.ApiManagement

Artikel
01/16/2024

Definisi sumber daya Bicep

Jenis sumber daya layanan dapat disebarkan dengan operasi yang menargetkan:

Grup sumber daya - Lihat perintah penyebaran grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service, tambahkan Bicep berikut ke templat Anda.

resource symbolicname 'Microsoft.ApiManagement/service@2023-05-01-preview' = {
  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'
      }
    ]
    configurationApi: {
      legacyApi: 'string'
    }
    customProperties: {
      {customized property}: 'string'
    }
    developerPortalStatus: 'string'
    disableGateway: bool
    enableClientCertificate: bool
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        certificateSource: 'string'
        certificateStatus: 'string'
        defaultSslBinding: bool
        encodedCertificate: 'string'
        hostName: 'string'
        identityClientId: 'string'
        keyVaultId: 'string'
        negotiateClientCertificate: bool
        type: 'string'
      }
    ]
    legacyPortalStatus: 'string'
    natGatewayState: 'string'
    notificationSenderEmail: 'string'
    privateEndpointConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
        type: 'string'
      }
    ]
    publicIpAddressId: 'string'
    publicNetworkAccess: 'string'
    publisherEmail: 'string'
    publisherName: 'string'
    restore: bool
    virtualNetworkConfiguration: {
      subnetResourceId: 'string'
    }
    virtualNetworkType: 'string'
  }
  zones: [
    'string'
  ]
}

Nilai properti

service

Nama	Deskripsi	Nilai
nama	Nama sumber daya	string (diperlukan) Batas karakter: 1-50 Karakter yang valid: Alfanumerik dan tanda hubung. Mulai dengan huruf, dan akhiri dengan alfanumerik. Nama sumber daya harus unik di seluruh Azure.
lokasi	Lokasi sumber daya.	string (diperlukan)
tag	Tag sumber daya.	Kamus nama dan nilai tag. Lihat Tag dalam templat
sku	Properti SKU dari layanan API Management.	ApiManagementServiceSkuProperties (diperlukan)
identitas	Identitas layanan terkelola dari layanan Api Management.	ApiManagementServiceIdentity
properti	Properti layanan API Management.	ApiManagementServiceProperties (diperlukan)
zona	Daftar zona ketersediaan yang menunjukkan dari mana sumber daya perlu berasal.	string[]

ApiManagementServiceIdentity

Nama	Deskripsi	Nilai
jenis	Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.	'Tidak Ada' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (diperlukan)
userAssignedIdentities	Daftar identitas pengguna yang terkait dengan sumber daya. Identitas pengguna referensi kunci kamus akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Nama	Deskripsi	Nilai
{properti yang disesuaikan}		UserIdentityProperties

UserIdentityProperties

Nama	Deskripsi	Nilai
clientId	Id klien identitas yang ditetapkan pengguna.	string
principalId	Id utama identitas yang ditetapkan pengguna.	string

ApiManagementServiceProperties

Nama	Deskripsi	Nilai
additionalLocations	Lokasi pusat data tambahan dari layanan API Management.	AdditionalLocation[]
apiVersionConstraint	Batasan versi Control Plane Apis untuk layanan API Management.	ApiVersionConstraint
sertifikat	Daftar Sertifikat yang perlu diinstal di layanan API Management. Sertifikat maksimum yang didukung yang dapat diinstal adalah 10.	CertificateConfiguration[]
configurationApi	Konfigurasi API konfigurasi layanan API Management.	ConfigurationApi
customProperties	Properti kustom layanan API Management. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` akan menonaktifkan TLS_RSA_WITH_3DES_EDE_CBC_SHA sandi untuk semua TLS(1.0, 1.1 dan 1.2). Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` dapat digunakan untuk menonaktifkan hanya TLS 1.1. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` dapat digunakan untuk menonaktifkan TLS 1.0 pada layanan API Management. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` dapat digunakan untuk menonaktifkan hanya TLS 1.1 untuk komunikasi dengan backend. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` dapat digunakan untuk menonaktifkan TLS 1.0 untuk komunikasi dengan backend. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` dapat digunakan untuk mengaktifkan protokol HTTP2 pada layanan API Management. Tidak menentukan salah satu properti ini pada operasi PATCH akan mengatur ulang nilai properti yang dihilangkan ke defaultnya. Untuk semua pengaturan kecuali Http2, nilai defaultnya adalah `True` jika layanan dibuat pada atau sebelum 1 April 2018 dan `False` sebaliknya. Nilai default pengaturan Http2 adalah `False`. Anda dapat menonaktifkan salah satu cipher berikut dengan menggunakan pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Misalnya, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Nilai defaultnya adalah `true` untuk nilai tersebut. Catatan: Cipher berikut tidak dapat dinonaktifkan karena diperlukan oleh komponen platform internal: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256	ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus	Status portal pengembang dalam layanan API Management ini.	'Dinonaktifkan' 'Diaktifkan'
disableGateway	Properti hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi. Ini dapat digunakan untuk menonaktifkan gateway di wilayah master.	bool
enableClientCertificate	Properti hanya dimaksudkan untuk digunakan untuk Layanan SKU Konsumsi. Ini memberlakukan sertifikat klien untuk disajikan pada setiap permintaan ke gateway. Ini juga memungkinkan kemampuan untuk mengautentikasi sertifikat dalam kebijakan di gateway.	bool
hostnameConfigurations	Konfigurasi nama host kustom layanan API Management.	HostnameConfiguration[]
legacyPortalStatus	Status portal warisan di layanan API Management.	'Dinonaktifkan' 'Diaktifkan'
natGatewayState	Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.	'Dinonaktifkan' 'Diaktifkan'
notificationSenderEmail	Email alamat tempat pemberitahuan akan dikirim.	string
privateEndpointConnections	Daftar Koneksi Titik Akhir Privat layanan ini.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Alamat IP berbasis IP V4 SKU Standar Publik yang akan dikaitkan dengan Virtual Network layanan yang disebarkan di wilayah tersebut. Hanya didukung untuk Pengembang dan SKU Premium yang disebarkan di Virtual Network.	string
publicNetworkAccess	Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', titik akhir privat adalah metode akses eksklusif. Nilai defaultnya adalah 'Diaktifkan'	'Dinonaktifkan' 'Diaktifkan'
publisherEmail	Email penerbit.	string (diperlukan)
publisherName	Nama penerbit.	string (diperlukan)
pulihkan	Batal hapus Layanan Api Management jika sebelumnya dihapus sementara. Jika bendera ini ditentukan dan diatur ke True, semua properti lainnya akan diabaikan.	bool
virtualNetworkConfiguration	Konfigurasi jaringan virtual layanan API Management.	VirtualNetworkConfiguration
virtualNetworkType	Jenis VPN tempat layanan API Management perlu dikonfigurasi. Tidak Ada (Nilai Default) berarti layanan API Management bukan bagian dari Virtual Network apa pun, Eksternal berarti penyebaran API Management disiapkan di dalam Virtual Network memiliki Titik Akhir yang Menghadap Internet, dan Internal berarti bahwa API Management penyebaran disiapkan di dalam Virtual Network hanya memiliki Titik Akhir Yang Menghadap Intranet.	'Eksternal' 'Internal' 'Tidak Ada'

AdditionalLocation

Nama	Deskripsi	Nilai
disableGateway	Properti hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi. Ini dapat digunakan untuk menonaktifkan gateway di lokasi tambahan ini.	bool
lokasi	Nama lokasi wilayah tambahan di antara wilayah pusat Data Azure.	string (diperlukan)
natGatewayState	Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.	'Dinonaktifkan' 'Diaktifkan'
publicIpAddressId	Alamat IP berbasis IP V4 SKU Standar Publik yang akan dikaitkan dengan Virtual Network layanan yang disebarkan di lokasi tersebut. Hanya didukung untuk SKU Premium yang disebarkan di Virtual Network.	string
sku	Properti SKU dari layanan API Management.	ApiManagementServiceSkuProperties (diperlukan)
virtualNetworkConfiguration	Konfigurasi jaringan virtual untuk lokasi tersebut.	VirtualNetworkConfiguration
zona	Daftar zona ketersediaan yang menunjukkan dari mana sumber daya perlu berasal.	string[]

ApiManagementServiceSkuProperties

Nama	Deskripsi	Nilai
kapasitas	Kapasitas SKU (jumlah unit SKU yang disebarkan). Untuk kapasitas SKU Konsumsi harus ditentukan sebagai 0.	int (diperlukan)
nama	Nama Sku.	'Dasar' 'BasicV2' 'Konsumsi' 'Pengembang' 'Terisolasi' 'Premium' 'Standar' 'StandardV2' (diperlukan)

VirtualNetworkConfiguration

Nama	Deskripsi	Nilai
subnetResourceId	ID sumber daya lengkap subnet dalam jaringan virtual untuk menyebarkan layanan API Management.	string

ApiVersionConstraint

Nama	Deskripsi	Nilai
minApiVersion	Batasi panggilan API sarana kontrol ke layanan API Management dengan versi yang sama dengan atau lebih baru dari nilai ini.	string

CertificateConfiguration

Nama	Deskripsi	Nilai
sertifikat	Informasi sertifikat.	CertificateInformation
certificatePassword	Kata Sandi Sertifikat.	string
encodedCertificate	Sertifikat Yang Dikodekan Base64.	string
storeName	Lokasi penyimpanan sertifikat System.Security.Cryptography.x509certificates.StoreName. Hanya Root dan CertificateAuthority yang merupakan lokasi yang valid.	'CertificateAuthority' 'Root' (diperlukan)

CertificateInformation

Nama	Deskripsi	Nilai
kedaluwarsa	Tanggal kedaluwarsa sertifikat. Tanggal sesuai dengan format berikut: `yyyy-MM-ddTHH:mm:ssZ` seperti yang ditentukan oleh standar ISO 8601.	string (diperlukan)
subjek	Subjek sertifikat.	string (diperlukan)
thumbprint	Thumbprint sertifikat.	string (diperlukan)

ConfigurationApi

Nama	Deskripsi	Nilai
legacyApi	Indikasi apakah API Konfigurasi warisan (v1) harus diekspos pada layanan API Management atau tidak. Nilai bersifat opsional tetapi harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', API Konfigurasi warisan (v1) tidak akan tersedia untuk gateway yang dihost sendiri. Nilai defaultnya adalah 'Diaktifkan'	'Dinonaktifkan' 'Diaktifkan'

ApiManagementServiceBasePropertiesCustomProperties

Nama	Deskripsi	Nilai
{properti yang disesuaikan}		string

HostnameConfiguration

Nama	Deskripsi	Nilai
sertifikat	Informasi sertifikat.	CertificateInformation
certificatePassword	Kata Sandi Sertifikat.	string
certificateSource	Sumber Sertifikat.	'BuiltIn' 'Kustom' 'KeyVault' 'Dikelola'
certificateStatus	Status Sertifikat.	'Selesai' 'Gagal' 'InProgress'
defaultSslBinding	Tentukan true untuk menyiapkan sertifikat yang terkait dengan Nama Host ini sebagai Sertifikat SSL Default. Jika klien tidak mengirim header SNI, maka ini akan menjadi sertifikat yang akan ditantang. Properti berguna jika layanan mengaktifkan beberapa nama host kustom dan perlu memutuskan sertifikat ssl default. Pengaturan hanya diterapkan ke Jenis Nama Host gateway.	bool
encodedCertificate	Sertifikat Yang Dikodekan Base64.	string
hostName	Nama host untuk dikonfigurasi pada layanan Api Management.	string (diperlukan)
identityClientId	ClientId identitas Terkelola yang Ditetapkan Sistem atau Pengguna seperti yang dihasilkan oleh Azure AD, yang memiliki akses GET ke keyVault yang berisi sertifikat SSL.	string
keyVaultId	Url ke Rahasia KeyVault yang berisi Sertifikat Ssl. Jika Url absolut yang berisi versi disediakan, pembaruan otomatis sertifikat ssl tidak akan berfungsi. Ini mengharuskan layanan Api Management dikonfigurasi dengan aka.ms/apimmsi. Rahasia harus berjenis application/x-pkcs12	string
negotiateClientCertificate	Tentukan true untuk selalu menegosiasikan sertifikat klien pada nama host. Nilai Default adalah false.	bool
jenis	Jenis nama host.	'ConfigurationApi' 'DeveloperPortal' 'Manajemen' 'Portal' 'Proksi' 'Scm' (diperlukan)

RemotePrivateEndpointConnectionWrapper

Nama	Deskripsi	Nilai
id	Id sumber daya koneksi Titik Akhir Privat	string
nama	Nama Koneksi Titik Akhir Privat	string
properti	Properti sumber daya.	PrivateEndpointConnectionWrapperProperties
jenis	Jenis Sumber Daya Koneksi Titik Akhir Privat	string

PrivateEndpointConnectionWrapperProperties

Nama	Deskripsi	Nilai
privateEndpoint	Sumber daya titik akhir privat.	ArmIdWrapper
privateLinkServiceConnectionState	Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.	PrivateLinkServiceConnectionState (diperlukan)

ArmIdWrapper

Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.

PrivateLinkServiceConnectionState

Nama	Deskripsi	Nilai
actionsRequired	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.	string
deskripsi	Alasan persetujuan/penolakan koneksi.	string
status	Menunjukkan apakah koneksi telah Disetujui/Ditolak/Dihapus oleh pemilik layanan.	'Disetujui' 'Tertunda' 'Ditolak'

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat	Deskripsi
Membuat instance API Management dan semua sub-sumber daya menggunakan templat	Templat ini menunjukkan cara membuat layanan API Management dan mengonfigurasi sub-entitas
Menyebarkan API Management dengan Azure Cache for Redis eksternal	Templat ini menunjukkan cara membuat instans Azure API Management di tingkat Konsumsi dengan instans Azure Cache for Redis eksternal sebagai cache eksternal API Management.
Menyebarkan API Management di VNet eksternal dengan IP publik	Templat ini menunjukkan cara membuat instans Azure API Management di tingkat Premium dalam subnet jaringan virtual Anda dalam mode eksternal dan mengonfigurasi aturan NSG yang direkomendasikan pada subnet. Instans disebarkan ke dua zona ketersediaan. Templat ini juga mengonfigurasi alamat IP publik dari langganan Anda.
Membuat instans API Management dengan nama host kustom	Templat ini menunjukkan cara membuat instans Azure API Management dengan nama host kustom untuk portal dan beberapa nama host kustom untuk proksi
Membuat API Management di VNet Internal dengan App Gateway	Templat ini menunjukkan cara Membuat instans Azure API Management di jaringan privat yang dilindungi oleh Azure Application Gateway.
Menyebarkan API Management di VNet internal dengan IP publik	Templat ini menunjukkan cara membuat instans Azure API Management di tingkat Premium dalam subnet jaringan virtual Anda dalam mode internal dan mengonfigurasi aturan NSG yang direkomendasikan pada subnet. Instans disebarkan ke dua zona ketersediaan. Templat ini juga mengonfigurasi alamat IP publik dari langganan Anda.
Membuat instans API Management yang memiliki Identitas MSI	Templat ini membuat instans pengembang Azure API Management memiliki Identitas MSI
Membuat instans API Management tingkat Premium multiregion	Templat ini menunjukkan cara membuat instans API Management dengan lokasi tambahan. Lokasi utama sama dengan lokasi grup sumber daya. Untuk lokasi tambahan, templat menunjukkan NorthCentralUs dan US Timur2. Lokasi utama harus berbeda dari lokasi tambahan.
Membuat API Management dengan ssl proksi kustom menggunakan KeyVault	Templat ini menunjukkan cara Membuat instans Azure API Management dan mengonfigurasi nama host kustom untuk proksi dengan sertifikat ssl dari keyvault.
Membuat layanan API Management dengan SSL dari KeyVault	Templat ini menyebarkan layanan API Management yang dikonfigurasi dengan Identitas yang Ditetapkan Pengguna. Ini menggunakan identitas ini untuk mengambil sertifikat SSL dari KeyVault dan terus memperbaruinya dengan memeriksa setiap 4 jam.
Membuat dan memantau instans API Management	Templat ini membuat instans layanan Azure API Management dan ruang kerja Analitik Log dan menyiapkan pemantauan untuk layanan API Management Anda dengan Analitik Log
Membuat layanan API Management dengan titik akhir privat	Templat ini akan membuat layanan API Management, jaringan virtual, dan titik akhir privat yang mengekspos layanan API Management ke jaringan virtual.
Menyebarkan API Management ke Zona Ketersediaan	Templat ini membuat instans premium Azure API Management dan menyebarkan ke Zona Ketersediaan
Membuat instans API Management menggunakan template	Templat ini membuat instans pengembang Azure API Management
Front Door Standard/Premium dengan asal API Management	Templat ini membuat Front Door Premium dan instans API Management, dan menggunakan kebijakan NSG dan API Management global untuk memvalidasi bahwa lalu lintas telah masuk melalui asal Front Door.
Membuat Azure Front Door di depan Azure API Management	Sampel ini menunjukkan cara menggunakan Azure Front Door sebagai load balancer global di depan Azure API Management.
Application Gateway dengan API Management internal dan Aplikasi Web	Application Gateway merutekan lalu lintas Internet ke jaringan virtual (mode internal) API Management instans yang melayani API web yang dihosting di Azure Web App.

Definisi sumber daya templat ARM

Jenis sumber daya layanan dapat disebarkan dengan operasi yang menargetkan:

Grup sumber daya - Lihat perintah penyebaran grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service, tambahkan JSON berikut ke templat Anda.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2023-05-01-preview",
  "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"
      }
    ],
    "configurationApi": {
      "legacyApi": "string"
    },
    "customProperties": {
      "{customized property}": "string"
    },
    "developerPortalStatus": "string",
    "disableGateway": "bool",
    "enableClientCertificate": "bool",
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "certificateSource": "string",
        "certificateStatus": "string",
        "defaultSslBinding": "bool",
        "encodedCertificate": "string",
        "hostName": "string",
        "identityClientId": "string",
        "keyVaultId": "string",
        "negotiateClientCertificate": "bool",
        "type": "string"
      }
    ],
    "legacyPortalStatus": "string",
    "natGatewayState": "string",
    "notificationSenderEmail": "string",
    "privateEndpointConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        },
        "type": "string"
      }
    ],
    "publicIpAddressId": "string",
    "publicNetworkAccess": "string",
    "publisherEmail": "string",
    "publisherName": "string",
    "restore": "bool",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "string"
    },
    "virtualNetworkType": "string"
  },
  "zones": [ "string" ]
}

Nilai properti

service

Nama	Deskripsi	Nilai
jenis	Jenis sumber daya	'Microsoft.ApiManagement/service'
apiVersion	Versi api sumber daya	'2023-05-01-preview'
nama	Nama sumber daya	string (diperlukan) Batas karakter: 1-50 Karakter yang valid: Alfanumerik dan tanda hubung. Mulai dengan huruf, dan akhiri dengan alfanumerik. Nama sumber daya harus unik di seluruh Azure.
lokasi	Lokasi sumber daya.	string (diperlukan)
tag	Tag sumber daya.	Kamus nama dan nilai tag. Lihat Tag dalam templat
sku	Properti SKU dari layanan API Management.	ApiManagementServiceSkuProperties (diperlukan)
identity	Identitas layanan terkelola dari layanan Api Management.	ApiManagementServiceIdentity
properti	Properti layanan API Management.	ApiManagementServiceProperties (diperlukan)
zona	Daftar zona ketersediaan yang menunjukkan dari mana sumber daya perlu berasal.	string[]

ApiManagementServiceIdentity

Nama	Deskripsi	Nilai
jenis	Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.	'Tidak Ada' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (diperlukan)
userAssignedIdentities	Daftar identitas pengguna yang terkait dengan sumber daya. Identitas pengguna referensi kunci kamus akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Nama	Deskripsi	Nilai
{customized property}		UserIdentityProperties

UserIdentityProperties

Nama	Deskripsi	Nilai
clientId	Id klien identitas yang ditetapkan pengguna.	string
principalId	Id utama identitas yang ditetapkan pengguna.	string

ApiManagementServiceProperties

Nama	Deskripsi	Nilai
additionalLocations	Lokasi pusat data tambahan dari layanan API Management.	AdditionalLocation[]
apiVersionConstraint	Batasan versi Control Plane Apis untuk layanan API Management.	ApiVersionConstraint
sertifikat	Daftar Sertifikat yang perlu diinstal di layanan API Management. Sertifikat maksimum yang didukung yang dapat diinstal adalah 10.	CertificateConfiguration[]
configurationApi	Konfigurasi API konfigurasi layanan API Management.	ConfigurationApi
customProperties	Properti kustom layanan API Management. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` akan menonaktifkan TLS_RSA_WITH_3DES_EDE_CBC_SHA sandi untuk semua TLS(1.0, 1.1 dan 1.2). Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` dapat digunakan untuk menonaktifkan hanya TLS 1.1. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` dapat digunakan untuk menonaktifkan TLS 1.0 pada layanan API Management. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` dapat digunakan untuk menonaktifkan hanya TLS 1.1 untuk komunikasi dengan backend. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` dapat digunakan untuk menonaktifkan TLS 1.0 untuk komunikasi dengan backend. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` dapat digunakan untuk mengaktifkan protokol HTTP2 pada layanan API Management. Tidak menentukan salah satu properti ini pada operasi PATCH akan mengatur ulang nilai properti yang dihilangkan ke defaultnya. Untuk semua pengaturan kecuali Http2, nilai defaultnya adalah `True` jika layanan dibuat pada atau sebelum 1 April 2018 dan `False` sebaliknya. Nilai default pengaturan Http2 adalah `False`. Anda dapat menonaktifkan salah satu sandi berikut dengan menggunakan pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Misalnya, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Nilai defaultnya adalah `true` untuk nilai tersebut. Catatan: Sandi berikut tidak dapat dinonaktifkan karena diperlukan oleh komponen platform internal: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256	ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus	Status portal pengembang di layanan API Management ini.	'Dinonaktifkan' 'Diaktifkan'
disableGateway	Properti hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi. Ini dapat digunakan untuk menonaktifkan gateway di wilayah master.	bool
enableClientCertificate	Properti hanya dimaksudkan untuk digunakan untuk Layanan SKU Konsumsi. Ini memberlakukan sertifikat klien untuk disajikan pada setiap permintaan ke gateway. Ini juga memungkinkan kemampuan untuk mengautentikasi sertifikat dalam kebijakan di gateway.	bool
hostnameConfigurations	Konfigurasi nama host kustom layanan API Management.	HostnameConfiguration[]
legacyPortalStatus	Status portal warisan di layanan API Management.	'Dinonaktifkan' 'Diaktifkan'
natGatewayState	Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.	'Dinonaktifkan' 'Diaktifkan'
notificationSenderEmail	Email alamat tempat pemberitahuan akan dikirim.	string
privateEndpointConnections	Daftar Koneksi Titik Akhir Privat layanan ini.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Alamat IP berbasis IP V4 SKU Standar Publik yang akan dikaitkan dengan Virtual Network layanan yang disebarkan di wilayah tersebut. Hanya didukung untuk SKU Pengembang dan Premium yang disebarkan di Virtual Network.	string
publicNetworkAccess	Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', titik akhir privat adalah metode akses eksklusif. Nilai defaultnya adalah 'Diaktifkan'	'Dinonaktifkan' 'Diaktifkan'
publisherEmail	Email Publisher.	string (diperlukan)
publisherName	Nama penerbit.	string (diperlukan)
pulihkan	Batalkan penghapusan Layanan Api Management jika sebelumnya dihapus sementara. Jika bendera ini ditentukan dan diatur ke True, semua properti lainnya akan diabaikan.	bool
virtualNetworkConfiguration	Konfigurasi jaringan virtual layanan API Management.	VirtualNetworkConfiguration
virtualNetworkType	Jenis VPN tempat layanan API Management perlu dikonfigurasi. Tidak Ada (Nilai Default) berarti layanan API Management bukan bagian dari Virtual Network apa pun, Eksternal berarti penyebaran API Management disiapkan di dalam Virtual Network memiliki Titik Akhir Yang Menghadap Internet, dan Internal berarti bahwa API Management penyebaran disiapkan di dalam Virtual Network hanya memiliki Titik Akhir Yang Menghadap Intranet.	'Eksternal' 'Internal' 'Tidak Ada'

Lokasi Tambahan

Nama	Deskripsi	Nilai
disableGateway	Properti hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi. Ini dapat digunakan untuk menonaktifkan gateway di lokasi tambahan ini.	bool
lokasi	Nama lokasi wilayah tambahan di antara wilayah pusat Data Azure.	string (diperlukan)
natGatewayState	Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.	'Dinonaktifkan' 'Diaktifkan'
publicIpAddressId	Alamat IP berbasis IP V4 SKU Standar Publik yang akan dikaitkan dengan layanan yang Virtual Network disebarkan di lokasi tersebut. Hanya didukung untuk SKU Premium yang disebarkan di Virtual Network.	string
sku	Properti SKU dari layanan API Management.	ApiManagementServiceSkuProperties (diperlukan)
virtualNetworkConfiguration	Konfigurasi jaringan virtual untuk lokasi tersebut.	VirtualNetworkConfiguration
zona	Daftar zona ketersediaan yang menunjukkan dari mana sumber daya perlu berasal.	string[]

ApiManagementServiceSkuProperties

Nama	Deskripsi	Nilai
kapasitas	Kapasitas SKU (jumlah unit SKU yang disebarkan). Untuk kapasitas SKU Konsumsi harus ditentukan sebagai 0.	int (diperlukan)
nama	Nama Sku.	'Dasar' 'BasicV2' 'Konsumsi' 'Pengembang' 'Terisolasi' 'Premium' 'Standar' 'StandardV2' (diperlukan)

VirtualNetworkConfiguration

Nama	Deskripsi	Nilai
subnetResourceId	ID sumber daya lengkap subnet dalam jaringan virtual untuk menyebarkan layanan API Management.	string

ApiVersionConstraint

Nama	Deskripsi	Nilai
minApiVersion	Batasi panggilan API sarana kontrol ke layanan API Management dengan versi yang sama dengan atau lebih baru dari nilai ini.	string

CertificateConfiguration

Nama	Deskripsi	Nilai
sertifikat	Informasi sertifikat.	CertificateInformation
certificatePassword	Kata Sandi Sertifikat.	string
encodedCertificate	Sertifikat Yang Dikodekan Base64.	string
storeName	Lokasi penyimpanan sertifikat System.Security.Cryptography.x509certificates.StoreName. Hanya Root dan CertificateAuthority yang merupakan lokasi yang valid.	'CertificateAuthority' 'Root' (diperlukan)

CertificateInformation

Nama	Deskripsi	Nilai
kedaluwarsa	Tanggal kedaluwarsa sertifikat. Tanggal sesuai dengan format berikut: `yyyy-MM-ddTHH:mm:ssZ` seperti yang ditentukan oleh standar ISO 8601.	string (diperlukan)
subjek	Subjek sertifikat.	string (diperlukan)
thumbprint	Thumbprint sertifikat.	string (diperlukan)

ConfigurationApi

Nama	Deskripsi	Nilai
legacyApi	Indikasi apakah API Konfigurasi warisan (v1) harus diekspos pada layanan API Management atau tidak. Nilai bersifat opsional tetapi harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', API Konfigurasi warisan (v1) tidak akan tersedia untuk gateway yang dihost sendiri. Nilai defaultnya adalah 'Diaktifkan'	'Dinonaktifkan' 'Diaktifkan'

ApiManagementServiceBasePropertiesCustomProperties

Nama	Deskripsi	Nilai
{properti yang disesuaikan}		string

HostnameConfiguration

Nama	Deskripsi	Nilai
sertifikat	Informasi sertifikat.	CertificateInformation
certificatePassword	Kata Sandi Sertifikat.	string
certificateSource	Sumber Sertifikat.	'BuiltIn' 'Kustom' 'KeyVault' 'Dikelola'
certificateStatus	Status Sertifikat.	'Selesai' 'Gagal' 'InProgress'
defaultSslBinding	Tentukan true untuk menyiapkan sertifikat yang terkait dengan Nama Host ini sebagai Sertifikat SSL Default. Jika klien tidak mengirim header SNI, maka ini akan menjadi sertifikat yang akan ditantang. Properti berguna jika layanan mengaktifkan beberapa nama host kustom dan perlu memutuskan sertifikat ssl default. Pengaturan hanya diterapkan ke Jenis Nama Host gateway.	bool
encodedCertificate	Sertifikat Yang Dikodekan Base64.	string
hostName	Nama host untuk dikonfigurasi pada layanan Api Management.	string (diperlukan)
identityClientId	ClientId identitas Terkelola yang Ditetapkan Sistem atau Pengguna seperti yang dihasilkan oleh Azure AD, yang memiliki akses GET ke keyVault yang berisi sertifikat SSL.	string
keyVaultId	Url ke Rahasia KeyVault yang berisi Sertifikat Ssl. Jika Url absolut yang berisi versi disediakan, pembaruan otomatis sertifikat ssl tidak akan berfungsi. Ini mengharuskan layanan Api Management dikonfigurasi dengan aka.ms/apimmsi. Rahasia harus berjenis application/x-pkcs12	string
negotiateClientCertificate	Tentukan true untuk selalu menegosiasikan sertifikat klien pada nama host. Nilai Default adalah false.	bool
jenis	Jenis nama host.	'ConfigurationApi' 'DeveloperPortal' 'Manajemen' 'Portal' 'Proksi' 'Scm' (diperlukan)

RemotePrivateEndpointConnectionWrapper

Nama	Deskripsi	Nilai
id	Id sumber daya koneksi Titik Akhir Privat	string
nama	Nama Koneksi Titik Akhir Privat	string
properti	Properti sumber daya.	PrivateEndpointConnectionWrapperProperties
jenis	Jenis Sumber Daya Koneksi Titik Akhir Privat	string

PrivateEndpointConnectionWrapperProperties

Nama	Deskripsi	Nilai
privateEndpoint	Sumber daya titik akhir privat.	ArmIdWrapper
privateLinkServiceConnectionState	Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.	PrivateLinkServiceConnectionState (diperlukan)

ArmIdWrapper

Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.

PrivateLinkServiceConnectionState

Nama	Deskripsi	Nilai
actionsRequired	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.	string
deskripsi	Alasan persetujuan/penolakan koneksi.	string
status	Menunjukkan apakah koneksi telah Disetujui/Ditolak/Dihapus oleh pemilik layanan.	'Disetujui' 'Tertunda' 'Ditolak'

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat	Deskripsi
Membuat instance API Management dan semua sub-sumber daya menggunakan templat	Templat ini menunjukkan cara membuat layanan API Management dan mengonfigurasi sub-entitas
Menyebarkan API Management dengan Azure Cache for Redis eksternal	Templat ini menunjukkan cara membuat instans Azure API Management di tingkat Konsumsi dengan instans Azure Cache for Redis eksternal sebagai cache eksternal API Management.
Menyebarkan API Management di VNet eksternal dengan IP publik	Templat ini menunjukkan cara membuat instans Azure API Management di tingkat Premium dalam subnet jaringan virtual Anda dalam mode eksternal dan mengonfigurasi aturan NSG yang direkomendasikan pada subnet. Instans disebarkan ke dua zona ketersediaan. Templat ini juga mengonfigurasi alamat IP publik dari langganan Anda.
Membuat instans API Management dengan nama host kustom	Templat ini menunjukkan cara membuat instans Azure API Management dengan nama host kustom untuk portal dan beberapa nama host kustom untuk proksi
Membuat API Management di VNet Internal dengan App Gateway	Templat ini menunjukkan cara Membuat instans Azure API Management di jaringan privat yang dilindungi oleh Azure Application Gateway.
Menyebarkan API Management di VNet internal dengan IP publik	Templat ini menunjukkan cara membuat instans Azure API Management di tingkat Premium dalam subnet jaringan virtual Anda dalam mode internal dan mengonfigurasi aturan NSG yang direkomendasikan pada subnet. Instans disebarkan ke dua zona ketersediaan. Templat ini juga mengonfigurasi alamat IP publik dari langganan Anda.
Membuat instans API Management yang memiliki Identitas MSI	Templat ini membuat instans pengembang Azure API Management memiliki Identitas MSI
Membuat instans API Management tingkat Premium multiregion	Templat ini menunjukkan cara membuat instans API Management dengan lokasi tambahan. Lokasi utama sama dengan lokasi grup sumber daya. Untuk lokasi tambahan, templat menunjukkan NorthCentralUs dan US2 Timur. Lokasi utama harus berbeda dari lokasi tambahan.
Membuat API Management dengan ssl proksi kustom menggunakan KeyVault	Templat ini menunjukkan cara Membuat instans Azure API Management dan mengonfigurasi nama host kustom untuk proksi dengan sertifikat ssl dari keyvault.
Membuat layanan API Management dengan SSL dari KeyVault	Templat ini menyebarkan layanan API Management yang dikonfigurasi dengan Identitas yang Ditetapkan Pengguna. Ini menggunakan identitas ini untuk mengambil sertifikat SSL dari KeyVault dan terus memperbaruinya dengan memeriksa setiap 4 jam.
Membuat dan memantau instans API Management	Templat ini membuat instans layanan Azure API Management dan ruang kerja Analitik Log dan menyiapkan pemantauan untuk layanan API Management Anda dengan Log Analytics
Membuat layanan API Management dengan titik akhir privat	Templat ini akan membuat layanan API Management, jaringan virtual, dan titik akhir privat yang mengekspos layanan API Management ke jaringan virtual.
Menyebarkan API Management ke Zona Ketersediaan	Templat ini membuat instans premium Azure API Management dan menyebarkan ke Zona Ketersediaan
Membuat instans API Management menggunakan template	Templat ini membuat instans pengembang Azure API Management
Front Door Standard/Premium dengan asal API Management	Templat ini membuat Front Door Premium dan instans API Management, dan menggunakan kebijakan NSG dan API Management global untuk memvalidasi bahwa lalu lintas telah datang melalui asal Front Door.
Membuat Azure Front Door di depan Azure API Management	Sampel ini menunjukkan cara menggunakan Azure Front Door sebagai penyeimbang beban global di depan Azure API Management.
Application Gateway dengan API Management internal dan Aplikasi Web	Application Gateway merutekan lalu lintas Internet ke jaringan virtual (mode internal) API Management instans yang melayani API web yang dihosting di Azure Web App.

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya layanan dapat disebarkan dengan operasi yang menargetkan:

Grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service, tambahkan Terraform berikut ke templat Anda.

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

Nilai properti

service

Nama	Deskripsi	Nilai
jenis	Jenis sumber daya	"Microsoft.ApiManagement/service@2023-05-01-preview"
nama	Nama sumber daya	string (diperlukan) Batas karakter: 1-50 Karakter yang valid: Alfanumerik dan tanda hubung. Mulai dengan huruf, dan akhiri dengan alfanumerik. Nama sumber daya harus unik di seluruh Azure.
lokasi	Lokasi sumber daya.	string (diperlukan)
parent_id	Untuk menyebarkan ke grup sumber daya, gunakan ID grup sumber daya tersebut.	string (diperlukan)
tag	Tag sumber daya.	Kamus nama dan nilai tag.
sku	Properti SKU dari layanan API Management.	ApiManagementServiceSkuProperties (diperlukan)
identitas	Identitas layanan terkelola dari layanan Api Management.	ApiManagementServiceIdentity
properti	Properti layanan API Management.	ApiManagementServiceProperties (diperlukan)
zona	Daftar zona ketersediaan yang menunjukkan dari mana sumber daya perlu berasal.	string[]

ApiManagementServiceIdentity

Nama	Deskripsi	Nilai
jenis	Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan.	"SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (diperlukan)
identity_ids	Daftar identitas pengguna yang terkait dengan sumber daya. Identitas pengguna referensi kunci kamus akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	Array ID identitas pengguna.

ApiManagementServiceIdentityUserAssignedIdentities

Nama	Deskripsi	Nilai
{properti yang disesuaikan}		UserIdentityProperties

UserIdentityProperties

Nama	Deskripsi	Nilai
clientId	Id klien identitas yang ditetapkan pengguna.	string
principalId	Id utama identitas yang ditetapkan pengguna.	string

ApiManagementServiceProperties

Nama	Deskripsi	Nilai
additionalLocations	Lokasi pusat data tambahan dari layanan API Management.	AdditionalLocation[]
apiVersionConstraint	Batasan versi Control Plane Apis untuk layanan API Management.	ApiVersionConstraint
sertifikat	Daftar Sertifikat yang perlu diinstal di layanan API Management. Sertifikat maksimum yang didukung yang dapat diinstal adalah 10.	CertificateConfiguration[]
configurationApi	Konfigurasi API konfigurasi layanan API Management.	ConfigurationApi
customProperties	Properti kustom layanan API Management. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` akan menonaktifkan TLS_RSA_WITH_3DES_EDE_CBC_SHA sandi untuk semua TLS(1.0, 1.1 dan 1.2). Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` dapat digunakan untuk menonaktifkan hanya TLS 1.1. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` dapat digunakan untuk menonaktifkan TLS 1.0 pada layanan API Management. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` dapat digunakan untuk menonaktifkan hanya TLS 1.1 untuk komunikasi dengan backend. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` dapat digunakan untuk menonaktifkan TLS 1.0 untuk komunikasi dengan backend. Pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` dapat digunakan untuk mengaktifkan protokol HTTP2 pada layanan API Management. Tidak menentukan salah satu properti ini pada operasi PATCH akan mengatur ulang nilai properti yang dihilangkan ke defaultnya. Untuk semua pengaturan kecuali Http2, nilai defaultnya adalah `True` jika layanan dibuat pada atau sebelum 1 April 2018 dan `False` sebaliknya. Nilai default pengaturan Http2 adalah `False`. Anda dapat menonaktifkan salah satu cipher berikut dengan menggunakan pengaturan `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Misalnya, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Nilai defaultnya adalah `true` untuk nilai tersebut. Catatan: Cipher berikut tidak dapat dinonaktifkan karena diperlukan oleh komponen platform internal: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256	ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus	Status portal pengembang di layanan API Management ini.	"Dinonaktifkan" "Diaktifkan"
disableGateway	Properti hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi. Ini dapat digunakan untuk menonaktifkan gateway di wilayah master.	bool
enableClientCertificate	Properti hanya dimaksudkan untuk digunakan untuk Layanan SKU Konsumsi. Ini memberlakukan sertifikat klien untuk disajikan pada setiap permintaan ke gateway. Ini juga memungkinkan kemampuan untuk mengautentikasi sertifikat dalam kebijakan di gateway.	bool
hostnameConfigurations	Konfigurasi nama host kustom layanan API Management.	HostnameConfiguration[]
legacyPortalStatus	Status portal warisan di layanan API Management.	"Dinonaktifkan" "Diaktifkan"
natGatewayState	Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.	"Dinonaktifkan" "Diaktifkan"
notificationSenderEmail	Email alamat tempat pemberitahuan akan dikirim.	string
privateEndpointConnections	Daftar Koneksi Titik Akhir Privat layanan ini.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Alamat IP berbasis IP V4 SKU Standar Publik yang akan dikaitkan dengan Virtual Network layanan yang disebarkan di wilayah tersebut. Hanya didukung untuk SKU Pengembang dan Premium yang disebarkan di Virtual Network.	string
publicNetworkAccess	Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', titik akhir privat adalah metode akses eksklusif. Nilai defaultnya adalah 'Diaktifkan'	"Dinonaktifkan" "Diaktifkan"
publisherEmail	Email Publisher.	string (diperlukan)
publisherName	Nama penerbit.	string (diperlukan)
pulihkan	Batalkan penghapusan Layanan Api Management jika sebelumnya dihapus sementara. Jika bendera ini ditentukan dan diatur ke True, semua properti lainnya akan diabaikan.	bool
virtualNetworkConfiguration	Konfigurasi jaringan virtual layanan API Management.	VirtualNetworkConfiguration
virtualNetworkType	Jenis VPN tempat layanan API Management perlu dikonfigurasi. Tidak Ada (Nilai Default) berarti layanan API Management bukan bagian dari Virtual Network apa pun, Eksternal berarti penyebaran API Management disiapkan di dalam Virtual Network memiliki Titik Akhir Yang Menghadap Internet, dan Internal berarti bahwa API Management penyebaran disiapkan di dalam Virtual Network hanya memiliki Titik Akhir Yang Menghadap Intranet.	"Eksternal" "Internal" "Tidak Ada"

Lokasi Tambahan

Nama	Deskripsi	Nilai
disableGateway	Properti hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi. Ini dapat digunakan untuk menonaktifkan gateway di lokasi tambahan ini.	bool
lokasi	Nama lokasi wilayah tambahan di antara wilayah pusat Data Azure.	string (diperlukan)
natGatewayState	Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.	"Dinonaktifkan" "Diaktifkan"
publicIpAddressId	Alamat IP berbasis IP V4 SKU Standar Publik yang akan dikaitkan dengan layanan yang Virtual Network disebarkan di lokasi tersebut. Hanya didukung untuk SKU Premium yang disebarkan di Virtual Network.	string
sku	Properti SKU dari layanan API Management.	ApiManagementServiceSkuProperties (diperlukan)
virtualNetworkConfiguration	Konfigurasi jaringan virtual untuk lokasi tersebut.	VirtualNetworkConfiguration
zona	Daftar zona ketersediaan yang menunjukkan dari mana sumber daya perlu berasal.	string[]

ApiManagementServiceSkuProperties

Nama	Deskripsi	Nilai
kapasitas	Kapasitas SKU (jumlah unit SKU yang disebarkan). Untuk kapasitas SKU Konsumsi harus ditentukan sebagai 0.	int (diperlukan)
nama	Nama Sku.	"Dasar" "BasicV2" "Konsumsi" "Pengembang" "Terisolasi" "Premium" "Standar" "StandardV2" (diperlukan)

VirtualNetworkConfiguration

Nama	Deskripsi	Nilai
subnetResourceId	ID sumber daya lengkap subnet dalam jaringan virtual untuk menyebarkan layanan API Management.	string

ApiVersionConstraint

Nama	Deskripsi	Nilai
minApiVersion	Batasi panggilan API sarana kontrol ke layanan API Management dengan versi yang sama dengan atau lebih baru dari nilai ini.	string

CertificateConfiguration

Nama	Deskripsi	Nilai
sertifikat	Informasi sertifikat.	CertificateInformation
certificatePassword	Kata Sandi Sertifikat.	string
encodedCertificate	Sertifikat Yang Dikodekan Base64.	string
storeName	Lokasi penyimpanan sertifikat System.Security.Cryptography.x509certificates.StoreName. Hanya Root dan CertificateAuthority yang merupakan lokasi yang valid.	"CertificateAuthority" "Root" (diperlukan)

CertificateInformation

Nama	Deskripsi	Nilai
kedaluwarsa	Tanggal kedaluwarsa sertifikat. Tanggal sesuai dengan format berikut: `yyyy-MM-ddTHH:mm:ssZ` seperti yang ditentukan oleh standar ISO 8601.	string (diperlukan)
subjek	Subjek sertifikat.	string (diperlukan)
thumbprint	Thumbprint sertifikat.	string (diperlukan)

ConfigurationApi

Nama	Deskripsi	Nilai
legacyApi	Indikasi apakah API Konfigurasi warisan (v1) harus diekspos pada layanan API Management atau tidak. Nilai bersifat opsional tetapi harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', API Konfigurasi warisan (v1) tidak akan tersedia untuk gateway yang dihost sendiri. Nilai defaultnya adalah 'Diaktifkan'	"Dinonaktifkan" "Diaktifkan"

ApiManagementServiceBasePropertiesCustomProperties

Nama	Deskripsi	Nilai
{properti yang disesuaikan}		string

HostnameConfiguration

Nama	Deskripsi	Nilai
sertifikat	Informasi sertifikat.	CertificateInformation
certificatePassword	Kata Sandi Sertifikat.	string
certificateSource	Sumber Sertifikat.	"BuiltIn" "Custom" "KeyVault" "Dikelola"
certificateStatus	Status Sertifikat.	"Selesai" "Gagal" "InProgress"
defaultSslBinding	Tentukan true untuk menyiapkan sertifikat yang terkait dengan Nama Host ini sebagai Sertifikat SSL Default. Jika klien tidak mengirim header SNI, maka ini akan menjadi sertifikat yang akan ditantang. Properti berguna jika layanan mengaktifkan beberapa nama host kustom dan perlu memutuskan sertifikat ssl default. Pengaturan hanya diterapkan ke Jenis Nama Host gateway.	bool
encodedCertificate	Sertifikat Yang Dikodekan Base64.	string
hostName	Nama host untuk dikonfigurasi pada layanan Api Management.	string (diperlukan)
identityClientId	ClientId identitas Terkelola yang Ditetapkan Sistem atau Pengguna seperti yang dihasilkan oleh Azure AD, yang memiliki akses GET ke keyVault yang berisi sertifikat SSL.	string
keyVaultId	Url ke Rahasia KeyVault yang berisi Sertifikat Ssl. Jika Url absolut yang berisi versi disediakan, pembaruan otomatis sertifikat ssl tidak akan berfungsi. Ini mengharuskan layanan Api Management dikonfigurasi dengan aka.ms/apimmsi. Rahasia harus berjenis application/x-pkcs12	string
negotiateClientCertificate	Tentukan true untuk selalu menegosiasikan sertifikat klien pada nama host. Nilai Default adalah false.	bool
jenis	Jenis nama host.	"ConfigurationApi" "DeveloperPortal" "Manajemen" "Portal" "Proksi" "Scm" (diperlukan)

RemotePrivateEndpointConnectionWrapper

Nama	Deskripsi	Nilai
id	Id sumber daya koneksi Titik Akhir Privat	string
nama	Nama Koneksi Titik Akhir Privat	string
properti	Properti sumber daya.	PrivateEndpointConnectionWrapperProperties
jenis	Jenis Sumber Daya Koneksi Titik Akhir Privat	string

PrivateEndpointConnectionWrapperProperties

Nama	Deskripsi	Nilai
privateEndpoint	Sumber daya titik akhir privat.	ArmIdWrapper
privateLinkServiceConnectionState	Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.	PrivateLinkServiceConnectionState (diperlukan)

ArmIdWrapper

Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.

PrivateLinkServiceConnectionState

Nama	Deskripsi	Nilai
actionsRequired	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.	string
deskripsi	Alasan persetujuan/penolakan koneksi.	string
status	Menunjukkan apakah koneksi telah Disetujui/Ditolak/Dihapus oleh pemilik layanan.	"Disetujui" "Tertunda" "Ditolak"

Share via

Layanan Microsoft.ApiManagement

Definisi sumber daya Bicep

Format sumber daya

Nilai properti

service

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Templat Mulai Cepat

Definisi sumber daya templat ARM

Format sumber daya

Nilai properti

service

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

Lokasi Tambahan

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Templat Mulai Cepat

Definisi sumber daya Terraform (penyedia AzAPI)

Format sumber daya

Nilai properti

service

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

Lokasi Tambahan

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Saran dan Komentar

Saran dan Komentar

Sumber Daya Tambahan: