ApiPolicy interface

Paket:

@azure/arm-apimanagement

Antarmuka yang mewakili ApiPolicy.

Metode

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)	Membuat atau memperbarui konfigurasi kebijakan untuk API.
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)	Menghapus konfigurasi kebijakan di Api.
get(string, string, string, string, ApiPolicyGetOptionalParams)	Dapatkan konfigurasi kebijakan di tingkat API.
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)	Mendapatkan versi status entitas (Etag) dari kebijakan API yang ditentukan oleh pengidentifikasinya.
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)	Dapatkan konfigurasi kebijakan di tingkat API.

Detail Metode

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)

Membuat atau memperbarui konfigurasi kebijakan untuk API.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, parameters: PolicyContract, options?: ApiPolicyCreateOrUpdateOptionalParams): Promise<ApiPolicyCreateOrUpdateResponse>

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.

policyId

string

Pengidentifikasi Kebijakan.

parameters

PolicyContract

Konten kebijakan yang akan diterapkan.

options

ApiPolicyCreateOrUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<ApiPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)

Menghapus konfigurasi kebijakan di Api.

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

policyId

string

Pengidentifikasi Kebijakan.

ifMatch

string

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

options

ApiPolicyDeleteOptionalParams

Parameter opsi.

Mengembalikan

Promise<void>

get(string, string, string, string, ApiPolicyGetOptionalParams)

Dapatkan konfigurasi kebijakan di tingkat API.

function get(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetOptionalParams): Promise<ApiPolicyGetResponse>

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.

policyId

string

Pengidentifikasi Kebijakan.

options

ApiPolicyGetOptionalParams

Parameter opsi.

Mengembalikan

Promise<ApiPolicyGetResponse>

getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetEntityTagOptionalParams): Promise<ApiPolicyGetEntityTagHeaders>

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.

policyId

string

Pengidentifikasi Kebijakan.

options

ApiPolicyGetEntityTagOptionalParams

Parameter opsi.

Mengembalikan

Promise<ApiPolicyGetEntityTagHeaders>

listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

Dapatkan konfigurasi kebijakan di tingkat API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): Promise<PolicyCollection>

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

ApiPolicyListByApiOptionalParams

Parameter opsi.

Mengembalikan

Promise<PolicyCollection>