Api Management Service - Update

リファレンス

Service:: API Management

API Version:: 2022-08-01

既存のAPI Management サービスを更新します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
serviceName	path	True	string	API Management サービスの名前。 Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
identity	ApiManagementServiceIdentity	Api Management サービスのマネージドサービス ID。
properties.additionalLocations	AdditionalLocation[]	API Management サービスの追加のデータセンターの場所。
properties.apiVersionConstraint	ApiVersionConstraint	API Management サービスのコントロールプレーン Apis バージョン制約。
properties.certificates	CertificateConfiguration[]	API Management サービスにインストールする必要がある証明書の一覧。インストールできるサポートされる証明書の最大数は 10 です。
properties.customProperties	object	API Management サービスのカスタムプロパティ。を設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168`すると、すべての TLS(1.0、1.1、1.2) の暗号TLS_RSA_WITH_3DES_EDE_CBC_SHAが無効になります。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11`を使用すると、TLS 1.1 のみを無効にすることができます。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10`を使用すると、API Management サービスで TLS 1.0 を無効にすることができます。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11`を使用すると、バックエンドとの通信に TLS 1.1 のみを無効にすることができます。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10`を使用すると、バックエンドとの通信で TLS 1.0 を無効にすることができます。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2`を使用して、API Management サービスで HTTP2 プロトコルを有効にすることができます。 PATCH 操作でこれらのプロパティを指定しないと、省略されたプロパティの値が既定値にリセットされます。 Http2 を除くすべての設定の既定値は、サービスが `True` 2018 `False` 年 4 月 1 日以前に作成されたかどうか、それ以外の場合です。 Http2 設定の既定値はです `False`。 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`、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。たとえば、 `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. 既定値はそれらの `true` 値です。注: 次の暗号は、内部プラットフォームコンポーネントで必要であるため無効にできません: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	プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。これは、マスターリージョンでゲートウェイを無効にするために使用できます。
properties.enableClientCertificate	boolean	プロパティは、従量課金 SKU サービスにのみ使用されます。これにより、ゲートウェイへの各要求にクライアント証明書が提示されます。これにより、ゲートウェイのポリシーで証明書を認証することもできます。
properties.hostnameConfigurations	HostnameConfiguration[]	API Management サービスのカスタムホスト名の構成。
properties.natGatewayState	NatGatewayState	プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。
properties.notificationSenderEmail	string	通知の送信先となるアドレスをEmailします。
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]	このサービスのプライベートエンドポイント接続の一覧。
properties.publicIpAddressId	string	リージョンにデプロイされたサービスに関連付けられるパブリック Standard SKU IP V4 ベースの IP アドレスVirtual Network。 Virtual Networkにデプロイされている Developer SKU と Premium SKU でのみサポートされます。
properties.publicNetworkAccess	PublicNetworkAccess	このAPI Management サービスに対してパブリックエンドポイントアクセスが許可されているかどうか。値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベートエンドポイントは排他アクセス方法です。既定値は 'Enabled' です
properties.publisherEmail	string	発行元の電子メール。
properties.publisherName	string	発行元名。
properties.restore	boolean	以前に論理的に削除された場合は、Api Management サービスの削除を取り消します。このフラグを指定し、True に設定すると、他のすべてのプロパティは無視されます。
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration	API Management サービスの仮想ネットワーク構成。
properties.virtualNetworkType	VirtualNetworkType	API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスがVirtual Networkに含まれていないことを意味し、External はインターネットに接続するエンドポイントを持つVirtual Network内にAPI Management展開が設定されていることを意味し、内部はAPI Management展開は、イントラネット接続エンドポイントのみを持つVirtual Network内で設定されます。
sku	ApiManagementServiceSkuProperties	API Management サービスの SKU プロパティ。
tags	object	リソースタグ。
zones	string[]	リソースの取得元を表す可用性ゾーンの一覧。

応答

名前	型	説明
200 OK	ApiManagementServiceResource	サービスが正常に更新されました。
202 Accepted		サービス更新要求が受け入れられました。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

