Api Management Service - Update

Service:

API Management

API Version:

2022-08-01

Mevcut bir API Management hizmetini Güncelleştirmeler.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
serviceName	path	True	string	API Management hizmetinin adı. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
identity	ApiManagementServiceIdentity	Api Management hizmetinin yönetilen hizmet kimliği.
properties.additionalLocations	AdditionalLocation[]	API Management hizmetinin ek veri merkezi konumları.
properties.apiVersionConstraint	ApiVersionConstraint	API Management hizmeti için Denetim Düzlemi Api'leri sürüm kısıtlaması.
properties.certificates	CertificateConfiguration[]	API Management hizmetinde yüklenmesi gereken Sertifikaların listesi. Yüklenebilen desteklenen en yüksek sertifika sayısı 10'dur.
properties.customProperties	object	API Management hizmetinin özel özellikleri. AyarıMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168, tüm TLS(1.0, 1.1 ve 1.2) için şifreleme TLS_RSA_WITH_3DES_EDE_CBC_SHA devre dışı bırakır. Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir. AyarMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10, bir API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir. Arka uçlarla iletişimde yalnızca TLS 1.1'i devre dışı bırakmak için ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kullanılabilir. Arka uçlarla iletişimde TLS 1.0'ı devre dışı bırakmak için ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kullanılabilir. AyarMicrosoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2, bir API Management hizmetinde HTTP2 protokollerini etkinleştirmek için kullanılabilir. PATCH işleminde bu özelliklerden herhangi birinin belirtilmemesi, atlanmış özelliklerin değerlerini varsayılan değerlerine sıfırlar. Http2 dışındaki tüm ayarlar için varsayılan değer, hizmetin 1 Nisan 2018 False tarihinde veya öncesinde veya başka bir şekilde oluşturulup oluşturulmadığıdırTrue. Http2 ayarının varsayılan değeridir False. Ayarları Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]kullanarak aşağıdaki şifrelerden herhangi birini devre dışı bırakabilirsiniz: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Örneğin, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Varsayılan değer bunlar true içindir. Not: İç platform bileşenleri için gerekli olduğundan aşağıdaki şifreler devre dışı bırakılamaz: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
properties.disableGateway	boolean	Özellik yalnızca birden çok konuma dağıtılan api management hizmeti için geçerlidir. Bu, ana bölgede ağ geçidini devre dışı bırakmak için kullanılabilir.
properties.enableClientCertificate	boolean	Özellik yalnızca Tüketim SKU Hizmeti için kullanılacaktır. Bu, ağ geçidine yapılan her istekte bir istemci sertifikasının sunulmasını zorunlu kılabilir. Bu, ağ geçidindeki ilkede sertifikanın kimliğini doğrulama olanağı da sağlar.
properties.hostnameConfigurations	HostnameConfiguration[]	API Management hizmetinin özel ana bilgisayar adı yapılandırması.
properties.natGatewayState	NatGatewayState	Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir.
properties.notificationSenderEmail	string	Bildirimin gönderileceği adresi Email.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]	Bu hizmetin Özel Uç Nokta Bağlantılarının listesi.
properties.publicIpAddressId	string	Bölgede dağıtılan Sanal Ağ hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağ dağıtılan Geliştirici ve Premium SKU için desteklenir.
properties.publicNetworkAccess	PublicNetworkAccess	Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise özel uç noktalar özel erişim yöntemidir. Varsayılan değer :'Etkin'
properties.publisherEmail	string	Yayımcı e-postası.
properties.publisherName	string	Yayımcı adı.
properties.restore	boolean	Önceden geçici olarak silinmişse Api Management Hizmeti'nin geri alma işlemini geri alma. Bu bayrak belirtilirse ve True olarak ayarlanırsa diğer tüm özellikler yoksayılır.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration	API Management hizmetinin sanal ağ yapılandırması.
properties.virtualNetworkType	VirtualNetworkType	API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağ parçası olmadığı, Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı ve İç, API Management dağıtımının bir yalnızca İntranet'e Yönelik Uç Nokta Sanal Ağ.
sku	ApiManagementServiceSkuProperties	API Management hizmetinin SKU özellikleri.
tags	object	Kaynak etiketleri.
zones	string[]	Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.

Yanıtlar

Name	Tür	Description
200 OK	ApiManagementServiceResource	Hizmet başarıyla güncelleştirildi.
202 Accepted		Hizmet güncelleştirme isteği Kabul Edildi.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementUpdateServiceDisableTls10

ApiManagementUpdateServicePublisherDetails

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

Sample Request

HTTP

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

