你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Api Management Service - Update

服务:

API Management

API 版本:

2022-08-01

汇报现有的API 管理服务。

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 管理服务的名称。 正则表达式模式: ^[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 管理服务的托管服务标识。
properties.additionalLocations	AdditionalLocation[]	API 管理服务的其他数据中心位置。
properties.apiVersionConstraint	ApiVersionConstraint	API 管理服务的控制平面 Api 版本约束。
properties.certificates	CertificateConfiguration[]	需要安装在 API 管理 服务中的证书列表。 可安装的最大支持证书数为 10。
properties.customProperties	object	API 管理服务的自定义属性。 设置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 管理服务上禁用 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 管理服务上启用 HTTP2 协议。 如果不在 PATCH 操作上指定任何这些属性，则会将省略属性的值重置为其默认值。 对于除 Http2 之外的所有设置，默认值为 True ：服务是在 2018 False 年 4 月 1 日或之前创建的，否则为 。 Http2 设置的默认值为 False。 可以使用设置 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]禁用以下任何密码：TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA、TLS_RSA_WITH_AES_128_GCM_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA256、 TLS_RSA_WITH_AES_128_CBC_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA、TLS_RSA_WITH_AES_128_CBC_SHA。 例如：Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256false。 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 管理服务有效。 这可用于在主区域中禁用网关。
properties.enableClientCertificate	boolean	属性仅用于消耗 SKU 服务。 这强制要求在向网关的每个请求上显示客户端证书。 这还允许在网关上的策略中对证书进行身份验证。
properties.hostnameConfigurations	HostnameConfiguration[]	API 管理服务的自定义主机名配置。
properties.natGatewayState	NatGatewayState	属性可用于为此API 管理服务启用 NAT 网关。
properties.notificationSenderEmail	string	Email发送通知的地址。
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]	此服务的专用终结点连接列表。
properties.publicIpAddressId	string	基于公共标准 SKU IP V4 的 IP 地址，与区域中虚拟网络部署的服务相关联。 仅支持在 虚拟网络 中部署的开发人员和高级 SKU。
properties.publicNetworkAccess	PublicNetworkAccess	是否允许此API 管理服务访问公共终结点。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。 如果“已禁用”，则专用终结点是独占访问方法。 默认值为“Enabled”
properties.publisherEmail	string	发布者电子邮件。
properties.publisherName	string	发布者名称。
properties.restore	boolean	取消删除 Api 管理服务（如果以前是软删除的）。 如果指定了此标志并将其设置为 True，则将忽略所有其他属性。
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration	API 管理服务的虚拟网络配置。
properties.virtualNetworkType	VirtualNetworkType	需要在其中配置API 管理服务的 VPN 类型。 无 (默认值) 表示API 管理服务不属于任何虚拟网络，外部意味着API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，而内部意味着API 管理部署是在仅具有面向 Intranet 的终结点的虚拟网络内设置的.
sku	ApiManagementServiceSkuProperties	API 管理服务的 SKU 属性。
tags	object	资源标记。
zones	string[]	表示资源需要来自的可用性区域列表。

响应

名称	类型	说明
200 OK	ApiManagementServiceResource	已成功更新服务。
202 Accepted		服务更新请求已接受。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementUpdateServiceDisableTls10

ApiManagementUpdateServicePublisherDetails

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

示例请求

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 typing import Any, IO, Union

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceDisableTls10.json
// this example is just showing the usage of "ApiManagementService_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation
ApiManagementServicePatch patch = new ApiManagementServicePatch()
{
    CustomProperties =
    {
    ["Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"] = "false",
    },
};
ArmOperation<ApiManagementServiceResource> lro = await apiManagementService.UpdateAsync(WaitUntil.Completed, patch);
ApiManagementServiceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

示例响应

状态代码:

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

状态代码:

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

示例请求

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 typing import Any, IO, Union

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServicePublisherDetails.json
// this example is just showing the usage of "ApiManagementService_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation
ApiManagementServicePatch patch = new ApiManagementServicePatch()
{
    PublisherEmail = "foobar@live.com",
    PublisherName = "Contoso Vnext",
};
ArmOperation<ApiManagementServiceResource> lro = await apiManagementService.UpdateAsync(WaitUntil.Completed, patch);
ApiManagementServiceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

示例响应

状态代码:

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

状态代码:

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

