Api Management Service - Update

Referenz

Dienst:: API Management

API-Version:: 2022-08-01

Aktualisiert einen vorhandenen API-Verwaltungsdienst.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
identity	ApiManagementServiceIdentity	Verwaltete Dienstidentität des API-Verwaltungsdiensts.
properties.additionalLocations	AdditionalLocation[]	Zusätzliche Rechenzentrumsspeicherorte des API-Verwaltungsdiensts.
properties.apiVersionConstraint	ApiVersionConstraint	Steuern der Api-Versionsbeschränkung für den API-Verwaltungsdienst.
properties.certificates	CertificateConfiguration[]	Liste der Zertifikate, die im API-Verwaltungsdienst installiert werden müssen. Maximal unterstützte Zertifikate, die installiert werden können, sind 10.
properties.customProperties	object	Benutzerdefinierte Eigenschaften des API-Verwaltungsdiensts. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` deaktiviert die Verschlüsselung TLS_RSA_WITH_3DES_EDE_CBC_SHA für alle TLS(1.0, 1.1 und 1.2). Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` kann verwendet werden, um nur TLS 1.1 zu deaktivieren. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` kann verwendet werden, um TLS 1.0 für einen API-Verwaltungsdienst zu deaktivieren. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` kann verwendet werden, um nur TLS 1.1 für die Kommunikation mit Back-Ends zu deaktivieren. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` kann verwendet werden, um TLS 1.0 für die Kommunikation mit Back-Ends zu deaktivieren. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` kann verwendet werden, um das HTTP2-Protokoll für einen API-Verwaltungsdienst zu aktivieren. Keine dieser Eigenschaften für PATCH-Vorgänge angibt, werden die Werte der Eigenschaften auf ihre Standardwerte zurückgesetzt. Für alle Einstellungen mit Ausnahme von Http2 wird der Standardwert `True`, wenn der Dienst am oder vor dem 1. April 2018 erstellt wurde und andernfalls `False`. Der Standardwert der Http2-Einstellung ist `False`. Sie können eine der folgenden Chiffre mithilfe von Einstellungen `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`deaktivieren: 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. Beispiel: `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Der Standardwert ist `true` für sie. Hinweis: Die folgenden Verschlüsselungen können nicht deaktiviert werden, da sie von internen Plattformkomponenten benötigt werden: 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	Eigenschaft gilt nur für einen API-Verwaltungsdienst, der an mehreren Standorten bereitgestellt wird. Dies kann verwendet werden, um das Gateway im Masterbereich zu deaktivieren.
properties.enableClientCertificate	boolean	Eigenschaft, die nur für den Verbrauch-SKU-Dienst verwendet werden soll. Dadurch wird für jede Anforderung an das Gateway ein Clientzertifikat erzwungen. Dies ermöglicht auch die Authentifizierung des Zertifikats in der Richtlinie auf dem Gateway.
properties.hostnameConfigurations	HostnameConfiguration[]	Benutzerdefinierte Hostnamenkonfiguration des API-Verwaltungsdiensts.
properties.natGatewayState	NatGatewayState	Die Eigenschaft kann zum Aktivieren des NAT-Gateways für diesen API-Verwaltungsdienst verwendet werden.
properties.notificationSenderEmail	string maxLength: 100	E-Mail-Adresse, von der die Benachrichtigung gesendet wird.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]	Liste der privaten Endpunktverbindungen dieses Diensts.
properties.publicIpAddressId	string	Öffentliche SKU-IP-V4-basierte IP-Adresse, die dem in der Region bereitgestellten virtuellen Netzwerkdienst zugeordnet werden soll. Wird nur für Entwickler- und Premium-SKU unterstützt, die im virtuellen Netzwerk bereitgestellt werden.
properties.publicNetworkAccess	PublicNetworkAccess	Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API-Verwaltungsdienst zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss 'Aktiviert' oder 'Deaktiviert' sein. Wenn "Deaktiviert", sind private Endpunkte die exklusive Zugriffsmethode. Standardwert ist 'Enabled'
properties.publisherEmail	string maxLength: 100	Publisher-E-Mail.
properties.publisherName	string maxLength: 100	Herausgebername.
properties.restore	boolean	Rückgängigmachen des API-Verwaltungsdiensts, wenn er zuvor vorläufig gelöscht wurde. Wenn dieses Flag angegeben und auf True festgelegt ist, werden alle anderen Eigenschaften ignoriert.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration	Virtuelle Netzwerkkonfiguration des API-Verwaltungsdiensts.
properties.virtualNetworkType	VirtualNetworkType	Der Typ des VPN, in dem der API-Verwaltungsdienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API-Verwaltungsdienst nicht Teil eines virtuellen Netzwerks ist, extern bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das über einen internetgerichteten Endpunkt verfügt, und "Intern" bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das nur über einen Intranet-Endpunkt verfügt.
sku	ApiManagementServiceSkuProperties	SKU-Eigenschaften des API-Verwaltungsdiensts.
tags	object	Ressourcentags.
zones	string[]	Eine Liste der Verfügbarkeitszonen, aus denen die Ressource stammen muss.

Antworten

Name	Typ	Beschreibung
200 OK	ApiManagementServiceResource	Der Dienst wurde erfolgreich aktualisiert.
202 Accepted		Die Serviceupdateanforderung wurde akzeptiert.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementUpdateServiceDisableTls10

ApiManagementUpdateServicePublisherDetails

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

Beispielanforderung

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

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


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

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

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

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

from 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

package armapimanagement_test

import (
	"context"
	"log"

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

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

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

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

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

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

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

Beispiel für eine Antwort

Statuscode:: 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

Statuscode:: 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

Beispielanforderung

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

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


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

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

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

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

from 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

package armapimanagement_test

import (
	"context"
	"log"

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

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

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

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

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

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

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

Beispiel für eine Antwort

Statuscode:: 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

Statuscode:: 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

Beispielanforderung

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

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


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

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

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

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

from 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

package armapimanagement_test

import (
	"context"
	"log"

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

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

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

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

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

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

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

Beispiel für eine Antwort

Statuscode:: 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

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

Definitionen

Name	Beschreibung
AdditionalLocation	Beschreibung eines zusätzlichen RESSOURCENspeicherorts für die API-Verwaltung.
ApiManagementServiceIdentity	Identitätseigenschaften der Api-Verwaltungsdienstressource.
ApiManagementServiceResource	Eine einzelne API-Verwaltungsdienstressource in "List" oder "Get response".
ApiManagementServiceSkuProperties	SKU-Eigenschaften des API-Verwaltungsdiensts.
ApiManagementServiceUpdateParameters	Parameter, der für den Update-API-Verwaltungsdienst bereitgestellt wird.
ApimIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
ApiVersionConstraint	Steuern der Api-Versionsbeschränkung für den API-Verwaltungsdienst.
ArmIdWrapper	Ein Wrapper für eine ARM-Ressourcen-ID
CertificateConfiguration	Zertifikatkonfiguration, die aus nicht vertrauenswürdigen Zwischen- und Stammzertifikaten besteht.
CertificateInformation	SSL-Zertifikatinformationen.
CertificateSource	Zertifikatquelle.
CertificateStatus	Zertifikatstatus.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorFieldContract	Fehlerfeld-Vertrag.
ErrorResponse	Fehlerantwort.
HostnameConfiguration	Konfiguration des benutzerdefinierten Hostnamens.
HostnameType	Hostnamentyp.
NatGatewayState	Die Eigenschaft kann zum Aktivieren des NAT-Gateways für diesen API-Verwaltungsdienst verwendet werden.
PlatformVersion	Compute Platform Version, die den Dienst ausführt.
PrivateEndpointServiceConnectionStatus	Der Status der privaten Endpunktverbindung.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
PublicNetworkAccess	Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API-Verwaltungsdienst zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss 'Aktiviert' oder 'Deaktiviert' sein. Wenn "Deaktiviert", sind private Endpunkte die exklusive Zugriffsmethode. Standardwert ist 'Enabled'
RemotePrivateEndpointConnectionWrapper	Remote-Private Endpoint Connection-Ressource.
SkuType	Name der Sku.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserIdentityProperties
VirtualNetworkConfiguration	Konfiguration eines virtuellen Netzwerks, für das der API-Verwaltungsdienst bereitgestellt wird.
VirtualNetworkType	Der Typ des VPN, in dem der API-Verwaltungsdienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API-Verwaltungsdienst nicht Teil eines virtuellen Netzwerks ist, extern bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das über einen internetgerichteten Endpunkt verfügt, und "Intern" bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das nur über einen Intranet-Endpunkt verfügt.

AdditionalLocation

Objekt

Beschreibung eines zusätzlichen RESSOURCENspeicherorts für die API-Verwaltung.

Name	Typ	Standardwert	Beschreibung
disableGateway	boolean	False	Eigenschaft gilt nur für einen API-Verwaltungsdienst, der an mehreren Standorten bereitgestellt wird. Dies kann verwendet werden, um das Gateway an diesem zusätzlichen Speicherort zu deaktivieren.
gatewayRegionalUrl	string		Gateway-URL des API-Verwaltungsdiensts in der Region.
location	string		Der Standortname der zusätzlichen Region zwischen Azure Data Center-Regionen.
natGatewayState	NatGatewayState	Disabled	Die Eigenschaft kann zum Aktivieren des NAT-Gateways für diesen API-Verwaltungsdienst verwendet werden.
outboundPublicIPAddresses	string[]		Präfixe für ausgehende öffentliche IPV4-Adressen, die mit dem bereitgestellten NAT-Gatewaydienst verknüpft sind. Nur für Premium-SKU auf stv2-Plattform verfügbar.
platformVersion	PlatformVersion		Compute Platform Version, die den Dienst ausführt.
privateIPAddresses	string[]		Private Static Load Balanced IP-Adressen des API-Verwaltungsdiensts, der an einem bestimmten zusätzlichen Speicherort in einem internen virtuellen Netzwerk bereitgestellt wird. Nur für Standard-, Standard-, Premium- und isolierte SKU verfügbar.
publicIPAddresses	string[]		Ip-Adressen des API-Verwaltungsdiensts für öffentliche statische Lastenausgleich am zusätzlichen Speicherort. Nur für Standard-, Standard-, Premium- und isolierte SKU verfügbar.
publicIpAddressId	string		Öffentliche SKU-IP-V4-basierte IP-Adresse, die dem bereitgestellten Virtuellen Netzwerkdienst am Standort zugeordnet werden soll. Wird nur für Premium-SKU unterstützt, die im virtuellen Netzwerk bereitgestellt wird.
sku	ApiManagementServiceSkuProperties		SKU-Eigenschaften des API-Verwaltungsdiensts.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfiguration des virtuellen Netzwerks für den Speicherort.
zones	string[]		Eine Liste der Verfügbarkeitszonen, aus denen die Ressource stammen muss.

ApiManagementServiceIdentity

Objekt

Identitätseigenschaften der Api-Verwaltungsdienstressource.

Name	Typ	Beschreibung
principalId	string (uuid)	Die Prinzipal-ID der Identität.
tenantId	string (uuid)	Die Clientmandanten-ID der Identität.
type	ApimIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
userAssignedIdentities	<string, UserIdentityProperties>	Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiManagementServiceResource

Objekt

Eine einzelne API-Verwaltungsdienstressource in "List" oder "Get response".

Name	Typ	Standardwert	Beschreibung
etag	string		ETag der Ressource.
id	string		Ressourcen-ID.
identity	ApiManagementServiceIdentity		Verwaltete Dienstidentität des API-Verwaltungsdiensts.
location	string		Ressourcenspeicherort.
name	string		Ressourcenname.
properties.additionalLocations	AdditionalLocation[]		Zusätzliche Rechenzentrumsspeicherorte des API-Verwaltungsdiensts.
properties.apiVersionConstraint	ApiVersionConstraint		Steuern der Api-Versionsbeschränkung für den API-Verwaltungsdienst.
properties.certificates	CertificateConfiguration[]		Liste der Zertifikate, die im API-Verwaltungsdienst installiert werden müssen. Maximal unterstützte Zertifikate, die installiert werden können, sind 10.
properties.createdAtUtc	string (date-time)		Erstellung des UTC-Datums des API-Verwaltungsdiensts. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.customProperties	object		Benutzerdefinierte Eigenschaften des API-Verwaltungsdiensts. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` deaktiviert die Verschlüsselung TLS_RSA_WITH_3DES_EDE_CBC_SHA für alle TLS(1.0, 1.1 und 1.2). Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` kann verwendet werden, um nur TLS 1.1 zu deaktivieren. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` kann verwendet werden, um TLS 1.0 für einen API-Verwaltungsdienst zu deaktivieren. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` kann verwendet werden, um nur TLS 1.1 für die Kommunikation mit Back-Ends zu deaktivieren. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` kann verwendet werden, um TLS 1.0 für die Kommunikation mit Back-Ends zu deaktivieren. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` kann verwendet werden, um das HTTP2-Protokoll für einen API-Verwaltungsdienst zu aktivieren. Keine dieser Eigenschaften für PATCH-Vorgänge angibt, werden die Werte der Eigenschaften auf ihre Standardwerte zurückgesetzt. Für alle Einstellungen mit Ausnahme von Http2 wird der Standardwert `True`, wenn der Dienst am oder vor dem 1. April 2018 erstellt wurde und andernfalls `False`. Der Standardwert der Http2-Einstellung ist `False`. Sie können eine der folgenden Chiffre mithilfe von Einstellungen `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`deaktivieren: 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. Beispiel: `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Der Standardwert ist `true` für sie. Hinweis: Die folgenden Verschlüsselungen können nicht deaktiviert werden, da sie von internen Plattformkomponenten benötigt werden: 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		DEveloper Portal-Endpunkt-URL des API-Verwaltungsdiensts.
properties.disableGateway	boolean	False	Eigenschaft gilt nur für einen API-Verwaltungsdienst, der an mehreren Standorten bereitgestellt wird. Dies kann verwendet werden, um das Gateway im Masterbereich zu deaktivieren.
properties.enableClientCertificate	boolean	False	Eigenschaft, die nur für den Verbrauch-SKU-Dienst verwendet werden soll. Dadurch wird für jede Anforderung an das Gateway ein Clientzertifikat erzwungen. Dies ermöglicht auch die Authentifizierung des Zertifikats in der Richtlinie auf dem Gateway.
properties.gatewayRegionalUrl	string		Gateway-URL des API-Verwaltungsdiensts in der Standardregion.
properties.gatewayUrl	string		Gateway-URL des API-Verwaltungsdiensts.
properties.hostnameConfigurations	HostnameConfiguration[]		Benutzerdefinierte Hostnamenkonfiguration des API-Verwaltungsdiensts.
properties.managementApiUrl	string		Url des Verwaltungs-API-Endpunkts des API-Verwaltungsdiensts.
properties.natGatewayState	NatGatewayState	Disabled	Die Eigenschaft kann zum Aktivieren des NAT-Gateways für diesen API-Verwaltungsdienst verwendet werden.
properties.notificationSenderEmail	string maxLength: 100		E-Mail-Adresse, von der die Benachrichtigung gesendet wird.
properties.outboundPublicIPAddresses	string[]		Präfixe für ausgehende öffentliche IPV4-Adressen, die mit dem bereitgestellten NAT-Gatewaydienst verknüpft sind. Nur für Premium-SKU auf stv2-Plattform verfügbar.
properties.platformVersion	PlatformVersion		Compute Platform Version, die den Dienst an diesem Speicherort ausführt.
properties.portalUrl	string		Endpunkt-URL des Publisher-Portalendpunkts des API-Verwaltungsdiensts.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Liste der privaten Endpunktverbindungen dieses Diensts.
properties.privateIPAddresses	string[]		Private Static Load Balanced IP-Adressen des API-Verwaltungsdiensts in der primären Region, die in einem internen virtuellen Netzwerk bereitgestellt wird. Nur für Standard-, Standard-, Premium- und isolierte SKU verfügbar.
properties.provisioningState	string		Der aktuelle Bereitstellungsstatus des API-Verwaltungsdiensts, der eine der folgenden Sein kann: Created/Activating/Succeeded/Updating/Failed/Stopped/Endating/TerminationFailed/Deleted.
properties.publicIPAddresses	string[]		Öffentliche IP-Adressen für statische Lastenausgleich des API-Verwaltungsdiensts in der primären Region. Nur für Standard-, Standard-, Premium- und isolierte SKU verfügbar.
properties.publicIpAddressId	string		Öffentliche SKU-IP-V4-basierte IP-Adresse, die dem in der Region bereitgestellten virtuellen Netzwerkdienst zugeordnet werden soll. Wird nur für Entwickler- und Premium-SKU unterstützt, die im virtuellen Netzwerk bereitgestellt werden.
properties.publicNetworkAccess	PublicNetworkAccess		Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API-Verwaltungsdienst zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss 'Aktiviert' oder 'Deaktiviert' sein. Wenn "Deaktiviert", sind private Endpunkte die exklusive Zugriffsmethode. Standardwert ist 'Enabled'
properties.publisherEmail	string maxLength: 100		Publisher-E-Mail.
properties.publisherName	string maxLength: 100		Herausgebername.
properties.restore	boolean	False	Rückgängigmachen des API-Verwaltungsdiensts, wenn er zuvor vorläufig gelöscht wurde. Wenn dieses Flag angegeben und auf True festgelegt ist, werden alle anderen Eigenschaften ignoriert.
properties.scmUrl	string		SCM-Endpunkt-URL des API-Verwaltungsdiensts.
properties.targetProvisioningState	string		Der Bereitstellungsstatus des API-Verwaltungsdiensts, der auf den für den Dienst gestarteten lang ausgeführten Vorgang ausgerichtet ist.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Virtuelle Netzwerkkonfiguration des API-Verwaltungsdiensts.
properties.virtualNetworkType	VirtualNetworkType	None	Der Typ des VPN, in dem der API-Verwaltungsdienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API-Verwaltungsdienst nicht Teil eines virtuellen Netzwerks ist, extern bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das über einen internetgerichteten Endpunkt verfügt, und "Intern" bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das nur über einen Intranet-Endpunkt verfügt.
sku	ApiManagementServiceSkuProperties		SKU-Eigenschaften des API-Verwaltungsdiensts.
systemData	systemData		Metadaten zur Erstellung und letzten Änderung der Ressource.
tags	object		Ressourcentags.
type	string		Der Ressourcentyp für die API-Verwaltungsressource ist auf "Microsoft.ApiManagement" festgelegt.
zones	string[]		Eine Liste der Verfügbarkeitszonen, aus denen die Ressource stammen muss.

