你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
ApiManagementService interface
表示 ApiManagementService 的接口。
方法
方法详细信息
beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
更新虚拟网络中运行的 Microsoft.ApiManagement 资源，以选取更新的 DNS 更改。
function beginApplyNetworkConfigurationUpdates(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
返回
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
API 管理服务的名称。
返回
Promise<ApiManagementServiceResource>
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
创建 API 管理服务到给定的 Azure 存储帐户的备份。 这是长时间运行的作，可能需要几分钟才能完成。
function beginBackup(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- parameters
- ApiManagementServiceBackupRestoreParameters
提供给ApiManagementService_Backup作的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
创建 API 管理服务到给定的 Azure 存储帐户的备份。 这是长时间运行的作，可能需要几分钟才能完成。
function beginBackupAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<ApiManagementServiceResource>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- parameters
- ApiManagementServiceBackupRestoreParameters
提供给ApiManagementService_Backup作的参数。
选项参数。
返回
Promise<ApiManagementServiceResource>
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
创建或更新 API 管理服务。 这是长时间运行的作，可能需要几分钟才能完成。
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- parameters
- ApiManagementServiceResource
提供给 CreateOrUpdate API 管理服务作的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
创建或更新 API 管理服务。 这是长时间运行的作，可能需要几分钟才能完成。
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<ApiManagementServiceResource>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- parameters
- ApiManagementServiceResource
提供给 CreateOrUpdate API 管理服务作的参数。
选项参数。
返回
Promise<ApiManagementServiceResource>
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)
删除现有的 API 管理服务。
function beginDelete(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)
删除现有的 API 管理服务。
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
选项参数。
返回
Promise<void>
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
将 API 管理服务升级到 Stv2 平台。 有关详细信息，请参阅 https://aka.ms/apim-migrate-stv2。 此更改不可逆。 这是长时间运行的作，可能需要几分钟才能完成。
function beginMigrateToStv2(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
将 API 管理服务升级到 Stv2 平台。 有关详细信息，请参阅 https://aka.ms/apim-migrate-stv2。 此更改不可逆。 这是长时间运行的作，可能需要几分钟才能完成。
function beginMigrateToStv2AndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<ApiManagementServiceResource>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
选项参数。
返回
Promise<ApiManagementServiceResource>
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
还原使用当前服务上的ApiManagementService_Backup作创建的 API 管理服务的备份。 这是长时间运行的作，可能需要几分钟才能完成。
function beginRestore(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- parameters
- ApiManagementServiceBackupRestoreParameters
从备份作提供给还原 API 管理服务的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
还原使用当前服务上的ApiManagementService_Backup作创建的 API 管理服务的备份。 这是长时间运行的作，可能需要几分钟才能完成。
function beginRestoreAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<ApiManagementServiceResource>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- parameters
- ApiManagementServiceBackupRestoreParameters
从备份作提供给还原 API 管理服务的参数。
选项参数。
返回
Promise<ApiManagementServiceResource>
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
更新现有的 API 管理服务。
function beginUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- parameters
- ApiManagementServiceUpdateParameters
提供给 CreateOrUpdate API 管理服务作的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
更新现有的 API 管理服务。
function beginUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<ApiManagementServiceResource>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
- parameters
- ApiManagementServiceUpdateParameters
提供给 CreateOrUpdate API 管理服务作的参数。
选项参数。
返回
Promise<ApiManagementServiceResource>
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)
检查 API 管理服务的名称的可用性和正确性。
function checkNameAvailability(parameters: ApiManagementServiceCheckNameAvailabilityParameters, options?: ApiManagementServiceCheckNameAvailabilityOptionalParams): Promise<ApiManagementServiceNameAvailabilityResult>参数
提供给 CheckNameAvailability作的参数。
选项参数。
返回
get(string, string, ApiManagementServiceGetOptionalParams)
获取 API 管理服务资源说明。
function get(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetOptionalParams): Promise<ApiManagementServiceResource>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
选项参数。
返回
Promise<ApiManagementServiceResource>
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)
获取 API 管理服务的自定义域所有权标识符。
function getDomainOwnershipIdentifier(options?: ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams): Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>参数
返回
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)
获取 API 管理服务的单Sign-On 令牌，该令牌有效期为 5 分钟。
function getSsoToken(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetSsoTokenOptionalParams): Promise<ApiManagementServiceGetSsoTokenResult>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- serviceName
-
string
API 管理服务的名称。
选项参数。
返回
list(ApiManagementServiceListOptionalParams)
列出 Azure 订阅中的所有 API 管理服务。
function list(options?: ApiManagementServiceListOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>参数
选项参数。
返回
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)
列出资源组中的所有 API 管理服务。
function listByResourceGroup(resourceGroupName: string, options?: ApiManagementServiceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
选项参数。