ApiManagementService interface

Balíček:

@azure/arm-apimanagement

Rozhraní představující apiManagementService.

Metody

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	Aktualizuje prostředek Microsoft.ApiManagement spuštěný ve virtuální síti a vybere aktualizované změny DNS.
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	Aktualizuje prostředek Microsoft.ApiManagement spuštěný ve virtuální síti a vybere aktualizované změny DNS.
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Vytvoří zálohu služby API Management do daného účtu úložiště Azure. Tato operace je dlouhotrvající a dokončení může trvat několik minut.
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Vytvoří zálohu služby API Management do daného účtu úložiště Azure. Tato operace je dlouhotrvající a dokončení může trvat několik minut.
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Vytvoří nebo aktualizuje službu API Management. Tato operace je dlouhotrvající a dokončení může trvat několik minut.
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Vytvoří nebo aktualizuje službu API Management. Tato operace je dlouhotrvající a dokončení může trvat několik minut.
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)	Odstraní existující službu API Management.
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)	Odstraní existující službu API Management.
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Upgraduje službu API Management na platformu Stv2. Podrobnosti najdete v https://aka.ms/apim-migrate-stv2. Tato změna není nevratná. Tato operace je dlouhotrvající a dokončení může trvat několik minut.
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Upgraduje službu API Management na platformu Stv2. Podrobnosti najdete v https://aka.ms/apim-migrate-stv2. Tato změna není nevratná. Tato operace je dlouhotrvající a dokončení může trvat několik minut.
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Obnoví zálohu služby API Management vytvořenou pomocí operace ApiManagementService_Backup v aktuální službě. Jedná se o dlouhotrvající operaci, která může trvat několik minut.
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Obnoví zálohu služby API Management vytvořenou pomocí operace ApiManagementService_Backup v aktuální službě. Jedná se o dlouhotrvající operaci, která může trvat několik minut.
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Aktualizuje existující službu API Management.
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Aktualizuje existující službu API Management.
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)	Kontroluje dostupnost a správnost názvu služby API Management.
get(string, string, ApiManagementServiceGetOptionalParams)	Získá popis prostředku služby API Management.
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)	Získejte identifikátor vlastnictví vlastní domény pro službu API Management.
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)	Získá token single-Sign-On pro službu API Management, který je platný po dobu 5 minut.
list(ApiManagementServiceListOptionalParams)	Zobrazí seznam všech služeb API Management v rámci předplatného Azure.
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)	Vypíše všechny služby API Management v rámci skupiny prostředků.

Podrobnosti metody

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

Aktualizuje prostředek Microsoft.ApiManagement spuštěný ve virtuální síti a vybere aktualizované změny DNS.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Parametry možností.

Návraty

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

beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

Aktualizuje prostředek Microsoft.ApiManagement spuštěný ve virtuální síti a vybere aktualizované změny DNS.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Parametry možností.

Návraty

Promise<ApiManagementServiceResource>

beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Vytvoří zálohu služby API Management do daného účtu úložiště Azure. Tato operace je dlouhotrvající a dokončení může trvat několik minut.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

parameters

ApiManagementServiceBackupRestoreParameters

Parametry zadané do operace ApiManagementService_Backup

options

ApiManagementServiceBackupOptionalParams

Parametry možností.

Návraty

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

beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Vytvoří zálohu služby API Management do daného účtu úložiště Azure. Tato operace je dlouhotrvající a dokončení může trvat několik minut.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

parameters

ApiManagementServiceBackupRestoreParameters

Parametry zadané do operace ApiManagementService_Backup

options

ApiManagementServiceBackupOptionalParams

Parametry možností.

Návraty

Promise<ApiManagementServiceResource>

beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Vytvoří nebo aktualizuje službu API Management. Tato operace je dlouhotrvající a dokončení může trvat několik minut.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

parameters

ApiManagementServiceResource

Parametry zadané pro operaci služby CreateOrUpdate API Management

options

ApiManagementServiceCreateOrUpdateOptionalParams

Parametry možností.

Návraty

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

beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Vytvoří nebo aktualizuje službu API Management. Tato operace je dlouhotrvající a dokončení může trvat několik minut.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

parameters

ApiManagementServiceResource

Parametry zadané pro operaci služby CreateOrUpdate API Management

options

ApiManagementServiceCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<ApiManagementServiceResource>

beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)

Odstraní existující službu API Management.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

options

ApiManagementServiceDeleteOptionalParams

Parametry možností.

Návraty

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

beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)

Odstraní existující službu API Management.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

options

ApiManagementServiceDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Upgraduje službu API Management na platformu Stv2. Podrobnosti najdete v https://aka.ms/apim-migrate-stv2. Tato změna není nevratná. Tato operace je dlouhotrvající a dokončení může trvat několik minut.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

options

ApiManagementServiceMigrateToStv2OptionalParams

Parametry možností.

Návraty

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

beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Upgraduje službu API Management na platformu Stv2. Podrobnosti najdete v https://aka.ms/apim-migrate-stv2. Tato změna není nevratná. Tato operace je dlouhotrvající a dokončení může trvat několik minut.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

options

ApiManagementServiceMigrateToStv2OptionalParams

Parametry možností.

Návraty

Promise<ApiManagementServiceResource>

beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Obnoví zálohu služby API Management vytvořenou pomocí operace ApiManagementService_Backup v aktuální službě. Jedná se o dlouhotrvající operaci, která může trvat několik minut.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

parameters

ApiManagementServiceBackupRestoreParameters

Parametry poskytnuté službě Restore API Management z operace zálohování

options

ApiManagementServiceRestoreOptionalParams

Parametry možností.

Návraty

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

beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Obnoví zálohu služby API Management vytvořenou pomocí operace ApiManagementService_Backup v aktuální službě. Jedná se o dlouhotrvající operaci, která může trvat několik minut.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

parameters

ApiManagementServiceBackupRestoreParameters

Parametry poskytnuté službě Restore API Management z operace zálohování

options

ApiManagementServiceRestoreOptionalParams

Parametry možností.

Návraty

Promise<ApiManagementServiceResource>

beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Aktualizuje existující službu API Management.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

parameters

ApiManagementServiceUpdateParameters

Parametry zadané pro operaci služby CreateOrUpdate API Management

options

ApiManagementServiceUpdateOptionalParams

Parametry možností.

Návraty

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

beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Aktualizuje existující službu API Management.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

parameters

ApiManagementServiceUpdateParameters

Parametry zadané pro operaci služby CreateOrUpdate API Management

options

ApiManagementServiceUpdateOptionalParams

Parametry možností.

Návraty

Promise<ApiManagementServiceResource>

checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)

Kontroluje dostupnost a správnost názvu služby API Management.

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

Parametry

parameters

ApiManagementServiceCheckNameAvailabilityParameters

Parametry zadané do operace CheckNameAvailability

options

ApiManagementServiceCheckNameAvailabilityOptionalParams

Parametry možností.

Návraty

Promise<ApiManagementServiceNameAvailabilityResult>

get(string, string, ApiManagementServiceGetOptionalParams)

Získá popis prostředku služby API Management.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

options

ApiManagementServiceGetOptionalParams

Parametry možností.

Návraty

Promise<ApiManagementServiceResource>

getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)

Získejte identifikátor vlastnictví vlastní domény pro službu API Management.

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

Parametry

options

ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams

Parametry možností.

Návraty

Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>

getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)

Získá token single-Sign-On pro službu API Management, který je platný po dobu 5 minut.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

serviceName

string

Název služby API Management.

options

ApiManagementServiceGetSsoTokenOptionalParams

Parametry možností.

Návraty

Promise<ApiManagementServiceGetSsoTokenResult>

list(ApiManagementServiceListOptionalParams)

Zobrazí seznam všech služeb API Management v rámci předplatného Azure.

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

Parametry

options

ApiManagementServiceListOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>

listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)

Vypíše všechny služby API Management v rámci skupiny prostředků.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

options

ApiManagementServiceListByResourceGroupOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>