{
  "properties": {
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"
    }
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource;
import java.util.HashMap;
import java.util.Map;

/** Samples for ApiManagementService Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceDisableTls10.json
     */
    /**
     * Sample code: ApiManagementUpdateServiceDisableTls10.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateServiceDisableTls10(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        ApiManagementServiceResource resource =
            manager
                .apiManagementServices()
                .getByResourceGroupWithResponse("rg1", "apimService1", com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withCustomProperties(
                mapOf("Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10", "false"))
            .apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

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_update_service_disable_tls10.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_update(
        resource_group_name="rg1",
        service_name="apimService1",
        parameters={
            "properties": {
                "customProperties": {"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"}
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceDisableTls10.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

Go

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/ApiManagementUpdateServiceDisableTls10.json
func ExampleServiceClient_BeginUpdate_apiManagementUpdateServiceDisableTls10() {
	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().BeginUpdate(ctx, "rg1", "apimService1", armapimanagement.ServiceUpdateParameters{
		Properties: &armapimanagement.ServiceUpdateProperties{
			CustomProperties: map[string]*string{
				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("false"),
			},
		},
	}, nil)
	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{
	// 		"Owner": to.Ptr("sasolank"),
	// 		"Pool": to.Ptr("Manual"),
	// 		"Reserved": to.Ptr(""),
	// 		"TestExpiration": to.Ptr("Thu, 29 Jun 2017 18:50:40 GMT"),
	// 		"TestSuiteExpiration": to.Ptr("Thu, 29 Jun 2017 18:51:46 GMT"),
	// 		"UID": to.Ptr("4f5025fe-0669-4e2e-8320-5199466e5eb3"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAAYRPs="),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-29T17:50:42.319Z"); return t}()),
	// 		CustomProperties: map[string]*string{
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("False"),
	// 		},
	// 		GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
	// 		HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 		},
	// 		ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 		NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 		PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		PublicIPAddresses: []*string{
	// 			to.Ptr("40.86.176.232")},
	// 			ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 			TargetProvisioningState: to.Ptr(""),
	// 			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
	// 			PublisherEmail: to.Ptr("admin@live.com"),
	// 			PublisherName: to.Ptr("Contoso"),
	// 		},
	// 		SKU: &armapimanagement.ServiceSKUProperties{
	// 			Name: to.Ptr(armapimanagement.SKUTypeStandard),
	// 			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

JavaScript

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

/**
 * This sample demonstrates how to Updates an existing API Management service.
 *
 * @summary Updates an existing API Management service.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceDisableTls10.json
 */
async function apiManagementUpdateServiceDisableTls10() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    customProperties: {
      microsoftWindowsAzureApiManagementGatewaySecurityProtocolsTls10: "false",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginUpdateAndWait(
    resourceGroupName,
    serviceName,
    parameters
  );
  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/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "sasolank",
    "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
    "Reserved": "",
    "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
    "Pool": "Manual",
    "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
  },
  "location": "West US",
  "etag": "AAAAAAAYRPs=",
  "properties": {
    "publisherEmail": "admin@live.com",
    "publisherName": "Contoso",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2017-06-29T17:50:42.3191122Z",
    "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": [
      "40.86.176.232"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
    },
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  }
}

ApiManagementUpdateServicePublisherDetails

Sample Request

HTTP

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

{
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext"
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource;
import java.util.HashMap;
import java.util.Map;

/** Samples for ApiManagementService Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServicePublisherDetails.json
     */
    /**
     * Sample code: ApiManagementUpdateServicePublisherDetails.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateServicePublisherDetails(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        ApiManagementServiceResource resource =
            manager
                .apiManagementServices()
                .getByResourceGroupWithResponse("rg1", "apimService1", com.azure.core.util.Context.NONE)
                .getValue();
        resource.update().withPublisherEmail("foobar@live.com").withPublisherName("Contoso Vnext").apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

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_update_service_publisher_details.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_update(
        resource_group_name="rg1",
        service_name="apimService1",
        parameters={"properties": {"publisherEmail": "foobar@live.com", "publisherName": "Contoso Vnext"}},
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServicePublisherDetails.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

Go

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/ApiManagementUpdateServicePublisherDetails.json
func ExampleServiceClient_BeginUpdate_apiManagementUpdateServicePublisherDetails() {
	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().BeginUpdate(ctx, "rg1", "apimService1", armapimanagement.ServiceUpdateParameters{
		Properties: &armapimanagement.ServiceUpdateProperties{
			PublisherEmail: to.Ptr("foobar@live.com"),
			PublisherName:  to.Ptr("Contoso Vnext"),
		},
	}, nil)
	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{
	// 		"Owner": to.Ptr("sasolank"),
	// 		"Pool": to.Ptr("Manual"),
	// 		"Reserved": to.Ptr(""),
	// 		"TestExpiration": to.Ptr("Thu, 29 Jun 2017 18:50:40 GMT"),
	// 		"TestSuiteExpiration": to.Ptr("Thu, 29 Jun 2017 18:51:46 GMT"),
	// 		"UID": to.Ptr("4f5025fe-0669-4e2e-8320-5199466e5eb3"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAAYRPs="),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-29T17:50:42.319Z"); return t}()),
	// 		CustomProperties: map[string]*string{
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("False"),
	// 		},
	// 		GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
	// 		HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 		},
	// 		ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 		NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 		PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		PublicIPAddresses: []*string{
	// 			to.Ptr("40.86.176.232")},
	// 			ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 			TargetProvisioningState: to.Ptr(""),
	// 			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
	// 			PublisherEmail: to.Ptr("foobar@live.com"),
	// 			PublisherName: to.Ptr("Contoso Vnext"),
	// 		},
	// 		SKU: &armapimanagement.ServiceSKUProperties{
	// 			Name: to.Ptr(armapimanagement.SKUTypeStandard),
	// 			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

JavaScript

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

/**
 * This sample demonstrates how to Updates an existing API Management service.
 *
 * @summary Updates an existing API Management service.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServicePublisherDetails.json
 */
async function apiManagementUpdateServicePublisherDetails() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    publisherEmail: "foobar@live.com",
    publisherName: "Contoso Vnext",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginUpdateAndWait(
    resourceGroupName,
    serviceName,
    parameters
  );
  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/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "sasolank",
    "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
    "Reserved": "",
    "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
    "Pool": "Manual",
    "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
  },
  "location": "West US",
  "etag": "AAAAAAAYRPs=",
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2017-06-29T17:50:42.3191122Z",
    "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": [
      "40.86.176.232"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
    },
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  }
}

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

Sample Request

HTTP

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

