ApiPortals interface
واجهة تمثل ApiPortals.
الأساليب
| begin |
إنشاء مدخل API الافتراضي أو تحديث مدخل واجهة برمجة التطبيقات الموجود. |
| begin |
إنشاء مدخل API الافتراضي أو تحديث مدخل واجهة برمجة التطبيقات الموجود. |
| begin |
احذف مدخل API الافتراضي. |
| begin |
احذف مدخل API الافتراضي. |
| get(string, string, string, Api |
احصل على مدخل واجهة برمجة التطبيقات وخصائصه. |
| list(string, string, Api |
يعالج الطلبات لسرد جميع الموارد في خدمة. |
| validate |
تحقق من أن المجالات صالحة وكذلك غير مستخدمة. |
تفاصيل الأسلوب
beginCreateOrUpdate(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
إنشاء مدخل API الافتراضي أو تحديث مدخل واجهة برمجة التطبيقات الموجود.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على المورد. يمكنك الحصول على هذه القيمة من واجهة برمجة تطبيقات Azure Resource Manager أو المدخل.
- serviceName
-
string
اسم مورد الخدمة.
- apiPortalName
-
string
اسم مدخل واجهة برمجة التطبيقات.
- apiPortalResource
- ApiPortalResource
مدخل واجهة برمجة التطبيقات لعملية الإنشاء أو التحديث
معلمات الخيارات.
المرتجعات
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>
beginCreateOrUpdateAndWait(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
إنشاء مدخل API الافتراضي أو تحديث مدخل واجهة برمجة التطبيقات الموجود.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<ApiPortalResource>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على المورد. يمكنك الحصول على هذه القيمة من واجهة برمجة تطبيقات Azure Resource Manager أو المدخل.
- serviceName
-
string
اسم مورد الخدمة.
- apiPortalName
-
string
اسم مدخل واجهة برمجة التطبيقات.
- apiPortalResource
- ApiPortalResource
مدخل واجهة برمجة التطبيقات لعملية الإنشاء أو التحديث
معلمات الخيارات.
المرتجعات
Promise<ApiPortalResource>
beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)
احذف مدخل API الافتراضي.
function beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على المورد. يمكنك الحصول على هذه القيمة من واجهة برمجة تطبيقات Azure Resource Manager أو المدخل.
- serviceName
-
string
اسم مورد الخدمة.
- apiPortalName
-
string
اسم مدخل واجهة برمجة التطبيقات.
- options
- ApiPortalsDeleteOptionalParams
معلمات الخيارات.
المرتجعات
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)
احذف مدخل API الافتراضي.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<void>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على المورد. يمكنك الحصول على هذه القيمة من واجهة برمجة تطبيقات Azure Resource Manager أو المدخل.
- serviceName
-
string
اسم مورد الخدمة.
- apiPortalName
-
string
اسم مدخل واجهة برمجة التطبيقات.
- options
- ApiPortalsDeleteOptionalParams
معلمات الخيارات.
المرتجعات
Promise<void>
get(string, string, string, ApiPortalsGetOptionalParams)
احصل على مدخل واجهة برمجة التطبيقات وخصائصه.
function get(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsGetOptionalParams): Promise<ApiPortalResource>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على المورد. يمكنك الحصول على هذه القيمة من واجهة برمجة تطبيقات Azure Resource Manager أو المدخل.
- serviceName
-
string
اسم مورد الخدمة.
- apiPortalName
-
string
اسم مدخل واجهة برمجة التطبيقات.
- options
- ApiPortalsGetOptionalParams
معلمات الخيارات.
المرتجعات
Promise<ApiPortalResource>
list(string, string, ApiPortalsListOptionalParams)
يعالج الطلبات لسرد جميع الموارد في خدمة.
function list(resourceGroupName: string, serviceName: string, options?: ApiPortalsListOptionalParams): PagedAsyncIterableIterator<ApiPortalResource, ApiPortalResource[], PageSettings>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على المورد. يمكنك الحصول على هذه القيمة من واجهة برمجة تطبيقات Azure Resource Manager أو المدخل.
- serviceName
-
string
اسم مورد الخدمة.
- options
- ApiPortalsListOptionalParams
معلمات الخيارات.
المرتجعات
validateDomain(string, string, string, CustomDomainValidatePayload, ApiPortalsValidateDomainOptionalParams)
تحقق من أن المجالات صالحة وكذلك غير مستخدمة.
function validateDomain(resourceGroupName: string, serviceName: string, apiPortalName: string, validatePayload: CustomDomainValidatePayload, options?: ApiPortalsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد التي تحتوي على المورد. يمكنك الحصول على هذه القيمة من واجهة برمجة تطبيقات Azure Resource Manager أو المدخل.
- serviceName
-
string
اسم مورد الخدمة.
- apiPortalName
-
string
اسم مدخل واجهة برمجة التطبيقات.
- validatePayload
- CustomDomainValidatePayload
حمولة المجال المخصصة التي سيتم التحقق من صحتها
معلمات الخيارات.
المرتجعات
Promise<CustomDomainValidateResult>