Freigeben über


GlobalSchema interface

Schnittstelle, die ein GlobalSchema darstellt.

Methoden

beginCreateOrUpdate(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)

Erstellt ein neues oder aktualisiert das vorhandene angegebene Schema des API Management-Diensts instance.

beginCreateOrUpdateAndWait(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)

Erstellt ein neues oder aktualisiert das vorhandene angegebene Schema des API Management-Diensts instance.

delete(string, string, string, string, GlobalSchemaDeleteOptionalParams)

Löscht ein bestimmtes Schema.

get(string, string, string, GlobalSchemaGetOptionalParams)

Ruft die Details des Schemas ab, das durch den Bezeichner angegeben wird.

getEntityTag(string, string, string, GlobalSchemaGetEntityTagOptionalParams)

Ruft die Etag-Version (Entity State) des Schemas ab, das durch den Bezeichner angegeben wird.

listByService(string, string, GlobalSchemaListByServiceOptionalParams)

Listet eine Auflistung von Schemas auf, die beim Dienst instance registriert sind.

Details zur Methode

beginCreateOrUpdate(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)

Erstellt ein neues oder aktualisiert das vorhandene angegebene Schema des API Management-Diensts instance.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, schemaId: string, parameters: GlobalSchemaContract, options?: GlobalSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<GlobalSchemaCreateOrUpdateResponse>, GlobalSchemaCreateOrUpdateResponse>>

Parameter

resourceGroupName

string

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

serviceName

string

Der Name des API Management-Diensts.

schemaId

string

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

parameters
GlobalSchemaContract

Erstellen oder Aktualisieren von Parametern

options
GlobalSchemaCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

beginCreateOrUpdateAndWait(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)

Erstellt ein neues oder aktualisiert das vorhandene angegebene Schema des API Management-Diensts instance.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, schemaId: string, parameters: GlobalSchemaContract, options?: GlobalSchemaCreateOrUpdateOptionalParams): Promise<GlobalSchemaCreateOrUpdateResponse>

Parameter

resourceGroupName

string

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

serviceName

string

Der Name des API Management-Diensts.

schemaId

string

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

parameters
GlobalSchemaContract

Erstellen oder Aktualisieren von Parametern

options
GlobalSchemaCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

delete(string, string, string, string, GlobalSchemaDeleteOptionalParams)

Löscht ein bestimmtes Schema.

function delete(resourceGroupName: string, serviceName: string, schemaId: string, ifMatch: string, options?: GlobalSchemaDeleteOptionalParams): Promise<void>

Parameter

resourceGroupName

string

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

serviceName

string

Der Name des API Management-Diensts.

schemaId

string

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

ifMatch

string

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

options
GlobalSchemaDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, GlobalSchemaGetOptionalParams)

Ruft die Details des Schemas ab, das durch den Bezeichner angegeben wird.

function get(resourceGroupName: string, serviceName: string, schemaId: string, options?: GlobalSchemaGetOptionalParams): Promise<GlobalSchemaGetResponse>

Parameter

resourceGroupName

string

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

serviceName

string

Der Name des API Management-Diensts.

schemaId

string

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

options
GlobalSchemaGetOptionalParams

Die Optionsparameter.

Gibt zurück

getEntityTag(string, string, string, GlobalSchemaGetEntityTagOptionalParams)

Ruft die Etag-Version (Entity State) des Schemas ab, das durch den Bezeichner angegeben wird.

function getEntityTag(resourceGroupName: string, serviceName: string, schemaId: string, options?: GlobalSchemaGetEntityTagOptionalParams): Promise<GlobalSchemaGetEntityTagHeaders>

Parameter

resourceGroupName

string

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

serviceName

string

Der Name des API Management-Diensts.

schemaId

string

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

options
GlobalSchemaGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

listByService(string, string, GlobalSchemaListByServiceOptionalParams)

Listet eine Auflistung von Schemas auf, die beim Dienst instance registriert sind.

function listByService(resourceGroupName: string, serviceName: string, options?: GlobalSchemaListByServiceOptionalParams): PagedAsyncIterableIterator<GlobalSchemaContract, GlobalSchemaContract[], PageSettings>

Parameter

resourceGroupName

string

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

serviceName

string

Der Name des API Management-Diensts.

options
GlobalSchemaListByServiceOptionalParams

Die Optionsparameter.

Gibt zurück