{
  "properties": {
    "additionalLocations": [
      {
        "location": "Australia East",
        "sku": {
          "name": "Premium",
          "capacity": 3
        },
        "zones": [
          "1",
          "2",
          "3"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
    },
    "virtualNetworkType": "External",
    "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"
  },
  "sku": {
    "name": "Premium",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ]
}

Java

import com.azure.resourcemanager.apimanagement.models.AdditionalLocation;
import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource;
import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceSkuProperties;
import com.azure.resourcemanager.apimanagement.models.SkuType;
import com.azure.resourcemanager.apimanagement.models.VirtualNetworkConfiguration;
import com.azure.resourcemanager.apimanagement.models.VirtualNetworkType;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/** Samples for ApiManagementService Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json
     */
    /**
     * Sample code: ApiManagementUpdateServiceToNewVnetAndAvailabilityZones.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateServiceToNewVnetAndAvailabilityZones(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        ApiManagementServiceResource resource =
            manager
                .apiManagementServices()
                .getByResourceGroupWithResponse("rg1", "apimService1", com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withSku(new ApiManagementServiceSkuProperties().withName(SkuType.PREMIUM).withCapacity(3))
            .withZones(Arrays.asList("1", "2", "3"))
            .withPublicIpAddressId(
                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east")
            .withVirtualNetworkConfiguration(
                new VirtualNetworkConfiguration()
                    .withSubnetResourceId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"))
            .withAdditionalLocations(
                Arrays
                    .asList(
                        new AdditionalLocation()
                            .withLocation("Australia East")
                            .withSku(new ApiManagementServiceSkuProperties().withName(SkuType.PREMIUM).withCapacity(3))
                            .withZones(Arrays.asList("1", "2", "3"))
                            .withPublicIpAddressId(
                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip")
                            .withVirtualNetworkConfiguration(
                                new VirtualNetworkConfiguration()
                                    .withSubnetResourceId(
                                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"))))
            .withVirtualNetworkType(VirtualNetworkType.EXTERNAL)
            .apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Python

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_update_service_to_new_vnet_and_azs.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_update(
        resource_group_name="rg1",
        service_name="apimService1",
        parameters={
            "properties": {
                "additionalLocations": [
                    {
                        "location": "Australia East",
                        "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
                        "sku": {"capacity": 3, "name": "Premium"},
                        "virtualNetworkConfiguration": {
                            "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
                        },
                        "zones": ["1", "2", "3"],
                    }
                ],
                "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east",
                "virtualNetworkConfiguration": {
                    "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
                },
                "virtualNetworkType": "External",
            },
            "sku": {"capacity": 3, "name": "Premium"},
            "zones": ["1", "2", "3"],
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceToNewVnetAndAZs.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

Go

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/ApiManagementUpdateServiceToNewVnetAndAZs.json
func ExampleServiceClient_BeginUpdate_apiManagementUpdateServiceToNewVnetAndAvailabilityZones() {
	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().BeginUpdate(ctx, "rg1", "apimService1", armapimanagement.ServiceUpdateParameters{
		Properties: &armapimanagement.ServiceUpdateProperties{
			AdditionalLocations: []*armapimanagement.AdditionalLocation{
				{
					Location:          to.Ptr("Australia East"),
					PublicIPAddressID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"),
					SKU: &armapimanagement.ServiceSKUProperties{
						Name:     to.Ptr(armapimanagement.SKUTypePremium),
						Capacity: to.Ptr[int32](3),
					},
					VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
						SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"),
					},
					Zones: []*string{
						to.Ptr("1"),
						to.Ptr("2"),
						to.Ptr("3")},
				}},
			PublicIPAddressID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"),
			VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
				SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"),
			},
			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeExternal),
		},
		SKU: &armapimanagement.ServiceSKUProperties{
			Name:     to.Ptr(armapimanagement.SKUTypePremium),
			Capacity: to.Ptr[int32](3),
		},
		Zones: []*string{
			to.Ptr("1"),
			to.Ptr("2"),
			to.Ptr("3")},
	}, nil)
	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"),
	// 	Etag: to.Ptr("AAAAAAAWBIU="),
	// 	Location: to.Ptr("Japan East"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		AdditionalLocations: []*armapimanagement.AdditionalLocation{
	// 			{
	// 				DisableGateway: to.Ptr(false),
	// 				GatewayRegionalURL: to.Ptr("https://apimService1-australiaeast-01.regional.azure-api.net"),
	// 				Location: to.Ptr("Australia East"),
	// 				PlatformVersion: to.Ptr(armapimanagement.PlatformVersionStv2),
	// 				PublicIPAddresses: []*string{
	// 					to.Ptr("20.213.1.35")},
	// 					PublicIPAddressID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"),
	// 					SKU: &armapimanagement.ServiceSKUProperties{
	// 						Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 						Capacity: to.Ptr[int32](3),
	// 					},
	// 					VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
	// 						SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"),
	// 					},
	// 					Zones: []*string{
	// 						to.Ptr("1"),
	// 						to.Ptr("2"),
	// 						to.Ptr("3")},
	// 				}},
	// 				CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-08T23:41:35.644Z"); return t}()),
	// 				CustomProperties: map[string]*string{
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": to.Ptr("false"),
	// 				},
	// 				DeveloperPortalURL: to.Ptr("https://apimService1.developer.azure-api.net"),
	// 				DisableGateway: to.Ptr(false),
	// 				GatewayRegionalURL: to.Ptr("https://apimService1-japaneast-01.regional.azure-api.net"),
	// 				GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
	// 				HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 					{
	// 						Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 						CertificateSource: to.Ptr(armapimanagement.CertificateSourceBuiltIn),
	// 						DefaultSSLBinding: to.Ptr(false),
	// 						HostName: to.Ptr("apimService1.azure-api.net"),
	// 						NegotiateClientCertificate: to.Ptr(false),
	// 					},
	// 					{
	// 						Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 						Certificate: &armapimanagement.CertificateInformation{
	// 							Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-06-09T23:59:59.000Z"); return t}()),
	// 							Subject: to.Ptr("CN=mycustomdomain.int-azure-api.net"),
	// 							Thumbprint: to.Ptr("2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD"),
	// 						},
	// 						CertificateSource: to.Ptr(armapimanagement.CertificateSourceManaged),
	// 						DefaultSSLBinding: to.Ptr(true),
	// 						HostName: to.Ptr("mycustomdomain.int-azure-api.net"),
	// 						NegotiateClientCertificate: to.Ptr(false),
	// 				}},
	// 				ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 				NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 				PlatformVersion: to.Ptr(armapimanagement.PlatformVersionStv2),
	// 				PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				PublicIPAddresses: []*string{
	// 					to.Ptr("20.78.248.217")},
	// 					PublicIPAddressID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"),
	// 					PublicNetworkAccess: to.Ptr(armapimanagement.PublicNetworkAccessEnabled),
	// 					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/vnet-apim-japaneast/subnets/apim2"),
	// 					},
	// 					VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeInternal),
	// 					PublisherEmail: to.Ptr("contoso@microsoft.com"),
	// 					PublisherName: to.Ptr("apimPublisher"),
	// 				},
	// 				SKU: &armapimanagement.ServiceSKUProperties{
	// 					Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 					Capacity: to.Ptr[int32](3),
	// 				},
	// 				SystemData: &armapimanagement.SystemData{
	// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-21T20:04:21.610Z"); return t}()),
	// 					LastModifiedBy: to.Ptr("contoso@microsoft.com"),
	// 					LastModifiedByType: to.Ptr(armapimanagement.CreatedByTypeUser),
	// 				},
	// 				Zones: []*string{
	// 					to.Ptr("1"),
	// 					to.Ptr("2"),
	// 					to.Ptr("3")},
	// 				}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Updates an existing API Management service.
 *
 * @summary Updates an existing API Management service.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json
 */
async function apiManagementUpdateServiceToNewVnetAndAvailabilityZones() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    additionalLocations: [
      {
        location: "Australia East",
        publicIpAddressId:
          "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
        sku: { name: "Premium", capacity: 3 },
        virtualNetworkConfiguration: {
          subnetResourceId:
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default",
        },
        zones: ["1", "2", "3"],
      },
    ],
    publicIpAddressId:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east",
    sku: { name: "Premium", capacity: 3 },
    virtualNetworkConfiguration: {
      subnetResourceId:
        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2",
    },
    virtualNetworkType: "External",
    zones: ["1", "2", "3"],
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginUpdateAndWait(
    resourceGroupName,
    serviceName,
    parameters
  );
  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/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "location": "Japan East",
  "etag": "AAAAAAAWBIU=",
  "properties": {
    "publisherEmail": "contoso@microsoft.com",
    "publisherName": "apimPublisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2021-04-08T23:41:35.6447381Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-japaneast-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "mycustomdomain.int-azure-api.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-06-09T23:59:59+00:00",
          "thumbprint": "2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD",
          "subject": "CN=mycustomdomain.int-azure-api.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Managed"
      }
    ],
    "publicIPAddresses": [
      "20.78.248.217"
    ],
    "additionalLocations": [
      {
        "location": "Australia East",
        "sku": {
          "name": "Premium",
          "capacity": 3
        },
        "zones": [
          "1",
          "2",
          "3"
        ],
        "publicIPAddresses": [
          "20.213.1.35"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net",
        "disableGateway": false,
        "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
        "platformVersion": "stv2"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false"
    },
    "virtualNetworkType": "Internal",
    "disableGateway": false,
    "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east",
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-01-21T20:04:21.6108974Z"
  }
}

Tanımlar

Name	Description
AdditionalLocation	Ek API Management kaynak konumunun açıklaması.
ApiManagementServiceIdentity	Api Management hizmet kaynağının kimlik özellikleri.
ApiManagementServiceResource	Liste veya Yanıt al'da tek bir API Management hizmet kaynağı.
ApiManagementServiceSkuProperties	hizmet kaynağı SKU özelliklerini API Management.
ApiManagementServiceUpdateParameters	Güncelleştirme Api Management Hizmeti'ne sağlanan parametre.
ApimIdentityType	Kaynak için kullanılan kimlik türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.
ApiVersionConstraint	API Management hizmeti için Denetim Düzlemi Api'leri sürüm kısıtlaması.
ArmIdWrapper	ARM kaynak kimliği için sarmalayıcı
CertificateConfiguration	Güvenilir olmayan ara ve kök sertifikalardan oluşan sertifika yapılandırması.
CertificateInformation	SSL sertifika bilgileri.
CertificateSource	Sertifika Kaynağı.
CertificateStatus	Sertifika Durumu.
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorFieldContract	Hata Alanı sözleşmesi.
ErrorResponse	Hata Yanıtı.
HostnameConfiguration	Özel ana bilgisayar adı yapılandırması.
HostnameType	Ana bilgisayar adı türü.
NatGatewayState	Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir.
PlatformVersion	Hizmeti çalıştıran İşlem Platformu Sürümü.
PrivateEndpointServiceConnectionStatus	Özel uç nokta bağlantı durumu.
PrivateLinkServiceConnectionState	Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.
PublicNetworkAccess	Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise özel uç noktalar özel erişim yöntemidir. Varsayılan değer :'Etkin'
RemotePrivateEndpointConnectionWrapper	Uzak Özel Uç Nokta Bağlantısı kaynağı.
SkuType	Sku'nun adı.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
UserIdentityProperties
VirtualNetworkConfiguration	API Management hizmetinin dağıtıldığı bir sanal ağın yapılandırması.
VirtualNetworkType	API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağ parçası olmadığı, Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı ve İç, API Management dağıtımının bir yalnızca İntranet'e Yönelik Uç Nokta Sanal Ağ.

AdditionalLocation

Ek API Management kaynak konumunun açıklaması.

Name	Tür	Varsayılan değer	Description
disableGateway	boolean	False	Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu ek konumda ağ geçidini devre dışı bırakmak için kullanılabilir.
gatewayRegionalUrl	string		Bölgedeki API Management hizmetinin Ağ Geçidi URL'si.
location	string		Azure Veri merkezi bölgeleri arasındaki ek bölgenin konum adı.
natGatewayState	NatGatewayState	Disabled	Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir.
outboundPublicIPAddresses	string[]		NAT Ağ Geçidi dağıtılan hizmetiyle ilişkili giden genel IPV4 adresi ön ekleri. Yalnızca stv2 platformunda Premium SKU için kullanılabilir.
platformVersion	PlatformVersion		Hizmeti çalıştıran İşlem Platformu Sürümü.
privateIPAddresses	string[]		Belirli bir ek konumdaki bir İç Sanal Ağ dağıtılan API Management hizmetinin Özel Statik Yük Dengeli IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.
publicIPAddresses	string[]		Ek konumdaki API Management hizmetinin Genel Statik Yük Dengeli IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.
publicIpAddressId	string		Konumda dağıtılan Sanal Ağ hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağ'de dağıtılan Premium SKU için desteklenir.
sku	ApiManagementServiceSkuProperties		API Management hizmetinin SKU özellikleri.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Konum için sanal ağ yapılandırması.
zones	string[]		Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.

ApiManagementServiceIdentity

Api Management hizmet kaynağının kimlik özellikleri.

Name	Tür	Description
principalId	string	Kimliğin asıl kimliği.
tenantId	string	Kimliğin istemci kiracı kimliği.
type	ApimIdentityType	Kaynak için kullanılan kimlik türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.
userAssignedIdentities	<string,  UserIdentityProperties>	Kaynakla ilişkili kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlüğü anahtar başvuruları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Liste veya Yanıt al'da tek bir API Management hizmet kaynağı.

Name	Tür	Varsayılan değer	Description
etag	string		Kaynağın ETag'i.
id	string		Kaynak Kimliği.
identity	ApiManagementServiceIdentity		Api Management hizmetinin yönetilen hizmet kimliği.
location	string		Kaynak konumu.
name	string		Kaynak adı.
properties.additionalLocations	AdditionalLocation[]		API Management hizmetinin ek veri merkezi konumları.
properties.apiVersionConstraint	ApiVersionConstraint		API Management hizmeti için Denetim Düzlemi Api'leri sürüm kısıtlaması.
properties.certificates	CertificateConfiguration[]		API Management hizmetine yüklenmesi gereken Sertifikaların listesi. Yüklenebilen desteklenen en fazla sertifika sayısı 10'dur.
properties.createdAtUtc	string		API Management hizmetinin oluşturma UTC tarihi. Tarih şu biçime uygundur: yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtildiği gibi.
properties.customProperties	object		API Management hizmetinin özel özellikleri. AyarMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168, tüm TLS(1.0, 1.1 ve 1.2) için şifre TLS_RSA_WITH_3DES_EDE_CBC_SHA devre dışı bırakır. Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir. AyarMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10, bir API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir. Arka uçlarla iletişimde yalnızca TLS 1.1'i devre dışı bırakmak için ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kullanılabilir. Arka uçlarla iletişimde TLS 1.0'ı devre dışı bırakmak için ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kullanılabilir. AyarMicrosoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2, bir API Management hizmetinde HTTP2 protokollerini etkinleştirmek için kullanılabilir. PATCH işleminde bu özelliklerden herhangi birinin belirtilmemesi atlanmış özelliklerin değerlerini varsayılan değerlerine sıfırlar. Http2 dışındaki tüm ayarlar için varsayılan değer, hizmetin 1 Nisan 2018 tarihinde veya öncesinde oluşturulmuş olması ve False aksi halde olmasıdırTrue. Http2 ayarının varsayılan değeri şeklindedir False. Ayarları Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]kullanarak aşağıdaki şifrelemelerden herhangi birini devre dışı bırakabilirsiniz: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Örneğin: Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256false Varsayılan değer onlar true içindir. Not: İç platform bileşenleri için gerekli olduğundan aşağıdaki şifreler devre dışı bırakılamaz: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
properties.developerPortalUrl	string		API Management hizmetinin DEveloper Portal uç nokta URL'si.
properties.disableGateway	boolean	False	Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu, ana bölgede ağ geçidini devre dışı bırakmak için kullanılabilir.
properties.enableClientCertificate	boolean	False	Özellik yalnızca Tüketim SKU Hizmeti için kullanılacaktır. Bu, ağ geçidine yapılan her istekte bir istemci sertifikasının sunulmasını zorunlu kılabilir. Bu, ağ geçidindeki ilkede sertifikanın kimliğini doğrulama olanağı da sağlar.
properties.gatewayRegionalUrl	string		Varsayılan Bölgedeki API Management hizmetinin ağ geçidi URL'si.
properties.gatewayUrl	string		API Management hizmetinin ağ geçidi URL'si.
properties.hostnameConfigurations	HostnameConfiguration[]		API Management hizmetinin özel ana bilgisayar adı yapılandırması.
properties.managementApiUrl	string		API Management hizmetinin Yönetim API'si uç nokta URL'si.
properties.natGatewayState	NatGatewayState	Disabled	Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir.
properties.notificationSenderEmail	string		Bildirimin gönderileceği adresi Email.
properties.outboundPublicIPAddresses	string[]		NAT Ağ Geçidi dağıtılan hizmetiyle ilişkili giden genel IPV4 adresi ön ekleri. Yalnızca stv2 platformunda Premium SKU için kullanılabilir.
properties.platformVersion	PlatformVersion		Bu konumda hizmeti çalıştıran İşlem Platformu Sürümü.
properties.portalUrl	string		API Management hizmetinin Yayımcı portalı uç noktası Url'si.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Bu hizmetin Özel Uç Nokta Bağlantılarının listesi.
properties.privateIPAddresses	string[]		Bir İç Sanal Ağ dağıtılan Birincil bölgedeki API Management hizmetinin Özel Statik Yük Dengeli IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.
properties.provisioningState	string		aşağıdakilerden biri olabilecek API Management hizmetinin geçerli sağlama durumu: Oluşturuldu/Etkinleştirildi/Başarılı/Güncelleştirildi/Başarısız/Durduruldu/Sonlandırılıyor/SonlandırmaKiled/Silindi.
properties.publicIPAddresses	string[]		Birincil bölgedeki API Management hizmetinin Genel Statik Yük Dengeli IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.
properties.publicIpAddressId	string		Bölgede dağıtılan Sanal Ağ hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağ'de dağıtılan Geliştirici ve Premium SKU için desteklenir.
properties.publicNetworkAccess	PublicNetworkAccess		Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise, özel uç noktalar özel erişim yöntemidir. Varsayılan değer :'Etkin'.
properties.publisherEmail	string		Yayımcı e-postası.
properties.publisherName	string		Yayımcı adı.
properties.restore	boolean	False	Önceden geçici olarak silinmişse Api Management Hizmeti'nin silinmesini geri alma. Bu bayrak belirtilirse ve True olarak ayarlanırsa diğer tüm özellikler yoksayılır.
properties.scmUrl	string		API Management hizmetinin SCM uç nokta URL'si.
properties.targetProvisioningState	string		Hizmette başlatılan uzun süre çalışan işlem tarafından hedeflenen API Management hizmetinin sağlama durumu.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		API Management hizmetinin sanal ağ yapılandırması.
properties.virtualNetworkType	VirtualNetworkType	None	API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağ parçası olmadığı, Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı, İç ise API Management dağıtımının bir içinde ayarlandığı anlamına gelir Sanal Ağ yalnızca İntranet'e Yönelik Uç Noktası vardır.
sku	ApiManagementServiceSkuProperties		API Management hizmetinin SKU özellikleri.
systemData	systemData		Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
tags	object		Kaynak etiketleri.
type	string		API Management kaynağın kaynak türü Microsoft.ApiManagement olarak ayarlanır.
zones	string[]		Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.

