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)	Создает резервную копию службы Управление API в указанной учетной записи хранения Azure. Эта операция является длительной и может занять несколько минут.
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Создает резервную копию службы Управление API в указанной учетной записи хранения Azure. Эта операция является длительной и может занять несколько минут.
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Создает или обновляет службу Управления API. Эта операция является длительной и может занять несколько минут.
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Создает или обновляет службу Управления API. Эта операция является длительной и может занять несколько минут.
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)	Удаляет имеющуюся службу Управления API.
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)	Удаляет имеющуюся службу Управления API.
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Обновляет службу Управление API до платформы Stv2. Дополнительные сведения см. в https://aka.ms/apim-migrate-stv2разделе . Это изменение не является обратимым. Эта операция является длительной и может занять несколько минут.
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Обновляет службу Управление API до платформы Stv2. Дополнительные сведения см. в https://aka.ms/apim-migrate-stv2разделе . Это изменение не является обратимым. Эта операция является длительной и может занять несколько минут.
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Восстанавливает резервную копию службы Управление API, созданной с помощью операции ApiManagementService_Backup в текущей службе. Это длительная операция, и ее выполнение может занять несколько минут.
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Восстанавливает резервную копию службы Управление API, созданной с помощью операции ApiManagementService_Backup в текущей службе. Это длительная операция, и ее выполнение может занять несколько минут.
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Обновления существующую службу Управление API.
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Обновления существующую службу Управление API.
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)	Проверяет доступность и правильность имени службы Управление API.
get(string, string, ApiManagementServiceGetOptionalParams)	Возвращает описание ресурса службы Управление API.
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)	Получите идентификатор владения личным доменом для службы Управление API.
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)	Возвращает токен единого входа для службы Управление API, действительный в течение 5 минут.
list(ApiManagementServiceListOptionalParams)	Список всех Управление API служб в подписке Azure.
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)	Вывод списка всех Управление API служб в группе ресурсов.

Сведения о методе

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.

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

Имя службы Управление API.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Параметры параметров.

Возвращаемое значение

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.

options

ApiManagementServiceBackupOptionalParams

Параметры параметров.

Возвращаемое значение

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.

options

ApiManagementServiceBackupOptionalParams

Параметры параметров.

Возвращаемое значение

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 службы.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

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 службы.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

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.

options

ApiManagementServiceDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

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.

options

ApiManagementServiceDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

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.

options

ApiManagementServiceMigrateToStv2OptionalParams

Параметры параметров.

Возвращаемое значение

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.

options

ApiManagementServiceMigrateToStv2OptionalParams

Параметры параметров.

Возвращаемое значение

Promise<ApiManagementServiceResource>

beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Восстанавливает резервную копию службы Управление API, созданной с помощью операции ApiManagementService_Backup в текущей службе. Это длительная операция, и ее выполнение может занять несколько минут.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

parameters

ApiManagementServiceBackupRestoreParameters

Параметры, предоставленные для операции восстановления Управление API из резервного копирования.

options

ApiManagementServiceRestoreOptionalParams

Параметры параметров.

Возвращаемое значение

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

beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Восстанавливает резервную копию службы Управление API, созданной с помощью операции ApiManagementService_Backup в текущей службе. Это длительная операция, и ее выполнение может занять несколько минут.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

parameters

ApiManagementServiceBackupRestoreParameters

Параметры, предоставленные для операции восстановления Управление API из резервного копирования.

options

ApiManagementServiceRestoreOptionalParams

Параметры параметров.

Возвращаемое значение

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 службы.

options

ApiManagementServiceUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

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 службы.

options

ApiManagementServiceUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<ApiManagementServiceResource>

checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)

Проверяет доступность и правильность имени службы Управление API.

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

Параметры

parameters

ApiManagementServiceCheckNameAvailabilityParameters

Параметры, предоставляемые для операции CheckNameAvailability.

options

ApiManagementServiceCheckNameAvailabilityOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<ApiManagementServiceNameAvailabilityResult>

get(string, string, ApiManagementServiceGetOptionalParams)

Возвращает описание ресурса службы Управление API.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

options

ApiManagementServiceGetOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<ApiManagementServiceResource>

getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)

Получите идентификатор владения личным доменом для службы Управление API.

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

Параметры

options

ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>

getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)

Возвращает токен единого входа для службы Управление API, действительный в течение 5 минут.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

options

ApiManagementServiceGetSsoTokenOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<ApiManagementServiceGetSsoTokenResult>

list(ApiManagementServiceListOptionalParams)

Список всех Управление API служб в подписке Azure.

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

Параметры

options

ApiManagementServiceListOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>

listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)

Вывод списка всех Управление API служб в группе ресурсов.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

options

ApiManagementServiceListByResourceGroupOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>