Api Management Service - Delete

Referenz

Dienst:: API Management

API-Version:: 2021-08-01

Löscht einen vorhandenen API Management-Dienst.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
serviceName	path	True	string	Der Name des API Management-Diensts. RegEx-Muster: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK		Der Dienst wurde erfolgreich gelöscht.
202 Accepted	ApiManagementServiceResource	Die Dienstlöschanforderung wurde akzeptiert.
204 No Content		Der Dienst ist nicht vorhanden.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementServiceDeleteService

Beispielanforderung

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

import com.azure.core.util.Context;

/** Samples for ApiManagementService Delete. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementServiceDeleteService.json
     */
    /**
     * Sample code: ApiManagementServiceDeleteService.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementServiceDeleteService(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiManagementServices().delete("rg1", "apimService1", Context.NONE);
    }
}

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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_service_delete_service.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_delete(
        resource_group_name="rg1",
        service_name="apimService1",
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementServiceDeleteService.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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementServiceDeleteService.json
func ExampleServiceClient_BeginDelete() {
	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().BeginDelete(ctx, "rg1", "apimService1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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 Deletes an existing API Management service.
 *
 * @summary Deletes an existing API Management service.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementServiceDeleteService.json
 */
async function apiManagementServiceDeleteService() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginDeleteAndWait(
    resourceGroupName,
    serviceName
  );
  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 System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementServiceDeleteService.json
// this example is just showing the usage of "ApiManagementService_Delete" 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://video2.skills-academy.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
await apiManagementService.DeleteAsync(WaitUntil.Completed);

Console.WriteLine($"Succeeded");

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/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2021-08-01

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "location": "West US",
  "etag": "AAAAAAFfhHY=",
  "properties": {
    "publisherEmail": "contoso@live.com",
    "publisherName": "Microsoft",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "Deleting",
    "createdAtUtc": "2016-12-20T19:41:21.5823069Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-westus-01.regional.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.XX.XXX.168"
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/BlockVNETSamir/subnets/default"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  }
}

Statuscode:: 204

Statuscode:: 200

Definitionen

Name	Beschreibung
AdditionalLocation	Beschreibung eines zusätzlichen API Management Ressourcenspeicherorts.
ApiManagementServiceIdentity	Identitätseigenschaften der Api Management-Dienstressource.
ApiManagementServiceResource	Eine einzelne API Management Dienstressource in "List" oder "Get response".
ApiManagementServiceSkuProperties	API Management SKU-Eigenschaften der Dienstressource.
ApimIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
ApiVersionConstraint	Versionseinschränkung der Steuerungsebenen-API für den API Management-Dienst.
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	Fehler Feldvertrag.
ErrorResponse	Fehlerantwort.
HostnameConfiguration	Konfiguration des benutzerdefinierten Hostnamens.
HostnameType	Hostnamentyp.
PlatformVersion	Computeplattformversion, die den Dienst ausführt.
PrivateEndpointServiceConnectionStatus	Die verbindung mit dem privaten Endpunkt status.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Verbindungsstatus zwischen Dienstconsumer und Anbieter.
PublicNetworkAccess	Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API Management-Dienst zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss "Aktiviert" oder "Deaktiviert" sein. Bei "Disabled" sind private Endpunkte die exklusive Zugriffsmethode. Der Standardwert ist "Enabled".
RemotePrivateEndpointConnectionWrapper	Verbindungsressource des privaten Remoteendpunkts.
SkuType	Name der SKU.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UserIdentityProperties
VirtualNetworkConfiguration	Konfiguration eines virtuellen Netzwerks, in dem API Management Dienst bereitgestellt wird.
VirtualNetworkType	Der VPN-Typ, in dem API Management Dienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API Management-Dienst nicht Teil eines Virtual Network ist. Extern bedeutet, dass die API Management Bereitstellung innerhalb einer Virtual Network eingerichtet ist, die über einen Endpunkt mit Internetzugriff verfügt, und Intern bedeutet, dass API Management die Bereitstellung wird in einem Virtual Network eingerichtet, der nur über einen Intranetendpunkt verfügt.

AdditionalLocation

Beschreibung eines zusätzlichen API Management Ressourcenspeicherorts.

