ApiSchema interface

Paket:

@azure/arm-apimanagement

Schnittstelle, die ein ApiSchema darstellt.

Methoden

beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)	Erstellt oder aktualisiert die Schemakonfiguration für die API
beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)	Erstellt oder aktualisiert die Schemakonfiguration für die API
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)	Löscht die Schemakonfiguration aus der API
get(string, string, string, string, ApiSchemaGetOptionalParams)	Ruft die Schemakonfiguration auf API-Ebene ab
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)	Ruft die Etag-Version (Entity State) des Schemas ab, das durch den Bezeichner angegeben wird.
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)	Ruft die Schemakonfiguration auf API-Ebene ab

Details zur Methode

beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Erstellt oder aktualisiert die Schemakonfiguration für die API

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>

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.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

schemaId

string

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

parameters

SchemaContract

Der anzuwendende Schemainhalt.

options

ApiSchemaCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Erstellt oder aktualisiert die Schemakonfiguration für die API

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>

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.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

schemaId

string

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

parameters

SchemaContract

Der anzuwendende Schemainhalt.

options

ApiSchemaCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiSchemaCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)

Löscht die Schemakonfiguration aus der API

function delete(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, ifMatch: string, options?: ApiSchemaDeleteOptionalParams): 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.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

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

ApiSchemaDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, string, ApiSchemaGetOptionalParams)

Ruft die Schemakonfiguration auf API-Ebene ab

function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>

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.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

schemaId

string

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

options

ApiSchemaGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiSchemaGetResponse>

getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>

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.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

schemaId

string

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

options

ApiSchemaGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiSchemaGetEntityTagHeaders>

listByApi(string, string, string, ApiSchemaListByApiOptionalParams)

Ruft die Schemakonfiguration auf API-Ebene ab

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], 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.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

options

ApiSchemaListByApiOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>