Api Management Service - Apply Network Configuration Updates

Referensi

Service:: API Management

API Version:: 2022-08-01

Updates sumber daya Microsoft.ApiManagement yang berjalan di Jaringan virtual untuk memilih perubahan DNS yang diperbarui.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates?api-version=2022-08-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
serviceName	path	True	string	Nama layanan API Management. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
location	string	Lokasi layanan Api Management yang akan diperbarui untuk layanan multi-wilayah. Untuk layanan yang disebarkan dalam satu wilayah, parameter ini tidak diperlukan.

Respons

Nama	Jenis	Deskripsi
200 OK	ApiManagementServiceResource	Pembaruan konfigurasi jaringan berhasil diterapkan pada layanan Api Management.
202 Accepted		Diterima: Header lokasi berisi URL tempat status operasi yang berjalan lama dapat diperiksa. Headers location: string
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Nama

Jenis

Deskripsi

200 OK

ApiManagementServiceResource

Pembaruan konfigurasi jaringan berhasil diterapkan pada layanan Api Management.

202 Accepted

Diterima: Header lokasi berisi URL tempat status operasi yang berjalan lama dapat diperiksa.

Headers

location: string

Other Status Codes

ErrorResponse

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementApplyNetworkConfigurationUpdates

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/applynetworkconfigurationupdates?api-version=2022-08-01

{
  "location": "west us"
}

import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceApplyNetworkConfigurationParameters;

/** Samples for ApiManagementService ApplyNetworkConfigurationUpdates. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json
     */
    /**
     * Sample code: ApiManagementApplyNetworkConfigurationUpdates.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementApplyNetworkConfigurationUpdates(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiManagementServices()
            .applyNetworkConfigurationUpdates(
                "rg1",
                "apimService1",
                new ApiManagementServiceApplyNetworkConfigurationParameters().withLocation("west us"),
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_apply_network_configuration_updates.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.api_management_service.begin_apply_network_configuration_updates(
        resource_group_name="rg1",
        service_name="apimService1",
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json
func ExampleServiceClient_BeginApplyNetworkConfigurationUpdates() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewServiceClient().BeginApplyNetworkConfigurationUpdates(ctx, "rg1", "apimService1", &armapimanagement.ServiceClientBeginApplyNetworkConfigurationUpdatesOptions{Parameters: &armapimanagement.ServiceApplyNetworkConfigurationParameters{
		Location: to.Ptr("west us"),
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServiceResource = armapimanagement.ServiceResource{
	// 	Name: to.Ptr("apimService1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 	Tags: map[string]*string{
	// 		"UID": to.Ptr("52ed5986-717b-45b4-b17c-3df8db372cff"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAAXX6Y="),
	// 	Location: to.Ptr("East Asia"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-09-22T01:50:34.792Z"); return t}()),
	// 		GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
	// 		HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 		},
	// 		ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 		PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		PublicIPAddresses: []*string{
	// 			to.Ptr("207.46.155.24")},
	// 			ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 			TargetProvisioningState: to.Ptr(""),
	// 			VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
	// 				SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/eastUsVirtualNetwork/subnets/apimSubnet"),
	// 			},
	// 			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeExternal),
	// 			PublisherEmail: to.Ptr("admin@live.com"),
	// 			PublisherName: to.Ptr("Contoso"),
	// 		},
	// 		SKU: &armapimanagement.ServiceSKUProperties{
	// 			Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 			Capacity: to.Ptr[int32](1),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
 *
 * @summary Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json
 */