Name	Typ	Standardwert	Beschreibung
disableGateway	boolean	False	Die Eigenschaft ist nur für einen Api Management-Dienst gültig, 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 Management-Diensts in der Region.
location	string		Der Standortname der zusätzlichen Region unter den Azure-Rechenzentrumsregionen.
platformVersion	PlatformVersion		Computeplattformversion, die den Dienst ausführt.
privateIPAddresses	string[]		Private statische LASTENausgleichs-IP-Adressen des API Management Diensts, der in einem internen Virtual Network an einem bestimmten zusätzlichen Speicherort bereitgestellt wird. Nur für Basic-, Standard-, Premium- und Isolierte SKU verfügbar.
publicIPAddresses	string[]		Öffentliche ip-Adressen mit statischem Lastenausgleich des API Management-Diensts am zusätzlichen Standort. Nur für Basic-, Standard-, Premium- und Isolierte SKU verfügbar.
publicIpAddressId	string		Öffentliche Standard-SKU IP V4-basierte IP-Adresse, die Virtual Network bereitgestellten Dienst am Standort zugeordnet werden soll. Wird nur für Premium-SKU unterstützt, die in Virtual Network bereitgestellt wird.
sku	ApiManagementServiceSkuProperties		SKU-Eigenschaften des API Management-Diensts.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfiguration des virtuellen Netzwerks für den Standort.
zones	string[]		Eine Liste der Verfügbarkeitszonen, die angibt, wo die Ressource herkommen muss.

ApiManagementServiceIdentity

Identitätseigenschaften der Api Management-Dienstressource.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der Identität.
tenantId	string	Die Clientmandanten-ID der Identität.
type	ApimIdentityType	Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener 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 Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiManagementServiceResource

Eine einzelne API Management Dienstressource 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 Management-Diensts.
location	string		Ressourcenspeicherort
name	string		Name der Ressource.
properties.additionalLocations	AdditionalLocation[]		Zusätzliche Rechenzentrumsstandorte des API Management-Diensts.
properties.apiVersionConstraint	ApiVersionConstraint		Versionseinschränkung der Steuerungsebenen-API für den API Management-Dienst.
properties.certificates	CertificateConfiguration[]		Liste der Zertifikate, die im API Management-Dienst installiert werden müssen. Die maximale Anzahl von unterstützten Zertifikaten, die installiert werden können, beträgt 10.
properties.createdAtUtc	string		Erstellungsdatum des API Management-Diensts. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.customProperties	object		Benutzerdefinierte Eigenschaften des API Management-Diensts. Durch die Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` wird die TLS_RSA_WITH_3DES_EDE_CBC_SHA für alle TLS(1.0, 1.1 und 1.2) deaktiviert. Die Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` kann verwendet werden, um nur TLS 1.1 zu deaktivieren. Die Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` kann verwendet werden, um TLS 1.0 für einen API Management-Dienst zu deaktivieren. Die 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. Die 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. Die Einstellung `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` kann verwendet werden, um das HTTP2-Protokoll für einen API Management-Dienst zu aktivieren. Wenn Sie keine dieser Eigenschaften beim PATCH-Vorgang angeben, werden die Werte der ausgelassenen Eigenschaften auf die Standardwerte zurückgesetzt. Für alle Einstellungen mit Ausnahme von Http2 ist `True` der Standardwert, wenn der Dienst am oder vor dem 1. April 2018 erstellt wurde und `False` andernfalls. Der Standardwert der Http2-Einstellung ist `False`. Sie können jede der folgenden Verschlüsselungen mithilfe der 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 für interne Plattformkomponenten erforderlich sind: 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 Management-Diensts.
properties.disableGateway	boolean	False	Die Eigenschaft ist nur für einen Api Management-Dienst gültig, der an mehreren Standorten bereitgestellt wird. Dies kann verwendet werden, um das Gateway in master Region zu deaktivieren.
properties.enableClientCertificate	boolean	False	Eigenschaft, die nur für den Verbrauchs-SKU-Dienst verwendet werden soll. Dadurch wird erzwungen, dass bei jeder Anforderung an das Gateway ein Clientzertifikat angezeigt wird. Dies ermöglicht auch die Authentifizierung des Zertifikats in der Richtlinie auf dem Gateway.
properties.gatewayRegionalUrl	string		Gateway-URL des API Management-Diensts in der Standardregion.
properties.gatewayUrl	string		Gateway-URL des API Management-Diensts.
properties.hostnameConfigurations	HostnameConfiguration[]		Konfiguration des benutzerdefinierten Hostnamens des API Management-Diensts.
properties.managementApiUrl	string		Verwaltungs-API-Endpunkt-URL des API Management-Diensts.
properties.notificationSenderEmail	string		Email Adresse, von der die Benachrichtigung gesendet wird.
properties.platformVersion	PlatformVersion		Computeplattformversion, die den Dienst an diesem Speicherort ausführt.
properties.portalUrl	string		Endpunkt-URL des API Management-Diensts des Herausgeberportals.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Liste der Privaten Endpunktverbindungen dieses Diensts.
properties.privateIPAddresses	string[]		Ip-Adressen mit privatem statischem Lastenausgleich des API Management-Diensts in der primären Region, die in einem internen Virtual Network bereitgestellt wird. Nur für Basic-, Standard-, Premium- und Isolierte SKU verfügbar.
properties.provisioningState	string		Der aktuelle Bereitstellungsstatus des API Management Dienst, der wie folgt aussehen kann: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.publicIPAddresses	string[]		Öffentliche ip-Adressen mit statischem Lastenausgleich des API Management-Diensts in der primären Region. Nur für Basic-, Standard-, Premium- und Isolierte SKU verfügbar.
properties.publicIpAddressId	string		Public Standard SKU IP V4-basierte IP-Adresse, die Virtual Network bereitgestellten Dienst in der Region zugeordnet werden soll. Wird nur für Entwickler- und Premium-SKU unterstützt, die in Virtual Network bereitgestellt wird.
properties.publicNetworkAccess	PublicNetworkAccess		Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API Management-Dienst zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss "Aktiviert" oder "Deaktiviert" sein. Bei "Disabled" sind private Endpunkte die exklusive Zugriffsmethode. Der Standardwert ist "Enabled".
properties.publisherEmail	string		Herausgeber-E-Mail.
properties.publisherName	string		Herausgebername.
properties.restore	boolean	False	Wiederherstellen des Api Management-Diensts, 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 Management-Diensts.
properties.targetProvisioningState	string		Der Bereitstellungsstatus des API Management Diensts, auf den der für den Dienst gestartete Vorgang mit langer Ausführungszeit ausgerichtet ist.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Virtuelle Netzwerkkonfiguration des API Management-Diensts.
properties.virtualNetworkType	VirtualNetworkType	None	Der VPN-Typ, in dem API Management Dienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API Management-Dienst nicht Teil eines Virtual Network ist. Extern bedeutet, dass die API Management Bereitstellung innerhalb einer Virtual Network eingerichtet ist, die über einen Endpunkt mit Internetzugriff verfügt, und Intern bedeutet, dass API Management die Bereitstellung wird in einem Virtual Network eingerichtet, der nur über einen Intranetendpunkt verfügt.
sku	ApiManagementServiceSkuProperties		SKU-Eigenschaften des API Management-Diensts.
systemData	systemData		Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
tags	object		Ressourcentags.
type	string		Der Ressourcentyp für API Management Ressource ist auf Microsoft.ApiManagement festgelegt.
zones	string[]		Eine Liste der Verfügbarkeitszonen, die angibt, wo die Ressource herkommen muss.

ApiManagementServiceSkuProperties

API Management SKU-Eigenschaften der Dienstressource.

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

ApimIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

Name	Typ	Beschreibung
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

Versionseinschränkung der Steuerungsebenen-API für den API Management-Dienst.

Name	Typ	Beschreibung
minApiVersion	string	Beschränken Sie die API-Aufrufe der Steuerungsebene an API Management Dienst, deren Version gleich oder höher ist.

ArmIdWrapper

Ein Wrapper für eine ARM-Ressourcen-ID

Name	Typ	Beschreibung
id	string

CertificateConfiguration

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 Zertifikatspeicherort System.Security.Cryptography.x509certificates.StoreName. Nur Root und CertificateAuthority sind gültige Speicherorte.

CertificateInformation

SSL-Zertifikatinformationen.

Name	Typ	Beschreibung
expiry	string	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

Zertifikatquelle.

Name	Typ	Beschreibung
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

Zertifikatstatus.

Name	Typ	Beschreibung
Completed	string
Failed	string
InProgress	string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorFieldContract

Fehler Feldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte 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 der Anforderung gesendet werden, im Falle eines Validierungsfehlers.
error.message	string	Lesbare Darstellung des Fehlers.

HostnameConfiguration

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 SSL-Standardzertifikat einzurichten. Wenn ein Client den SNI-Header nicht sendet, ist dies das Zertifikat, das angefordert wird. Die -Eigenschaft ist nützlich, wenn für einen Dienst mehrere benutzerdefinierte Hostnamen aktiviert sind und er sich für das SSL-Standardzertifikat entscheiden muss. Die Einstellung, die nur auf den Proxy-Hostnamentyp angewendet wird.
encodedCertificate	string		Base64-codiertes Zertifikat.
hostName	string		Hostname, der für den Api Management-Dienst konfiguriert werden soll.
identityClientId	string		Client-ID der system- oder benutzerseitig zugewiesenen verwalteten Identität, wie von Azure AD generiert, die GET-Zugriff auf den keyVault mit dem SSL-Zertifikat hat.
keyVaultId	string		Url zum KeyVault-Geheimnis, das das Ssl-Zertifikat enthält. Wenn eine absolute URL mit version angegeben wird, funktioniert das automatische Aktualisieren des SSL-Zertifikats nicht. Dazu muss der Api Management-Dienst mit aka.ms/apimmsi konfiguriert werden. Das Geheimnis sollte vom Typ application/x-pkcs12 sein.
negotiateClientCertificate	boolean	False	Geben Sie true an, um immer das Clientzertifikat für den Hostnamen auszuhandeln. Der Standardwert ist false.
type	HostnameType		Hostnamentyp.

HostnameType

Hostnamentyp.

Name	Typ	Beschreibung
DeveloperPortal	string
Management	string
Portal	string
Proxy	string
Scm	string

PlatformVersion

Computeplattformversion, die den Dienst ausführt.

Name	Typ	Beschreibung
mtv1	string	Plattform, auf der der Dienst auf mehrinstanzenfähiger V1-Plattform ausgeführt wird.
stv1	string	Plattform, auf der der Dienst auf der Einzelmandanten-V1-Plattform ausgeführt wird.
stv2	string	Plattform, auf der der Dienst auf der Einzelmandanten-V2-Plattform ausgeführt wird.
undetermined	string	Die Plattformversion kann nicht bestimmt werden, da die Computeplattform nicht bereitgestellt wird.

PrivateEndpointServiceConnectionStatus

Die verbindung mit dem privaten Endpunkt status.

Name	Typ	Beschreibung
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Verbindungsstatus zwischen Dienstconsumer und Anbieter.

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer 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

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

Name	Typ	Beschreibung
Disabled	string
Enabled	string

RemotePrivateEndpointConnectionWrapper

Verbindungsressource des privaten Remoteendpunkts.

Name	Typ	Beschreibung
id	string	Verbindungsressourcen-ID des privaten Endpunkts
name	string	Verbindungsname des privaten Endpunkts
properties.groupIds	string[]	Alle Gruppen-IDs.
properties.privateEndpoint	ArmIdWrapper	Die Ressource des privaten Endpunkts.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Verbindungsstatus zwischen Dienstconsumer und Anbieter.
properties.provisioningState	string	Der Bereitstellungsstatus der Verbindungsressource des privaten Endpunkts.
type	string	Verbindungsressourcentyp für private Endpunkte

SkuType

Name der SKU.

Name	Typ	Beschreibung
Basic	string	Grundlegende SKU von Api Management.
Consumption	string	Verbrauchs-SKU von Api Management.
Developer	string	Entwickler-SKU von Api Management.
Isolated	string	Isolierte SKU von Api Management.
Premium	string	Premium-SKU von Api Management.
Standard	string	Standard-SKU von Api Management.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	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	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

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

Konfiguration eines virtuellen Netzwerks, in dem API Management Dienst bereitgestellt wird.

Name	Typ	Beschreibung
subnetResourceId	string	Die vollständige Ressourcen-ID eines Subnetzes in einem virtuellen Netzwerk, in dem der API Management Dienst bereitgestellt werden soll.
subnetname	string	Der Name des Teilnetzes.
vnetid	string	Die ID des virtuellen Netzwerks. Dies ist in der Regel eine GUID. Erwartet standardmäßig eine NULL-GUID.

VirtualNetworkType

Der VPN-Typ, in dem API Management Dienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API Management-Dienst nicht Teil eines Virtual Network ist. Extern bedeutet, dass die API Management Bereitstellung innerhalb einer Virtual Network eingerichtet ist, die über einen Endpunkt mit Internetzugriff verfügt, und Intern bedeutet, dass API Management die Bereitstellung wird in einem Virtual Network eingerichtet, der nur über einen Intranetendpunkt verfügt.

Name	Typ	Beschreibung
External	string	Der Dienst ist Teil von Virtual Network und über das Internet zugänglich.
Internal	string	Der Dienst ist Teil von Virtual Network und nur innerhalb des virtuellen Netzwerks zugänglich.
None	string	Der Dienst ist nicht Teil einer Virtual Network.