Usługa Microsoft.ApiManagement
- najnowsze
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Definicja zasobu Bicep
Typ zasobu usługi można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.ApiManagement/service@2024-06-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
location: 'string'
name: 'string'
properties: {
additionalLocations: [
{
disableGateway: bool
location: 'string'
natGatewayState: 'string'
publicIpAddressId: 'string'
sku: {
capacity: int
name: 'string'
}
virtualNetworkConfiguration: {
subnetResourceId: 'string'
}
zones: [
'string'
]
}
]
apiVersionConstraint: {
minApiVersion: 'string'
}
certificates: [
{
certificate: {
expiry: 'string'
subject: 'string'
thumbprint: 'string'
}
certificatePassword: 'string'
encodedCertificate: 'string'
storeName: 'string'
}
]
configurationApi: {
legacyApi: 'string'
}
customProperties: {
{customized property}: 'string'
}
developerPortalStatus: 'string'
disableGateway: bool
enableClientCertificate: bool
hostnameConfigurations: [
{
certificate: {
expiry: 'string'
subject: 'string'
thumbprint: 'string'
}
certificatePassword: 'string'
certificateSource: 'string'
certificateStatus: 'string'
defaultSslBinding: bool
encodedCertificate: 'string'
hostName: 'string'
identityClientId: 'string'
keyVaultId: 'string'
negotiateClientCertificate: bool
type: 'string'
}
]
legacyPortalStatus: 'string'
natGatewayState: 'string'
notificationSenderEmail: 'string'
privateEndpointConnections: [
{
id: 'string'
name: 'string'
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
type: 'string'
}
]
publicIpAddressId: 'string'
publicNetworkAccess: 'string'
publisherEmail: 'string'
publisherName: 'string'
releaseChannel: 'string'
restore: bool
virtualNetworkConfiguration: {
subnetResourceId: 'string'
}
virtualNetworkType: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
zones: [
'string'
]
}
Wartości właściwości
Dodatkowa lokalizacja
| Nazwa | Opis | Wartość |
|---|---|---|
| disableGateway | Właściwość prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Może to służyć do wyłączania bramy w tej dodatkowej lokalizacji. | Bool |
| lokalizacja | Nazwa lokalizacji dodatkowego regionu między regionami centrum danych platformy Azure. | ciąg (wymagany) |
| natGatewayState | Właściwość może służyć do włączania bramy translatora adresów sieciowych dla tej usługi API Management. | "Wyłączone" "Włączone" |
| publicIpAddressId | Publiczny adres IP jednostki SKU w warstwie Standardowa w wersji 4, który ma być skojarzony z usługą wdrożona w sieci wirtualnej w lokalizacji. Obsługiwane tylko w przypadku jednostki SKU w warstwie Premium wdrażanej w sieci wirtualnej. | struna |
| Numer jednostki magazynowej | Właściwości jednostki SKU usługi API Management. | ApiManagementServiceSkuProperties (wymagane) |
| virtualNetworkConfiguration | Konfiguracja sieci wirtualnej dla lokalizacji. | VirtualNetworkConfiguration |
| Stref | Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób. | string[] |
ApiManagementServiceBasePropertiesCustomProperties
| Nazwa | Opis | Wartość |
|---|
ApiManagementServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używany dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (wymagane) |
| userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z zasobem. Tożsamość użytkownika odwołania do klucza słownika będą identyfikatorami zasobów usługi ARM w formularzu: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
ApiManagementServiceIdentityUserAssignedIdentities |
ApiManagementServiceIdentityUserAssignedIdentities
| Nazwa | Opis | Wartość |
|---|
ApiManagementServiceProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| additionalLocations | Dodatkowe lokalizacje centrów danych usługi API Management. | AdditionalLocation[] |
| apiVersionConstraint | Ograniczenie wersji interfejsu API płaszczyzny sterowania dla usługi API Management. | ApiVersionConstraint |
| Certyfikaty | Lista certyfikatów, które należy zainstalować w usłudze API Management. Maksymalna obsługiwana liczba obsługiwanych certyfikatów, które można zainstalować, wynosi 10. | CertificateConfiguration[] |
| configurationApi | Konfiguracja konfiguracji interfejsu API usługi API Management. | ConfigurationApi |
| customProperties | Właściwości niestandardowe usługi API Management. Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 spowoduje wyłączenie TLS_RSA_WITH_3DES_EDE_CBC_SHA szyfrowania dla wszystkich protokołów TLS(1.0, 1.1 i 1.2).Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 może służyć do wyłączania tylko protokołu TLS 1.1.Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 może służyć do wyłączania protokołu TLS 1.0 w usłudze API Management.Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 może służyć do wyłączania tylko protokołu TLS 1.1 na potrzeby komunikacji z zapleczem.Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 może służyć do wyłączania protokołu TLS 1.0 na potrzeby komunikacji z zapleczem.Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 może służyć do włączania protokołu HTTP2 w usłudze API Management.Nie określono żadnej z tych właściwości operacji PATCH spowoduje zresetowanie wartości właściwości pominiętych do ich wartości domyślnych. Dla wszystkich ustawień z wyjątkiem Http2 wartość domyślna jest True, jeśli usługa została utworzona w dniu 1 kwietnia 2018 r. lub przed 1 kwietnia 2018 r. i False inaczej. Wartość domyślna ustawienia Http2 to False.Można wyłączyć dowolny z następujących szyfrów przy użyciu ustawień 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. Na przykład Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Wartość domyślna to true dla nich.Uwaga: następujące szyfry nie mogą być wyłączone, ponieważ są one wymagane przez składniki platformy wewnętrznej: 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 | Stan portalu dla deweloperów w tej usłudze API Management. | "Wyłączone" "Włączone" |
| disableGateway | Właściwość prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Może to służyć do wyłączania bramy w regionie głównym. | Bool |
| enableClientCertificate | Właściwość przeznaczona tylko do użycia w przypadku usługi SKU Zużycie. Wymusza to prezentowanie certyfikatu klienta dla każdego żądania do bramy. Umożliwia to również uwierzytelnianie certyfikatu w zasadach w bramie. | Bool |
| hostnameConfigurations | Niestandardowa konfiguracja nazwy hosta usługi API Management. | Nazwa hostaKonfiguracja[] |
| legacyPortalStatus | Stan starszego portalu w usłudze API Management. | "Wyłączone" "Włączone" |
| natGatewayState | Właściwość może służyć do włączania bramy translatora adresów sieciowych dla tej usługi API Management. | "Wyłączone" "Włączone" |
| notificationSenderEmail | Adres e-mail, z którego zostanie wysłane powiadomienie. | struna Ograniczenia: Maksymalna długość = |
| privateEndpointConnections | Lista połączeń prywatnego punktu końcowego tej usługi. | RemotePrivateEndpointConnectionWrapper[] |
| publicIpAddressId | Publiczny standardowy adres IP jednostki SKU w wersji 4, który ma być skojarzony z wdrożona usługa sieci wirtualnej w regionie. Obsługiwane tylko w przypadku jednostki SKU developer i Premium wdrażanej w sieci wirtualnej. | struna |
| publicNetworkAccess | Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tej usługi API Management. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone". Jeśli wartość jest wyłączona, prywatne punkty końcowe są wyłączną metodą dostępu. Wartość domyślna to "Włączone" | "Wyłączone" "Włączone" |
| publisherEmail | Adres e-mail wydawcy. | struna Ograniczenia: Maksymalna długość = (wymagana) |
| publisherName | Nazwa wydawcy. | struna Ograniczenia: Maksymalna długość = (wymagana) |
| releaseChannel | Kanał wydania tej usługi API Management. | "Wartość domyślna" "Wersja zapoznawcza" "Stabilny" |
| przywrócić | Cofnij usunięcie usługi Api Management, jeśli została ona wcześniej usunięta nietrwale. Jeśli ta flaga jest określona i ustawiona na True, wszystkie inne właściwości zostaną zignorowane. | Bool |
| virtualNetworkConfiguration | Konfiguracja sieci wirtualnej usługi API Management. | VirtualNetworkConfiguration |
| virtualNetworkType | Typ sieci VPN, w której należy skonfigurować usługę API Management. Brak (wartość domyślna) oznacza, że usługa API Management nie jest częścią żadnej sieci wirtualnej, zewnętrzne oznacza, że wdrożenie usługi API Management jest konfigurowane wewnątrz sieci wirtualnej mającej punkt końcowy dostępny z Internetu, a wewnętrzne oznacza, że wdrożenie usługi API Management jest skonfigurowane wewnątrz sieci wirtualnej, która ma tylko punkt końcowy dostępny dla intranetu. | "Zewnętrzne" "Wewnętrzny" "Brak" |
ApiManagementServiceSkuProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| pojemność | Pojemność jednostki SKU (liczba wdrożonych jednostek SKU). W obszarze Pojemność jednostki SKU zużycie musi być określona jako 0. | int (wymagane) |
| nazwa | Nazwa jednostki SKU. | "Podstawowa" "BasicV2" "Zużycie" "Deweloper" "Izolowany" "Premium" "Standardowa" "StandardV2" (wymagany) |
ApimResourceTags
| Nazwa | Opis | Wartość |
|---|
ApiVersionConstraint
| Nazwa | Opis | Wartość |
|---|---|---|
| minApiVersion | Ogranicz wywołania interfejsu API płaszczyzny sterowania do usługi API Management z wersją równą lub nowszą niż ta wartość. | struna |
ArmIdWrapper
| Nazwa | Opis | Wartość |
|---|
Konfiguracja certyfikatu
| Nazwa | Opis | Wartość |
|---|---|---|
| certyfikat | Informacje o certyfikacie. | CertificateInformation |
| certificatePassword | Hasło certyfikatu. | struna |
| zakodowanycertyfikat | Certyfikat zakodowany w formacie Base64. | struna |
| storeName | Lokalizacja magazynu certyfikatów System.Security.Cryptography.x509certificates.StoreName. Prawidłowe lokalizacje to tylko katalog główny i certyfikatuAuthority. | "CertificateAuthority" "Root" (wymagane) |
CertificateInformation
| Nazwa | Opis | Wartość |
|---|---|---|
| Upływie terminu ważności | Data wygaśnięcia certyfikatu. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601. |
ciąg (wymagany) |
| Temat | Podmiot certyfikatu. | ciąg (wymagany) |
| Odcisk palca | Odcisk palca certyfikatu. | ciąg (wymagany) |
ConfigurationApi
| Nazwa | Opis | Wartość |
|---|---|---|
| legacyApi | Wskazanie, czy starszy interfejs API konfiguracji (wersja 1) powinien być uwidoczniony w usłudze API Management. Wartość jest opcjonalna, ale musi być "Włączona" lub "Wyłączona". W przypadku ustawienia "Wyłączone" starszy interfejs API konfiguracji (wersja 1) nie będzie dostępny dla bram hostowanych samodzielnie. Wartość domyślna to "Włączone" | "Wyłączone" "Włączone" |
Nazwa hostaKonfiguracja
| Nazwa | Opis | Wartość |
|---|---|---|
| certyfikat | Informacje o certyfikacie. | CertificateInformation |
| certificatePassword | Hasło certyfikatu. | struna |
| certificateSource | Źródło certyfikatu. | "BuiltIn" "Niestandardowy" "KeyVault" "Zarządzane" |
| certificateStatus | Stan certyfikatu. | "Ukończono" "Niepowodzenie" "Ruch przychodzący" |
| defaultSslBinding | Określ wartość true, aby skonfigurować certyfikat skojarzony z tą nazwą hosta jako domyślny certyfikat SSL. Jeśli klient nie wyśle nagłówka SNI, będzie to certyfikat, który zostanie zakwestionowany. Właściwość jest przydatna, jeśli usługa ma włączoną wiele niestandardowych nazw hostów i musi zdecydować o domyślnym certyfikacie SSL. Ustawienie stosowane tylko do typu nazwy hosta bramy. | Bool |
| zakodowanycertyfikat | Certyfikat zakodowany w formacie Base64. | struna |
| nazwa hosta | Nazwa hosta do skonfigurowania w usłudze Api Management. | ciąg (wymagany) |
| identityClientId | Identyfikator clientId tożsamości zarządzanej przypisanej przez system lub użytkownika wygenerowany przez usługę Azure AD, który ma dostęp GET do magazynu kluczy zawierającego certyfikat SSL. | struna |
| keyVaultId | Adres URL wpisu tajnego usługi KeyVault zawierającego certyfikat SSL. Jeśli podany jest bezwzględny adres URL zawierający wersję, automatyczna aktualizacja certyfikatu ssl nie będzie działać. Wymaga to skonfigurowania usługi Api Management przy użyciu aka.ms/apimmsi. Wpis tajny powinien być typu application/x-pkcs12 | struna |
| negotiateClientCertificate | Określ wartość true, aby zawsze negocjować certyfikat klienta na nazwie hosta. Wartość domyślna to false. | Bool |
| typ | Typ nazwy hosta. | "ConfigurationApi" "DeveloperPortal" "Zarządzanie" "Portal" "Serwer proxy" "Scm" (wymagane) |
Microsoft.ApiManagement/service
| Nazwa | Opis | Wartość |
|---|---|---|
| tożsamość | Tożsamość usługi zarządzanej usługi Api Management. | ApiManagementServiceIdentity |
| lokalizacja | Lokalizacja zasobu. | ciąg (wymagany) |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 Wzorzec = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (wymagane) |
| Właściwości | Właściwości usługi API Management. | ApiManagementServiceProperties (wymagane) |
| Numer jednostki magazynowej | Właściwości jednostki SKU usługi API Management. | ApiManagementServiceSkuProperties (wymagane) |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
| Stref | Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób. | string[] |
PrivateEndpointConnectionWrapperProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| privateEndpoint | Zasób prywatnego punktu końcowego. | ArmIdWrapper |
| privateLinkServiceConnectionState | Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą. | PrivateLinkServiceConnectionState (wymagane) |
PrivateLinkServiceConnectionState
| Nazwa | Opis | Wartość |
|---|---|---|
| actionsRequired | Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy. | struna |
| opis | Przyczyna zatwierdzenia/odrzucenia połączenia. | struna |
| stan | Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi. | "Zatwierdzone" "Oczekujące" "Odrzucono" |
RemotePrivateEndpointConnectionWrapper
| Nazwa | Opis | Wartość |
|---|---|---|
| id | Identyfikator zasobu połączenia z prywatnym punktem końcowym | struna |
| nazwa | Nazwa połączenia prywatnego punktu końcowego | struna |
| Właściwości | Właściwości zasobu. | PrivateEndpointConnectionWrapperProperties |
| typ | Typ zasobu połączenia prywatnego punktu końcowego | struna |
UserIdentityProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| clientId | Identyfikator klienta tożsamości przypisanej przez użytkownika. | struna |
| principalId | Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika. | struna |
VirtualNetworkConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| subnetResourceId | Pełny identyfikator zasobu podsieci w sieci wirtualnej w celu wdrożenia usługi API Management. | struna Ograniczenia: Wzorzec = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$ |
Przykłady z przewodnika Szybki start
W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.
| Plik Bicep | Opis |
|---|---|
| Application Gateway z wewnętrznymi usługami API Management i Web App | Usługa Application Gateway routingu ruchu internetowego do wystąpienia usługi API Management sieci wirtualnej (w trybie wewnętrznym), które obsługuje internetowy interfejs API hostowany w aplikacji internetowej platformy Azure. |
| Tworzenie wystąpienia usługi API Management w warstwie Premium w wielu regionach | Ten szablon przedstawia sposób tworzenia wystąpienia usługi API Management z dodatkowymi lokalizacjami. Lokalizacja podstawowa jest taka sama jak lokalizacja grupy zasobów. W przypadku dodatkowych lokalizacji szablon zawiera wartości NorthCentralUs i East US2. Lokalizacja podstawowa powinna być inna niż w przypadku dodatkowych lokalizacji. |
| Tworzenie wystąpienia usługi API Management z tożsamości usługi ZARZĄDZANEj | Ten szablon tworzy wystąpienie dewelopera usługi Azure API Management z tożsamością msi |
| Tworzenie wystąpienia usługi API Management przy użyciu szablonu | Ten szablon tworzy wystąpienie dewelopera usługi Azure API Management |
| Tworzenie usługi API Management z prywatnym punktem końcowym | Ten szablon spowoduje utworzenie usługi API Management, sieci wirtualnej i prywatnego punktu końcowego uwidaczniającego usługę API Management w sieci wirtualnej. |
| Tworzenie usługi API Management przy użyciu protokołu SSL z usługi KeyVault | Ten szablon wdraża usługę API Management skonfigurowaną przy użyciu tożsamości przypisanej przez użytkownika. Używa tej tożsamości do pobierania certyfikatu SSL z usługi KeyVault i aktualizuje go co 4 godziny. |
| tworzenie usługi API Management w wewnętrznej sieci wirtualnej przy użyciu usługi App Gateway | Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management w sieci prywatnej chronionej przez usługę Azure Application Gateway. |
| wdrażanie usługi API Management w zewnętrznej sieci wirtualnej z publicznym adresem IP | Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management w warstwie Premium w podsieci sieci wirtualnej w trybie zewnętrznym i konfigurowania zalecanych reguł sieciowej grupy zabezpieczeń w podsieci. Wystąpienie jest wdrażane w dwóch strefach dostępności. Szablon konfiguruje również publiczny adres IP z subskrypcji. |
| wdrażanie usługi API Management w wewnętrznej sieci wirtualnej z publicznym adresem IP | Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management w warstwie Premium w podsieci sieci wirtualnej w trybie wewnętrznym i konfigurowania zalecanych reguł sieciowej grupy zabezpieczeń w podsieci. Wystąpienie jest wdrażane w dwóch strefach dostępności. Szablon konfiguruje również publiczny adres IP z subskrypcji. |
| wdrażanie usługi API Management w strefach dostępności | Ten szablon tworzy wystąpienie usługi Azure API Management w warstwie Premium i wdraża je w strefie dostępności |
| wdrażanie usługi API Management za pomocą zewnętrznej pamięci podręcznej Azure Cache for Redis | Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management w warstwie Zużycie z zewnętrznym wystąpieniem usługi Azure Cache for Redis jako zewnętrzną pamięcią podręczną usługi API Management. |
| usługi Front Door Standard/Premium z źródła usługi API Management | Ten szablon tworzy usługę Front Door Premium i wystąpienie usługi API Management oraz używa sieciowej grupy zabezpieczeń i globalnych zasad usługi API Management, aby sprawdzić, czy ruch przechodzi przez źródło usługi Front Door. |
Definicja zasobu szablonu usługi ARM
Typ zasobu usługi można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.ApiManagement/service",
"apiVersion": "2024-06-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"location": "string",
"properties": {
"additionalLocations": [
{
"disableGateway": "bool",
"location": "string",
"natGatewayState": "string",
"publicIpAddressId": "string",
"sku": {
"capacity": "int",
"name": "string"
},
"virtualNetworkConfiguration": {
"subnetResourceId": "string"
},
"zones": [ "string" ]
}
],
"apiVersionConstraint": {
"minApiVersion": "string"
},
"certificates": [
{
"certificate": {
"expiry": "string",
"subject": "string",
"thumbprint": "string"
},
"certificatePassword": "string",
"encodedCertificate": "string",
"storeName": "string"
}
],
"configurationApi": {
"legacyApi": "string"
},
"customProperties": {
"{customized property}": "string"
},
"developerPortalStatus": "string",
"disableGateway": "bool",
"enableClientCertificate": "bool",
"hostnameConfigurations": [
{
"certificate": {
"expiry": "string",
"subject": "string",
"thumbprint": "string"
},
"certificatePassword": "string",
"certificateSource": "string",
"certificateStatus": "string",
"defaultSslBinding": "bool",
"encodedCertificate": "string",
"hostName": "string",
"identityClientId": "string",
"keyVaultId": "string",
"negotiateClientCertificate": "bool",
"type": "string"
}
],
"legacyPortalStatus": "string",
"natGatewayState": "string",
"notificationSenderEmail": "string",
"privateEndpointConnections": [
{
"id": "string",
"name": "string",
"properties": {
"privateEndpoint": {
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
},
"type": "string"
}
],
"publicIpAddressId": "string",
"publicNetworkAccess": "string",
"publisherEmail": "string",
"publisherName": "string",
"releaseChannel": "string",
"restore": "bool",
"virtualNetworkConfiguration": {
"subnetResourceId": "string"
},
"virtualNetworkType": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
},
"zones": [ "string" ]
}
Wartości właściwości
Dodatkowa lokalizacja
| Nazwa | Opis | Wartość |
|---|---|---|
| disableGateway | Właściwość prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Może to służyć do wyłączania bramy w tej dodatkowej lokalizacji. | Bool |
| lokalizacja | Nazwa lokalizacji dodatkowego regionu między regionami centrum danych platformy Azure. | ciąg (wymagany) |
| natGatewayState | Właściwość może służyć do włączania bramy translatora adresów sieciowych dla tej usługi API Management. | "Wyłączone" "Włączone" |
| publicIpAddressId | Publiczny adres IP jednostki SKU w warstwie Standardowa w wersji 4, który ma być skojarzony z usługą wdrożona w sieci wirtualnej w lokalizacji. Obsługiwane tylko w przypadku jednostki SKU w warstwie Premium wdrażanej w sieci wirtualnej. | struna |
| Numer jednostki magazynowej | Właściwości jednostki SKU usługi API Management. | ApiManagementServiceSkuProperties (wymagane) |
| virtualNetworkConfiguration | Konfiguracja sieci wirtualnej dla lokalizacji. | VirtualNetworkConfiguration |
| Stref | Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób. | string[] |
ApiManagementServiceBasePropertiesCustomProperties
| Nazwa | Opis | Wartość |
|---|
ApiManagementServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używany dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (wymagane) |
| userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z zasobem. Tożsamość użytkownika odwołania do klucza słownika będą identyfikatorami zasobów usługi ARM w formularzu: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
ApiManagementServiceIdentityUserAssignedIdentities |
ApiManagementServiceIdentityUserAssignedIdentities
| Nazwa | Opis | Wartość |
|---|
ApiManagementServiceProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| additionalLocations | Dodatkowe lokalizacje centrów danych usługi API Management. | AdditionalLocation[] |
| apiVersionConstraint | Ograniczenie wersji interfejsu API płaszczyzny sterowania dla usługi API Management. | ApiVersionConstraint |
| Certyfikaty | Lista certyfikatów, które należy zainstalować w usłudze API Management. Maksymalna obsługiwana liczba obsługiwanych certyfikatów, które można zainstalować, wynosi 10. | CertificateConfiguration[] |
| configurationApi | Konfiguracja konfiguracji interfejsu API usługi API Management. | ConfigurationApi |
| customProperties | Właściwości niestandardowe usługi API Management. Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 spowoduje wyłączenie TLS_RSA_WITH_3DES_EDE_CBC_SHA szyfrowania dla wszystkich protokołów TLS(1.0, 1.1 i 1.2).Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 może służyć do wyłączania tylko protokołu TLS 1.1.Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 może służyć do wyłączania protokołu TLS 1.0 w usłudze API Management.Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 może służyć do wyłączania tylko protokołu TLS 1.1 na potrzeby komunikacji z zapleczem.Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 może służyć do wyłączania protokołu TLS 1.0 na potrzeby komunikacji z zapleczem.Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 może służyć do włączania protokołu HTTP2 w usłudze API Management.Nie określono żadnej z tych właściwości operacji PATCH spowoduje zresetowanie wartości właściwości pominiętych do ich wartości domyślnych. Dla wszystkich ustawień z wyjątkiem Http2 wartość domyślna jest True, jeśli usługa została utworzona w dniu 1 kwietnia 2018 r. lub przed 1 kwietnia 2018 r. i False inaczej. Wartość domyślna ustawienia Http2 to False.Można wyłączyć dowolny z następujących szyfrów przy użyciu ustawień 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. Na przykład Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Wartość domyślna to true dla nich.Uwaga: następujące szyfry nie mogą być wyłączone, ponieważ są one wymagane przez składniki platformy wewnętrznej: 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 | Stan portalu dla deweloperów w tej usłudze API Management. | "Wyłączone" "Włączone" |
| disableGateway | Właściwość prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Może to służyć do wyłączania bramy w regionie głównym. | Bool |
| enableClientCertificate | Właściwość przeznaczona tylko do użycia w przypadku usługi SKU Zużycie. Wymusza to prezentowanie certyfikatu klienta dla każdego żądania do bramy. Umożliwia to również uwierzytelnianie certyfikatu w zasadach w bramie. | Bool |
| hostnameConfigurations | Niestandardowa konfiguracja nazwy hosta usługi API Management. | Nazwa hostaKonfiguracja[] |
| legacyPortalStatus | Stan starszego portalu w usłudze API Management. | "Wyłączone" "Włączone" |
| natGatewayState | Właściwość może służyć do włączania bramy translatora adresów sieciowych dla tej usługi API Management. | "Wyłączone" "Włączone" |
| notificationSenderEmail | Adres e-mail, z którego zostanie wysłane powiadomienie. | struna Ograniczenia: Maksymalna długość = |
| privateEndpointConnections | Lista połączeń prywatnego punktu końcowego tej usługi. | RemotePrivateEndpointConnectionWrapper[] |
| publicIpAddressId | Publiczny standardowy adres IP jednostki SKU w wersji 4, który ma być skojarzony z wdrożona usługa sieci wirtualnej w regionie. Obsługiwane tylko w przypadku jednostki SKU developer i Premium wdrażanej w sieci wirtualnej. | struna |
| publicNetworkAccess | Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tej usługi API Management. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone". Jeśli wartość jest wyłączona, prywatne punkty końcowe są wyłączną metodą dostępu. Wartość domyślna to "Włączone" | "Wyłączone" "Włączone" |
| publisherEmail | Adres e-mail wydawcy. | struna Ograniczenia: Maksymalna długość = (wymagana) |
| publisherName | Nazwa wydawcy. | struna Ograniczenia: Maksymalna długość = (wymagana) |
| releaseChannel | Kanał wydania tej usługi API Management. | "Wartość domyślna" "Wersja zapoznawcza" "Stabilny" |
| przywrócić | Cofnij usunięcie usługi Api Management, jeśli została ona wcześniej usunięta nietrwale. Jeśli ta flaga jest określona i ustawiona na True, wszystkie inne właściwości zostaną zignorowane. | Bool |
| virtualNetworkConfiguration | Konfiguracja sieci wirtualnej usługi API Management. | VirtualNetworkConfiguration |
| virtualNetworkType | Typ sieci VPN, w której należy skonfigurować usługę API Management. Brak (wartość domyślna) oznacza, że usługa API Management nie jest częścią żadnej sieci wirtualnej, zewnętrzne oznacza, że wdrożenie usługi API Management jest konfigurowane wewnątrz sieci wirtualnej mającej punkt końcowy dostępny z Internetu, a wewnętrzne oznacza, że wdrożenie usługi API Management jest skonfigurowane wewnątrz sieci wirtualnej, która ma tylko punkt końcowy dostępny dla intranetu. | "Zewnętrzne" "Wewnętrzny" "Brak" |
ApiManagementServiceSkuProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| pojemność | Pojemność jednostki SKU (liczba wdrożonych jednostek SKU). W obszarze Pojemność jednostki SKU zużycie musi być określona jako 0. | int (wymagane) |
| nazwa | Nazwa jednostki SKU. | "Podstawowa" "BasicV2" "Zużycie" "Deweloper" "Izolowany" "Premium" "Standardowa" "StandardV2" (wymagany) |
ApimResourceTags
| Nazwa | Opis | Wartość |
|---|
ApiVersionConstraint
| Nazwa | Opis | Wartość |
|---|---|---|
| minApiVersion | Ogranicz wywołania interfejsu API płaszczyzny sterowania do usługi API Management z wersją równą lub nowszą niż ta wartość. | struna |
ArmIdWrapper
| Nazwa | Opis | Wartość |
|---|
Konfiguracja certyfikatu
| Nazwa | Opis | Wartość |
|---|---|---|
| certyfikat | Informacje o certyfikacie. | CertificateInformation |
| certificatePassword | Hasło certyfikatu. | struna |
| zakodowanycertyfikat | Certyfikat zakodowany w formacie Base64. | struna |
| storeName | Lokalizacja magazynu certyfikatów System.Security.Cryptography.x509certificates.StoreName. Prawidłowe lokalizacje to tylko katalog główny i certyfikatuAuthority. | "CertificateAuthority" "Root" (wymagane) |
CertificateInformation
| Nazwa | Opis | Wartość |
|---|---|---|
| Upływie terminu ważności | Data wygaśnięcia certyfikatu. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601. |
ciąg (wymagany) |
| Temat | Podmiot certyfikatu. | ciąg (wymagany) |
| Odcisk palca | Odcisk palca certyfikatu. | ciąg (wymagany) |
ConfigurationApi
| Nazwa | Opis | Wartość |
|---|---|---|
| legacyApi | Wskazanie, czy starszy interfejs API konfiguracji (wersja 1) powinien być uwidoczniony w usłudze API Management. Wartość jest opcjonalna, ale musi być "Włączona" lub "Wyłączona". W przypadku ustawienia "Wyłączone" starszy interfejs API konfiguracji (wersja 1) nie będzie dostępny dla bram hostowanych samodzielnie. Wartość domyślna to "Włączone" | "Wyłączone" "Włączone" |
Nazwa hostaKonfiguracja
| Nazwa | Opis | Wartość |
|---|---|---|
| certyfikat | Informacje o certyfikacie. | CertificateInformation |
| certificatePassword | Hasło certyfikatu. | struna |
| certificateSource | Źródło certyfikatu. | "BuiltIn" "Niestandardowy" "KeyVault" "Zarządzane" |
| certificateStatus | Stan certyfikatu. | "Ukończono" "Niepowodzenie" "Ruch przychodzący" |
| defaultSslBinding | Określ wartość true, aby skonfigurować certyfikat skojarzony z tą nazwą hosta jako domyślny certyfikat SSL. Jeśli klient nie wyśle nagłówka SNI, będzie to certyfikat, który zostanie zakwestionowany. Właściwość jest przydatna, jeśli usługa ma włączoną wiele niestandardowych nazw hostów i musi zdecydować o domyślnym certyfikacie SSL. Ustawienie stosowane tylko do typu nazwy hosta bramy. | Bool |
| zakodowanycertyfikat | Certyfikat zakodowany w formacie Base64. | struna |
| nazwa hosta | Nazwa hosta do skonfigurowania w usłudze Api Management. | ciąg (wymagany) |
| identityClientId | Identyfikator clientId tożsamości zarządzanej przypisanej przez system lub użytkownika wygenerowany przez usługę Azure AD, który ma dostęp GET do magazynu kluczy zawierającego certyfikat SSL. | struna |
| keyVaultId | Adres URL wpisu tajnego usługi KeyVault zawierającego certyfikat SSL. Jeśli podany jest bezwzględny adres URL zawierający wersję, automatyczna aktualizacja certyfikatu ssl nie będzie działać. Wymaga to skonfigurowania usługi Api Management przy użyciu aka.ms/apimmsi. Wpis tajny powinien być typu application/x-pkcs12 | struna |
| negotiateClientCertificate | Określ wartość true, aby zawsze negocjować certyfikat klienta na nazwie hosta. Wartość domyślna to false. | Bool |
| typ | Typ nazwy hosta. | "ConfigurationApi" "DeveloperPortal" "Zarządzanie" "Portal" "Serwer proxy" "Scm" (wymagane) |
Microsoft.ApiManagement/service
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | "2024-06-01-preview" |
| tożsamość | Tożsamość usługi zarządzanej usługi Api Management. | ApiManagementServiceIdentity |
| lokalizacja | Lokalizacja zasobu. | ciąg (wymagany) |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 Wzorzec = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (wymagane) |
| Właściwości | Właściwości usługi API Management. | ApiManagementServiceProperties (wymagane) |
| Numer jednostki magazynowej | Właściwości jednostki SKU usługi API Management. | ApiManagementServiceSkuProperties (wymagane) |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
| typ | Typ zasobu | "Microsoft.ApiManagement/service" |
| Stref | Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób. | string[] |
PrivateEndpointConnectionWrapperProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| privateEndpoint | Zasób prywatnego punktu końcowego. | ArmIdWrapper |
| privateLinkServiceConnectionState | Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą. | PrivateLinkServiceConnectionState (wymagane) |
PrivateLinkServiceConnectionState
| Nazwa | Opis | Wartość |
|---|---|---|
| actionsRequired | Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy. | struna |
| opis | Przyczyna zatwierdzenia/odrzucenia połączenia. | struna |
| stan | Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi. | "Zatwierdzone" "Oczekujące" "Odrzucono" |
RemotePrivateEndpointConnectionWrapper
| Nazwa | Opis | Wartość |
|---|---|---|
| id | Identyfikator zasobu połączenia z prywatnym punktem końcowym | struna |
| nazwa | Nazwa połączenia prywatnego punktu końcowego | struna |
| Właściwości | Właściwości zasobu. | PrivateEndpointConnectionWrapperProperties |
| typ | Typ zasobu połączenia prywatnego punktu końcowego | struna |
UserIdentityProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| clientId | Identyfikator klienta tożsamości przypisanej przez użytkownika. | struna |
| principalId | Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika. | struna |
VirtualNetworkConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| subnetResourceId | Pełny identyfikator zasobu podsieci w sieci wirtualnej w celu wdrożenia usługi API Management. | struna Ograniczenia: Wzorzec = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$ |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Szablon | Opis |
|---|---|
|
Application Gateway z wewnętrznymi usługami API Management i Web App Wdrażanie do Azure  |
Usługa Application Gateway routingu ruchu internetowego do wystąpienia usługi API Management sieci wirtualnej (w trybie wewnętrznym), które obsługuje internetowy interfejs API hostowany w aplikacji internetowej platformy Azure. |
|
Tworzenie wystąpienia usługi API Management w warstwie Premium w wielu regionach Wdrażanie do Azure |
Ten szablon przedstawia sposób tworzenia wystąpienia usługi API Management z dodatkowymi lokalizacjami. Lokalizacja podstawowa jest taka sama jak lokalizacja grupy zasobów. W przypadku dodatkowych lokalizacji szablon zawiera wartości NorthCentralUs i East US2. Lokalizacja podstawowa powinna być inna niż w przypadku dodatkowych lokalizacji. |
|
Tworzenie wystąpienia usługi API Management i wszystkich zasobów podrzędnych przy użyciu szablonu Wdrażanie do Azure |
Ten szablon przedstawia sposób tworzenia usługi API Management i konfigurowania jednostek podrzędnych |
|
Tworzenie wystąpienia usługi API Management z tożsamości usługi ZARZĄDZANEj Wdrażanie do Azure |
Ten szablon tworzy wystąpienie dewelopera usługi Azure API Management z tożsamością msi |
|
Tworzenie wystąpienia usługi API Management przy użyciu szablonu Wdrażanie do Azure |
Ten szablon tworzy wystąpienie dewelopera usługi Azure API Management |
|
Tworzenie wystąpienia usługi API Management z niestandardowymi nazwami hostów Wdrażanie do Azure |
Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management z niestandardową nazwą hosta dla portalu i wieloma niestandardowymi nazwami hostów dla serwera proxy |
|
Tworzenie usługi API Management z prywatnym punktem końcowym Wdrażanie do Azure |
Ten szablon spowoduje utworzenie usługi API Management, sieci wirtualnej i prywatnego punktu końcowego uwidaczniającego usługę API Management w sieci wirtualnej. |
|
Tworzenie usługi API Management przy użyciu protokołu SSL z usługi KeyVault Wdrażanie do Azure |
Ten szablon wdraża usługę API Management skonfigurowaną przy użyciu tożsamości przypisanej przez użytkownika. Używa tej tożsamości do pobierania certyfikatu SSL z usługi KeyVault i aktualizuje go co 4 godziny. |
|
Tworzenie i monitorowanie wystąpienia usługi API Management Wdrażanie do Azure |
Ten szablon tworzy wystąpienie usługi Azure API Management i obszaru roboczego usługi Log Analytics oraz konfiguruje monitorowanie usługi API Management za pomocą usługi Log Analytics |
|
tworzenie usługi API Management w wewnętrznej sieci wirtualnej przy użyciu usługi App Gateway Wdrażanie do Azure |
Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management w sieci prywatnej chronionej przez usługę Azure Application Gateway. |
|
Tworzenie usługi API Management przy użyciu niestandardowego protokołu SSL serwera proxy przy użyciu usługi KeyVault Wdrażanie do Azure |
Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management i konfigurowania niestandardowej nazwy hosta dla serwera proxy przy użyciu certyfikatu ssl z usługi keyvault. |
|
tworzenie usługi Azure Front Door przed usługą Azure API Management Wdrażanie do Azure |
W tym przykładzie pokazano, jak używać usługi Azure Front Door jako globalnego modułu równoważenia obciążenia przed usługą Azure API Management. |
|
wdrażanie usługi API Management w zewnętrznej sieci wirtualnej z publicznym adresem IP Wdrażanie do Azure |
Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management w warstwie Premium w podsieci sieci wirtualnej w trybie zewnętrznym i konfigurowania zalecanych reguł sieciowej grupy zabezpieczeń w podsieci. Wystąpienie jest wdrażane w dwóch strefach dostępności. Szablon konfiguruje również publiczny adres IP z subskrypcji. |
|
wdrażanie usługi API Management w wewnętrznej sieci wirtualnej z publicznym adresem IP Wdrażanie do Azure |
Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management w warstwie Premium w podsieci sieci wirtualnej w trybie wewnętrznym i konfigurowania zalecanych reguł sieciowej grupy zabezpieczeń w podsieci. Wystąpienie jest wdrażane w dwóch strefach dostępności. Szablon konfiguruje również publiczny adres IP z subskrypcji. |
|
wdrażanie usługi API Management w strefach dostępności Wdrażanie do Azure |
Ten szablon tworzy wystąpienie usługi Azure API Management w warstwie Premium i wdraża je w strefie dostępności |
|
wdrażanie usługi API Management za pomocą zewnętrznej pamięci podręcznej Azure Cache for Redis Wdrażanie do Azure |
Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management w warstwie Zużycie z zewnętrznym wystąpieniem usługi Azure Cache for Redis jako zewnętrzną pamięcią podręczną usługi API Management. |
|
usługi Front Door Standard/Premium z źródła usługi API Management Wdrażanie do Azure |
Ten szablon tworzy usługę Front Door Premium i wystąpienie usługi API Management oraz używa sieciowej grupy zabezpieczeń i globalnych zasad usługi API Management, aby sprawdzić, czy ruch przechodzi przez źródło usługi Front Door. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu usługi można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service@2024-06-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
zones = [
"string"
]
body = jsonencode({
properties = {
additionalLocations = [
{
disableGateway = bool
location = "string"
natGatewayState = "string"
publicIpAddressId = "string"
sku = {
capacity = int
name = "string"
}
virtualNetworkConfiguration = {
subnetResourceId = "string"
}
zones = [
"string"
]
}
]
apiVersionConstraint = {
minApiVersion = "string"
}
certificates = [
{
certificate = {
expiry = "string"
subject = "string"
thumbprint = "string"
}
certificatePassword = "string"
encodedCertificate = "string"
storeName = "string"
}
]
configurationApi = {
legacyApi = "string"
}
customProperties = {
{customized property} = "string"
}
developerPortalStatus = "string"
disableGateway = bool
enableClientCertificate = bool
hostnameConfigurations = [
{
certificate = {
expiry = "string"
subject = "string"
thumbprint = "string"
}
certificatePassword = "string"
certificateSource = "string"
certificateStatus = "string"
defaultSslBinding = bool
encodedCertificate = "string"
hostName = "string"
identityClientId = "string"
keyVaultId = "string"
negotiateClientCertificate = bool
type = "string"
}
]
legacyPortalStatus = "string"
natGatewayState = "string"
notificationSenderEmail = "string"
privateEndpointConnections = [
{
id = "string"
name = "string"
properties = {
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
type = "string"
}
]
publicIpAddressId = "string"
publicNetworkAccess = "string"
publisherEmail = "string"
publisherName = "string"
releaseChannel = "string"
restore = bool
virtualNetworkConfiguration = {
subnetResourceId = "string"
}
virtualNetworkType = "string"
}
})
}
Wartości właściwości
Dodatkowa lokalizacja
| Nazwa | Opis | Wartość |
|---|---|---|
| disableGateway | Właściwość prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Może to służyć do wyłączania bramy w tej dodatkowej lokalizacji. | Bool |
| lokalizacja | Nazwa lokalizacji dodatkowego regionu między regionami centrum danych platformy Azure. | ciąg (wymagany) |
| natGatewayState | Właściwość może służyć do włączania bramy translatora adresów sieciowych dla tej usługi API Management. | "Wyłączone" "Włączone" |
| publicIpAddressId | Publiczny adres IP jednostki SKU w warstwie Standardowa w wersji 4, który ma być skojarzony z usługą wdrożona w sieci wirtualnej w lokalizacji. Obsługiwane tylko w przypadku jednostki SKU w warstwie Premium wdrażanej w sieci wirtualnej. | struna |
| Numer jednostki magazynowej | Właściwości jednostki SKU usługi API Management. | ApiManagementServiceSkuProperties (wymagane) |
| virtualNetworkConfiguration | Konfiguracja sieci wirtualnej dla lokalizacji. | VirtualNetworkConfiguration |
| Stref | Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób. | string[] |
ApiManagementServiceBasePropertiesCustomProperties
| Nazwa | Opis | Wartość |
|---|
ApiManagementServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ tożsamości używany dla zasobu. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. | "Brak" "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (wymagane) |
| userAssignedIdentities | Lista tożsamości użytkowników skojarzonych z zasobem. Tożsamość użytkownika odwołania do klucza słownika będą identyfikatorami zasobów usługi ARM w formularzu: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
ApiManagementServiceIdentityUserAssignedIdentities |
ApiManagementServiceIdentityUserAssignedIdentities
| Nazwa | Opis | Wartość |
|---|
ApiManagementServiceProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| additionalLocations | Dodatkowe lokalizacje centrów danych usługi API Management. | AdditionalLocation[] |
| apiVersionConstraint | Ograniczenie wersji interfejsu API płaszczyzny sterowania dla usługi API Management. | ApiVersionConstraint |
| Certyfikaty | Lista certyfikatów, które należy zainstalować w usłudze API Management. Maksymalna obsługiwana liczba obsługiwanych certyfikatów, które można zainstalować, wynosi 10. | CertificateConfiguration[] |
| configurationApi | Konfiguracja konfiguracji interfejsu API usługi API Management. | ConfigurationApi |
| customProperties | Właściwości niestandardowe usługi API Management. Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 spowoduje wyłączenie TLS_RSA_WITH_3DES_EDE_CBC_SHA szyfrowania dla wszystkich protokołów TLS(1.0, 1.1 i 1.2).Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 może służyć do wyłączania tylko protokołu TLS 1.1.Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 może służyć do wyłączania protokołu TLS 1.0 w usłudze API Management.Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 może służyć do wyłączania tylko protokołu TLS 1.1 na potrzeby komunikacji z zapleczem.Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 może służyć do wyłączania protokołu TLS 1.0 na potrzeby komunikacji z zapleczem.Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 może służyć do włączania protokołu HTTP2 w usłudze API Management.Nie określono żadnej z tych właściwości operacji PATCH spowoduje zresetowanie wartości właściwości pominiętych do ich wartości domyślnych. Dla wszystkich ustawień z wyjątkiem Http2 wartość domyślna jest True, jeśli usługa została utworzona w dniu 1 kwietnia 2018 r. lub przed 1 kwietnia 2018 r. i False inaczej. Wartość domyślna ustawienia Http2 to False.Można wyłączyć dowolny z następujących szyfrów przy użyciu ustawień 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. Na przykład Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Wartość domyślna to true dla nich.Uwaga: następujące szyfry nie mogą być wyłączone, ponieważ są one wymagane przez składniki platformy wewnętrznej: 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 | Stan portalu dla deweloperów w tej usłudze API Management. | "Wyłączone" "Włączone" |
| disableGateway | Właściwość prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Może to służyć do wyłączania bramy w regionie głównym. | Bool |
| enableClientCertificate | Właściwość przeznaczona tylko do użycia w przypadku usługi SKU Zużycie. Wymusza to prezentowanie certyfikatu klienta dla każdego żądania do bramy. Umożliwia to również uwierzytelnianie certyfikatu w zasadach w bramie. | Bool |
| hostnameConfigurations | Niestandardowa konfiguracja nazwy hosta usługi API Management. | Nazwa hostaKonfiguracja[] |
| legacyPortalStatus | Stan starszego portalu w usłudze API Management. | "Wyłączone" "Włączone" |
| natGatewayState | Właściwość może służyć do włączania bramy translatora adresów sieciowych dla tej usługi API Management. | "Wyłączone" "Włączone" |
| notificationSenderEmail | Adres e-mail, z którego zostanie wysłane powiadomienie. | struna Ograniczenia: Maksymalna długość = |
| privateEndpointConnections | Lista połączeń prywatnego punktu końcowego tej usługi. | RemotePrivateEndpointConnectionWrapper[] |
| publicIpAddressId | Publiczny standardowy adres IP jednostki SKU w wersji 4, który ma być skojarzony z wdrożona usługa sieci wirtualnej w regionie. Obsługiwane tylko w przypadku jednostki SKU developer i Premium wdrażanej w sieci wirtualnej. | struna |
| publicNetworkAccess | Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tej usługi API Management. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone". Jeśli wartość jest wyłączona, prywatne punkty końcowe są wyłączną metodą dostępu. Wartość domyślna to "Włączone" | "Wyłączone" "Włączone" |
| publisherEmail | Adres e-mail wydawcy. | struna Ograniczenia: Maksymalna długość = (wymagana) |
| publisherName | Nazwa wydawcy. | struna Ograniczenia: Maksymalna długość = (wymagana) |
| releaseChannel | Kanał wydania tej usługi API Management. | "Wartość domyślna" "Wersja zapoznawcza" "Stabilny" |
| przywrócić | Cofnij usunięcie usługi Api Management, jeśli została ona wcześniej usunięta nietrwale. Jeśli ta flaga jest określona i ustawiona na True, wszystkie inne właściwości zostaną zignorowane. | Bool |
| virtualNetworkConfiguration | Konfiguracja sieci wirtualnej usługi API Management. | VirtualNetworkConfiguration |
| virtualNetworkType | Typ sieci VPN, w której należy skonfigurować usługę API Management. Brak (wartość domyślna) oznacza, że usługa API Management nie jest częścią żadnej sieci wirtualnej, zewnętrzne oznacza, że wdrożenie usługi API Management jest konfigurowane wewnątrz sieci wirtualnej mającej punkt końcowy dostępny z Internetu, a wewnętrzne oznacza, że wdrożenie usługi API Management jest skonfigurowane wewnątrz sieci wirtualnej, która ma tylko punkt końcowy dostępny dla intranetu. | "Zewnętrzne" "Wewnętrzny" "Brak" |
ApiManagementServiceSkuProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| pojemność | Pojemność jednostki SKU (liczba wdrożonych jednostek SKU). W obszarze Pojemność jednostki SKU zużycie musi być określona jako 0. | int (wymagane) |
| nazwa | Nazwa jednostki SKU. | "Podstawowa" "BasicV2" "Zużycie" "Deweloper" "Izolowany" "Premium" "Standardowa" "StandardV2" (wymagany) |
ApimResourceTags
| Nazwa | Opis | Wartość |
|---|
ApiVersionConstraint
| Nazwa | Opis | Wartość |
|---|---|---|
| minApiVersion | Ogranicz wywołania interfejsu API płaszczyzny sterowania do usługi API Management z wersją równą lub nowszą niż ta wartość. | struna |
ArmIdWrapper
| Nazwa | Opis | Wartość |
|---|
Konfiguracja certyfikatu
| Nazwa | Opis | Wartość |
|---|---|---|
| certyfikat | Informacje o certyfikacie. | CertificateInformation |
| certificatePassword | Hasło certyfikatu. | struna |
| zakodowanycertyfikat | Certyfikat zakodowany w formacie Base64. | struna |
| storeName | Lokalizacja magazynu certyfikatów System.Security.Cryptography.x509certificates.StoreName. Prawidłowe lokalizacje to tylko katalog główny i certyfikatuAuthority. | "CertificateAuthority" "Root" (wymagane) |
CertificateInformation
| Nazwa | Opis | Wartość |
|---|---|---|
| Upływie terminu ważności | Data wygaśnięcia certyfikatu. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601. |
ciąg (wymagany) |
| Temat | Podmiot certyfikatu. | ciąg (wymagany) |
| Odcisk palca | Odcisk palca certyfikatu. | ciąg (wymagany) |
ConfigurationApi
| Nazwa | Opis | Wartość |
|---|---|---|
| legacyApi | Wskazanie, czy starszy interfejs API konfiguracji (wersja 1) powinien być uwidoczniony w usłudze API Management. Wartość jest opcjonalna, ale musi być "Włączona" lub "Wyłączona". W przypadku ustawienia "Wyłączone" starszy interfejs API konfiguracji (wersja 1) nie będzie dostępny dla bram hostowanych samodzielnie. Wartość domyślna to "Włączone" | "Wyłączone" "Włączone" |
Nazwa hostaKonfiguracja
| Nazwa | Opis | Wartość |
|---|---|---|
| certyfikat | Informacje o certyfikacie. | CertificateInformation |
| certificatePassword | Hasło certyfikatu. | struna |
| certificateSource | Źródło certyfikatu. | "BuiltIn" "Niestandardowy" "KeyVault" "Zarządzane" |
| certificateStatus | Stan certyfikatu. | "Ukończono" "Niepowodzenie" "Ruch przychodzący" |
| defaultSslBinding | Określ wartość true, aby skonfigurować certyfikat skojarzony z tą nazwą hosta jako domyślny certyfikat SSL. Jeśli klient nie wyśle nagłówka SNI, będzie to certyfikat, który zostanie zakwestionowany. Właściwość jest przydatna, jeśli usługa ma włączoną wiele niestandardowych nazw hostów i musi zdecydować o domyślnym certyfikacie SSL. Ustawienie stosowane tylko do typu nazwy hosta bramy. | Bool |
| zakodowanycertyfikat | Certyfikat zakodowany w formacie Base64. | struna |
| nazwa hosta | Nazwa hosta do skonfigurowania w usłudze Api Management. | ciąg (wymagany) |
| identityClientId | Identyfikator clientId tożsamości zarządzanej przypisanej przez system lub użytkownika wygenerowany przez usługę Azure AD, który ma dostęp GET do magazynu kluczy zawierającego certyfikat SSL. | struna |
| keyVaultId | Adres URL wpisu tajnego usługi KeyVault zawierającego certyfikat SSL. Jeśli podany jest bezwzględny adres URL zawierający wersję, automatyczna aktualizacja certyfikatu ssl nie będzie działać. Wymaga to skonfigurowania usługi Api Management przy użyciu aka.ms/apimmsi. Wpis tajny powinien być typu application/x-pkcs12 | struna |
| negotiateClientCertificate | Określ wartość true, aby zawsze negocjować certyfikat klienta na nazwie hosta. Wartość domyślna to false. | Bool |
| typ | Typ nazwy hosta. | "ConfigurationApi" "DeveloperPortal" "Zarządzanie" "Portal" "Serwer proxy" "Scm" (wymagane) |
Microsoft.ApiManagement/service
| Nazwa | Opis | Wartość |
|---|---|---|
| tożsamość | Tożsamość usługi zarządzanej usługi Api Management. | ApiManagementServiceIdentity |
| lokalizacja | Lokalizacja zasobu. | ciąg (wymagany) |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 Wzorzec = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (wymagane) |
| Właściwości | Właściwości usługi API Management. | ApiManagementServiceProperties (wymagane) |
| Numer jednostki magazynowej | Właściwości jednostki SKU usługi API Management. | ApiManagementServiceSkuProperties (wymagane) |
| Tagi | Tagi zasobów | Słownik nazw tagów i wartości. |
| typ | Typ zasobu | "Microsoft.ApiManagement/service@2024-06-01-preview" |
| Stref | Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób. | string[] |
PrivateEndpointConnectionWrapperProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| privateEndpoint | Zasób prywatnego punktu końcowego. | ArmIdWrapper |
| privateLinkServiceConnectionState | Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą. | PrivateLinkServiceConnectionState (wymagane) |
PrivateLinkServiceConnectionState
| Nazwa | Opis | Wartość |
|---|---|---|
| actionsRequired | Komunikat wskazujący, czy zmiany u dostawcy usług wymagają aktualizacji odbiorcy. | struna |
| opis | Przyczyna zatwierdzenia/odrzucenia połączenia. | struna |
| stan | Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi. | "Zatwierdzone" "Oczekujące" "Odrzucono" |
RemotePrivateEndpointConnectionWrapper
| Nazwa | Opis | Wartość |
|---|---|---|
| id | Identyfikator zasobu połączenia z prywatnym punktem końcowym | struna |
| nazwa | Nazwa połączenia prywatnego punktu końcowego | struna |
| Właściwości | Właściwości zasobu. | PrivateEndpointConnectionWrapperProperties |
| typ | Typ zasobu połączenia prywatnego punktu końcowego | struna |
UserIdentityProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| clientId | Identyfikator klienta tożsamości przypisanej przez użytkownika. | struna |
| principalId | Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika. | struna |
VirtualNetworkConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| subnetResourceId | Pełny identyfikator zasobu podsieci w sieci wirtualnej w celu wdrożenia usługi API Management. | struna Ograniczenia: Wzorzec = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$ |