async function apiManagementApplyNetworkConfigurationUpdates() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    location: "west us",
  };
  const options = {
    parameters,
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginApplyNetworkConfigurationUpdatesAndWait(
    resourceGroupName,
    serviceName,
    options
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "UID": "52ed5986-717b-45b4-b17c-3df8db372cff"
  },
  "location": "East Asia",
  "etag": "AAAAAAAXX6Y=",
  "properties": {
    "publisherEmail": "admin@live.com",
    "publisherName": "Contoso",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2015-09-22T01:50:34.7921566Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "207.46.155.24"
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/eastUsVirtualNetwork/subnets/apimSubnet"
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

Definisi

Nama	Deskripsi
AdditionalLocation	Deskripsi lokasi sumber daya API Management tambahan.
ApiManagementServiceApplyNetworkConfigurationParameters	Parameter yang diberikan ke operasi Terapkan konfigurasi Jaringan.
ApiManagementServiceIdentity	Properti identitas sumber daya layanan Api Management.
ApiManagementServiceResource	Satu sumber daya layanan API Management dalam Daftar atau Dapatkan respons.
ApiManagementServiceSkuProperties	API Management properti SKU sumber daya layanan.
ApimIdentityType	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.
ApiVersionConstraint	Batasan versi Control Plane Apis untuk layanan API Management.
ArmIdWrapper	Pembungkus untuk id sumber daya ARM
CertificateConfiguration	Konfigurasi sertifikat yang terdiri dari perantara dan sertifikat akar yang tidak tepercaya.
CertificateInformation	Informasi sertifikat SSL.
CertificateSource	Sumber Sertifikat.
CertificateStatus	Status Sertifikat.
createdByType	Jenis identitas yang membuat sumber daya.
ErrorFieldContract	Kontrak Bidang Kesalahan.
ErrorResponse	Respons Kesalahan.
HostnameConfiguration	Konfigurasi nama host kustom.
HostnameType	Jenis nama host.
NatGatewayState	Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.
PlatformVersion	Versi Platform Komputasi yang menjalankan layanan.
PrivateEndpointServiceConnectionStatus	Status koneksi titik akhir privat.
PrivateLinkServiceConnectionState	Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.
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'
RemotePrivateEndpointConnectionWrapper	Sumber daya Koneksi Titik Akhir Privat Jarak Jauh.
SkuType	Nama Sku.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
UserIdentityProperties
VirtualNetworkConfiguration	Konfigurasi jaringan virtual tempat layanan API Management disebarkan.
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.

AdditionalLocation

Deskripsi lokasi sumber daya API Management tambahan.

Nama	Jenis	Nilai Default	Deskripsi
disableGateway	boolean	False	Properti hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi. Ini dapat digunakan untuk menonaktifkan gateway di lokasi tambahan ini.
gatewayRegionalUrl	string		URL gateway layanan API Management di Wilayah.
location	string		Nama lokasi wilayah tambahan di antara wilayah pusat Data Azure.
natGatewayState	NatGatewayState	Disabled	Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.
outboundPublicIPAddresses	string[]		Awalan alamat IPV4 publik keluar yang terkait dengan layanan yang disebarkan NAT Gateway. Hanya tersedia untuk SKU Premium pada platform stv2.
platformVersion	PlatformVersion		Versi Platform Komputasi yang menjalankan layanan.
privateIPAddresses	string[]		Alamat IP Privat Static Load Balanced dari layanan API Management yang disebarkan di Virtual Network Internal di lokasi tambahan tertentu. Hanya tersedia untuk SKU Dasar, Standar, Premium, dan Terisolasi.
publicIPAddresses	string[]		Alamat IP Load Balanced Statis Publik dari layanan API Management di lokasi tambahan. Hanya tersedia untuk SKU Dasar, Standar, Premium, dan Terisolasi.
publicIpAddressId	string		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.
sku	ApiManagementServiceSkuProperties		Properti SKU dari layanan API Management.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfigurasi jaringan virtual untuk lokasi tersebut.
zones	string[]		Daftar zona ketersediaan yang menunjukkan dari mana sumber daya perlu berasal.

ApiManagementServiceApplyNetworkConfigurationParameters

Parameter yang diberikan ke operasi Terapkan konfigurasi Jaringan.

Nama	Jenis	Deskripsi
location	string	Lokasi layanan Api Management yang akan diperbarui untuk layanan multi-wilayah. Untuk layanan yang disebarkan dalam satu wilayah, parameter ini tidak diperlukan.

ApiManagementServiceIdentity

Properti identitas sumber daya layanan Api Management.

Nama	Jenis	Deskripsi
principalId	string	Id utama identitas.
tenantId	string	Id penyewa klien identitas.
type	ApimIdentityType	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.
userAssignedIdentities	<string, UserIdentityProperties>	Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Satu sumber daya layanan API Management dalam Daftar atau Dapatkan respons.

Nama	Jenis	Nilai Default	Deskripsi
etag	string		ETag sumber daya.
id	string		ID Sumber Daya.
identity	ApiManagementServiceIdentity		Identitas layanan terkelola dari layanan Api Management.
location	string		Lokasi sumber daya.
name	string		Nama sumber daya.
properties.additionalLocations	AdditionalLocation[]		Lokasi pusat data tambahan dari layanan API Management.
properties.apiVersionConstraint	ApiVersionConstraint		Batasan versi Control Plane Apis untuk layanan API Management.
properties.certificates	CertificateConfiguration[]		Daftar Sertifikat yang perlu diinstal di layanan API Management. Sertifikat maksimum yang didukung yang dapat diinstal adalah 10.
properties.createdAtUtc	string		Tanggal UTC pembuatan layanan API Management. Tanggal sesuai dengan format berikut: `yyyy-MM-ddTHH:mm:ssZ` seperti yang ditentukan oleh standar ISO 8601.
properties.customProperties	object		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: 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
properties.developerPortalUrl	string		URL titik akhir Portal DEveloper dari layanan API Management.
properties.disableGateway	boolean	False	Properti hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi. Ini dapat digunakan untuk menonaktifkan gateway di wilayah master.
properties.enableClientCertificate	boolean	False	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.
properties.gatewayRegionalUrl	string		URL gateway layanan API Management di Wilayah Default.
properties.gatewayUrl	string		URL gateway layanan API Management.
properties.hostnameConfigurations	HostnameConfiguration[]		Konfigurasi nama host kustom layanan API Management.
properties.managementApiUrl	string		URL titik akhir API Manajemen dari layanan API Management.
properties.natGatewayState	NatGatewayState	Disabled	Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.
properties.notificationSenderEmail	string		Email alamat tempat pemberitahuan akan dikirim.
properties.outboundPublicIPAddresses	string[]		Awalan alamat IPV4 publik keluar yang terkait dengan layanan yang disebarkan NAT Gateway. Hanya tersedia untuk SKU Premium pada platform stv2.
properties.platformVersion	PlatformVersion		Versi Platform Komputasi yang menjalankan layanan di lokasi ini.
properties.portalUrl	string		Url titik akhir portal penerbit dari layanan API Management.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Daftar Koneksi Titik Akhir Privat layanan ini.
properties.privateIPAddresses	string[]		Alamat IP Privat Static Load Balanced dari layanan API Management di wilayah Primer yang disebarkan dalam Virtual Network Internal. Hanya tersedia untuk SKU Dasar, Standar, Premium, dan Terisolasi.
properties.provisioningState	string		Status provisi layanan API Management saat ini yang dapat menjadi salah satu dari yang berikut: Create/Activating/Succeeded/Updating/Failed/Stop/Terminating/TerminationFailed/Deleted.
properties.publicIPAddresses	string[]		Alamat IP Load Balanced Statis Publik dari layanan API Management di wilayah Utama. Hanya tersedia untuk SKU Dasar, Standar, Premium, dan Terisolasi.
properties.publicIpAddressId	string		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.
properties.publicNetworkAccess	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'
properties.publisherEmail	string		Email Publisher.
properties.publisherName	string		Nama penerbit.
properties.restore	boolean	False	Batalkan penghapusan Layanan Api Management jika sebelumnya dihapus sementara. Jika bendera ini ditentukan dan diatur ke True, semua properti lainnya akan diabaikan.
properties.scmUrl	string		URL titik akhir SCM dari layanan API Management.
properties.targetProvisioningState	string		Status penyediaan layanan API Management, yang ditargetkan oleh operasi jangka panjang yang dimulai pada layanan.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfigurasi jaringan virtual layanan API Management.
properties.virtualNetworkType	VirtualNetworkType	None	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.
sku	ApiManagementServiceSkuProperties		Properti SKU dari layanan API Management.
systemData	systemData		Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
tags	object		Tag sumber daya.
type	string		Jenis sumber daya untuk sumber daya API Management diatur ke Microsoft.ApiManagement.
zones	string[]		Daftar zona ketersediaan yang menunjukkan dari mana sumber daya perlu berasal.

ApiManagementServiceSkuProperties

API Management properti SKU sumber daya layanan.

Nama	Jenis	Deskripsi
capacity	integer	Kapasitas SKU (jumlah unit SKU yang disebarkan). Untuk kapasitas SKU Konsumsi harus ditentukan sebagai 0.
name	SkuType	Nama Sku.

ApimIdentityType

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.

Nama	Jenis	Deskripsi
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

Batasan versi Control Plane Apis untuk layanan API Management.

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

ArmIdWrapper

Pembungkus untuk id sumber daya ARM

Nama	Jenis	Deskripsi
id	string

CertificateConfiguration

Konfigurasi sertifikat yang terdiri dari perantara dan sertifikat akar yang tidak tepercaya.

Nama	Jenis	Deskripsi
certificate	CertificateInformation	Informasi sertifikat.
certificatePassword	string	Kata Sandi Sertifikat.
encodedCertificate	string	Sertifikat Yang Dikodekan Base64.
storeName	enum: CertificateAuthority Root	Lokasi penyimpanan sertifikat System.Security.Cryptography.x509certificates.StoreName. Hanya Root dan CertificateAuthority yang merupakan lokasi yang valid.

CertificateInformation

Informasi sertifikat SSL.

Nama	Jenis	Deskripsi
expiry	string	Tanggal kedaluwarsa sertifikat. Tanggal sesuai dengan format berikut: `yyyy-MM-ddTHH:mm:ssZ` seperti yang ditentukan oleh standar ISO 8601.
subject	string	Subjek sertifikat.
thumbprint	string	Thumbprint sertifikat.

CertificateSource

Sumber Sertifikat.

Nama	Jenis	Deskripsi
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

Status Sertifikat.

Nama	Jenis	Deskripsi
Completed	string
Failed	string
InProgress	string

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorFieldContract

Kontrak Bidang Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan tingkat properti.
message	string	Representasi kesalahan tingkat properti yang dapat dibaca manusia.
target	string	Nama properti.

ErrorResponse

Respons Kesalahan.

Nama	Jenis	Deskripsi
error.code	string	Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.
error.details	ErrorFieldContract[]	Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.
error.message	string	Representasi kesalahan yang dapat dibaca manusia.

HostnameConfiguration

Konfigurasi nama host kustom.

Nama	Jenis	Nilai Default	Deskripsi
certificate	CertificateInformation		Informasi sertifikat.
certificatePassword	string		Kata Sandi Sertifikat.
certificateSource	CertificateSource		Sumber Sertifikat.
certificateStatus	CertificateStatus		Status Sertifikat.
defaultSslBinding	boolean	False	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.
encodedCertificate	string		Sertifikat Yang Dikodekan Base64.
hostName	string		Nama host untuk dikonfigurasi pada layanan Api Management.
identityClientId	string		ClientId identitas Terkelola yang Ditetapkan Sistem atau Pengguna seperti yang dihasilkan oleh Azure AD, yang memiliki akses GET ke keyVault yang berisi sertifikat SSL.
keyVaultId	string		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. Rahasianya harus berjenis application/x-pkcs12
negotiateClientCertificate	boolean	False	Tentukan true untuk selalu menegosiasikan sertifikat klien pada nama host. Nilai Default adalah false.
type	HostnameType		Jenis nama host.

HostnameType

Jenis nama host.

Nama	Jenis	Deskripsi
DeveloperPortal	string
Management	string
Portal	string
Proxy	string
Scm	string

NatGatewayState

Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.

Nama	Jenis	Deskripsi
Disabled	string	Nat Gateway dinonaktifkan untuk layanan.
Enabled	string	Nat Gateway diaktifkan untuk layanan.

PlatformVersion

Versi Platform Komputasi yang menjalankan layanan.

Nama	Jenis	Deskripsi
mtv1	string	Platform yang menjalankan layanan pada platform Multi Tenant V1.
stv1	string	Platform yang menjalankan layanan pada platform Penyewa Tunggal V1.
stv2	string	Platform yang menjalankan layanan pada platform Penyewa Tunggal V2.
undetermined	string	Versi platform tidak dapat ditentukan, karena platform komputasi tidak disebarkan.

PrivateEndpointServiceConnectionStatus

Status koneksi titik akhir privat.

Nama	Jenis	Deskripsi
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.

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

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'

Nama	Jenis	Deskripsi
Disabled	string
Enabled	string

RemotePrivateEndpointConnectionWrapper

Sumber daya Koneksi Titik Akhir Privat Jarak Jauh.

Nama	Jenis	Deskripsi
id	string	Id sumber daya koneksi Titik Akhir Privat
name	string	Nama Koneksi Titik Akhir Privat
properties.groupIds	string[]	Semua id Grup.
properties.privateEndpoint	ArmIdWrapper	Sumber daya titik akhir privat.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.
properties.provisioningState	string	Status penyediaan sumber daya koneksi titik akhir privat.
type	string	Jenis Sumber Daya Koneksi Titik Akhir Privat

SkuType

Nama Sku.

Nama	Jenis	Deskripsi
Basic	string	SKU Dasar Api Management.
Consumption	string	Konsumsi SKU Api Management.
Developer	string	SKU Pengembang Api Management.
Isolated	string	SKU Api Management yang terisolasi.
Premium	string	Premium SKU of Api Management.
Standard	string	SKU Standar Api Management.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.

UserIdentityProperties

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

VirtualNetworkConfiguration

Konfigurasi jaringan virtual tempat layanan API Management disebarkan.

Nama	Jenis	Deskripsi
subnetResourceId	string	ID sumber daya lengkap subnet dalam jaringan virtual untuk menyebarkan layanan API Management.
subnetname	string	Nama subnetnya.
vnetid	string	ID jaringan virtual. Ini biasanya GUID. Mengharapkan GUID null secara default.

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.

Nama	Jenis	Deskripsi
External	string	Layanan ini adalah bagian dari Virtual Network dan dapat diakses dari Internet.
Internal	string	Layanan ini adalah bagian dari Virtual Network dan hanya dapat diakses dari dalam jaringan virtual.
None	string	Layanan ini bukan bagian dari Virtual Network apa pun.

Share via

Api Management Service - Apply Network Configuration Updates

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Scopes

Contoh

ApiManagementApplyNetworkConfigurationUpdates

Sample Request

Sample Response

Definisi

AdditionalLocation

ApiManagementServiceApplyNetworkConfigurationParameters

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

CertificateSource

CertificateStatus

createdByType

ErrorFieldContract

ErrorResponse

HostnameConfiguration

HostnameType

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType

Sumber Daya Tambahan: