ApiManagementService interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل ApiManagementService.

الأساليب

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	تحديث مورد Microsoft.ApiManagement قيد التشغيل في الشبكة الظاهرية لاختيار تغييرات DNS المحدثة.
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	تحديث مورد Microsoft.ApiManagement قيد التشغيل في الشبكة الظاهرية لاختيار تغييرات DNS المحدثة.
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	إنشاء نسخة احتياطية من خدمة APIM إلى حساب تخزين Azure المحدد. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	إنشاء نسخة احتياطية من خدمة APIM إلى حساب تخزين Azure المحدد. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	إنشاء خدمة APIM أو تحديثها. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	إنشاء خدمة APIM أو تحديثها. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)	حذف خدمة APIM موجودة.
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)	حذف خدمة APIM موجودة.
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	ترقية خدمة APIM إلى النظام الأساسي Stv2. للحصول على تفاصيل راجع https://aka.ms/apim-migrate-stv2. هذا التغيير غير قابل للعكس. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	ترقية خدمة APIM إلى النظام الأساسي Stv2. للحصول على تفاصيل راجع https://aka.ms/apim-migrate-stv2. هذا التغيير غير قابل للعكس. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	استعادة نسخة احتياطية من خدمة APIM التي تم إنشاؤها باستخدام عملية ApiManagementService_Backup على الخدمة الحالية. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	استعادة نسخة احتياطية من خدمة APIM التي تم إنشاؤها باستخدام عملية ApiManagementService_Backup على الخدمة الحالية. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	تحديث خدمة API Management موجودة.
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	تحديث خدمة API Management موجودة.
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)	يتحقق من توفر الاسم وصحته لخدمة APIM.
get(string, string, ApiManagementServiceGetOptionalParams)	الحصول على وصف مورد خدمة APIM.
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)	احصل على معرف ملكية المجال المخصص لخدمة APIM.
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)	يحصل على الرمز المميز أحاديSign-On لخدمة إدارة واجهة برمجة التطبيقات الصالح لمدة 5 دقائق.
list(ApiManagementServiceListOptionalParams)	يسرد جميع خدمات APIM ضمن اشتراك Azure.
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)	سرد جميع خدمات APIM ضمن مجموعة موارد.

تفاصيل الأسلوب

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

تحديث مورد Microsoft.ApiManagement قيد التشغيل في الشبكة الظاهرية لاختيار تغييرات DNS المحدثة.

