Dela via

ApiOperation interface

  • Referens
Paket:
@azure/arm-apimanagement

Gränssnitt som representerar en ApiOperation.

Metoder

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

Skapar en ny åtgärd i API:et eller uppdaterar en befintlig.
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

Tar bort den angivna åtgärden i API:et.
get(string, string, string, string, ApiOperationGetOptionalParams)

Hämtar information om API-åtgärden som anges av dess identifierare.
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

Hämtar entitetstillståndsversionen (Etag) för API-åtgärden som anges av dess identifierare.
listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Visar en samling åtgärder för det angivna API:et.
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

Uppdateringar information om åtgärden i API:et som anges av dess identifierare.

Metodinformation

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

Skapar en ny åtgärd i API:et eller uppdaterar en befintlig.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

operationId

string

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.

parameters
OperationContract

Skapa parametrar.

options
ApiOperationCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ApiOperationCreateOrUpdateResponse>

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

Tar bort den angivna åtgärden i API:et.

function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, options?: ApiOperationDeleteOptionalParams): Promise<void>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

operationId

string

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

options
ApiOperationDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

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

Hämtar information om API-åtgärden som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

operationId

string

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.

options
ApiOperationGetOptionalParams

Alternativparametrarna.

Returer

Promise<ApiOperationGetResponse>

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

Hämtar entitetstillståndsversionen (Etag) för API-åtgärden som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

operationId

string

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.

options
ApiOperationGetEntityTagOptionalParams

Alternativparametrarna.

Returer

Promise<ApiOperationGetEntityTagHeaders>

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Visar en samling åtgärder för det angivna API:et.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

options
ApiOperationListByApiOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

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

Uppdateringar information om åtgärden i API:et som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

apiId

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.

operationId

string

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management tjänstinstansen.

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

parameters
OperationUpdateContract

Parametrar för API-åtgärdsuppdatering.

options
ApiOperationUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ApiOperationUpdateResponse>