ApiManagementService interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący usługę ApiManagementService.

Metody

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	Aktualizuje zasób Microsoft.ApiManagement uruchomiony w sieci wirtualnej, aby wybrać zaktualizowane zmiany DNS.
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	Aktualizuje zasób Microsoft.ApiManagement uruchomiony w sieci wirtualnej, aby wybrać zaktualizowane zmiany DNS.
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Tworzy kopię zapasową usługi API Management dla danego konta usługi Azure Storage. Ta długotrwała operacja może potrwać kilka minut.
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Tworzy kopię zapasową usługi API Management dla danego konta usługi Azure Storage. Ta długotrwała operacja może potrwać kilka minut.
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Tworzy lub aktualizuje usługę API Management. Ta długotrwała operacja może potrwać kilka minut.
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Tworzy lub aktualizuje usługę API Management. Ta długotrwała operacja może potrwać kilka minut.
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)	Usuwa istniejącą usługę API Management.
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)	Usuwa istniejącą usługę API Management.
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Uaktualnia usługę API Management do platformy Stv2. Aby uzyskać szczegółowe informacje, zobacz https://aka.ms/apim-migrate-stv2. Ta zmiana nie jest odwracalna. Ta długotrwała operacja może potrwać kilka minut.
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Uaktualnia usługę API Management do platformy Stv2. Aby uzyskać szczegółowe informacje, zobacz https://aka.ms/apim-migrate-stv2. Ta zmiana nie jest odwracalna. Ta długotrwała operacja może potrwać kilka minut.
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Przywraca kopię zapasową usługi API Management utworzoną przy użyciu operacji ApiManagementService_Backup w bieżącej usłudze. Jest to długotrwała operacja i może potrwać kilka minut.
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Przywraca kopię zapasową usługi API Management utworzoną przy użyciu operacji ApiManagementService_Backup w bieżącej usłudze. Jest to długotrwała operacja i może potrwać kilka minut.
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Aktualizuje istniejącą usługę API Management.
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Aktualizuje istniejącą usługę API Management.
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)	Sprawdza dostępność i poprawność nazwy usługi API Management.
get(string, string, ApiManagementServiceGetOptionalParams)	Pobiera opis zasobu usługi API Management.
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)	Pobierz identyfikator własności domeny niestandardowej dla usługi API Management.
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)	Pobiera token single-Sign-On dla usługi API Management, który jest ważny przez 5 minut.
list(ApiManagementServiceListOptionalParams)	Wyświetla listę wszystkich usług API Management w ramach subskrypcji platformy Azure.
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)	Wyświetl listę wszystkich usług API Management w grupie zasobów.

Szczegóły metody

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

Aktualizuje zasób Microsoft.ApiManagement uruchomiony w sieci wirtualnej, aby wybrać zaktualizowane zmiany DNS.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Parametry opcji.

Zwraca

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

beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

Aktualizuje zasób Microsoft.ApiManagement uruchomiony w sieci wirtualnej, aby wybrać zaktualizowane zmiany DNS.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Parametry opcji.

Zwraca

Promise<ApiManagementServiceResource>

beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Tworzy kopię zapasową usługi API Management dla danego konta usługi Azure Storage. Ta długotrwała operacja może potrwać kilka minut.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

parameters

ApiManagementServiceBackupRestoreParameters

Parametry dostarczone do operacji ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

Parametry opcji.

Zwraca

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

beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Tworzy kopię zapasową usługi API Management dla danego konta usługi Azure Storage. Ta długotrwała operacja może potrwać kilka minut.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

parameters

ApiManagementServiceBackupRestoreParameters

Parametry dostarczone do operacji ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

Parametry opcji.

Zwraca

Promise<ApiManagementServiceResource>

beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Tworzy lub aktualizuje usługę API Management. Ta długotrwała operacja może potrwać kilka minut.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

parameters

ApiManagementServiceResource

Parametry dostarczone do operacji usługi CreateOrUpdate API Management.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

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

beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Tworzy lub aktualizuje usługę API Management. Ta długotrwała operacja może potrwać kilka minut.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

