ApiOperation interface

Paket:

@azure/arm-apimanagement

Antarmuka yang mewakili ApiOperation.

Metode

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)	Membuat operasi baru di API atau memperbarui yang sudah ada.
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)	Menghapus operasi yang ditentukan dalam API.
get(string, string, string, string, ApiOperationGetOptionalParams)	Mendapatkan detail Operasi API yang ditentukan oleh pengidentifikasinya.
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)	Mendapatkan versi status entitas (Etag) dari operasi API yang ditentukan oleh pengidentifikasinya.
listByApi(string, string, string, ApiOperationListByApiOptionalParams)	Mencantumkan kumpulan operasi untuk API yang ditentukan.
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)	Memperbarui detail operasi dalam API yang ditentukan oleh pengidentifikasinya.

Detail Metode

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

Membuat operasi baru di API atau memperbarui yang sudah ada.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

apiId

string

Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

operationId

string

Pengidentifikasi operasi dalam API. Harus unik dalam instans layanan API Management saat ini.

parameters

OperationContract

Buat parameter.

options

ApiOperationCreateOrUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<ApiOperationCreateOrUpdateResponse>

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

Menghapus operasi yang ditentukan dalam API.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

apiId

string

Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

operationId

string

Pengidentifikasi operasi dalam API. Harus unik dalam instans layanan API Management saat ini.

ifMatch

string

ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.

options

ApiOperationDeleteOptionalParams

Parameter opsi.

Mengembalikan

Promise<void>

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

Mendapatkan detail Operasi API yang ditentukan oleh pengidentifikasinya.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

apiId

string

Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

operationId

string

Pengidentifikasi operasi dalam API. Harus unik dalam instans layanan API Management saat ini.

options

ApiOperationGetOptionalParams

Parameter opsi.

Mengembalikan

Promise<ApiOperationGetResponse>

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

Mendapatkan versi status entitas (Etag) dari operasi API yang ditentukan oleh pengidentifikasinya.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

apiId

string

Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

operationId

string

Pengidentifikasi operasi dalam API. Harus unik dalam instans layanan API Management saat ini.

options

ApiOperationGetEntityTagOptionalParams

Parameter opsi.

Mengembalikan

Promise<ApiOperationGetEntityTagHeaders>

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Mencantumkan kumpulan operasi untuk API yang ditentukan.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

apiId

string

Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

options

ApiOperationListByApiOptionalParams

Parameter opsi.

Mengembalikan

PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

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

Memperbarui detail operasi dalam API yang ditentukan oleh pengidentifikasinya.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

apiId

string

Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

operationId

string

Pengidentifikasi operasi dalam API. Harus unik dalam instans layanan API Management saat ini.

ifMatch

string

ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.

parameters

OperationUpdateContract

Parameter Pembaruan Operasi API.

options

ApiOperationUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<ApiOperationUpdateResponse>