ApiManagementServiceSkuProperties

hizmet kaynağı SKU özelliklerini API Management.

Name	Tür	Description
capacity	integer	SKU'nun kapasitesi (SKU'nun dağıtılan birim sayısı). Tüketim için SKU kapasitesi 0 olarak belirtilmelidir.
name	SkuType	Sku'nun adı.

ApiManagementServiceUpdateParameters

Güncelleştirme Api Management Hizmeti'ne sağlanan parametre.

Name	Tür	Varsayılan değer	Description
etag	string		Kaynağın ETag'i.
id	string		Kaynak Kimliği.
identity	ApiManagementServiceIdentity		Api Management hizmetinin yönetilen hizmet kimliği.
name	string		Kaynak adı.
properties.additionalLocations	AdditionalLocation[]		API Management hizmetinin ek veri merkezi konumları.
properties.apiVersionConstraint	ApiVersionConstraint		API Management hizmeti için Denetim Düzlemi Api'leri sürüm kısıtlaması.
properties.certificates	CertificateConfiguration[]		API Management hizmetine yüklenmesi gereken Sertifikaların listesi. Yüklenebilen desteklenen en fazla sertifika sayısı 10'dur.
properties.createdAtUtc	string		API Management hizmetinin oluşturma UTC tarihi. Tarih şu biçime uygundur: yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtildiği gibi.
properties.customProperties	object		API Management hizmetinin özel özellikleri. AyarMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168, tüm TLS(1.0, 1.1 ve 1.2) için şifre TLS_RSA_WITH_3DES_EDE_CBC_SHA devre dışı bırakır. Ayar Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 yalnızca TLS 1.1'i devre dışı bırakmak için kullanılabilir. AyarMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10, bir API Management hizmetinde TLS 1.0'ı devre dışı bırakmak için kullanılabilir. Arka uçlarla iletişimde yalnızca TLS 1.1'i devre dışı bırakmak için ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kullanılabilir. Arka uçlarla iletişimde TLS 1.0'ı devre dışı bırakmak için ayarı Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kullanılabilir. AyarMicrosoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2, bir API Management hizmetinde HTTP2 protokollerini etkinleştirmek için kullanılabilir. PATCH işleminde bu özelliklerden herhangi birinin belirtilmemesi atlanmış özelliklerin değerlerini varsayılan değerlerine sıfırlar. Http2 dışındaki tüm ayarlar için varsayılan değer, hizmetin 1 Nisan 2018 tarihinde veya öncesinde oluşturulmuş olması ve False aksi halde olmasıdırTrue. Http2 ayarının varsayılan değeri şeklindedir False. Ayarları Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]kullanarak aşağıdaki şifrelemelerden herhangi birini devre dışı bırakabilirsiniz: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Örneğin: Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256false Varsayılan değer onlar true içindir. Not: İç platform bileşenleri için gerekli olduğundan aşağıdaki şifreler devre dışı bırakılamaz: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
properties.developerPortalUrl	string		API Management hizmetinin DEveloper Portal uç nokta URL'si.
properties.disableGateway	boolean	False	Özellik yalnızca birden çok konuma dağıtılan bir Api Management hizmeti için geçerlidir. Bu, ana bölgede ağ geçidini devre dışı bırakmak için kullanılabilir.
properties.enableClientCertificate	boolean	False	Özellik yalnızca Tüketim SKU Hizmeti için kullanılacaktır. Bu, ağ geçidine yapılan her istekte bir istemci sertifikasının sunulmasını zorunlu kılabilir. Bu, ağ geçidindeki ilkede sertifikanın kimliğini doğrulama olanağı da sağlar.
properties.gatewayRegionalUrl	string		Varsayılan Bölgedeki API Management hizmetinin ağ geçidi URL'si.
properties.gatewayUrl	string		API Management hizmetinin ağ geçidi URL'si.
properties.hostnameConfigurations	HostnameConfiguration[]		API Management hizmetinin özel ana bilgisayar adı yapılandırması.
properties.managementApiUrl	string		API Management hizmetinin Yönetim API'si uç nokta URL'si.
properties.natGatewayState	NatGatewayState	Disabled	Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir.
properties.notificationSenderEmail	string		Bildirimin gönderileceği adresi Email.
properties.outboundPublicIPAddresses	string[]		NAT Ağ Geçidi dağıtılan hizmetiyle ilişkili giden genel IPV4 adresi ön ekleri. Yalnızca stv2 platformunda Premium SKU için kullanılabilir.
properties.platformVersion	PlatformVersion		Bu konumda hizmeti çalıştıran İşlem Platformu Sürümü.
properties.portalUrl	string		API Management hizmetinin Yayımcı portalı uç noktası Url'si.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Bu hizmetin Özel Uç Nokta Bağlantılarının listesi.
properties.privateIPAddresses	string[]		Bir İç Sanal Ağ dağıtılan Birincil bölgedeki API Management hizmetinin Özel Statik Yük Dengeli IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.
properties.provisioningState	string		aşağıdakilerden biri olabilecek API Management hizmetinin geçerli sağlama durumu: Oluşturuldu/Etkinleştirildi/Başarılı/Güncelleştirildi/Başarısız/Durduruldu/Sonlandırılıyor/SonlandırmaKiled/Silindi.
properties.publicIPAddresses	string[]		Birincil bölgedeki API Management hizmetinin Genel Statik Yük Dengeli IP adresleri. Yalnızca Temel, Standart, Premium ve Yalıtılmış SKU için kullanılabilir.
properties.publicIpAddressId	string		Bölgede dağıtılan Sanal Ağ hizmetle ilişkilendirilecek Genel Standart SKU IP V4 tabanlı IP adresi. Yalnızca Sanal Ağ'de dağıtılan Geliştirici ve Premium SKU için desteklenir.
properties.publicNetworkAccess	PublicNetworkAccess		Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise, özel uç noktalar özel erişim yöntemidir. Varsayılan değer :'Etkin'.
properties.publisherEmail	string		Yayımcı e-postası.
properties.publisherName	string		Yayımcı adı.
properties.restore	boolean	False	Önceden geçici olarak silinmişse Api Management Hizmeti'nin silinmesini geri alma. Bu bayrak belirtilirse ve True olarak ayarlanırsa diğer tüm özellikler yoksayılır.
properties.scmUrl	string		API Management hizmetinin SCM uç nokta URL'si.
properties.targetProvisioningState	string		Hizmette başlatılan uzun süre çalışan işlem tarafından hedeflenen API Management hizmetinin sağlama durumu.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		API Management hizmetinin sanal ağ yapılandırması.
properties.virtualNetworkType	VirtualNetworkType	None	API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağ parçası olmadığı, Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı, İç ise API Management dağıtımının bir içinde ayarlandığı anlamına gelir Sanal Ağ yalnızca İntranet'e Yönelik Uç Noktası vardır.
sku	ApiManagementServiceSkuProperties		API Management hizmetinin SKU özellikleri.
tags	object		Kaynak etiketleri.
type	string		API Management kaynağın kaynak türü Microsoft.ApiManagement olarak ayarlanır.
zones	string[]		Kaynağın nereden gelmesi gerektiğini belirten kullanılabilirlik alanlarının listesi.