示例请求

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 typing import Any, IO, Union

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json
// this example is just showing the usage of "ApiManagementService_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation
ApiManagementServicePatch patch = new ApiManagementServicePatch()
{
    Sku = new ApiManagementServiceSkuProperties(ApiManagementServiceSkuType.Premium, 3),
    Zones =
    {
    "1","2","3"
    },
    PublicIPAddressId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"),
    VirtualNetworkConfiguration = new VirtualNetworkConfiguration()
    {
        SubnetResourceId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"),
    },
    AdditionalLocations =
    {
    new AdditionalLocation(new AzureLocation("Australia East"),new ApiManagementServiceSkuProperties(ApiManagementServiceSkuType.Premium,3))
    {
    Zones =
    {
    "1","2","3"
    },
    PublicIPAddressId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"),
    VirtualNetworkConfiguration = new VirtualNetworkConfiguration()
    {
    SubnetResourceId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"),
    },
    }
    },
    VirtualNetworkType = VirtualNetworkType.External,
};
ArmOperation<ApiManagementServiceResource> lro = await apiManagementService.UpdateAsync(WaitUntil.Completed, patch);
ApiManagementServiceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

示例响应

状态代码:

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

状态代码:

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 管理资源位置的说明。
ApiManagementServiceIdentity	Api 管理服务资源的标识属性。
ApiManagementServiceResource	列表或获取响应中的单个API 管理服务资源。
ApiManagementServiceSkuProperties	API 管理服务资源 SKU 属性。
ApiManagementServiceUpdateParameters	提供给更新 Api 管理服务的参数。
ApimIdentityType	用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。
ApiVersionConstraint	API 管理服务的控制平面 Api 版本约束。
ArmIdWrapper	ARM 资源 ID 的包装器
CertificateConfiguration	由不受信任的中间文件和根证书组成的证书配置。
CertificateInformation	SSL 证书信息。
CertificateSource	证书源。
CertificateStatus	证书状态。
createdByType	创建资源的标识类型。
ErrorFieldContract	错误字段协定。
ErrorResponse	错误响应。
HostnameConfiguration	自定义主机名配置。
HostnameType	主机名类型。
NatGatewayState	属性可用于为此API 管理服务启用 NAT 网关。
PlatformVersion	运行服务的计算平台版本。
PrivateEndpointServiceConnectionStatus	专用终结点连接状态。
PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
PublicNetworkAccess	是否允许此API 管理服务访问公共终结点。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。 如果“已禁用”，则专用终结点是独占访问方法。 默认值为“Enabled”
RemotePrivateEndpointConnectionWrapper	远程专用终结点连接资源。
SkuType	SKU 的名称。
systemData	与资源的创建和上次修改相关的元数据。
UserIdentityProperties
VirtualNetworkConfiguration	配置API 管理服务部署到的虚拟网络。
VirtualNetworkType	需要在其中配置API 管理服务的 VPN 类型。 无 (默认值) 表示API 管理服务不属于任何虚拟网络，外部意味着API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，而内部意味着API 管理部署是在仅具有面向 Intranet 的终结点的虚拟网络内设置的.

AdditionalLocation

其他API 管理资源位置的说明。

名称	类型	默认值	说明
disableGateway	boolean	False	属性仅对部署在多个位置的 Api 管理服务有效。 这可用于在此附加位置中禁用网关。
gatewayRegionalUrl	string		区域中API 管理服务的网关 URL。
location	string		Azure 数据中心区域之间其他区域的位置名称。
natGatewayState	NatGatewayState	Disabled	属性可用于为此API 管理服务启用 NAT 网关。
outboundPublicIPAddresses	string[]		与 NAT 网关部署的服务关联的出站公共 IPV4 地址前缀。 仅适用于 stv2 平台上的高级 SKU。
platformVersion	PlatformVersion		运行服务的计算平台版本。
privateIPAddresses	string[]		部署在特定附加位置的内部虚拟网络API 管理服务的专用静态负载均衡 IP 地址。 仅适用于基本、标准、高级和独立 SKU。
publicIPAddresses	string[]		其他位置中API 管理服务的公共静态负载均衡 IP 地址。 仅适用于基本、标准、高级和独立 SKU。
publicIpAddressId	string		要与位置中部署 虚拟网络的服务关联的基于公共标准 SKU IP V4 的 IP 地址。 仅支持在 虚拟网络 中部署的高级 SKU。
sku	ApiManagementServiceSkuProperties		API 管理服务的 SKU 属性。
virtualNetworkConfiguration	VirtualNetworkConfiguration		位置的虚拟网络配置。
zones	string[]		表示资源需要来自的可用性区域列表。

ApiManagementServiceIdentity

Api 管理服务资源的标识属性。

名称	类型	说明
principalId	string	标识的主体 ID。
tenantId	string	标识的客户端租户 ID。
type	ApimIdentityType	用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。
userAssignedIdentities	<string,  UserIdentityProperties>	与资源关联的用户标识列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