ApiManagementServiceSkuProperties

Objekt

SKU-Eigenschaften des API-Verwaltungsdiensts.

Name	Typ	Beschreibung
capacity	integer (int32)	Kapazität der SKU (Anzahl der bereitgestellten Einheiten der SKU). Für den Verbrauch muss die SKU-Kapazität als 0 angegeben werden.
name	SkuType	Name der Sku.

ApiManagementServiceUpdateParameters

Objekt

Parameter, der für den Update-API-Verwaltungsdienst bereitgestellt wird.

Name	Typ	Standardwert	Beschreibung
etag	string		ETag der Ressource.
id	string		Ressourcen-ID.
identity	ApiManagementServiceIdentity		Verwaltete Dienstidentität des API-Verwaltungsdiensts.
name	string		Ressourcenname.
properties.additionalLocations	AdditionalLocation[]		Zusätzliche Rechenzentrumsspeicherorte des API-Verwaltungsdiensts.
properties.apiVersionConstraint	ApiVersionConstraint		Steuern der Api-Versionsbeschränkung für den API-Verwaltungsdienst.
properties.certificates	CertificateConfiguration[]		Liste der Zertifikate, die im API-Verwaltungsdienst installiert werden müssen. Maximal unterstützte Zertifikate, die installiert werden können, sind 10.
properties.createdAtUtc	string (date-time)		Erstellung des UTC-Datums des API-Verwaltungsdiensts. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.customProperties	object		Benutzerdefinierte Eigenschaften des API-Verwaltungsdiensts. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` deaktiviert die Verschlüsselung TLS_RSA_WITH_3DES_EDE_CBC_SHA für alle TLS(1.0, 1.1 und 1.2). Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` kann verwendet werden, um nur TLS 1.1 zu deaktivieren. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` kann verwendet werden, um TLS 1.0 für einen API-Verwaltungsdienst zu deaktivieren. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` kann verwendet werden, um nur TLS 1.1 für die Kommunikation mit Back-Ends zu deaktivieren. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` kann verwendet werden, um TLS 1.0 für die Kommunikation mit Back-Ends zu deaktivieren. Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` kann verwendet werden, um das HTTP2-Protokoll für einen API-Verwaltungsdienst zu aktivieren. Keine dieser Eigenschaften für PATCH-Vorgänge angibt, werden die Werte der Eigenschaften auf ihre Standardwerte zurückgesetzt. Für alle Einstellungen mit Ausnahme von Http2 wird der Standardwert `True`, wenn der Dienst am oder vor dem 1. April 2018 erstellt wurde und andernfalls `False`. Der Standardwert der Http2-Einstellung ist `False`. Sie können eine der folgenden Chiffre mithilfe von Einstellungen `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`deaktivieren: 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. Beispiel: `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Der Standardwert ist `true` für sie. Hinweis: Die folgenden Verschlüsselungen können nicht deaktiviert werden, da sie von internen Plattformkomponenten benötigt werden: 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		DEveloper Portal-Endpunkt-URL des API-Verwaltungsdiensts.
properties.disableGateway	boolean	False	Eigenschaft gilt nur für einen API-Verwaltungsdienst, der an mehreren Standorten bereitgestellt wird. Dies kann verwendet werden, um das Gateway im Masterbereich zu deaktivieren.
properties.enableClientCertificate	boolean	False	Eigenschaft, die nur für den Verbrauch-SKU-Dienst verwendet werden soll. Dadurch wird für jede Anforderung an das Gateway ein Clientzertifikat erzwungen. Dies ermöglicht auch die Authentifizierung des Zertifikats in der Richtlinie auf dem Gateway.
properties.gatewayRegionalUrl	string		Gateway-URL des API-Verwaltungsdiensts in der Standardregion.
properties.gatewayUrl	string		Gateway-URL des API-Verwaltungsdiensts.
properties.hostnameConfigurations	HostnameConfiguration[]		Benutzerdefinierte Hostnamenkonfiguration des API-Verwaltungsdiensts.
properties.managementApiUrl	string		Url des Verwaltungs-API-Endpunkts des API-Verwaltungsdiensts.
properties.natGatewayState	NatGatewayState	Disabled	Die Eigenschaft kann zum Aktivieren des NAT-Gateways für diesen API-Verwaltungsdienst verwendet werden.
properties.notificationSenderEmail	string maxLength: 100		E-Mail-Adresse, von der die Benachrichtigung gesendet wird.
properties.outboundPublicIPAddresses	string[]		Präfixe für ausgehende öffentliche IPV4-Adressen, die mit dem bereitgestellten NAT-Gatewaydienst verknüpft sind. Nur für Premium-SKU auf stv2-Plattform verfügbar.
properties.platformVersion	PlatformVersion		Compute Platform Version, die den Dienst an diesem Speicherort ausführt.
properties.portalUrl	string		Endpunkt-URL des Publisher-Portalendpunkts des API-Verwaltungsdiensts.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Liste der privaten Endpunktverbindungen dieses Diensts.
properties.privateIPAddresses	string[]		Private Static Load Balanced IP-Adressen des API-Verwaltungsdiensts in der primären Region, die in einem internen virtuellen Netzwerk bereitgestellt wird. Nur für Standard-, Standard-, Premium- und isolierte SKU verfügbar.
properties.provisioningState	string		Der aktuelle Bereitstellungsstatus des API-Verwaltungsdiensts, der eine der folgenden Sein kann: Created/Activating/Succeeded/Updating/Failed/Stopped/Endating/TerminationFailed/Deleted.
properties.publicIPAddresses	string[]		Öffentliche IP-Adressen für statische Lastenausgleich des API-Verwaltungsdiensts in der primären Region. Nur für Standard-, Standard-, Premium- und isolierte SKU verfügbar.
properties.publicIpAddressId	string		Öffentliche SKU-IP-V4-basierte IP-Adresse, die dem in der Region bereitgestellten virtuellen Netzwerkdienst zugeordnet werden soll. Wird nur für Entwickler- und Premium-SKU unterstützt, die im virtuellen Netzwerk bereitgestellt werden.
properties.publicNetworkAccess	PublicNetworkAccess		Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API-Verwaltungsdienst zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss 'Aktiviert' oder 'Deaktiviert' sein. Wenn "Deaktiviert", sind private Endpunkte die exklusive Zugriffsmethode. Standardwert ist 'Enabled'
properties.publisherEmail	string maxLength: 100		Publisher-E-Mail.
properties.publisherName	string maxLength: 100		Herausgebername.
properties.restore	boolean	False	Rückgängigmachen des API-Verwaltungsdiensts, wenn er zuvor vorläufig gelöscht wurde. Wenn dieses Flag angegeben und auf True festgelegt ist, werden alle anderen Eigenschaften ignoriert.
properties.scmUrl	string		SCM-Endpunkt-URL des API-Verwaltungsdiensts.
properties.targetProvisioningState	string		Der Bereitstellungsstatus des API-Verwaltungsdiensts, der auf den für den Dienst gestarteten lang ausgeführten Vorgang ausgerichtet ist.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Virtuelle Netzwerkkonfiguration des API-Verwaltungsdiensts.
properties.virtualNetworkType	VirtualNetworkType	None	Der Typ des VPN, in dem der API-Verwaltungsdienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API-Verwaltungsdienst nicht Teil eines virtuellen Netzwerks ist, extern bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das über einen internetgerichteten Endpunkt verfügt, und "Intern" bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das nur über einen Intranet-Endpunkt verfügt.
sku	ApiManagementServiceSkuProperties		SKU-Eigenschaften des API-Verwaltungsdiensts.
tags	object		Ressourcentags.
type	string		Der Ressourcentyp für die API-Verwaltungsressource ist auf "Microsoft.ApiManagement" festgelegt.
zones	string[]		Eine Liste der Verfügbarkeitszonen, aus denen die Ressource stammen muss.

ApimIdentityType

Enumeration

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

Wert	Beschreibung
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ApiVersionConstraint

Objekt

Steuern der Api-Versionsbeschränkung für den API-Verwaltungsdienst.

Name	Typ	Beschreibung
minApiVersion	string	Beschränken Sie die API-Aufrufe der Steuerebene an den API-Verwaltungsdienst mit der version gleich oder neuer als diesem Wert.

ArmIdWrapper

Objekt

Ein Wrapper für eine ARM-Ressourcen-ID

Name	Typ	Beschreibung
id	string

CertificateConfiguration

Objekt

Zertifikatkonfiguration, die aus nicht vertrauenswürdigen Zwischen- und Stammzertifikaten besteht.

Name	Typ	Beschreibung
certificate	CertificateInformation	Zertifikatinformationen.
certificatePassword	string	Zertifikatkennwort.
encodedCertificate	string	Base64-Codiertes Zertifikat.
storeName	enum: CertificateAuthority Root	Der Speicherort des System.Security.Cryptography.x509certificates.StoreName-Zertifikatspeicherorts. Nur Stamm- und Zertifikatautorität sind gültige Speicherorte.

CertificateInformation

Objekt

SSL-Zertifikatinformationen.

Name	Typ	Beschreibung
expiry	string (date-time)	Ablaufdatum des Zertifikats. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
subject	string	Betreff des Zertifikats.
thumbprint	string	Fingerabdruck des Zertifikats.

CertificateSource

Enumeration

Zertifikatquelle.

Wert	Beschreibung
BuiltIn
Custom
KeyVault
Managed

CertificateStatus

Enumeration

Zertifikatstatus.

Wert	Beschreibung
Completed
Failed
InProgress

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorFieldContract

Objekt

Fehlerfeld-Vertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Lesbare Darstellung des Fehlers auf Eigenschaftsebene.
target	string	Eigenschaftenname.

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Dienstdefinierter Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die in Anforderung gesendet werden, im Falle eines Überprüfungsfehlers.
error.message	string	Lesbare Darstellung des Fehlers.

HostnameConfiguration

Objekt

Konfiguration des benutzerdefinierten Hostnamens.

Name	Typ	Standardwert	Beschreibung
certificate	CertificateInformation		Zertifikatinformationen.
certificatePassword	string		Zertifikatkennwort.
certificateSource	CertificateSource		Zertifikatquelle.
certificateStatus	CertificateStatus		Zertifikatstatus.
defaultSslBinding	boolean	False	Geben Sie true an, um das diesem Hostnamen zugeordnete Zertifikat als Standard-SSL-Zertifikat einzurichten. Wenn ein Client den SNI-Header nicht sendet, ist dies das Zertifikat, das herausfordert wird. Die Eigenschaft ist nützlich, wenn ein Dienst mehrere benutzerdefinierte Hostnamen aktiviert hat und es für das Standard-SSL-Zertifikat entscheiden muss. Die Einstellung wurde nur auf den Hostnamentyp des Gateways angewendet.
encodedCertificate	string		Base64-Codiertes Zertifikat.
hostName	string		Hostname, der für den API-Verwaltungsdienst konfiguriert werden soll.
identityClientId	string		Vom System oder vom Benutzer zugewiesene verwaltete Identitäts-ClientId, die von Azure AD generiert wird, die GET-Zugriff auf den KeyVault hat, der das SSL-Zertifikat enthält.
keyVaultId	string		Url zum Schlüsselschlüsselschlüssel, der das Ssl-Zertifikat enthält. Wenn absolute URL mit Version bereitgestellt wird, funktioniert die automatische Aktualisierung des SSL-Zertifikats nicht. Dazu muss der API-Verwaltungsdienst mit aka.ms/apimmsi konfiguriert werden. Der geheime Schlüssel sollte vom Typ anwendung/x-pkcs12 sein.
negotiateClientCertificate	boolean	False	Geben Sie true an, um das Clientzertifikat immer auf dem Hostnamen auszuhandeln. Der Standardwert ist "false".
type	HostnameType		Hostnamentyp.

HostnameType

Enumeration

Hostnamentyp.

Wert	Beschreibung
DeveloperPortal
Management
Portal
Proxy
Scm

NatGatewayState

Enumeration

Die Eigenschaft kann zum Aktivieren des NAT-Gateways für diesen API-Verwaltungsdienst verwendet werden.

Wert	Beschreibung
Disabled	Nat-Gateway ist für den Dienst deaktiviert.
Enabled	Nat-Gateway ist für den Dienst aktiviert.

PlatformVersion

Enumeration

Compute Platform Version, die den Dienst ausführt.

Wert	Beschreibung
mtv1	Plattform, die den Dienst auf der Multimandanten-V1-Plattform ausführt.
stv1	Plattform, auf der der Dienst auf der V1-Plattform mit einem einzigen Mandanten ausgeführt wird.
stv2	Plattform, auf der der Dienst auf der V2-Plattform des einzelnen Mandanten ausgeführt wird.
undetermined	Die Plattformversion kann nicht bestimmt werden, da keine Computeplattform bereitgestellt wird.

PrivateEndpointServiceConnectionStatus

Enumeration

Der Status der privaten Endpunktverbindung.

Wert	Beschreibung
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objekt

Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.
description	string	Der Grund für die Genehmigung/Ablehnung der Verbindung.
status	PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.

PublicNetworkAccess

Enumeration

Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API-Verwaltungsdienst zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss 'Aktiviert' oder 'Deaktiviert' sein. Wenn "Deaktiviert", sind private Endpunkte die exklusive Zugriffsmethode. Standardwert ist 'Enabled'

Wert	Beschreibung
Disabled
Enabled

RemotePrivateEndpointConnectionWrapper

Objekt

Remote-Private Endpoint Connection-Ressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID für private Endpunktverbindung
name	string	Name der privaten Endpunktverbindung
properties.groupIds	string[]	Alle Gruppen-IDs.
properties.privateEndpoint	ArmIdWrapper	Die Ressource des privaten Endpunkts.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
properties.provisioningState	string	Der Bereitstellungsstatus der privaten Endpunktverbindungsressource.
type	string	Ressourcentyp für private Endpunktverbindung

SkuType

Enumeration

Name der Sku.

Wert	Beschreibung
Basic	Grundlegende SKU der API-Verwaltung.
Consumption	Verbrauchs-SKU der API-Verwaltung.
Developer	Entwickler-SKU der API-Verwaltung.
Isolated	Isolierte SKU der API-Verwaltung.
Premium	Premium-SKU der API-Verwaltung.
Standard	Standard-SKU der API-Verwaltung.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserIdentityProperties

Objekt

Name	Typ	Beschreibung
clientId	string	Die Client-ID der vom Benutzer zugewiesenen Identität.
principalId	string	Die Prinzipal-ID der vom Benutzer zugewiesenen Identität.

VirtualNetworkConfiguration

Objekt

Konfiguration eines virtuellen Netzwerks, für das der API-Verwaltungsdienst bereitgestellt wird.

Name	Typ	Beschreibung
subnetResourceId	string pattern: ^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$	Die vollständige Ressourcen-ID eines Subnetzes in einem virtuellen Netzwerk, in dem der API-Verwaltungsdienst bereitgestellt wird.
subnetname	string	Der Name des Subnetzes.
vnetid	string	Die ID des virtuellen Netzwerks. Dies ist in der Regel eine GUID. Erwartet standardmäßig eine NULL-GUID.

VirtualNetworkType

Enumeration

Der Typ des VPN, in dem der API-Verwaltungsdienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API-Verwaltungsdienst nicht Teil eines virtuellen Netzwerks ist, extern bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das über einen internetgerichteten Endpunkt verfügt, und "Intern" bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das nur über einen Intranet-Endpunkt verfügt.

Wert	Beschreibung
External	Der Dienst ist Teil des virtuellen Netzwerks und kann über das Internet zugänglich sein.
Internal	Der Dienst ist Teil des virtuellen Netzwerks und kann nur über das virtuelle Netzwerk zugänglich sein.
None	Der Dienst ist nicht Teil eines virtuellen Netzwerks.

Freigeben über

Api Management Service - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementUpdateServiceDisableTls10

Beispielanforderung

Beispiel für eine Antwort

ApiManagementUpdateServicePublisherDetails

Beispielanforderung

Beispiel für eine Antwort

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApiManagementServiceUpdateParameters

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

CertificateSource

CertificateStatus

createdByType

ErrorFieldContract

ErrorResponse

HostnameConfiguration

HostnameType

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType

Zusätzliche Ressourcen