Tag interface
واجهة تمثل علامة.
الأساليب
تفاصيل الأسلوب
assignToApi(string, string, string, string, TagAssignToApiOptionalParams)
تعيين علامة إلى واجهة برمجة التطبيقات.
function assignToApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagAssignToApiOptionalParams): Promise<TagAssignToApiResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- TagAssignToApiOptionalParams
معلمات الخيارات.
المرتجعات
Promise<TagAssignToApiResponse>
assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)
تعيين علامة إلى العملية.
function assignToOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagAssignToOperationOptionalParams): Promise<TagContract>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
معلمات الخيارات.
المرتجعات
Promise<TagContract>
assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)
تعيين علامة إلى المنتج.
function assignToProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagAssignToProductOptionalParams): Promise<TagContract>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- productId
-
string
معرف المنتج. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- TagAssignToProductOptionalParams
معلمات الخيارات.
المرتجعات
Promise<TagContract>
createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)
إنشاء علامة.
function createOrUpdate(resourceGroupName: string, serviceName: string, tagId: string, parameters: TagCreateUpdateParameters, options?: TagCreateOrUpdateOptionalParams): Promise<TagCreateOrUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- parameters
- TagCreateUpdateParameters
إنشاء معلمات.
- options
- TagCreateOrUpdateOptionalParams
معلمات الخيارات.
المرتجعات
Promise<TagCreateOrUpdateResponse>
delete(string, string, string, string, TagDeleteOptionalParams)
حذف علامة معينة لمثيل خدمة APIM.
function delete(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, options?: TagDeleteOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- options
- TagDeleteOptionalParams
معلمات الخيارات.
المرتجعات
Promise<void>
detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)
فصل العلامة من واجهة برمجة التطبيقات.
function detachFromApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagDetachFromApiOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- TagDetachFromApiOptionalParams
معلمات الخيارات.
المرتجعات
Promise<void>
detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)
فصل العلامة من العملية.
function detachFromOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagDetachFromOperationOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
معلمات الخيارات.
المرتجعات
Promise<void>
detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)
افصل العلامة عن المنتج.
function detachFromProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagDetachFromProductOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- productId
-
string
معرف المنتج. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
معلمات الخيارات.
المرتجعات
Promise<void>
get(string, string, string, TagGetOptionalParams)
يحصل على تفاصيل العلامة المحددة بواسطة معرفها.
function get(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetOptionalParams): Promise<TagGetResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- TagGetOptionalParams
معلمات الخيارات.
المرتجعات
Promise<TagGetResponse>
getByApi(string, string, string, string, TagGetByApiOptionalParams)
الحصول على علامة مقترنة بواجهة برمجة التطبيقات.
function getByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetByApiOptionalParams): Promise<TagGetByApiResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- TagGetByApiOptionalParams
معلمات الخيارات.
المرتجعات
Promise<TagGetByApiResponse>
getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)
الحصول على علامة مقترنة بالعملية.
function getByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetByOperationOptionalParams): Promise<TagGetByOperationResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- TagGetByOperationOptionalParams
معلمات الخيارات.
المرتجعات
Promise<TagGetByOperationResponse>
getByProduct(string, string, string, string, TagGetByProductOptionalParams)
الحصول على علامة مقترنة بالمنتج.
function getByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetByProductOptionalParams): Promise<TagGetByProductResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- productId
-
string
معرف المنتج. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- TagGetByProductOptionalParams
معلمات الخيارات.
المرتجعات
Promise<TagGetByProductResponse>
getEntityState(string, string, string, TagGetEntityStateOptionalParams)
يحصل على إصدار حالة الكيان للعلامة المحددة بواسطة معرفها.
function getEntityState(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetEntityStateOptionalParams): Promise<TagGetEntityStateHeaders>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- TagGetEntityStateOptionalParams
معلمات الخيارات.
المرتجعات
Promise<TagGetEntityStateHeaders>
getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)
يحصل على إصدار حالة الكيان للعلامة المحددة بواسطة معرفها.
function getEntityStateByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetEntityStateByApiOptionalParams): Promise<TagGetEntityStateByApiHeaders>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
معلمات الخيارات.
المرتجعات
Promise<TagGetEntityStateByApiHeaders>
getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)
يحصل على إصدار حالة الكيان للعلامة المحددة بواسطة معرفها.
function getEntityStateByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetEntityStateByOperationOptionalParams): Promise<TagGetEntityStateByOperationHeaders>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
معلمات الخيارات.
المرتجعات
Promise<TagGetEntityStateByOperationHeaders>
getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)
يحصل على إصدار حالة الكيان للعلامة المحددة بواسطة معرفها.
function getEntityStateByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetEntityStateByProductOptionalParams): Promise<TagGetEntityStateByProductHeaders>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- productId
-
string
معرف المنتج. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
معلمات الخيارات.
المرتجعات
Promise<TagGetEntityStateByProductHeaders>
listByApi(string, string, string, TagListByApiOptionalParams)
يسرد جميع العلامات المقترنة بواجهة برمجة التطبيقات.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: TagListByApiOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- options
- TagListByApiOptionalParams
معلمات الخيارات.
المرتجعات
listByOperation(string, string, string, string, TagListByOperationOptionalParams)
يسرد كافة العلامات المقترنة بالعملية.
function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: TagListByOperationOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- apiId
-
string
معرف مراجعة واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. تحتوي المراجعة غير الحالية على ؛ rev=n كلاحقة حيث n هو رقم المراجعة.
- operationId
-
string
معرف العملية داخل واجهة برمجة التطبيقات. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- TagListByOperationOptionalParams
معلمات الخيارات.
المرتجعات
listByProduct(string, string, string, TagListByProductOptionalParams)
يسرد كافة العلامات المقترنة بالمنتج.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: TagListByProductOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- productId
-
string
معرف المنتج. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- options
- TagListByProductOptionalParams
معلمات الخيارات.
المرتجعات
listByService(string, string, TagListByServiceOptionalParams)
يسرد مجموعة من العلامات المعرفة داخل مثيل خدمة.
function listByService(resourceGroupName: string, serviceName: string, options?: TagListByServiceOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- options
- TagListByServiceOptionalParams
معلمات الخيارات.
المرتجعات
update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)
يحدث تفاصيل العلامة المحددة بواسطة معرفها.
function update(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, parameters: TagCreateUpdateParameters, options?: TagUpdateOptionalParams): Promise<TagUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- tagId
-
string
معرف العلامة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- parameters
- TagCreateUpdateParameters
تحديث المعلمات.
- options
- TagUpdateOptionalParams
معلمات الخيارات.
المرتجعات
Promise<TagUpdateResponse>