ApiManagementServiceResource

列表或获取响应中的单个API 管理服务资源。

名称	类型	默认值	说明
etag	string		资源的 ETag。
id	string		资源 ID。
identity	ApiManagementServiceIdentity		Api 管理服务的托管服务标识。
location	string		资源位置。
name	string		资源名称。
properties.additionalLocations	AdditionalLocation[]		API 管理服务的其他数据中心位置。
properties.apiVersionConstraint	ApiVersionConstraint		API 管理服务的控制平面 Api 版本约束。
properties.certificates	CertificateConfiguration[]		需要安装在 API 管理 服务中的证书列表。 可安装的最大支持证书数为 10。
properties.createdAtUtc	string		API 管理服务的创建 UTC 日期。日期符合以下格式：yyyy-MM-ddTHH:mm:ssZ由 ISO 8601 标准指定。
properties.customProperties	object		API 管理服务的自定义属性。 设置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 管理服务上禁用 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 管理服务上启用 HTTP2 协议。 如果不在 PATCH 操作上指定任何这些属性，则会将省略属性的值重置为其默认值。 对于除 Http2 之外的所有设置，默认值为 True ：服务是在 2018 False 年 4 月 1 日或之前创建的，否则为 。 Http2 设置的默认值为 False。 可以使用设置 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]禁用以下任何密码：TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA、TLS_RSA_WITH_AES_128_GCM_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA256、 TLS_RSA_WITH_AES_128_CBC_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA、TLS_RSA_WITH_AES_128_CBC_SHA。 例如：Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256false。 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 管理服务的 DEveloper 门户终结点 URL。
properties.disableGateway	boolean	False	属性仅对部署在多个位置的 Api 管理服务有效。 这可用于在主区域中禁用网关。
properties.enableClientCertificate	boolean	False	属性仅用于消耗 SKU 服务。 这强制要求在向网关的每个请求上显示客户端证书。 这还允许在网关上的策略中对证书进行身份验证。
properties.gatewayRegionalUrl	string		默认区域中API 管理服务的网关 URL。
properties.gatewayUrl	string		API 管理服务的网关 URL。
properties.hostnameConfigurations	HostnameConfiguration[]		API 管理服务的自定义主机名配置。
properties.managementApiUrl	string		API 管理服务的管理 API 终结点 URL。
properties.natGatewayState	NatGatewayState	Disabled	属性可用于为此API 管理服务启用 NAT 网关。
properties.notificationSenderEmail	string		Email发送通知的地址。
properties.outboundPublicIPAddresses	string[]		与 NAT 网关部署的服务关联的出站公共 IPV4 地址前缀。 仅适用于 stv2 平台上的高级 SKU。
properties.platformVersion	PlatformVersion		在此位置运行服务的计算平台版本。
properties.portalUrl	string		API 管理服务的发布者门户终结点 URL。
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		此服务的专用终结点连接列表。
properties.privateIPAddresses	string[]		主要区域中API 管理服务的专用静态负载均衡 IP 地址，部署在内部虚拟网络中。 仅适用于基本、标准、高级和独立 SKU。
properties.provisioningState	string		API 管理服务的当前预配状态，可以是以下之一：创建/激活/成功/更新/失败/已停止/终止/TerminationFailed/Deleted。
properties.publicIPAddresses	string[]		主要区域中API 管理服务的公共静态负载均衡 IP 地址。 仅适用于基本、标准、高级和独立 SKU。
properties.publicIpAddressId	string		基于公共标准 SKU IP V4 的 IP 地址，与区域中虚拟网络部署的服务相关联。 仅支持在 虚拟网络 中部署的开发人员和高级 SKU。
properties.publicNetworkAccess	PublicNetworkAccess		是否允许此API 管理服务访问公共终结点。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。 如果“已禁用”，则专用终结点是独占访问方法。 默认值为“Enabled”
properties.publisherEmail	string		发布者电子邮件。
properties.publisherName	string		发布者名称。
properties.restore	boolean	False	取消删除 Api 管理服务（如果以前是软删除的）。 如果指定了此标志并将其设置为 True，则将忽略所有其他属性。
properties.scmUrl	string		API 管理服务的 SCM 终结点 URL。
properties.targetProvisioningState	string		API 管理服务的预配状态，这是服务上启动的长时间运行操作的目标。
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		API 管理服务的虚拟网络配置。
properties.virtualNetworkType	VirtualNetworkType	None	需要在其中配置API 管理服务的 VPN 类型。 无 (默认值) 表示API 管理服务不属于任何虚拟网络，外部意味着API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，而内部意味着API 管理部署是在仅具有面向 Intranet 的终结点的虚拟网络内设置的.
sku	ApiManagementServiceSkuProperties		API 管理服务的 SKU 属性。
systemData	systemData		与资源的创建和上次修改相关的元数据。
tags	object		资源标记。
type	string		API 管理资源的资源类型设置为 Microsoft.ApiManagement。
zones	string[]		表示资源需要来自的可用性区域列表。

