Gateway interface
واجهة تمثل بوابة.
الأساليب
تفاصيل الأسلوب
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
إنشاء بوابة أو تحديثها لاستخدامها في مثيل APIM.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- gatewayId
-
string
معرف كيان البوابة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. يجب ألا تكون القيمة "مدارة"
- parameters
- GatewayContract
تفاصيل البوابة.
معلمات الخيارات.
المرتجعات
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
حذف بوابة معينة.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- gatewayId
-
string
معرف كيان البوابة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. يجب ألا تكون القيمة "مدارة"
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- options
- GatewayDeleteOptionalParams
معلمات الخيارات.
المرتجعات
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
يحصل على الرمز المميز لتخويل الوصول المشترك للبوابة.
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- gatewayId
-
string
معرف كيان البوابة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. يجب ألا تكون القيمة "مدارة"
- parameters
- GatewayTokenRequestContract
خصائص عقد طلب رمز البوابة المميز.
معلمات الخيارات.
المرتجعات
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
يحصل على تفاصيل البوابة المحددة بواسطة معرفها.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- gatewayId
-
string
معرف كيان البوابة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. يجب ألا تكون القيمة "مدارة"
- options
- GatewayGetOptionalParams
معلمات الخيارات.
المرتجعات
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
يحصل على إصدار حالة الكيان (Etag) من البوابة المحددة بواسطة معرفها.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- gatewayId
-
string
معرف كيان البوابة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. يجب ألا تكون القيمة "مدارة"
معلمات الخيارات.
المرتجعات
Promise<GatewayGetEntityTagHeaders>
invalidateDebugCredentials(string, string, string, GatewayInvalidateDebugCredentialsOptionalParams)
الإجراء هو إبطال جميع بيانات اعتماد تصحيح الأخطاء الصادرة للبوابة.
function invalidateDebugCredentials(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayInvalidateDebugCredentialsOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- gatewayId
-
string
معرف كيان البوابة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. يجب ألا تكون القيمة "مدارة"
معلمات الخيارات.
المرتجعات
Promise<void>
listByService(string, string, GatewayListByServiceOptionalParams)
يسرد مجموعة من البوابات المسجلة مع مثيل الخدمة.
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
معلمات الخيارات.
المرتجعات
listDebugCredentials(string, string, string, GatewayListDebugCredentialsContract, GatewayListDebugCredentialsOptionalParams)
إنشاء بيانات اعتماد تصحيح أخطاء جديدة للبوابة.
function listDebugCredentials(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayListDebugCredentialsContract, options?: GatewayListDebugCredentialsOptionalParams): Promise<GatewayDebugCredentialsContract>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- gatewayId
-
string
معرف كيان البوابة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. يجب ألا تكون القيمة "مدارة"
- parameters
- GatewayListDebugCredentialsContract
سرد خصائص بيانات اعتماد تصحيح الأخطاء.
معلمات الخيارات.
المرتجعات
Promise<GatewayDebugCredentialsContract>
listKeys(string, string, string, GatewayListKeysOptionalParams)
استرداد مفاتيح البوابة.
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- gatewayId
-
string
معرف كيان البوابة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. يجب ألا تكون القيمة "مدارة"
- options
- GatewayListKeysOptionalParams
معلمات الخيارات.
المرتجعات
Promise<GatewayListKeysResponse>
listTrace(string, string, string, GatewayListTraceContract, GatewayListTraceOptionalParams)
عمليات جلب التتبع التي تم جمعها بواسطة البوابة.
function listTrace(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayListTraceContract, options?: GatewayListTraceOptionalParams): Promise<GatewayListTraceResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- gatewayId
-
string
معرف كيان البوابة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. يجب ألا تكون القيمة "مدارة"
- parameters
- GatewayListTraceContract
قائمة خصائص التتبع.
- options
- GatewayListTraceOptionalParams
معلمات الخيارات.
المرتجعات
Promise<GatewayListTraceResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
إعادة إنشاء مفتاح بوابة محدد لإبطال أي رموز مميزة تم إنشاؤها باستخدامه.
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- gatewayId
-
string
معرف كيان البوابة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. يجب ألا تكون القيمة "مدارة"
- parameters
- GatewayKeyRegenerationRequestContract
خصائص عقد طلب تجديد مفتاح البوابة.
معلمات الخيارات.
المرتجعات
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
تحديث تفاصيل البوابة المحددة بواسطة معرفها.
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- gatewayId
-
string
معرف كيان البوابة. يجب أن يكون فريدا في مثيل خدمة APIM الحالي. يجب ألا تكون القيمة "مدارة"
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- parameters
- GatewayContract
تفاصيل البوابة.
- options
- GatewayUpdateOptionalParams
معلمات الخيارات.
المرتجعات
Promise<GatewayUpdateResponse>