ApiManagementService interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en ApiManagementService.

Metoder

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	Uppdateringar resursen Microsoft.ApiManagement som körs i det virtuella nätverket för att välja de uppdaterade DNS-ändringarna.
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	Uppdateringar resursen Microsoft.ApiManagement som körs i det virtuella nätverket för att välja de uppdaterade DNS-ändringarna.
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Skapar en säkerhetskopia av API Management-tjänsten till det angivna Azure Storage-kontot. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Skapar en säkerhetskopia av API Management-tjänsten till det angivna Azure Storage-kontot. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Skapar eller uppdaterar en API Management-tjänst. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Skapar eller uppdaterar en API Management-tjänst. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)	Tar bort en befintlig API Management tjänst.
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)	Tar bort en befintlig API Management tjänst.
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Uppgraderar en API Management-tjänst till Stv2-plattformen. Mer information finns i https://aka.ms/apim-migrate-stv2. Den här ändringen är inte reversibel. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Uppgraderar en API Management-tjänst till Stv2-plattformen. Mer information finns i https://aka.ms/apim-migrate-stv2. Den här ändringen är inte reversibel. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Återställer en säkerhetskopia av en API Management tjänst som skapats med hjälp av den ApiManagementService_Backup åtgärden för den aktuella tjänsten. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Återställer en säkerhetskopia av en API Management tjänst som skapats med hjälp av den ApiManagementService_Backup åtgärden för den aktuella tjänsten. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Uppdateringar en befintlig API Management tjänst.
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Uppdateringar en befintlig API Management tjänst.
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)	Kontrollerar tillgänglighet och korrekthet för ett namn för en API Management-tjänst.
get(string, string, ApiManagementServiceGetOptionalParams)	Hämtar en API Management tjänstresursbeskrivning.
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)	Hämta den anpassade domänägaridentifieraren för en API Management-tjänst.
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)	Hämtar token för enkel inloggning för API Management-tjänsten som är giltig i 5 minuter.
list(ApiManagementServiceListOptionalParams)	Visar en lista över alla API Management tjänster i en Azure-prenumeration.
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)	Visa en lista över alla API Management tjänster i en resursgrupp.

Metodinformation

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

Uppdateringar resursen Microsoft.ApiManagement som körs i det virtuella nätverket för att välja de uppdaterade DNS-ändringarna.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Alternativparametrarna.

Returer

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

beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

Uppdateringar resursen Microsoft.ApiManagement som körs i det virtuella nätverket för att välja de uppdaterade DNS-ändringarna.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Alternativparametrarna.

Returer

Promise<ApiManagementServiceResource>

beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Skapar en säkerhetskopia av API Management-tjänsten till det angivna Azure Storage-kontot. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

parameters

ApiManagementServiceBackupRestoreParameters

Parametrar som har angetts för åtgärden ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

Alternativparametrarna.

Returer

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

beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Skapar en säkerhetskopia av API Management-tjänsten till det angivna Azure Storage-kontot. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

parameters

ApiManagementServiceBackupRestoreParameters

Parametrar som har angetts för åtgärden ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

Alternativparametrarna.

Returer

Promise<ApiManagementServiceResource>

beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Skapar eller uppdaterar en API Management-tjänst. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

parameters

ApiManagementServiceResource

Parametrar som angetts för åtgärden CreateOrUpdate API Management-tjänsten.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

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

beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Skapar eller uppdaterar en API Management-tjänst. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

parameters

ApiManagementServiceResource

Parametrar som tillhandahålls till åtgärden CreateOrUpdate API Management service.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ApiManagementServiceResource>

beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)

Tar bort en befintlig API Management tjänst.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

ApiManagementServiceDeleteOptionalParams

Alternativparametrarna.

Returer

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

beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)

Tar bort en befintlig API Management tjänst.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

ApiManagementServiceDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Uppgraderar en API Management-tjänst till Stv2-plattformen. Mer information finns i https://aka.ms/apim-migrate-stv2. Den här ändringen är inte reversibel. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

ApiManagementServiceMigrateToStv2OptionalParams

Alternativparametrarna.

Returer

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

beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Uppgraderar en API Management-tjänst till Stv2-plattformen. Mer information finns i https://aka.ms/apim-migrate-stv2. Den här ändringen är inte reversibel. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

ApiManagementServiceMigrateToStv2OptionalParams

Alternativparametrarna.

Returer

Promise<ApiManagementServiceResource>

beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Återställer en säkerhetskopia av en API Management tjänst som skapats med hjälp av den ApiManagementService_Backup åtgärden för den aktuella tjänsten. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

parameters

ApiManagementServiceBackupRestoreParameters

Parametrar som tillhandahålls till tjänsten Restore API Management from backup (Återställ API Management från säkerhetskopiering).

options

ApiManagementServiceRestoreOptionalParams

Alternativparametrarna.

Returer

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

beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Återställer en säkerhetskopia av en API Management tjänst som skapats med hjälp av den ApiManagementService_Backup åtgärden för den aktuella tjänsten. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

parameters

ApiManagementServiceBackupRestoreParameters

Parametrar som tillhandahålls till tjänsten Restore API Management from backup (Återställ API Management från säkerhetskopiering).

options

ApiManagementServiceRestoreOptionalParams

Alternativparametrarna.

Returer

Promise<ApiManagementServiceResource>

beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Uppdateringar en befintlig API Management tjänst.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

parameters

ApiManagementServiceUpdateParameters

Parametrar som tillhandahålls till åtgärden CreateOrUpdate API Management service.

options

ApiManagementServiceUpdateOptionalParams

Alternativparametrarna.

Returer

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

beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Uppdateringar en befintlig API Management tjänst.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

parameters

ApiManagementServiceUpdateParameters

Parametrar som tillhandahålls till åtgärden CreateOrUpdate API Management service.

options

ApiManagementServiceUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<ApiManagementServiceResource>

checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)

Kontrollerar tillgänglighet och korrekthet för ett namn för en API Management-tjänst.

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

Parametrar

parameters

ApiManagementServiceCheckNameAvailabilityParameters

Parametrar som har angetts för åtgärden CheckNameAvailability.

options

ApiManagementServiceCheckNameAvailabilityOptionalParams

Alternativparametrarna.

Returer

Promise<ApiManagementServiceNameAvailabilityResult>

get(string, string, ApiManagementServiceGetOptionalParams)

Hämtar en API Management tjänstresursbeskrivning.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

ApiManagementServiceGetOptionalParams

Alternativparametrarna.

Returer

Promise<ApiManagementServiceResource>

getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)

Hämta den anpassade domänägaridentifieraren för en API Management-tjänst.

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

Parametrar

options

ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams

Alternativparametrarna.

Returer

Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>

getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)

Hämtar token för enkel inloggning för API Management-tjänsten som är giltig i 5 minuter.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

ApiManagementServiceGetSsoTokenOptionalParams

Alternativparametrarna.

Returer

Promise<ApiManagementServiceGetSsoTokenResult>

list(ApiManagementServiceListOptionalParams)

Visar en lista över alla API Management tjänster i en Azure-prenumeration.

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

Parametrar

options

ApiManagementServiceListOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>

listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)

Visa en lista över alla API Management tjänster i en resursgrupp.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

options

ApiManagementServiceListByResourceGroupOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>