ApiPolicy interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل ApiPolicy.

الأساليب

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)	إنشاء أو تحديث تكوين النهج لواجهة برمجة التطبيقات.
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)	حذف تكوين النهج في واجهة برمجة التطبيقات.
get(string, string, string, string, ApiPolicyGetOptionalParams)	احصل على تكوين النهج على مستوى واجهة برمجة التطبيقات.
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)	يحصل على إصدار حالة الكيان (Etag) من نهج واجهة برمجة التطبيقات المحدد بواسطة المعرف الخاص به.
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)	احصل على تكوين النهج على مستوى واجهة برمجة التطبيقات.

تفاصيل الأسلوب

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

إنشاء أو تحديث تكوين النهج لواجهة برمجة التطبيقات.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

policyId

string

معرف النهج.

parameters

PolicyContract

محتويات النهج التي يجب تطبيقها.

options

ApiPolicyCreateOrUpdateOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiPolicyCreateOrUpdateResponse>

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

حذف تكوين النهج في واجهة برمجة التطبيقات.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

policyId

string

معرف النهج.

ifMatch

string

ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.

options

ApiPolicyDeleteOptionalParams

معلمات الخيارات.

المرتجعات

Promise<void>

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

احصل على تكوين النهج على مستوى واجهة برمجة التطبيقات.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

policyId

string

معرف النهج.

options

ApiPolicyGetOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiPolicyGetResponse>

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

يحصل على إصدار حالة الكيان (Etag) من نهج واجهة برمجة التطبيقات المحدد بواسطة المعرف الخاص به.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

policyId

string

معرف النهج.

options

ApiPolicyGetEntityTagOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiPolicyGetEntityTagHeaders>

listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

احصل على تكوين النهج على مستوى واجهة برمجة التطبيقات.

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

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

apiId

string

معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.

options

ApiPolicyListByApiOptionalParams

معلمات الخيارات.

المرتجعات

Promise<PolicyCollection>