Api Management Service - Update

Service:

API Management

API Version:

2022-08-01

Frissítések meglévő API Management szolgáltatást.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string	A API Management szolgáltatás neve. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem törzse

Name	Típus	Description
identity	ApiManagementServiceIdentity	Az Api Management szolgáltatás felügyeltszolgáltatás-identitása.
properties.additionalLocations	AdditionalLocation[]	A API Management szolgáltatás további adatközponti helyei.
properties.apiVersionConstraint	ApiVersionConstraint	A Control Plane Apis verziókorlátozása az API Management szolgáltatáshoz.
properties.certificates	CertificateConfiguration[]	A API Management szolgáltatásban telepíteni kívánt tanúsítványok listája. A maximálisan telepíthető tanúsítványok maximális mérete 10.
properties.customProperties	object	A API Management szolgáltatás egyéni tulajdonságai. A beállítás Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 letiltja a titkosítási TLS_RSA_WITH_3DES_EDE_CBC_SHA az összes TLS-hez (1.0, 1.1 és 1.2). A beállítás Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 csak a TLS 1.1 letiltására használható. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 letilthatja a TLS 1.0-t egy API Management szolgáltatásban. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 letilthatja a TLS 1.1-et a háttérrendszerekkel folytatott kommunikációhoz. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 letilthatja a TLS 1.0-t a háttérrendszerekkel folytatott kommunikációhoz. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 engedélyezhető a HTTP2 protokoll egy API Management szolgáltatásban. Ha nem adja meg ezeket a tulajdonságokat a PATCH műveletben, a rendszer visszaállítja a kihagyott tulajdonságok alapértelmezett értékeit. A Http2 kivételével az összes beállításnál az alapértelmezett érték az, True ha a szolgáltatás 2018 False . április 1-jén vagy azt megelőzően jött létre. A HTTP2-beállítás alapértelmezett értéke .False A következő titkosítások bármelyikét letilthatja a következő beállításokkalMicrosoft.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. Például: Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Az alapértelmezett érték számukra.true Megjegyzés: A következő titkosítások nem tilthatók le, mivel belső platformösszetevők igénylik őket: 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	A tulajdonság csak több helyen üzembe helyezett Api Management-szolgáltatásra érvényes. Ezzel letilthatja az átjárót a főrégióban.
properties.enableClientCertificate	boolean	A tulajdonság csak használati termékváltozat-szolgáltatáshoz lett használva. Ez kikényszeríti az ügyféltanúsítvány bemutatását az átjárónak küldött minden egyes kérésen. Ez lehetővé teszi a tanúsítvány hitelesítését is az átjáró házirendjében.
properties.hostnameConfigurations	HostnameConfiguration[]	A API Management szolgáltatás egyéni állomásnév-konfigurációja.
properties.natGatewayState	NatGatewayState	A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.
properties.notificationSenderEmail	string	Email címet, amelyről az értesítés el lesz küldve.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]	A szolgáltatás privát végponti kapcsolatainak listája.
properties.publicIpAddressId	string	A régióban Virtual Network üzembe helyezett szolgáltatáshoz társítandó nyilvános standard termékváltozatÚ V4-alapú IP-cím. Csak az Virtual Network-ban üzembe helyezett fejlesztői és prémium termékváltozatok esetében támogatott.
properties.publicNetworkAccess	PublicNetworkAccess	Azt határozza meg, hogy a nyilvános végponthoz való hozzáférés engedélyezve van-e ehhez a API Management szolgáltatáshoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" értékűnek kell lennie. Ha a "Letiltva", a privát végpontok a kizárólagos hozzáférési módszer. Az alapértelmezett érték az "Engedélyezve"
properties.publisherEmail	string	Közzétevő e-mail-címe.
properties.publisherName	string	Közzétevő neve.
properties.restore	boolean	Törölje az Api Management Service-t, ha korábban helyreállítható módon törölték. Ha ez a jelző meg van adva, és Igaz értékre van állítva, a rendszer minden más tulajdonságot figyelmen kívül hagy.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration	A API Management szolgáltatás virtuális hálózati konfigurációja.
properties.virtualNetworkType	VirtualNetworkType	Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) azt jelenti, hogy a API Management szolgáltatás nem része egyetlen Virtual Network sem, a Külső azt jelenti, hogy a API Management üzembe helyezés internetkapcsolattal rendelkező Virtual Network belül van beállítva, a Belső pedig azt jelenti, hogy API Management az üzembe helyezés csak intranetes végponttal rendelkező Virtual Network van beállítva.
sku	ApiManagementServiceSkuProperties	A API Management szolgáltatás termékváltozat-tulajdonságai.
tags	object	Erőforráscímkék.
zones	string[]	A rendelkezésre állási zónák listája, amely azt jelöli, hogy honnan kell származnia az erőforrásnak.

Válaszok

Name	Típus	Description
200 OK	ApiManagementServiceResource	A szolgáltatás frissítése sikerült.
202 Accepted		A szolgáltatásfrissítési kérelem elfogadva.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

ApiManagementUpdateServiceDisableTls10

ApiManagementUpdateServicePublisherDetails

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

Sample Request

HTTP

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

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

Java

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

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

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

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

Python

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

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

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


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

    response = client.api_management_service.begin_update(
        resource_group_name="rg1",
        service_name="apimService1",
        parameters={
            "properties": {
                "customProperties": {"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"}
            }
        },
    ).result()
    print(response)


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

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