ApiManagementUpdateServiceDisableTls10

ApiManagementUpdateServicePublisherDetails

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

Sample Request

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"
    }
  }
}

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

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

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

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

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"
  }
}

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

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

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

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

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"
  ]
}

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

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

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

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"
  }
}

定義

名前	説明
AdditionalLocation	追加のAPI Management リソースの場所の説明。
ApiManagementServiceIdentity	Api Management サービスリソースの ID プロパティ。
ApiManagementServiceResource	List または Get response の 1 つのAPI Management サービスリソース。
ApiManagementServiceSkuProperties	サービスリソース SKU のプロパティをAPI Managementします。
ApiManagementServiceUpdateParameters	Update Api Management Service に指定されたパラメーター。
ApimIdentityType	リソースに使用される ID の種類。種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスから ID を削除します。
ApiVersionConstraint	API Management サービスのコントロールプレーン Apis バージョン制約。
ArmIdWrapper	ARM リソース ID のラッパー
CertificateConfiguration	信頼されていない中間証明書とルート証明書で構成される証明書の構成。
CertificateInformation	SSL 証明書情報。
CertificateSource	証明書ソース。
CertificateStatus	証明書の状態。
createdByType	リソースを作成した ID の種類。
ErrorFieldContract	エラーフィールドコントラクト。
ErrorResponse	エラー応答。
HostnameConfiguration	カスタムホスト名の構成。
HostnameType	ホスト名の種類。
NatGatewayState	プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。
PlatformVersion	サービスを実行しているコンピューティングプラットフォームのバージョン。
PrivateEndpointServiceConnectionStatus	プライベートエンドポイント接続の状態。
PrivateLinkServiceConnectionState	サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
PublicNetworkAccess	このAPI Management サービスに対してパブリックエンドポイントアクセスが許可されているかどうか。値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベートエンドポイントは排他アクセス方法です。既定値は 'Enabled' です
RemotePrivateEndpointConnectionWrapper	リモートプライベートエンドポイント接続リソース。
SkuType	SKU の名前。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserIdentityProperties
VirtualNetworkConfiguration	API Management サービスがデプロイされる仮想ネットワークの構成。
VirtualNetworkType	API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスがVirtual Networkに含まれていないことを意味し、External はインターネットに接続するエンドポイントを持つVirtual Network内にAPI Management展開が設定されていることを意味し、内部はAPI Management展開は、イントラネット接続エンドポイントのみを持つVirtual Network内で設定されます。

AdditionalLocation

追加のAPI Management リソースの場所の説明。

名前	型	既定値	説明
disableGateway	boolean	False	プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。これは、この追加の場所でゲートウェイを無効にするために使用できます。
gatewayRegionalUrl	string		リージョン内のAPI Management サービスのゲートウェイ URL。
location	string		Azure データセンターリージョン間の追加リージョンの場所名。
natGatewayState	NatGatewayState	Disabled	プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。
outboundPublicIPAddresses	string[]		NAT Gateway によってデプロイされたサービスに関連付けられている送信パブリック IPV4 アドレスプレフィックス。 stv2 プラットフォームの Premium SKU でのみ使用できます。
platformVersion	PlatformVersion		サービスを実行しているコンピューティングプラットフォームのバージョン。
privateIPAddresses	string[]		特定の追加の場所にある内部Virtual NetworkにデプロイされるAPI Management サービスのプライベート静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。
publicIPAddresses	string[]		追加の場所にあるAPI Management サービスのパブリック静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。
publicIpAddressId	string		場所にデプロイされたサービスに関連付けられるパブリック Standard SKU IP V4 ベースの IP アドレスVirtual Network。 Virtual Networkにデプロイされている Premium SKU でのみサポートされます。
sku	ApiManagementServiceSkuProperties		API Management サービスの SKU プロパティ。
virtualNetworkConfiguration	VirtualNetworkConfiguration		場所の仮想ネットワーク構成。
zones	string[]		リソースの取得元を表す可用性ゾーンの一覧。

