ApiOperation interface
واجهة تمثل ApiOperation.
الأساليب
| create |
إنشاء عملية جديدة في واجهة برمجة التطبيقات أو تحديث عملية موجودة. |
| delete(string, string, string, string, string, Api |
حذف العملية المحددة في واجهة برمجة التطبيقات. |
| get(string, string, string, string, Api |
يحصل على تفاصيل عملية واجهة برمجة التطبيقات المحددة بواسطة معرفها. |
| get |
يحصل على إصدار حالة الكيان (Etag) من عملية واجهة برمجة التطبيقات المحددة بواسطة معرفها. |
| list |
يسرد مجموعة من العمليات لواجهة برمجة التطبيقات المحددة. |
| update(string, string, string, string, string, Operation |
يحدث تفاصيل العملية في واجهة برمجة التطبيقات المحددة بواسطة معرفها. |
تفاصيل الأسلوب
createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)
إنشاء عملية جديدة في واجهة برمجة التطبيقات أو تحديث عملية موجودة.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, parameters: OperationContract, options?: ApiOperationCreateOrUpdateOptionalParams): Promise<ApiOperationCreateOrUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- parameters
- OperationContract
إنشاء معلمات.
معلمات الخيارات.
المرتجعات
Promise<ApiOperationCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)
حذف العملية المحددة في واجهة برمجة التطبيقات.
function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, options?: ApiOperationDeleteOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- options
- ApiOperationDeleteOptionalParams
معلمات الخيارات.
المرتجعات
Promise<void>
get(string, string, string, string, ApiOperationGetOptionalParams)
يحصل على تفاصيل عملية واجهة برمجة التطبيقات المحددة بواسطة معرفها.
function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetOptionalParams): Promise<ApiOperationGetResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- ApiOperationGetOptionalParams
معلمات الخيارات.
المرتجعات
Promise<ApiOperationGetResponse>
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)
يحصل على إصدار حالة الكيان (Etag) من عملية واجهة برمجة التطبيقات المحددة بواسطة معرفها.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetEntityTagOptionalParams): Promise<ApiOperationGetEntityTagHeaders>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
معلمات الخيارات.
المرتجعات
Promise<ApiOperationGetEntityTagHeaders>
listByApi(string, string, string, ApiOperationListByApiOptionalParams)
يسرد مجموعة من العمليات لواجهة برمجة التطبيقات المحددة.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
معلمات الخيارات.
المرتجعات
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)
يحدث تفاصيل العملية في واجهة برمجة التطبيقات المحددة بواسطة معرفها.
function update(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: ApiOperationUpdateOptionalParams): Promise<ApiOperationUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- parameters
- OperationUpdateContract
معلمات تحديث عملية API.
- options
- ApiOperationUpdateOptionalParams
معلمات الخيارات.
المرتجعات
Promise<ApiOperationUpdateResponse>