parameters

ApiManagementServiceResource

Parametry dostarczone do operacji usługi CreateOrUpdate API Management.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ApiManagementServiceResource>

beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)

Usuwa istniejącą usługę API Management.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

ApiManagementServiceDeleteOptionalParams

Parametry opcji.

Zwraca

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

beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)

Usuwa istniejącą usługę API Management.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

ApiManagementServiceDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Uaktualnia usługę API Management do platformy Stv2. Aby uzyskać szczegółowe informacje, zobacz https://aka.ms/apim-migrate-stv2. Ta zmiana nie jest odwracalna. Ta długotrwała operacja może potrwać kilka minut.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

ApiManagementServiceMigrateToStv2OptionalParams

Parametry opcji.

Zwraca

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

beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Uaktualnia usługę API Management do platformy Stv2. Aby uzyskać szczegółowe informacje, zobacz https://aka.ms/apim-migrate-stv2. Ta zmiana nie jest odwracalna. Ta długotrwała operacja może potrwać kilka minut.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

ApiManagementServiceMigrateToStv2OptionalParams

Parametry opcji.

Zwraca

Promise<ApiManagementServiceResource>

beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Przywraca kopię zapasową usługi API Management utworzoną przy użyciu operacji ApiManagementService_Backup w bieżącej usłudze. Jest to długotrwała operacja i może potrwać kilka minut.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

parameters

ApiManagementServiceBackupRestoreParameters

Parametry dostarczone do usługi Restore API Management z operacji tworzenia kopii zapasowej.

options

ApiManagementServiceRestoreOptionalParams

Parametry opcji.

Zwraca

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

beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Przywraca kopię zapasową usługi API Management utworzoną przy użyciu operacji ApiManagementService_Backup w bieżącej usłudze. Jest to długotrwała operacja i może potrwać kilka minut.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

parameters

ApiManagementServiceBackupRestoreParameters

Parametry dostarczone do usługi Restore API Management z operacji tworzenia kopii zapasowej.

options

ApiManagementServiceRestoreOptionalParams

Parametry opcji.

Zwraca

Promise<ApiManagementServiceResource>

beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Aktualizuje istniejącą usługę API Management.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

parameters

ApiManagementServiceUpdateParameters

Parametry dostarczone do operacji usługi CreateOrUpdate API Management.

options

ApiManagementServiceUpdateOptionalParams

Parametry opcji.

Zwraca

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

beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Aktualizuje istniejącą usługę API Management.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

parameters

ApiManagementServiceUpdateParameters

Parametry dostarczone do operacji usługi CreateOrUpdate API Management.

options

ApiManagementServiceUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ApiManagementServiceResource>

checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)

Sprawdza dostępność i poprawność nazwy usługi API Management.

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

Parametry

parameters

ApiManagementServiceCheckNameAvailabilityParameters

Parametry dostarczone do operacji CheckNameAvailability.

options

ApiManagementServiceCheckNameAvailabilityOptionalParams

Parametry opcji.

Zwraca

Promise<ApiManagementServiceNameAvailabilityResult>

get(string, string, ApiManagementServiceGetOptionalParams)

Pobiera opis zasobu usługi API Management.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

ApiManagementServiceGetOptionalParams

Parametry opcji.

Zwraca

Promise<ApiManagementServiceResource>

getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)

Pobierz identyfikator własności domeny niestandardowej dla usługi API Management.

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

Parametry

options

ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams

Parametry opcji.

Zwraca

Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>

getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)

Pobiera token single-Sign-On dla usługi API Management, który jest ważny przez 5 minut.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

options

ApiManagementServiceGetSsoTokenOptionalParams

Parametry opcji.

Zwraca

Promise<ApiManagementServiceGetSsoTokenResult>

list(ApiManagementServiceListOptionalParams)

Wyświetla listę wszystkich usług API Management w ramach subskrypcji platformy Azure.

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

Parametry

options

ApiManagementServiceListOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>

listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)

Wyświetl listę wszystkich usług API Management w grupie zasobów.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

options

ApiManagementServiceListByResourceGroupOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>