ApimIdentityType

Kaynak için kullanılan kimlik türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan kimlik kümesini içerir. 'Hiçbiri' türü hizmetten tüm kimlikleri kaldırır.

Name	Tür	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

API Management hizmeti için Denetim Düzlemi Api'leri sürüm kısıtlaması.

Name	Tür	Description
minApiVersion	string	Denetim düzlemi API çağrılarını bu değere eşit veya bundan daha yeni bir sürüme sahip API Management hizmetiyle sınırlayın.

ArmIdWrapper

ARM kaynak kimliği için sarmalayıcı

Name	Tür	Description
id	string

CertificateConfiguration

Güvenilir olmayan ara ve kök sertifikalardan oluşan sertifika yapılandırması.

Name	Tür	Description
certificate	CertificateInformation	Sertifika bilgileri.
certificatePassword	string	Sertifika Parolası.
encodedCertificate	string	Base64 Kodlanmış sertifika.
storeName	enum: CertificateAuthority Root	System.Security.Cryptography.x509certificates.StoreName sertifika deposu konumu. Yalnızca Root ve CertificateAuthority geçerli konumlardır.

CertificateInformation

SSL sertifika bilgileri.

Name	Tür	Description
expiry	string	Sertifikanın son kullanma tarihi. Tarih şu biçime uygundur: yyyy-MM-ddTHH:mm:ssZ ISO 8601 standardı tarafından belirtildiği gibi.
subject	string	Sertifikanın konusu.
thumbprint	string	Sertifikanın parmak izi.

