Freigeben über

ApiOperation interface

  • Referenz
Paket:
@azure/arm-apimanagement

Schnittstelle, die eine ApiOperation darstellt.

Methoden

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)

Erstellt einen neuen Vorgang in der API oder aktualisiert einen bereits vorhandenen
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

Löscht den angegebenen Vorgang aus der API
get(string, string, string, string, ApiOperationGetOptionalParams)

Ruft die Details des API-Vorgangs ab, der durch seinen Bezeichner angegeben wird.
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

Ruft die Entitätsstatusversion (Etag) des API-Vorgangs ab, der durch seinen Bezeichner angegeben wird.
listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Listet eine Auflistung der Vorgänge für die angegebene API auf
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

Updates die Details des Vorgangs in der API, die durch den Bezeichner angegeben wird.

Details zur Methode

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)

Erstellt einen neuen Vorgang in der API oder aktualisiert einen bereits vorhandenen

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, parameters: OperationContract, options?: ApiOperationCreateOrUpdateOptionalParams): Promise<ApiOperationCreateOrUpdateResponse>

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. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss im aktuellen API Management Dienst instance eindeutig sein.

parameters
OperationContract

Erstellen sie Parameter.

options
ApiOperationCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiOperationCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

Löscht den angegebenen Vorgang aus der API

function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, options?: ApiOperationDeleteOptionalParams): 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. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. 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 bedingungslose Aktualisierung sein.

options
ApiOperationDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, string, ApiOperationGetOptionalParams)

Ruft die Details des API-Vorgangs ab, der durch seinen Bezeichner angegeben wird.

function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetOptionalParams): Promise<ApiOperationGetResponse>

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. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss im aktuellen API Management Dienst instance eindeutig sein.

options
ApiOperationGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiOperationGetResponse>

getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

Ruft die Entitätsstatusversion (Etag) des API-Vorgangs ab, der durch seinen Bezeichner angegeben wird.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetEntityTagOptionalParams): Promise<ApiOperationGetEntityTagHeaders>

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. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss im aktuellen API Management Dienst instance eindeutig sein.

options
ApiOperationGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiOperationGetEntityTagHeaders>

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Listet eine Auflistung der Vorgänge für die angegebene API auf

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], 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. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.

options
ApiOperationListByApiOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

Updates die Details des Vorgangs in der API, die durch den Bezeichner angegeben wird.

function update(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: ApiOperationUpdateOptionalParams): Promise<ApiOperationUpdateResponse>

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. Die nicht aktuelle Revision weist ;rev=n als Suffix auf, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. 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 bedingungslose Aktualisierung sein.

parameters
OperationUpdateContract

API-Vorgangsupdateparameter.

options
ApiOperationUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiOperationUpdateResponse>