Delen via

ApiOperation interface

  • Referentie
Pakket:
@azure/arm-apimanagement

Interface die een ApiOperation vertegenwoordigt.

Methoden

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

Hiermee maakt u een nieuwe bewerking in de API of werkt u een bestaande bewerking bij.
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

Hiermee verwijdert u de opgegeven bewerking in de API.
get(string, string, string, string, ApiOperationGetOptionalParams)

Hiermee haalt u de details op van de API-bewerking die is opgegeven door de id.
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

Hiermee haalt u de versie van de entiteitsstatus (Etag) op van de API-bewerking die is opgegeven door de id.
listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Geeft een verzameling van de bewerkingen voor de opgegeven API weer.
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

Updates de details van de bewerking in de API die is opgegeven door de id.

Methodedetails

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

Hiermee maakt u een nieuwe bewerking in de API of werkt u een bestaande bewerking bij.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management service.

apiId

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

operationId

string

Bewerkings-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.

parameters
OperationContract

Parameters maken.

options
ApiOperationCreateOrUpdateOptionalParams

De optiesparameters.

Retouren

Promise<ApiOperationCreateOrUpdateResponse>

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

Hiermee verwijdert u de opgegeven bewerking in de API.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management service.

apiId

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

operationId

string

Bewerkings-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.

ifMatch

string

ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.

options
ApiOperationDeleteOptionalParams

De optiesparameters.

Retouren

Promise<void>

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

Hiermee haalt u de details op van de API-bewerking die is opgegeven door de id.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management service.

apiId

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

operationId

string

Bewerkings-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.

options
ApiOperationGetOptionalParams

De optiesparameters.

Retouren

Promise<ApiOperationGetResponse>

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

Hiermee haalt u de versie van de entiteitsstatus (Etag) op van de API-bewerking die is opgegeven door de id.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management service.

apiId

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

operationId

string

Bewerkings-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.

options
ApiOperationGetEntityTagOptionalParams

De optiesparameters.

Retouren

Promise<ApiOperationGetEntityTagHeaders>

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Geeft een verzameling van de bewerkingen voor de opgegeven API weer.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management service.

apiId

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

options
ApiOperationListByApiOptionalParams

De optiesparameters.

Retouren

PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

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

Updates de details van de bewerking in de API die is opgegeven door de id.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management service.

apiId

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

operationId

string

Bewerkings-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.

ifMatch

string

ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.

parameters
OperationUpdateContract

Parameters voor het bijwerken van API-bewerkingen.

options
ApiOperationUpdateOptionalParams

De optiesparameters.

Retouren

Promise<ApiOperationUpdateResponse>