CertificateSource

Sertifika Kaynağı.

Name	Tür	Description
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

Sertifika Durumu.

Name	Tür	Description
Completed	string
Failed	string
InProgress	string

createdByType

Kaynağı oluşturan kimliğin türü.

Name	Tür	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorFieldContract

Hata Alanı sözleşmesi.

Name	Tür	Description
code	string	Özellik düzeyi hata kodu.
message	string	Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
target	string	Özellik adı.

ErrorResponse

Hata Yanıtı.

Name	Tür	Description
error.code	string	Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
error.details	ErrorFieldContract[]	Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
error.message	string	Hatanın insan tarafından okunabilen gösterimi.

HostnameConfiguration

Özel ana bilgisayar adı yapılandırması.

Name	Tür	Varsayılan değer	Description
certificate	CertificateInformation		Sertifika bilgileri.
certificatePassword	string		Sertifika Parolası.
certificateSource	CertificateSource		Sertifika Kaynağı.
certificateStatus	CertificateStatus		Sertifika Durumu.
defaultSslBinding	boolean	False	Bu Ana Bilgisayar Adı ile ilişkili sertifikayı Varsayılan SSL Sertifikası olarak ayarlamak için true değerini belirtin. bir istemci SNI üst bilgisini göndermezse, bu sorgulanacak sertifika olacaktır. Özelliği, bir hizmetin birden çok özel ana bilgisayar adı etkinse ve varsayılan ssl sertifikasına karar vermesi gerekiyorsa kullanışlıdır. Ayar yalnızca ağ geçidi Ana Bilgisayar Adı Türüne uygulanır.
encodedCertificate	string		Base64 Kodlanmış sertifika.
hostName	string		Api Management hizmetinde yapılandırılan konak adı.
identityClientId	string		ssl sertifikasını içeren keyVault'a GET erişimi olan Azure AD tarafından oluşturulan Sistem veya Kullanıcı Tarafından Atanan Yönetilen kimlik clientId değeri.
keyVaultId	string		Ssl Sertifikasını içeren KeyVault Gizli Dizisinin URL'si. Sürümü içeren mutlak Url sağlanırsa, ssl sertifikasının otomatik olarak güncelleştirilmesi çalışmaz. Bunun için Api Management hizmetinin aka.ms/apimmsi ile yapılandırılması gerekir. Gizli dizi application/x-pkcs12 türünde olmalıdır
negotiateClientCertificate	boolean	False	Ana bilgisayar adında her zaman istemci sertifikası anlaşması yapmak için true değerini belirtin. Varsayılan Değer false'tur.
type	HostnameType		Ana bilgisayar adı türü.

