Freigeben über


Api Schema - Delete

Löscht die Schemakonfiguration in der API.

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}?api-version=2024-05-01
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}?force={force}&api-version=2024-05-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
apiId
path True

string

minLength: 1
maxLength: 256
pattern: ^[^*#&+:<>?]+$

API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

schemaId
path True

string

minLength: 1
maxLength: 80

Schema-ID-ID-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

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 (uuid)

Die ID des Zielabonnements. Der Wert muss eine UUID sein.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

force
query

boolean

Wenn true alle Verweise auf das Schema entfernt, bevor Sie es löschen.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-Match True

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

Antworten

Name Typ Beschreibung
200 OK

Die Schemakonfiguration auf API-Ebene wurde erfolgreich gelöscht.

204 No Content

Die Schemakonfiguration auf API-Ebene wurde erfolgreich gelöscht.

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

ApiManagementDeleteApiSchema

Beispielanforderung

DELETE https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d5b28d1f7fab116c282650/schemas/59d5b28e1f7fab116402044e?api-version=2024-05-01

Beispiel für eine Antwort

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.