ApiManagementServiceIdentity

Api Management サービスリソースの ID プロパティ。

名前	型	説明
principalId	string	ID のプリンシパル ID。
tenantId	string	ID のクライアントテナント ID。
type	ApimIdentityType	リソースに使用される ID の種類。種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスから ID を削除します。
userAssignedIdentities	<string, UserIdentityProperties>	リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリキーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

ApiManagementServiceResource

List または Get response の 1 つのAPI Management サービスリソース。

名前	型	既定値	説明
etag	string		リソースの ETag。
id	string		リソースの ID
identity	ApiManagementServiceIdentity		Api Management サービスのマネージドサービス ID。
location	string		リソースの場所。
name	string		リソース名。
properties.additionalLocations	AdditionalLocation[]		API Management サービスの追加のデータセンターの場所。
properties.apiVersionConstraint	ApiVersionConstraint		API Management サービスのコントロールプレーン Apis バージョン制約。
properties.certificates	CertificateConfiguration[]		API Management サービスにインストールする必要がある証明書の一覧。インストールできるサポートされる証明書の最大数は 10 です。
properties.createdAtUtc	string		API Management サービスの作成 UTC 日付。日付は、ISO 8601 標準で指定されている形式`yyyy-MM-ddTHH:mm:ssZ`に準拠しています。
properties.customProperties	object		API Management サービスのカスタムプロパティ。を設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168`すると、すべての TLS(1.0、1.1、1.2) の暗号TLS_RSA_WITH_3DES_EDE_CBC_SHAが無効になります。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11`を使用すると、TLS 1.1 のみを無効にすることができます。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10`を使用すると、API Management サービスで TLS 1.0 を無効にすることができます。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11`を使用すると、バックエンドとの通信に TLS 1.1 のみを無効にすることができます。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10`を使用すると、バックエンドとの通信で TLS 1.0 を無効にすることができます。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2`を使用して、API Management サービスで HTTP2 プロトコルを有効にすることができます。 PATCH 操作でこれらのプロパティを指定しないと、省略されたプロパティの値が既定値にリセットされます。 Http2 を除くすべての設定の既定値は、サービスが `True` 2018 `False` 年 4 月 1 日以前に作成されたかどうか、それ以外の場合です。 Http2 設定の既定値はです `False`。 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`、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。たとえば、 `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. 既定値はそれらの `true` 値です。注: 次の暗号は、内部プラットフォームコンポーネントで必要であるため無効にできません: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 サービスの DEveloper Portal エンドポイント URL。
properties.disableGateway	boolean	False	プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。これは、マスターリージョンでゲートウェイを無効にするために使用できます。
properties.enableClientCertificate	boolean	False	プロパティは、従量課金 SKU サービスにのみ使用されます。これにより、ゲートウェイへの各要求にクライアント証明書が提示されます。これにより、ゲートウェイのポリシーで証明書を認証することもできます。
properties.gatewayRegionalUrl	string		既定のリージョンのAPI Management サービスのゲートウェイ URL。
properties.gatewayUrl	string		API Management サービスのゲートウェイ URL。
properties.hostnameConfigurations	HostnameConfiguration[]		API Management サービスのカスタムホスト名の構成。
properties.managementApiUrl	string		API Management サービスの管理 API エンドポイント URL。
properties.natGatewayState	NatGatewayState	Disabled	プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。
properties.notificationSenderEmail	string		通知の送信先となるアドレスをEmailします。
properties.outboundPublicIPAddresses	string[]		NAT Gateway によってデプロイされたサービスに関連付けられている送信パブリック IPV4 アドレスプレフィックス。 stv2 プラットフォームの Premium SKU でのみ使用できます。
properties.platformVersion	PlatformVersion		この場所でサービスを実行しているコンピューティングプラットフォームのバージョン。
properties.portalUrl	string		API Management サービスのパブリッシャーポータルエンドポイント URL。
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		このサービスのプライベートエンドポイント接続の一覧。
properties.privateIPAddresses	string[]		内部Virtual NetworkにデプロイされているプライマリリージョンのAPI Management サービスのプライベート静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。
properties.provisioningState	string		API Management サービスの現在のプロビジョニング状態。次のいずれかになります。Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted。
properties.publicIPAddresses	string[]		プライマリリージョンのAPI Management サービスのパブリック静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。
properties.publicIpAddressId	string		リージョンにデプロイされたサービスに関連付けられるパブリック Standard SKU IP V4 ベースの IP アドレスVirtual Network。 Virtual Networkにデプロイされている Developer SKU と Premium SKU でのみサポートされます。
properties.publicNetworkAccess	PublicNetworkAccess		このAPI Management サービスに対してパブリックエンドポイントアクセスが許可されているかどうか。値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベートエンドポイントは排他アクセス方法です。既定値は 'Enabled' です
properties.publisherEmail	string		発行元の電子メール。
properties.publisherName	string		発行元名。
properties.restore	boolean	False	以前に論理的に削除された場合は、Api Management サービスの削除を取り消します。このフラグを指定し、True に設定すると、他のすべてのプロパティは無視されます。
properties.scmUrl	string		API Management サービスの SCM エンドポイント URL。
properties.targetProvisioningState	string		API Management サービスのプロビジョニング状態。これは、サービスで開始された実行時間の長い操作を対象とします。
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		API Management サービスの仮想ネットワーク構成。
properties.virtualNetworkType	VirtualNetworkType	None	API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスがVirtual Networkに含まれていないことを意味し、External はインターネットに接続するエンドポイントを持つVirtual Network内にAPI Management展開が設定されていることを意味し、内部はAPI Management展開は、イントラネット接続エンドポイントのみを持つVirtual Network内で設定されます。
sku	ApiManagementServiceSkuProperties		API Management サービスの SKU プロパティ。
systemData	systemData		リソースの作成と最後の変更に関連するメタデータ。
tags	object		リソースタグ。
type	string		API Management リソースのリソースの種類は Microsoft.ApiManagement に設定されています。
zones	string[]		リソースの取得元を表す可用性ゾーンの一覧。