HostnameType

Ana bilgisayar adı türü.

Name	Tür	Description
DeveloperPortal	string
Management	string
Portal	string
Proxy	string
Scm	string

NatGatewayState

Özellik, bu API Management hizmeti için NAT Ağ Geçidi'ni etkinleştirmek için kullanılabilir.

Name	Tür	Description
Disabled	string	Nat Gateway hizmet için devre dışı bırakıldı.
Enabled	string	Nat Gateway hizmet için etkinleştirildi.

PlatformVersion

Hizmeti çalıştıran İşlem Platformu Sürümü.

Name	Tür	Description
mtv1	string	Hizmeti Çok Kiracılı V1 platformunda çalıştıran platform.
stv1	string	Hizmeti Tek Kiracılı V1 platformunda çalıştıran platform.
stv2	string	Hizmeti Tek Kiracılı V2 platformunda çalıştıran platform.
undetermined	string	İşlem platformu dağıtılmadığından platform sürümü belirlenemiyor.

PrivateEndpointServiceConnectionStatus

Özel uç nokta bağlantı durumu.

Name	Tür	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.

Name	Tür	Description
actionsRequired	string	Hizmet sağlayıcısında yapılan değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.
description	string	Bağlantının onay/reddedilme nedeni.
status	PrivateEndpointServiceConnectionStatus	Bağlantının hizmet sahibi tarafından Onaylanıp Reddedildiğini/Kaldırıldığını gösterir.