ApiManagementServiceSkuProperties

API 管理服务资源 SKU 属性。

名称	类型	说明
capacity	integer	SKU 的容量 (SKU) 的已部署单位数。 对于消耗型 SKU 容量，必须指定为 0。
name	SkuType	SKU 的名称。

ApiManagementServiceUpdateParameters

提供给更新 Api 管理服务的参数。

名称	类型	默认值	说明
etag	string		资源的 ETag。
id	string		资源 ID。
identity	ApiManagementServiceIdentity		Api 管理服务的托管服务标识。
name	string		资源名称。
properties.additionalLocations	AdditionalLocation[]		API 管理服务的其他数据中心位置。
properties.apiVersionConstraint	ApiVersionConstraint		API 管理服务的控制平面 Api 版本约束。
properties.certificates	CertificateConfiguration[]		需要安装在 API 管理 服务中的证书列表。 可安装的最大支持证书数为 10。
properties.createdAtUtc	string		API 管理服务的创建 UTC 日期。日期符合以下格式：yyyy-MM-ddTHH:mm:ssZ由 ISO 8601 标准指定。
properties.customProperties	object		API 管理服务的自定义属性。 设置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 管理服务上禁用 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 管理服务上启用 HTTP2 协议。 如果不在 PATCH 操作上指定任何这些属性，则会将省略属性的值重置为其默认值。 对于除 Http2 之外的所有设置，默认值为 True ：服务是在 2018 False 年 4 月 1 日或之前创建的，否则为 。 Http2 设置的默认值为 False。 可以使用设置 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]禁用以下任何密码：TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA、TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA、TLS_RSA_WITH_AES_128_GCM_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA256、 TLS_RSA_WITH_AES_128_CBC_SHA256、TLS_RSA_WITH_AES_256_CBC_SHA、TLS_RSA_WITH_AES_128_CBC_SHA。 例如：Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256false。 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 管理服务的 DEveloper 门户终结点 URL。
properties.disableGateway	boolean	False	属性仅对部署在多个位置的 Api 管理服务有效。 这可用于在主区域中禁用网关。
properties.enableClientCertificate	boolean	False	属性仅用于消耗 SKU 服务。 这强制要求在向网关的每个请求上显示客户端证书。 这还允许在网关上的策略中对证书进行身份验证。
properties.gatewayRegionalUrl	string		默认区域中API 管理服务的网关 URL。
properties.gatewayUrl	string		API 管理服务的网关 URL。
properties.hostnameConfigurations	HostnameConfiguration[]		API 管理服务的自定义主机名配置。
properties.managementApiUrl	string		API 管理服务的管理 API 终结点 URL。
properties.natGatewayState	NatGatewayState	Disabled	属性可用于为此API 管理服务启用 NAT 网关。
properties.notificationSenderEmail	string		Email发送通知的地址。
properties.outboundPublicIPAddresses	string[]		与 NAT 网关部署的服务关联的出站公共 IPV4 地址前缀。 仅适用于 stv2 平台上的高级 SKU。
properties.platformVersion	PlatformVersion		在此位置运行服务的计算平台版本。
properties.portalUrl	string		API 管理服务的发布者门户终结点 URL。
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		此服务的专用终结点连接列表。
properties.privateIPAddresses	string[]		主要区域中API 管理服务的专用静态负载均衡 IP 地址，部署在内部虚拟网络中。 仅适用于基本、标准、高级和独立 SKU。
properties.provisioningState	string		API 管理服务的当前预配状态，可以是以下之一：创建/激活/成功/更新/失败/已停止/终止/TerminationFailed/Deleted。
properties.publicIPAddresses	string[]		主要区域中API 管理服务的公共静态负载均衡 IP 地址。 仅适用于基本、标准、高级和独立 SKU。
properties.publicIpAddressId	string		基于公共标准 SKU IP V4 的 IP 地址，与区域中虚拟网络部署的服务相关联。 仅支持在 虚拟网络 中部署的开发人员和高级 SKU。
properties.publicNetworkAccess	PublicNetworkAccess		是否允许此API 管理服务访问公共终结点。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。 如果“已禁用”，则专用终结点是独占访问方法。 默认值为“Enabled”
properties.publisherEmail	string		发布者电子邮件。
properties.publisherName	string		发布者名称。
properties.restore	boolean	False	取消删除 Api 管理服务（如果以前是软删除的）。 如果指定了此标志并将其设置为 True，则将忽略所有其他属性。
properties.scmUrl	string		API 管理服务的 SCM 终结点 URL。
properties.targetProvisioningState	string		API 管理服务的预配状态，这是服务上启动的长时间运行操作的目标。
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		API 管理服务的虚拟网络配置。
properties.virtualNetworkType	VirtualNetworkType	None	需要在其中配置API 管理服务的 VPN 类型。 无 (默认值) 表示API 管理服务不属于任何虚拟网络，外部意味着API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，而内部意味着API 管理部署是在仅具有面向 Intranet 的终结点的虚拟网络内设置的.
sku	ApiManagementServiceSkuProperties		API 管理服务的 SKU 属性。
tags	object		资源标记。
type	string		API 管理资源的资源类型设置为 Microsoft.ApiManagement。
zones	string[]		表示资源需要来自的可用性区域列表。

