WorkspaceApiOperation interface
واجهة تمثل WorkspaceApiOperation.
الأساليب
تفاصيل الأسلوب
createOrUpdate(string, string, string, string, string, OperationContract, WorkspaceApiOperationCreateOrUpdateOptionalParams)
إنشاء عملية جديدة في واجهة برمجة التطبيقات أو تحديث عملية موجودة.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, parameters: OperationContract, options?: WorkspaceApiOperationCreateOrUpdateOptionalParams): Promise<WorkspaceApiOperationCreateOrUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- parameters
- OperationContract
إنشاء معلمات.
معلمات الخيارات.
المرتجعات
delete(string, string, string, string, string, string, WorkspaceApiOperationDeleteOptionalParams)
حذف العملية المحددة في واجهة برمجة التطبيقات.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, options?: WorkspaceApiOperationDeleteOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
معلمات الخيارات.
المرتجعات
Promise<void>
get(string, string, string, string, string, WorkspaceApiOperationGetOptionalParams)
يحصل على تفاصيل عملية واجهة برمجة التطبيقات المحددة بواسطة معرفها.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetOptionalParams): Promise<WorkspaceApiOperationGetResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
معلمات الخيارات.
المرتجعات
Promise<WorkspaceApiOperationGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiOperationGetEntityTagOptionalParams)
يحصل على إصدار حالة الكيان (Etag) من عملية واجهة برمجة التطبيقات المحددة بواسطة معرفها.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetEntityTagOptionalParams): Promise<WorkspaceApiOperationGetEntityTagHeaders>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
معلمات الخيارات.
المرتجعات
listByApi(string, string, string, string, WorkspaceApiOperationListByApiOptionalParams)
يسرد مجموعة من العمليات لواجهة برمجة التطبيقات المحددة.
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
معلمات الخيارات.
المرتجعات
update(string, string, string, string, string, string, OperationUpdateContract, WorkspaceApiOperationUpdateOptionalParams)
يحدث تفاصيل العملية في واجهة برمجة التطبيقات المحددة بواسطة معرفها.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: WorkspaceApiOperationUpdateOptionalParams): Promise<WorkspaceApiOperationUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- parameters
- OperationUpdateContract
معلمات تحديث عملية API.
معلمات الخيارات.
المرتجعات
Promise<WorkspaceApiOperationUpdateResponse>