PublicNetworkAccess

Bu API Management hizmeti için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır, ancak geçirilirse 'Etkin' veya 'Devre Dışı' olmalıdır. 'Devre dışı' ise özel uç noktalar özel erişim yöntemidir. Varsayılan değer :'Etkin'

Name	Tür	Description
Disabled	string
Enabled	string

RemotePrivateEndpointConnectionWrapper

Uzak Özel Uç Nokta Bağlantısı kaynağı.

Name	Tür	Description
id	string	Özel Uç Nokta bağlantı kaynak kimliği
name	string	Özel Uç Nokta Bağlantı Adı
properties.groupIds	string[]	Tüm Grup kimlikleri.
properties.privateEndpoint	ArmIdWrapper	Özel uç noktanın kaynağı.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu.
properties.provisioningState	string	Özel uç nokta bağlantı kaynağının sağlama durumu.
type	string	Özel Uç Nokta Bağlantısı Kaynak Türü

SkuType

Sku'nun adı.

Name	Tür	Description
Basic	string	Api Management'ın temel SKU'su.
Consumption	string	Api Management'ın Tüketim SKU'su.
Developer	string	Api Management Geliştirici SKU'su.
Isolated	string	Api Management'ın yalıtılmış SKU'su.
Premium	string	Api Management'ın Premium SKU'su.
Standard	string	Api Management'ın standart SKU'su.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimliğin türü.

UserIdentityProperties

Name	Tür	Description
clientId	string	Kullanıcı tarafından atanan kimliğin istemci kimliği.
principalId	string	Kullanıcı tarafından atanan kimliğin asıl kimliği.

VirtualNetworkConfiguration

API Management hizmetinin dağıtıldığı bir sanal ağın yapılandırması.

Name	Tür	Description
subnetResourceId	string	API Management hizmetinin dağıtılacağı sanal ağdaki bir alt ağın tam kaynak kimliği.
subnetname	string	Alt ağın adı.
vnetid	string	Sanal ağ kimliği. Bu genellikle bir GUID'dir. Varsayılan olarak null GUID bekleyebilirsiniz.

VirtualNetworkType

API Management hizmetinin yapılandırılması gereken VPN türü. Hiçbiri (Varsayılan Değer), API Management hizmetinin herhangi bir Sanal Ağ parçası olmadığı, Dış, API Management dağıtımının İnternet'e Yönelik Uç Noktası olan bir Sanal Ağ içinde ayarlandığı ve İç, API Management dağıtımının bir yalnızca İntranet'e Yönelik Uç Nokta Sanal Ağ.

Name	Tür	Description
External	string	Hizmet Sanal Ağ bir parçasıdır ve İnternet'ten erişilebilir.
Internal	string	Hizmet Sanal Ağ bir parçasıdır ve yalnızca sanal ağ içinden erişilebilir.
None	string	Hizmet herhangi bir Sanal Ağ parçası değildir.