Go

package armapimanagement_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceDisableTls10.json
func ExampleServiceClient_BeginUpdate_apiManagementUpdateServiceDisableTls10() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewServiceClient().BeginUpdate(ctx, "rg1", "apimService1", armapimanagement.ServiceUpdateParameters{
		Properties: &armapimanagement.ServiceUpdateProperties{
			CustomProperties: map[string]*string{
				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("false"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServiceResource = armapimanagement.ServiceResource{
	// 	Name: to.Ptr("apimService1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 	Tags: map[string]*string{
	// 		"Owner": to.Ptr("sasolank"),
	// 		"Pool": to.Ptr("Manual"),
	// 		"Reserved": to.Ptr(""),
	// 		"TestExpiration": to.Ptr("Thu, 29 Jun 2017 18:50:40 GMT"),
	// 		"TestSuiteExpiration": to.Ptr("Thu, 29 Jun 2017 18:51:46 GMT"),
	// 		"UID": to.Ptr("4f5025fe-0669-4e2e-8320-5199466e5eb3"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAAYRPs="),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-29T17:50:42.319Z"); return t}()),
	// 		CustomProperties: map[string]*string{
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("False"),
	// 		},
	// 		GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
	// 		HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 		},
	// 		ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 		NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 		PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		PublicIPAddresses: []*string{
	// 			to.Ptr("40.86.176.232")},
	// 			ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 			TargetProvisioningState: to.Ptr(""),
	// 			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
	// 			PublisherEmail: to.Ptr("admin@live.com"),
	// 			PublisherName: to.Ptr("Contoso"),
	// 		},
	// 		SKU: &armapimanagement.ServiceSKUProperties{
	// 			Name: to.Ptr(armapimanagement.SKUTypeStandard),
	// 			Capacity: to.Ptr[int32](1),
	// 		},
	// 	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Updates an existing API Management service.
 *
 * @summary Updates an existing API Management service.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceDisableTls10.json
 */
async function apiManagementUpdateServiceDisableTls10() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    customProperties: {
      microsoftWindowsAzureApiManagementGatewaySecurityProtocolsTls10: "false",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginUpdateAndWait(
    resourceGroupName,
    serviceName,
    parameters
  );
  console.log(result);
}

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

Sample Response

Status code:

202

Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse

Status code:

200

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

ApiManagementUpdateServicePublisherDetails

Sample Request

HTTP

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

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

Java

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

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

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

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

Python

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

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

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


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

    response = client.api_management_service.begin_update(
        resource_group_name="rg1",
        service_name="apimService1",
        parameters={"properties": {"publisherEmail": "foobar@live.com", "publisherName": "Contoso Vnext"}},
    ).result()
    print(response)


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

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

Go

package armapimanagement_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServicePublisherDetails.json
func ExampleServiceClient_BeginUpdate_apiManagementUpdateServicePublisherDetails() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewServiceClient().BeginUpdate(ctx, "rg1", "apimService1", armapimanagement.ServiceUpdateParameters{
		Properties: &armapimanagement.ServiceUpdateProperties{
			PublisherEmail: to.Ptr("foobar@live.com"),
			PublisherName:  to.Ptr("Contoso Vnext"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServiceResource = armapimanagement.ServiceResource{
	// 	Name: to.Ptr("apimService1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 	Tags: map[string]*string{
	// 		"Owner": to.Ptr("sasolank"),
	// 		"Pool": to.Ptr("Manual"),
	// 		"Reserved": to.Ptr(""),
	// 		"TestExpiration": to.Ptr("Thu, 29 Jun 2017 18:50:40 GMT"),
	// 		"TestSuiteExpiration": to.Ptr("Thu, 29 Jun 2017 18:51:46 GMT"),
	// 		"UID": to.Ptr("4f5025fe-0669-4e2e-8320-5199466e5eb3"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAAYRPs="),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-29T17:50:42.319Z"); return t}()),
	// 		CustomProperties: map[string]*string{
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("False"),
	// 		},
	// 		GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
	// 		HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 		},
	// 		ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 		NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 		PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		PublicIPAddresses: []*string{
	// 			to.Ptr("40.86.176.232")},
	// 			ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 			TargetProvisioningState: to.Ptr(""),
	// 			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
	// 			PublisherEmail: to.Ptr("foobar@live.com"),
	// 			PublisherName: to.Ptr("Contoso Vnext"),
	// 		},
	// 		SKU: &armapimanagement.ServiceSKUProperties{
	// 			Name: to.Ptr(armapimanagement.SKUTypeStandard),
	// 			Capacity: to.Ptr[int32](1),
	// 		},
	// 	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Updates an existing API Management service.
 *
 * @summary Updates an existing API Management service.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServicePublisherDetails.json
 */
async function apiManagementUpdateServicePublisherDetails() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    publisherEmail: "foobar@live.com",
    publisherName: "Contoso Vnext",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginUpdateAndWait(
    resourceGroupName,
    serviceName,
    parameters
  );
  console.log(result);
}

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

Sample Response

Status code:

202

Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse

Status code:

200

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

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

Sample Request

HTTP

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

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

Java

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

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

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

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

Python

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

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

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


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

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


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

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

Go

package armapimanagement_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json
func ExampleServiceClient_BeginUpdate_apiManagementUpdateServiceToNewVnetAndAvailabilityZones() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewServiceClient().BeginUpdate(ctx, "rg1", "apimService1", armapimanagement.ServiceUpdateParameters{
		Properties: &armapimanagement.ServiceUpdateProperties{
			AdditionalLocations: []*armapimanagement.AdditionalLocation{
				{
					Location:          to.Ptr("Australia East"),
					PublicIPAddressID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"),
					SKU: &armapimanagement.ServiceSKUProperties{
						Name:     to.Ptr(armapimanagement.SKUTypePremium),
						Capacity: to.Ptr[int32](3),
					},
					VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
						SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"),
					},
					Zones: []*string{
						to.Ptr("1"),
						to.Ptr("2"),
						to.Ptr("3")},
				}},
			PublicIPAddressID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"),
			VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
				SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"),
			},
			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeExternal),
		},
		SKU: &armapimanagement.ServiceSKUProperties{
			Name:     to.Ptr(armapimanagement.SKUTypePremium),
			Capacity: to.Ptr[int32](3),
		},
		Zones: []*string{
			to.Ptr("1"),
			to.Ptr("2"),
			to.Ptr("3")},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServiceResource = armapimanagement.ServiceResource{
	// 	Name: to.Ptr("apimService1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 	Etag: to.Ptr("AAAAAAAWBIU="),
	// 	Location: to.Ptr("Japan East"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		AdditionalLocations: []*armapimanagement.AdditionalLocation{
	// 			{
	// 				DisableGateway: to.Ptr(false),
	// 				GatewayRegionalURL: to.Ptr("https://apimService1-australiaeast-01.regional.azure-api.net"),
	// 				Location: to.Ptr("Australia East"),
	// 				PlatformVersion: to.Ptr(armapimanagement.PlatformVersionStv2),
	// 				PublicIPAddresses: []*string{
	// 					to.Ptr("20.213.1.35")},
	// 					PublicIPAddressID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"),
	// 					SKU: &armapimanagement.ServiceSKUProperties{
	// 						Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 						Capacity: to.Ptr[int32](3),
	// 					},
	// 					VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
	// 						SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"),
	// 					},
	// 					Zones: []*string{
	// 						to.Ptr("1"),
	// 						to.Ptr("2"),
	// 						to.Ptr("3")},
	// 				}},
	// 				CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-08T23:41:35.644Z"); return t}()),
	// 				CustomProperties: map[string]*string{
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("false"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": to.Ptr("false"),
	// 				},
	// 				DeveloperPortalURL: to.Ptr("https://apimService1.developer.azure-api.net"),
	// 				DisableGateway: to.Ptr(false),
	// 				GatewayRegionalURL: to.Ptr("https://apimService1-japaneast-01.regional.azure-api.net"),
	// 				GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
	// 				HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 					{
	// 						Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 						CertificateSource: to.Ptr(armapimanagement.CertificateSourceBuiltIn),
	// 						DefaultSSLBinding: to.Ptr(false),
	// 						HostName: to.Ptr("apimService1.azure-api.net"),
	// 						NegotiateClientCertificate: to.Ptr(false),
	// 					},
	// 					{
	// 						Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 						Certificate: &armapimanagement.CertificateInformation{
	// 							Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-06-09T23:59:59.000Z"); return t}()),
	// 							Subject: to.Ptr("CN=mycustomdomain.int-azure-api.net"),
	// 							Thumbprint: to.Ptr("2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD"),
	// 						},
	// 						CertificateSource: to.Ptr(armapimanagement.CertificateSourceManaged),
	// 						DefaultSSLBinding: to.Ptr(true),
	// 						HostName: to.Ptr("mycustomdomain.int-azure-api.net"),
	// 						NegotiateClientCertificate: to.Ptr(false),
	// 				}},
	// 				ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 				NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 				PlatformVersion: to.Ptr(armapimanagement.PlatformVersionStv2),
	// 				PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				PublicIPAddresses: []*string{
	// 					to.Ptr("20.78.248.217")},
	// 					PublicIPAddressID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"),
	// 					PublicNetworkAccess: to.Ptr(armapimanagement.PublicNetworkAccessEnabled),
	// 					ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 					TargetProvisioningState: to.Ptr(""),
	// 					VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
	// 						SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"),
	// 					},
	// 					VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeInternal),
	// 					PublisherEmail: to.Ptr("contoso@microsoft.com"),
	// 					PublisherName: to.Ptr("apimPublisher"),
	// 				},
	// 				SKU: &armapimanagement.ServiceSKUProperties{
	// 					Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 					Capacity: to.Ptr[int32](3),
	// 				},
	// 				SystemData: &armapimanagement.SystemData{
	// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-21T20:04:21.610Z"); return t}()),
	// 					LastModifiedBy: to.Ptr("contoso@microsoft.com"),
	// 					LastModifiedByType: to.Ptr(armapimanagement.CreatedByTypeUser),
	// 				},
	// 				Zones: []*string{
	// 					to.Ptr("1"),
	// 					to.Ptr("2"),
	// 					to.Ptr("3")},
	// 				}
}

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

JavaScript

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

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

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

Sample Response

Status code:

202

Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse

Status code:

200

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

Definíciók

Name	Description
AdditionalLocation	Egy további API Management erőforrás helyének leírása.
ApiManagementServiceIdentity	Az Api Management szolgáltatás erőforrásának identitástulajdonságai.
ApiManagementServiceResource	Egyetlen API Management szolgáltatáserőforrás a List vagy a Get response (Válasz lekérése) listában.
ApiManagementServiceSkuProperties	API Management szolgáltatás erőforrás-termékváltozatának tulajdonságai.
ApiManagementServiceUpdateParameters	Az Update Api Management Service-nek megadott paraméter.
ApimIdentityType	Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.
ApiVersionConstraint	A Control Plane Apis verziókorlátozása az API Management szolgáltatáshoz.
ArmIdWrapper	ARM-erőforrásazonosító burkolója
CertificateConfiguration	Tanúsítványkonfiguráció, amely nem megbízható köztes és főtanúsítványokból áll.
CertificateInformation	SSL-tanúsítvány adatai.
CertificateSource	Tanúsítvány forrása.
CertificateStatus	Tanúsítvány állapota.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorFieldContract	Hibamező-szerződés.
ErrorResponse	Hibaválasz.
HostnameConfiguration	Egyéni állomásnév-konfiguráció.
HostnameType	Állomásnév típusa.
NatGatewayState	A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.
PlatformVersion	A szolgáltatást futtató Számítási platform verziója.
PrivateEndpointServiceConnectionStatus	A privát végpont kapcsolati állapota.
PrivateLinkServiceConnectionState	A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
PublicNetworkAccess	Azt határozza meg, hogy a nyilvános végponthoz való hozzáférés engedélyezve van-e ehhez a API Management szolgáltatáshoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" értékűnek kell lennie. Ha a "Letiltva", a privát végpontok a kizárólagos hozzáférési módszer. Az alapértelmezett érték az "Engedélyezve"
RemotePrivateEndpointConnectionWrapper	Távoli privát végpont kapcsolati erőforrása.
SkuType	A termékváltozat neve.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserIdentityProperties
VirtualNetworkConfiguration	Olyan virtuális hálózat konfigurálása, amelyre API Management szolgáltatás telepítve van.
VirtualNetworkType	Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) azt jelenti, hogy a API Management szolgáltatás nem része egyetlen Virtual Network sem, a Külső azt jelenti, hogy a API Management üzembe helyezés internetkapcsolattal rendelkező Virtual Network belül van beállítva, a Belső pedig azt jelenti, hogy API Management az üzembe helyezés csak intranetes végponttal rendelkező Virtual Network van beállítva.

AdditionalLocation

Egy további API Management erőforrás helyének leírása.

Name	Típus	Alapértelmezett érték	Description
disableGateway	boolean	False	A tulajdonság csak több helyen üzembe helyezett Api Management-szolgáltatásra érvényes. Ezzel letilthatja az átjárót ezen a további helyen.
gatewayRegionalUrl	string		A régióban található API Management szolgáltatás átjáró URL-címe.
location	string		A további régió helyneve az Azure Data center-régiók között.
natGatewayState	NatGatewayState	Disabled	A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.
outboundPublicIPAddresses	string[]		A NAT Gateway által üzembe helyezett szolgáltatáshoz társított kimenő nyilvános IPV4-címelőtagok. Csak prémium termékváltozathoz érhető el az stv2 platformon.
platformVersion	PlatformVersion		A szolgáltatást futtató Számítási platform verziója.
privateIPAddresses	string[]		A API Management szolgáltatás privát statikus terheléselosztású IP-címei, amelyek egy belső Virtual Network vannak üzembe helyezve egy adott további helyen. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.
publicIPAddresses	string[]		A API Management szolgáltatás nyilvános statikus terheléselosztású IP-címei a további helyen. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.
publicIpAddressId	string		Nyilvános standard termékváltozat V4-alapú IP-címe, amely Virtual Network üzembe helyezett szolgáltatáshoz társítandó a helyen. Csak az Virtual Network-ben üzembe helyezett prémium termékváltozat esetén támogatott.
sku	ApiManagementServiceSkuProperties		A API Management szolgáltatás termékváltozat-tulajdonságai.
virtualNetworkConfiguration	VirtualNetworkConfiguration		A hely virtuális hálózati konfigurációja.
zones	string[]		A rendelkezésre állási zónák listája, amely azt jelöli, hogy honnan kell származnia az erőforrásnak.

ApiManagementServiceIdentity

Az Api Management szolgáltatás erőforrásának identitástulajdonságai.

Name	Típus	Description
principalId	string	Az identitás egyszerű azonosítója.
tenantId	string	Az identitás ügyfélbérlő-azonosítója.
type	ApimIdentityType	Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.
userAssignedIdentities	<string,  UserIdentityProperties>	Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai ARM-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiManagementServiceResource

Egyetlen API Management szolgáltatáserőforrás a List vagy a Get response (Válasz lekérése) listában.

Name	Típus	Alapértelmezett érték	Description
etag	string		Az erőforrás ETagje.
id	string		Erőforrás-azonosító.
identity	ApiManagementServiceIdentity		Az Api Management szolgáltatás felügyeltszolgáltatás-identitása.
location	string		Erőforrás helye.
name	string		Erőforrás neve.
properties.additionalLocations	AdditionalLocation[]		A API Management szolgáltatás további adatközponti helyei.
properties.apiVersionConstraint	ApiVersionConstraint		A Control Plane Apis verziókorlátozása az API Management szolgáltatáshoz.
properties.certificates	CertificateConfiguration[]		A API Management szolgáltatásban telepíteni kívánt tanúsítványok listája. A legfeljebb telepíthető támogatott tanúsítványok maximális mérete 10.
properties.createdAtUtc	string		A API Management szolgáltatás létrehozási UTC-dátuma. A dátum az ISO 8601 szabvány által meghatározott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.
properties.customProperties	object		A API Management szolgáltatás egyéni tulajdonságai. A beállítás Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 letiltja a titkosítási TLS_RSA_WITH_3DES_EDE_CBC_SHA az összes TLS(1.0, 1.1 és 1.2) esetében. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 letilthatja a TLS 1.1-et. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 letilthatja a TLS 1.0-t egy API Management szolgáltatásban. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 letilthatja a TLS 1.1-et a háttérrendszerekkel folytatott kommunikációhoz. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 letilthatja a TLS 1.0-t a háttérrendszerekkel folytatott kommunikációhoz. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 engedélyezhető a HTTP2 protokoll egy API Management szolgáltatásban. Ha nem adja meg ezeket a tulajdonságokat a PATCH műveletben, az alaphelyzetbe állítja a kihagyott tulajdonságok értékeit az alapértelmezett értékre. A Http2 kivételével az összes beállítás esetében az alapértelmezett érték az, True ha a szolgáltatás 2018. április 1-jén vagy azt megelőzően jött létre, máskülönben False . A Http2-beállítás alapértelmezett értéke a .False A következő titkosítások bármelyikét letilthatja a következő beállításokkalMicrosoft.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. Például: Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Az alapértelmezett érték számukra.true Megjegyzés: A következő titkosítások nem tilthatók le, mivel belső platformösszetevőkre van szükségük: 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		A API Management szolgáltatás DEveloper-portálvégpontjának URL-címe.
properties.disableGateway	boolean	False	A tulajdonság csak több helyen üzembe helyezett Api Management-szolgáltatásra érvényes. Ezzel letilthatja az átjárót a főrégióban.
properties.enableClientCertificate	boolean	False	A tulajdonság csak használati termékváltozat-szolgáltatáshoz használható. Ez kikényszeríti az ügyféltanúsítvány bemutatását az átjáró felé irányuló minden egyes kérésen. Ez lehetővé teszi a tanúsítvány hitelesítését is az átjáró házirendjében.
properties.gatewayRegionalUrl	string		Az alapértelmezett régióban található API Management szolgáltatás átjáró URL-címe.
properties.gatewayUrl	string		A API Management szolgáltatás átjáróJÁNAK URL-címe.
properties.hostnameConfigurations	HostnameConfiguration[]		A API Management szolgáltatás egyéni állomásnév-konfigurációja.
properties.managementApiUrl	string		A API Management szolgáltatás felügyeleti API-végpontjának URL-címe.
properties.natGatewayState	NatGatewayState	Disabled	A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.
properties.notificationSenderEmail	string		Email címet, amelyről az értesítés el lesz küldve.
properties.outboundPublicIPAddresses	string[]		A NAT Gateway által üzembe helyezett szolgáltatáshoz társított kimenő nyilvános IPV4-címelőtagok. Csak prémium termékváltozathoz érhető el az stv2 platformon.
properties.platformVersion	PlatformVersion		A szolgáltatást ezen a helyen futtató számítási platform verziója.
properties.portalUrl	string		A Közzétevő portál végpontjának URL-címe a API Management szolgáltatásban.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		A szolgáltatás privát végpontkapcsolatainak listája.
properties.privateIPAddresses	string[]		A belső Virtual Network üzembe helyezett elsődleges régióban található API Management szolgáltatás privát statikus terheléselosztású IP-címei. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.
properties.provisioningState	string		A API Management szolgáltatás aktuális kiépítési állapota, amely a következők egyike lehet: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.publicIPAddresses	string[]		A API Management szolgáltatás nyilvános statikus terheléselosztású IP-címei az elsődleges régióban. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.
properties.publicIpAddressId	string		A régióban Virtual Network üzembe helyezett szolgáltatáshoz társítandó nyilvános standard termékváltozatú V4-alapú IP-cím. Csak a fejlesztői és prémium termékváltozatok Virtual Network való üzembe helyezéséhez támogatott.
properties.publicNetworkAccess	PublicNetworkAccess		Azt jelzi, hogy engedélyezve van-e a nyilvános végponthoz való hozzáférés ehhez a API Management szolgáltatáshoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" értéknek kell lennie. Ha a "Letiltva", a privát végpontok a kizárólagos hozzáférési módszer. Az alapértelmezett érték az "Engedélyezve"
properties.publisherEmail	string		Közzétevő e-mail-címe.
properties.publisherName	string		Közzétevő neve.
properties.restore	boolean	False	Törölje az Api Management Service-t, ha korábban helyreállítható módon törölték. Ha ez a jelző meg van adva, és True (Igaz) értékre van állítva, a rendszer figyelmen kívül hagyja az összes többi tulajdonságot.
properties.scmUrl	string		A API Management szolgáltatás SCM-végpontJÁNAK URL-címe.
properties.targetProvisioningState	string		A szolgáltatáson elindított hosszú ideig futó művelet által megcélzott API Management szolgáltatás kiépítési állapota.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		A API Management szolgáltatás virtuális hálózati konfigurációja.
properties.virtualNetworkType	VirtualNetworkType	None	Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) azt jelenti, hogy a API Management szolgáltatás nem része semmilyen Virtual Network, a Külső azt jelenti, hogy a API Management üzembe helyezés egy internetkapcsolattal rendelkező végponttal rendelkező Virtual Network belül van beállítva, a belső pedig azt jelenti, hogy API Management az üzembe helyezés csak intranetes végponttal rendelkező Virtual Network van beállítva.
sku	ApiManagementServiceSkuProperties		A API Management szolgáltatás termékváltozat-tulajdonságai.
systemData	systemData		Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
tags	object		Erőforráscímkék.
type	string		API Management erőforrás erőforrástípusa Microsoft.ApiManagement értékre van állítva.
zones	string[]		A rendelkezésre állási zónák listája, amely azt jelöli, hogy honnan kell származnia az erőforrásnak.

ApiManagementServiceSkuProperties

API Management szolgáltatás erőforrás-termékváltozatának tulajdonságai.

Name	Típus	Description
capacity	integer	A termékváltozat kapacitása (a termékváltozat üzembe helyezett egységeinek száma). A használati termékváltozat kapacitását 0-ként kell megadni.
name	SkuType	A termékváltozat neve.

ApiManagementServiceUpdateParameters

Az Update Api Management Service-nek megadott paraméter.

Name	Típus	Alapértelmezett érték	Description
etag	string		Az erőforrás ETagje.
id	string		Erőforrás-azonosító.
identity	ApiManagementServiceIdentity		Az Api Management szolgáltatás felügyeltszolgáltatás-identitása.
name	string		Erőforrás neve.
properties.additionalLocations	AdditionalLocation[]		A API Management szolgáltatás további adatközponti helyei.
properties.apiVersionConstraint	ApiVersionConstraint		A Control Plane Apis verziókorlátozása az API Management szolgáltatáshoz.
properties.certificates	CertificateConfiguration[]		A API Management szolgáltatásban telepíteni kívánt tanúsítványok listája. A legfeljebb telepíthető támogatott tanúsítványok maximális mérete 10.
properties.createdAtUtc	string		A API Management szolgáltatás létrehozási UTC-dátuma. A dátum az ISO 8601 szabványban megadott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.
properties.customProperties	object		A API Management szolgáltatás egyéni tulajdonságai. A beállítás Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 letiltja a titkosítási TLS_RSA_WITH_3DES_EDE_CBC_SHA az összes TLS(1.0, 1.1 és 1.2) esetében. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 letilthatja a TLS 1.1-et. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 letilthatja a TLS 1.0-t egy API Management szolgáltatásban. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 letilthatja a TLS 1.1-et a háttérrendszerekkel folytatott kommunikációhoz. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 letilthatja a TLS 1.0-t a háttérrendszerekkel folytatott kommunikációhoz. A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 engedélyezhető a HTTP2 protokoll egy API Management szolgáltatásban. Ha nem adja meg ezeket a tulajdonságokat a PATCH műveletben, az alaphelyzetbe állítja a kihagyott tulajdonságok értékeit az alapértelmezett értékre. A Http2 kivételével az összes beállítás esetében az alapértelmezett érték az, True ha a szolgáltatás 2018. április 1-jén vagy azt megelőzően jött létre, máskülönben False . A Http2-beállítás alapértelmezett értéke a .False A következő titkosítások bármelyikét letilthatja a következő beállításokkalMicrosoft.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. Például: Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Az alapértelmezett érték számukra.true Megjegyzés: A következő titkosítások nem tilthatók le, mivel belső platformösszetevőkre van szükségük: 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		A DEveloper Portál végpontjának URL-címe a API Management szolgáltatásban.
properties.disableGateway	boolean	False	A tulajdonság csak több helyen üzembe helyezett Api Management-szolgáltatásra érvényes. Ezzel letilthatja az átjárót a főrégióban.
properties.enableClientCertificate	boolean	False	A tulajdonság csak használati termékváltozat-szolgáltatáshoz használható. Ez kikényszeríti az ügyféltanúsítvány bemutatását az átjáró felé irányuló minden egyes kérésen. Ez lehetővé teszi a tanúsítvány hitelesítését is az átjáró házirendjében.
properties.gatewayRegionalUrl	string		Az alapértelmezett régióban található API Management szolgáltatás átjáró URL-címe.
properties.gatewayUrl	string		A API Management szolgáltatás átjáró URL-címe.
properties.hostnameConfigurations	HostnameConfiguration[]		A API Management szolgáltatás egyéni állomásnév-konfigurációja.
properties.managementApiUrl	string		A felügyeleti API-végpont URL-címe a API Management szolgáltatásban.
properties.natGatewayState	NatGatewayState	Disabled	A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.
properties.notificationSenderEmail	string		Email címet, amelyről az értesítés el lesz küldve.
properties.outboundPublicIPAddresses	string[]		A NAT Gateway által üzembe helyezett szolgáltatáshoz társított kimenő nyilvános IPV4-címelőtagok. Csak prémium termékváltozathoz érhető el az stv2 platformon.
properties.platformVersion	PlatformVersion		A szolgáltatást ezen a helyen futtató számítási platform verziója.
properties.portalUrl	string		A Publisher portál végpontjának URL-címe a API Management szolgáltatásban.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		A szolgáltatás privát végpontkapcsolatainak listája.
properties.privateIPAddresses	string[]		A API Management szolgáltatás privát statikus terheléselosztású IP-címei az elsődleges régióban, amely belső Virtual Network van üzembe helyezve. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.
properties.provisioningState	string		A API Management szolgáltatás jelenlegi kiépítési állapota, amely a következők egyike lehet: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.publicIPAddresses	string[]		A API Management szolgáltatás nyilvános statikus terheléselosztású IP-címei az elsődleges régióban. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.
properties.publicIpAddressId	string		A régióban Virtual Network üzembe helyezett szolgáltatáshoz társítandó nyilvános standard termékváltozatú V4-alapú IP-cím. Csak a fejlesztői és prémium termékváltozatok Virtual Network való üzembe helyezéséhez támogatott.
properties.publicNetworkAccess	PublicNetworkAccess		Azt jelzi, hogy engedélyezve van-e a nyilvános végponthoz való hozzáférés ehhez a API Management szolgáltatáshoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" értéknek kell lennie. Ha a "Letiltva", a privát végpontok a kizárólagos hozzáférési módszer. Az alapértelmezett érték az "Engedélyezve"
properties.publisherEmail	string		Közzétevő e-mail címe.
properties.publisherName	string		Közzétevő neve.
properties.restore	boolean	False	Törölje az Api Management Service-t, ha korábban helyreállítható módon törölték. Ha ez a jelző meg van adva, és True (Igaz) értékre van állítva, a rendszer figyelmen kívül hagyja az összes többi tulajdonságot.
properties.scmUrl	string		A API Management szolgáltatás SCM-végpontJÁNAK URL-címe.
properties.targetProvisioningState	string		A szolgáltatáson elindított hosszú ideig futó művelet által megcélzott API Management szolgáltatás kiépítési állapota.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		A API Management szolgáltatás virtuális hálózati konfigurációja.
properties.virtualNetworkType	VirtualNetworkType	None	Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) azt jelenti, hogy a API Management szolgáltatás nem része semmilyen Virtual Network, a Külső azt jelenti, hogy a API Management üzembe helyezés egy internetkapcsolattal rendelkező végponttal rendelkező Virtual Network belül van beállítva, a belső pedig azt jelenti, hogy API Management az üzembe helyezés csak intranetes végponttal rendelkező Virtual Network van beállítva.
sku	ApiManagementServiceSkuProperties		A API Management szolgáltatás termékváltozat-tulajdonságai.
tags	object		Erőforráscímkék.
type	string		API Management erőforrás erőforrástípusa Microsoft.ApiManagement értékre van állítva.
zones	string[]		A rendelkezésre állási zónák listája, amely azt jelöli, hogy honnan kell származnia az erőforrásnak.

ApimIdentityType

Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.

Name	Típus	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

A Control Plane Apis verziókorlátozása az API Management szolgáltatáshoz.

Name	Típus	Description
minApiVersion	string	Korlátozza a vezérlősík API-hívásait API Management szolgáltatásra, amelynek verziója megegyezik vagy újabb ennél az értéknél.

ArmIdWrapper

ARM-erőforrásazonosító burkolója

Name	Típus	Description
id	string

CertificateConfiguration

Tanúsítványkonfiguráció, amely nem megbízható köztes és főtanúsítványokból áll.

Name	Típus	Description
certificate	CertificateInformation	Tanúsítványadatok.
certificatePassword	string	Tanúsítvány jelszava.
encodedCertificate	string	Base64 kódolású tanúsítvány.
storeName	enum: CertificateAuthority Root	A System.Security.Cryptography.x509certificates.StoreName tanúsítványtároló helye. Csak a Gyökér és a CertificateAuthority érvényes hely.

CertificateInformation

SSL-tanúsítvány adatai.

Name	Típus	Description
expiry	string	A tanúsítvány lejárati dátuma. A dátum az ISO 8601 szabvány által meghatározott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.
subject	string	A tanúsítvány tárgya.
thumbprint	string	A tanúsítványhoz tartozó ujjlenyomat.

CertificateSource

Tanúsítvány forrása.

Name	Típus	Description
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

Tanúsítvány állapota.

Name	Típus	Description
Completed	string
Failed	string
InProgress	string

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorFieldContract

Hibamező-szerződés.

Name	Típus	Description
code	string	Tulajdonságszintű hibakód.
message	string	A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.
target	string	Tulajdonság neve.

ErrorResponse

Hibaválasz.

Name	Típus	Description
error.code	string	Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál.
error.details	ErrorFieldContract[]	Érvényesítési hiba esetén az érvénytelen mezők listája küldi el a kérést.
error.message	string	A hiba emberi olvasásra alkalmas ábrázolása.

HostnameConfiguration

Egyéni állomásnév-konfiguráció.

Name	Típus	Alapértelmezett érték	Description
certificate	CertificateInformation		Tanúsítványadatok.
certificatePassword	string		Tanúsítvány jelszava.
certificateSource	CertificateSource		Tanúsítvány forrása.
certificateStatus	CertificateStatus		Tanúsítvány állapota.
defaultSslBinding	boolean	False	Adja meg az igaz értéket az állomásnévhez társított tanúsítvány alapértelmezett SSL-tanúsítványként való beállításához. Ha egy ügyfél nem küldi el az SNI-fejlécet, akkor ez lesz az a tanúsítvány, amelyet a rendszer megtámad. A tulajdonság akkor hasznos, ha egy szolgáltatás több egyéni állomásnévvel rendelkezik, és el kell döntenie az alapértelmezett SSL-tanúsítványt. A beállítás csak az átjáró állomásnévtípusára van alkalmazva.
encodedCertificate	string		Base64 kódolású tanúsítvány.
hostName	string		Az Api Management szolgáltatásban konfigurálni kívánt állomásnév.
identityClientId	string		A rendszer vagy felhasználó által hozzárendelt felügyelt identitás ügyfélazonosítója a Azure AD által generált módon, amely GET-hozzáféréssel rendelkezik az SSL-tanúsítványt tartalmazó keyVaulthoz.
keyVaultId	string		Az SSL-tanúsítványt tartalmazó KeyVault-titkos kulcs URL-címe. Ha meg van adva a verziót tartalmazó abszolút URL-cím, az SSL-tanúsítvány automatikus frissítése nem fog működni. Ehhez konfigurálni kell az Api Management szolgáltatást a aka.ms/apimmsi. A titkos kódnak application/x-pkcs12 típusúnak kell lennie
negotiateClientCertificate	boolean	False	Adja meg az igaz értéket, hogy mindig egyeztetni szeretné az ügyféltanúsítványt az állomásnéven. Az alapértelmezett érték hamis.
type	HostnameType		Állomásnév típusa.

HostnameType

Állomásnév típusa.

Name	Típus	Description
DeveloperPortal	string
Management	string
Portal	string
Proxy	string
Scm	string

NatGatewayState

A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.

Name	Típus	Description
Disabled	string	A NAT Gateway le van tiltva a szolgáltatáshoz.
Enabled	string	A NAT Gateway engedélyezve van a szolgáltatáshoz.

PlatformVersion

A szolgáltatást futtató Számítási platform verziója.

Name	Típus	Description
mtv1	string	A szolgáltatást több-bérlős V1 platformon futtató platform.
stv1	string	A szolgáltatást egyetlen bérlős V1 platformon futtató platform.
stv2	string	A szolgáltatást egyetlen bérlős V2 platformon futtató platform.
undetermined	string	A platform verziója nem határozható meg, mivel a számítási platform nincs üzembe helyezve.

PrivateEndpointServiceConnectionStatus

A privát végpont kapcsolati állapota.

Name	Típus	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.

Name	Típus	Description
actionsRequired	string	Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.
description	string	A kapcsolat jóváhagyásának/elutasításának oka.
status	PrivateEndpointServiceConnectionStatus	Azt jelzi, hogy a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot.

PublicNetworkAccess

Azt határozza meg, hogy a nyilvános végponthoz való hozzáférés engedélyezve van-e ehhez a API Management szolgáltatáshoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" értékűnek kell lennie. Ha a "Letiltva", a privát végpontok a kizárólagos hozzáférési módszer. Az alapértelmezett érték az "Engedélyezve"

Name	Típus	Description
Disabled	string
Enabled	string

RemotePrivateEndpointConnectionWrapper

Távoli privát végpont kapcsolati erőforrása.

Name	Típus	Description
id	string	Privát végpont kapcsolati erőforrás-azonosítója
name	string	Privát végpont kapcsolatának neve
properties.groupIds	string[]	Az összes csoportazonosító.
properties.privateEndpoint	ArmIdWrapper	A privát végpont erőforrása.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.
properties.provisioningState	string	A privát végpont kapcsolati erőforrásának kiépítési állapota.
type	string	Privát végpont kapcsolati erőforrástípusa

SkuType

A termékváltozat neve.

Name	Típus	Description
Basic	string	Az Api Management alapszintű termékváltozata.
Consumption	string	Az Api Management használati termékváltozata.
Developer	string	Az Api Management fejlesztői termékváltozata.
Isolated	string	Az Api Management izolált termékváltozata.
Premium	string	Az Api Management prémium termékváltozata.
Standard	string	Az Api Management standard termékváltozata.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást utoljára módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UserIdentityProperties

Name	Típus	Description
clientId	string	A felhasználó által hozzárendelt identitás ügyfél-azonosítója.
principalId	string	A felhasználó által hozzárendelt identitás egyszerű azonosítója.

VirtualNetworkConfiguration

Olyan virtuális hálózat konfigurálása, amelyre API Management szolgáltatás telepítve van.

Name	Típus	Description
subnetResourceId	string	Egy virtuális hálózat alhálózatának teljes erőforrás-azonosítója a API Management szolgáltatás üzembe helyezéséhez.
subnetname	string	Az alhálózat neve.
vnetid	string	A virtuális hálózat azonosítója. Ez általában egy GUID. Alapértelmezés szerint null guid értéket vár.

VirtualNetworkType

Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) azt jelenti, hogy a API Management szolgáltatás nem része egyetlen Virtual Network sem, a Külső azt jelenti, hogy a API Management üzembe helyezés internetkapcsolattal rendelkező Virtual Network belül van beállítva, a Belső pedig azt jelenti, hogy API Management az üzembe helyezés csak intranetes végponttal rendelkező Virtual Network van beállítva.

Name	Típus	Description
External	string	A szolgáltatás a Virtual Network része, és az internetről érhető el.
Internal	string	A szolgáltatás a Virtual Network része, és csak a virtuális hálózaton belülről érhető el.
None	string	A szolgáltatás nem része egyetlen Virtual Network sem.