ApimIdentityType

用于资源的标识类型。 类型“SystemAssigned ,UserAssigned”包含隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

API 管理服务的控制平面 Api 版本约束。

名称	类型	说明
minApiVersion	string	将控制平面 API 调用限制为API 管理版本等于或高于此值的服务。

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	证书的到期日期。 日期符合以下格式： yyyy-MM-ddTHH:mm:ssZ 由 ISO 8601 标准指定。
subject	string	证书的使用者。
thumbprint	string	证书的指纹。

CertificateSource

证书源。

名称	类型	说明
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

证书状态。

名称	类型	说明
Completed	string
Failed	string
InProgress	string

createdByType

创建资源的标识类型。

名称	类型	说明
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	指定 true 以设置与此主机名关联的证书作为默认 SSL 证书。 如果客户端未发送 SNI 标头，则这是将质询的证书。 如果服务启用了多个自定义主机名，并且需要确定默认 ssl 证书，则 属性非常有用。 该设置仅适用于网关主机名类型。
encodedCertificate	string		Base64 编码证书。
hostName	string		在 Api 管理服务上配置的主机名。
identityClientId	string		由 Azure AD 生成的系统或用户分配的托管标识 clientId，该客户端对包含 SSL 证书的 keyVault 具有 GET 访问权限。
keyVaultId	string		包含 Ssl 证书的 KeyVault 机密的 URL。 如果提供了包含版本的绝对 URL，则无法自动更新 ssl 证书。 这要求使用 aka.ms/apimmsi 配置 Api 管理服务。 机密应为 application/x-pkcs12 类型
negotiateClientCertificate	boolean	False	指定 true 以始终协商主机名上的客户端证书。 默认值为 false。
type	HostnameType		主机名类型。

HostnameType

主机名类型。

名称	类型	说明
DeveloperPortal	string
Management	string
Portal	string
Proxy	string
Scm	string

NatGatewayState

属性可用于为此API 管理服务启用 NAT 网关。

名称	类型	说明
Disabled	string	服务已禁用 Nat 网关。
Enabled	string	为服务启用了 Nat 网关。

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 管理服务访问公共终结点。 值是可选的，但如果传入，则必须为“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 管理的基本 SKU。
Consumption	string	Api 管理的消耗 SKU。
Developer	string	Api 管理的开发人员 SKU。
Isolated	string	Api 管理的独立 SKU。
Premium	string	Api 管理的高级 SKU。
Standard	string	Api 管理的标准 SKU。

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源的创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

UserIdentityProperties

名称	类型	说明
clientId	string	用户分配标识的客户端 ID。
principalId	string	用户分配的标识的主体 ID。

VirtualNetworkConfiguration

配置API 管理服务部署到的虚拟网络。

名称	类型	说明
subnetResourceId	string	虚拟网络中要在其中部署API 管理服务的子网的完整资源 ID。
subnetname	string	子网的名称。
vnetid	string	虚拟网络 ID。 这通常是 GUID。 默认情况下，应为 NULL GUID。

VirtualNetworkType

需要在其中配置API 管理服务的 VPN 类型。 无 (默认值) 表示API 管理服务不属于任何虚拟网络，外部意味着API 管理部署是在具有面向 Internet 的终结点的虚拟网络内设置的，而内部意味着API 管理部署是在仅具有面向 Intranet 的终结点的虚拟网络内设置的.

名称	类型	说明
External	string	该服务是虚拟网络的一部分，可从 Internet 访问。
Internal	string	该服务是虚拟网络的一部分，只能从虚拟网络中访问。
None	string	该服务不属于任何虚拟网络。