ApiOperationPolicy interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل ApiOperationPolicy.

الأساليب

createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)	إنشاء أو تحديث تكوين النهج لمستوى عملية واجهة برمجة التطبيقات.
delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)	حذف تكوين النهج في عملية Api.
get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)	احصل على تكوين النهج على مستوى عملية واجهة برمجة التطبيقات.
getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)	يحصل على إصدار حالة الكيان (Etag) من نهج عملية واجهة برمجة التطبيقات المحدد بواسطة المعرف الخاص به.
listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)	احصل على قائمة تكوين النهج على مستوى عملية واجهة برمجة التطبيقات.

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

createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

apiId

string

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

operationId

string

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

policyId

string

معرف النهج.

parameters

PolicyContract

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

options

ApiOperationPolicyCreateOrUpdateOptionalParams

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

المرتجعات

Promise<ApiOperationPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)

حذف تكوين النهج في عملية Api.

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

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

apiId

string

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

operationId

string

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

policyId

string

معرف النهج.

ifMatch

string

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

options

ApiOperationPolicyDeleteOptionalParams

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

المرتجعات

Promise<void>

get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

apiId

string

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

operationId

string

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

policyId

string

معرف النهج.

options

ApiOperationPolicyGetOptionalParams

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

المرتجعات

Promise<ApiOperationPolicyGetResponse>

getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagHeaders>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

apiId

string

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

operationId

string

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

policyId

string

معرف النهج.

options

ApiOperationPolicyGetEntityTagOptionalParams

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

المرتجعات

Promise<ApiOperationPolicyGetEntityTagHeaders>

listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)

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

function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): Promise<PolicyCollection>

المعلمات

resourceGroupName

string

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

serviceName

string

اسم خدمة APIM.

apiId

string

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

operationId

string

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

options

ApiOperationPolicyListByOperationOptionalParams

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

المرتجعات

Promise<PolicyCollection>