function beginApplyNetworkConfigurationUpdates(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

معلمات الخيارات.

المرتجعات

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>

beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

تحديث مورد Microsoft.ApiManagement قيد التشغيل في الشبكة الظاهرية لاختيار تغييرات DNS المحدثة.

function beginApplyNetworkConfigurationUpdatesAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<ApiManagementServiceResource>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiManagementServiceResource>

beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

إنشاء نسخة احتياطية من خدمة APIM إلى حساب تخزين Azure المحدد. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.

function beginBackup(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

parameters

ApiManagementServiceBackupRestoreParameters

المعلمات المتوفرة لعملية ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

معلمات الخيارات.

المرتجعات

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>

beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

إنشاء نسخة احتياطية من خدمة APIM إلى حساب تخزين Azure المحدد. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.

function beginBackupAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<ApiManagementServiceResource>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

parameters

ApiManagementServiceBackupRestoreParameters

المعلمات المتوفرة لعملية ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiManagementServiceResource>

beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

إنشاء خدمة APIM أو تحديثها. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

parameters

ApiManagementServiceResource

المعلمات المتوفرة لعملية خدمة CreateOrUpdate API Management.

options

ApiManagementServiceCreateOrUpdateOptionalParams

معلمات الخيارات.

المرتجعات

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>

beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

إنشاء خدمة APIM أو تحديثها. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<ApiManagementServiceResource>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

parameters

ApiManagementServiceResource

المعلمات المتوفرة لعملية خدمة CreateOrUpdate API Management.

options

ApiManagementServiceCreateOrUpdateOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiManagementServiceResource>

beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)

حذف خدمة APIM موجودة.

function beginDelete(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

options

ApiManagementServiceDeleteOptionalParams

معلمات الخيارات.

المرتجعات

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)

حذف خدمة APIM موجودة.

function beginDeleteAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<void>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

options

ApiManagementServiceDeleteOptionalParams

معلمات الخيارات.

المرتجعات

Promise<void>

beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

ترقية خدمة APIM إلى النظام الأساسي Stv2. للحصول على تفاصيل راجع https://aka.ms/apim-migrate-stv2. هذا التغيير غير قابل للعكس. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.

function beginMigrateToStv2(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

options

ApiManagementServiceMigrateToStv2OptionalParams

معلمات الخيارات.

المرتجعات

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>

beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

ترقية خدمة APIM إلى النظام الأساسي Stv2. للحصول على تفاصيل راجع https://aka.ms/apim-migrate-stv2. هذا التغيير غير قابل للعكس. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.

function beginMigrateToStv2AndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<ApiManagementServiceResource>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

options

ApiManagementServiceMigrateToStv2OptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiManagementServiceResource>

beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

استعادة نسخة احتياطية من خدمة APIM التي تم إنشاؤها باستخدام عملية ApiManagementService_Backup على الخدمة الحالية. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.

function beginRestore(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

parameters

ApiManagementServiceBackupRestoreParameters

المعلمات المقدمة إلى خدمة Restore API Management من عملية النسخ الاحتياطي.

options

ApiManagementServiceRestoreOptionalParams

معلمات الخيارات.

المرتجعات

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>

beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

استعادة نسخة احتياطية من خدمة APIM التي تم إنشاؤها باستخدام عملية ApiManagementService_Backup على الخدمة الحالية. هذه عملية طويلة الأمد وقد تستغرق عدة دقائق لإكمالها.

function beginRestoreAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<ApiManagementServiceResource>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

parameters

ApiManagementServiceBackupRestoreParameters

المعلمات المقدمة إلى خدمة Restore API Management من عملية النسخ الاحتياطي.

options

ApiManagementServiceRestoreOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiManagementServiceResource>

beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

تحديث خدمة API Management موجودة.

function beginUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

parameters

ApiManagementServiceUpdateParameters

المعلمات المتوفرة لعملية خدمة CreateOrUpdate API Management.

options

ApiManagementServiceUpdateOptionalParams

معلمات الخيارات.

المرتجعات

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>

beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

تحديث خدمة API Management موجودة.

function beginUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<ApiManagementServiceResource>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

parameters

ApiManagementServiceUpdateParameters

المعلمات المتوفرة لعملية خدمة CreateOrUpdate API Management.

options

ApiManagementServiceUpdateOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiManagementServiceResource>

checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)

يتحقق من توفر الاسم وصحته لخدمة APIM.

function checkNameAvailability(parameters: ApiManagementServiceCheckNameAvailabilityParameters, options?: ApiManagementServiceCheckNameAvailabilityOptionalParams): Promise<ApiManagementServiceNameAvailabilityResult>

المعلمات

parameters

ApiManagementServiceCheckNameAvailabilityParameters

المعلمات المتوفرة لعملية CheckNameAvailability.

options

ApiManagementServiceCheckNameAvailabilityOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiManagementServiceNameAvailabilityResult>

get(string, string, ApiManagementServiceGetOptionalParams)

الحصول على وصف مورد خدمة APIM.

function get(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetOptionalParams): Promise<ApiManagementServiceResource>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

options

ApiManagementServiceGetOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiManagementServiceResource>

getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)

احصل على معرف ملكية المجال المخصص لخدمة APIM.

function getDomainOwnershipIdentifier(options?: ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams): Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>

المعلمات

options

ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>

getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)

يحصل على الرمز المميز أحاديSign-On لخدمة إدارة واجهة برمجة التطبيقات الصالح لمدة 5 دقائق.

function getSsoToken(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetSsoTokenOptionalParams): Promise<ApiManagementServiceGetSsoTokenResult>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

options

ApiManagementServiceGetSsoTokenOptionalParams

معلمات الخيارات.

المرتجعات

Promise<ApiManagementServiceGetSsoTokenResult>

list(ApiManagementServiceListOptionalParams)

يسرد جميع خدمات APIM ضمن اشتراك Azure.

function list(options?: ApiManagementServiceListOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>

المعلمات

options

ApiManagementServiceListOptionalParams

معلمات الخيارات.

المرتجعات

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>

listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)

سرد جميع خدمات APIM ضمن مجموعة موارد.

function listByResourceGroup(resourceGroupName: string, options?: ApiManagementServiceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

options

ApiManagementServiceListByResourceGroupOptionalParams

معلمات الخيارات.

المرتجعات

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>