ApiManagementServiceSkuProperties

サービスリソース SKU のプロパティをAPI Managementします。

名前	型	説明
capacity	integer	SKU の容量 (SKU のデプロイされたユニットの数)。従量課金 SKU の容量は 0 として指定する必要があります。
name	SkuType	SKU の名前。

ApiManagementServiceUpdateParameters

Update Api Management Service に指定されたパラメーター。

名前	型	既定値	説明
etag	string		リソースの ETag。
id	string		リソースの ID
identity	ApiManagementServiceIdentity		Api Management サービスのマネージドサービス ID。
name	string		リソース名。
properties.additionalLocations	AdditionalLocation[]		API Management サービスの追加のデータセンターの場所。
properties.apiVersionConstraint	ApiVersionConstraint		API Management サービスのコントロールプレーン Apis バージョン制約。
properties.certificates	CertificateConfiguration[]		API Management サービスにインストールする必要がある証明書の一覧。インストールできるサポートされる証明書の最大数は 10 です。
properties.createdAtUtc	string		API Management サービスの作成 UTC 日付。日付は、ISO 8601 標準で指定されている形式`yyyy-MM-ddTHH:mm:ssZ`に準拠しています。
properties.customProperties	object		API Management サービスのカスタムプロパティ。を設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168`すると、すべての TLS(1.0、1.1、1.2) の暗号TLS_RSA_WITH_3DES_EDE_CBC_SHAが無効になります。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11`を使用すると、TLS 1.1 のみを無効にすることができます。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10`を使用すると、API Management サービスで TLS 1.0 を無効にすることができます。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11`を使用すると、バックエンドとの通信に TLS 1.1 のみを無効にすることができます。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10`を使用すると、バックエンドとの通信で TLS 1.0 を無効にすることができます。設定`Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2`を使用して、API Management サービスで HTTP2 プロトコルを有効にすることができます。 PATCH 操作でこれらのプロパティを指定しないと、省略されたプロパティの値が既定値にリセットされます。 Http2 を除くすべての設定の既定値は、サービスが `True` 2018 `False` 年 4 月 1 日以前に作成されたかどうか、それ以外の場合です。 Http2 設定の既定値はです `False`。 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`、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。たとえば、 `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. 既定値はそれらの `true` 値です。注: 次の暗号は、内部プラットフォームコンポーネントで必要であるため無効にできません: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 サービスの DEveloper Portal エンドポイント URL。
properties.disableGateway	boolean	False	プロパティは、複数の場所にデプロイされた Api Management サービスに対してのみ有効です。これは、マスターリージョンでゲートウェイを無効にするために使用できます。
properties.enableClientCertificate	boolean	False	プロパティは、従量課金 SKU サービスにのみ使用されます。これにより、ゲートウェイへの各要求にクライアント証明書が提示されます。これにより、ゲートウェイのポリシーで証明書を認証することもできます。
properties.gatewayRegionalUrl	string		既定のリージョンのAPI Management サービスのゲートウェイ URL。
properties.gatewayUrl	string		API Management サービスのゲートウェイ URL。
properties.hostnameConfigurations	HostnameConfiguration[]		API Management サービスのカスタムホスト名の構成。
properties.managementApiUrl	string		API Management サービスの管理 API エンドポイント URL。
properties.natGatewayState	NatGatewayState	Disabled	プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。
properties.notificationSenderEmail	string		通知の送信先となるアドレスをEmailします。
properties.outboundPublicIPAddresses	string[]		NAT Gateway によってデプロイされたサービスに関連付けられている送信パブリック IPV4 アドレスプレフィックス。 stv2 プラットフォームの Premium SKU でのみ使用できます。
properties.platformVersion	PlatformVersion		この場所でサービスを実行しているコンピューティングプラットフォームのバージョン。
properties.portalUrl	string		API Management サービスのパブリッシャーポータルエンドポイント URL。
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		このサービスのプライベートエンドポイント接続の一覧。
properties.privateIPAddresses	string[]		内部Virtual NetworkにデプロイされているプライマリリージョンのAPI Management サービスのプライベート静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。
properties.provisioningState	string		API Management サービスの現在のプロビジョニング状態。次のいずれかになります。Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted。
properties.publicIPAddresses	string[]		プライマリリージョンのAPI Management サービスのパブリック静的負荷分散 IP アドレス。 Basic、Standard、Premium、Isolated SKU でのみ使用できます。
properties.publicIpAddressId	string		リージョンにデプロイされたサービスに関連付けられるパブリック Standard SKU IP V4 ベースの IP アドレスVirtual Network。 Virtual Networkにデプロイされている Developer SKU と Premium SKU でのみサポートされます。
properties.publicNetworkAccess	PublicNetworkAccess		このAPI Management サービスに対してパブリックエンドポイントアクセスが許可されているかどうか。値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベートエンドポイントは排他アクセス方法です。既定値は 'Enabled' です
properties.publisherEmail	string		発行元の電子メール。
properties.publisherName	string		発行元名。
properties.restore	boolean	False	以前に論理的に削除された場合は、Api Management サービスの削除を取り消します。このフラグを指定し、True に設定すると、他のすべてのプロパティは無視されます。
properties.scmUrl	string		API Management サービスの SCM エンドポイント URL。
properties.targetProvisioningState	string		API Management サービスのプロビジョニング状態。これは、サービスで開始された実行時間の長い操作を対象とします。
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		API Management サービスの仮想ネットワーク構成。
properties.virtualNetworkType	VirtualNetworkType	None	API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスがVirtual Networkに含まれていないことを意味し、External はインターネットに接続するエンドポイントを持つVirtual Network内にAPI Management展開が設定されていることを意味し、内部はAPI Management展開は、イントラネット接続エンドポイントのみを持つVirtual Network内で設定されます。
sku	ApiManagementServiceSkuProperties		API Management サービスの SKU プロパティ。
tags	object		リソースタグ。
type	string		API Management リソースのリソースの種類は Microsoft.ApiManagement に設定されています。
zones	string[]		リソースの取得元を表す可用性ゾーンの一覧。

ApimIdentityType

リソースに使用される ID の種類。種類 "SystemAssigned、UserAssigned" には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' は、サービスから ID を削除します。

名前	型	説明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

API Management サービスのコントロールプレーン Apis バージョン制約。

名前	型	説明
minApiVersion	string	コントロールプレーン API の呼び出しを、この値以上のバージョンAPI Managementサービスに制限します。

ArmIdWrapper

ARM リソース ID のラッパー

名前	型	説明
id	string

CertificateConfiguration

信頼されていない中間証明書とルート証明書で構成される証明書の構成。

名前	型	説明
certificate	CertificateInformation	証明書情報。
certificatePassword	string	証明書パスワード。
encodedCertificate	string	Base64 でエンコードされた証明書。
storeName	enum: CertificateAuthority Root	System.Security.Cryptography.x509certificates.StoreName 証明書ストアの場所。 Root と CertificateAuthority のみが有効な場所です。

CertificateInformation

SSL 証明書情報。

名前	型	説明
expiry	string	証明書の有効期限。日付は、ISO 8601 標準で指定されている形式 `yyyy-MM-ddTHH:mm:ssZ` に準拠しています。
subject	string	証明書のサブジェクト。
thumbprint	string	証明書の拇印。

CertificateSource

証明書ソース。

名前	型	説明
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

証明書の状態。

名前	型	説明
Completed	string
Failed	string
InProgress	string

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorFieldContract

エラーフィールドコントラクト。

名前	型	説明
code	string	プロパティレベルのエラーコード。
message	string	プロパティレベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラーコード。このコードは、応答に指定された HTTP エラーコードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。

HostnameConfiguration

カスタムホスト名の構成。

名前	型	既定値	説明
certificate	CertificateInformation		証明書情報。
certificatePassword	string		証明書パスワード。
certificateSource	CertificateSource		証明書ソース。
certificateStatus	CertificateStatus		証明書の状態。
defaultSslBinding	boolean	False	このホスト名に関連付けられている証明書を既定の SSL 証明書として設定するには、true を指定します。クライアントが SNI ヘッダーを送信しない場合、これはチャレンジされる証明書になります。プロパティは、サービスで複数のカスタムホスト名が有効になっており、既定の ssl 証明書を決定する必要がある場合に便利です。設定は、ゲートウェイのホスト名の種類にのみ適用されます。
encodedCertificate	string		Base64 でエンコードされた証明書。
hostName	string		Api Management サービスで構成するホスト名。
identityClientId	string		Azure AD によって生成されたシステムまたはユーザー割り当てマネージド ID clientId。SSL 証明書を含む keyVault への GET アクセス権を持ちます。
keyVaultId	string		Ssl 証明書を含む KeyVault シークレットの URL。バージョンを含む絶対 URL が指定されている場合、ssl 証明書の自動更新は機能しません。これには、api Management サービスを aka.ms/apimmsi で構成する必要があります。シークレットの種類は application/x-pkcs12 である必要があります
negotiateClientCertificate	boolean	False	ホスト名で常にクライアント証明書をネゴシエートするには、true を指定します。既定値は false です。
type	HostnameType		ホスト名の種類。

HostnameType

ホスト名の種類。

名前	型	説明
DeveloperPortal	string
Management	string
Portal	string
Proxy	string
Scm	string

NatGatewayState

プロパティを使用して、このAPI Management サービスの NAT ゲートウェイを有効にすることができます。

名前	型	説明
Disabled	string	サービスに対して Nat Gateway が無効になっています。
Enabled	string	サービスに対して Nat Gateway が有効になっています。

PlatformVersion

サービスを実行しているコンピューティングプラットフォームのバージョン。

名前	型	説明
mtv1	string	マルチテナント V1 プラットフォームでサービスを実行しているプラットフォーム。
stv1	string	シングルテナント V1 プラットフォームでサービスを実行しているプラットフォーム。
stv2	string	シングルテナント V2 プラットフォームでサービスを実行しているプラットフォーム。
undetermined	string	コンピューティングプラットフォームはデプロイされていないため、プラットフォームのバージョンを特定できません。

PrivateEndpointServiceConnectionStatus

プライベートエンドポイント接続の状態。

名前	型	説明
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。

名前	型	説明
actionsRequired	string	サービスプロバイダーの変更でコンシューマーに対する更新が必要かどうかを示すメッセージ。
description	string	接続の承認/拒否の理由。
status	PrivateEndpointServiceConnectionStatus	接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。

PublicNetworkAccess

このAPI Management サービスに対してパブリックエンドポイントアクセスが許可されているかどうか。値は省略可能ですが、渡される場合は、'Enabled' または 'Disabled' である必要があります。 "無効" の場合、プライベートエンドポイントは排他アクセス方法です。既定値は 'Enabled' です

名前	型	説明
Disabled	string
Enabled	string

RemotePrivateEndpointConnectionWrapper

リモートプライベートエンドポイント接続リソース。

名前	型	説明
id	string	プライベートエンドポイント接続リソース ID
name	string	プライベートエンドポイント接続名
properties.groupIds	string[]	すべてのグループ ID。
properties.privateEndpoint	ArmIdWrapper	プライベートエンドポイントのリソース。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	サービスコンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
properties.provisioningState	string	プライベートエンドポイント接続リソースのプロビジョニング状態。
type	string	プライベートエンドポイント接続リソースの種類

SkuType

SKU の名前。

名前	型	説明
Basic	string	Api Management の Basic SKU。
Consumption	string	Api Management の従量課金 SKU。
Developer	string	Api Management の開発者 SKU。
Isolated	string	Api Management の分離された SKU。
Premium	string	Api Management の Premium SKU。
Standard	string	Api Management の Standard SKU。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UserIdentityProperties

名前	型	説明
clientId	string	ユーザー割り当て ID のクライアント ID。
principalId	string	ユーザー割り当て ID のプリンシパル ID。

VirtualNetworkConfiguration

API Management サービスがデプロイされる仮想ネットワークの構成。

名前	型	説明
subnetResourceId	string	API Management サービスをデプロイする仮想ネットワーク内のサブネットの完全なリソース ID。
subnetname	string	サブネットの名前。
vnetid	string	仮想ネットワーク ID。これは通常、GUID です。既定では null GUID が必要です。

VirtualNetworkType

API Management サービスを構成する必要がある VPN の種類。 None (既定値) は、API Management サービスがVirtual Networkに含まれていないことを意味し、External はインターネットに接続するエンドポイントを持つVirtual Network内にAPI Management展開が設定されていることを意味し、内部はAPI Management展開は、イントラネット接続エンドポイントのみを持つVirtual Network内で設定されます。

名前	型	説明
External	string	このサービスはVirtual Networkの一部であり、インターネットからアクセスできます。
Internal	string	サービスはVirtual Networkの一部であり、仮想ネットワーク内からのみアクセスできます。
None	string	サービスは、Virtual Networkの一部ではありません。

Api Management Service - Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

Scopes

例

ApiManagementUpdateServiceDisableTls10

Sample Request

Sample Response

ApiManagementUpdateServicePublisherDetails

Sample Request

Sample Response

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

Sample Request

Sample Response

定義

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApiManagementServiceUpdateParameters

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

CertificateSource

CertificateStatus

createdByType

ErrorFieldContract

ErrorResponse

HostnameConfiguration

HostnameType

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType

その他のリソース