Freigeben über


Gateway Api - Delete

Löscht die angegebene API aus dem angegebenen Gateway.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
apiId
path True

string

API-Bezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.

gatewayId
path True

string

Gatewayentitätsbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein. Darf nicht über den Wert "verwaltet" verfügen

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

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

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

DIE API wurde erfolgreich aus dem Gateway entfernt

204 No Content

DIE API wurde von der vorherigen Anforderung erfolgreich entfernt oder ist im Gateway 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

ApiManagementDeleteGatewayApi

Beispielanforderung

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

Beispiel für eine Antwort

Definitionen

Name Beschreibung
ErrorFieldContract

Fehlerfeldvertrag.

ErrorResponse

Fehlerantwort.

ErrorFieldContract

Fehlerfeldvertrag.

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 im Falle eines Überprüfungsfehlers gesendet werden.

error.message

string

Lesbare Darstellung des Fehlers.