ApiManagementService interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un ApiManagementService.

Metodi

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	Aggiorna la risorsa Microsoft.ApiManagement in esecuzione nella rete virtuale per selezionare le modifiche DNS aggiornate.
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	Aggiorna la risorsa Microsoft.ApiManagement in esecuzione nella rete virtuale per selezionare le modifiche DNS aggiornate.
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Crea un backup del servizio Gestione API nell'account di archiviazione di Azure specificato. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Crea un backup del servizio Gestione API nell'account di archiviazione di Azure specificato. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Crea o aggiorna un servizio Gestione API. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Crea o aggiorna un servizio Gestione API. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)	Elimina un servizio Gestione API esistente.
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)	Elimina un servizio Gestione API esistente.
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Aggiorna un servizio Gestione API alla piattaforma Stv2. Per informazioni dettagliate, vedere https://aka.ms/apim-migrate-stv2. Questa modifica non è reversibile. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Aggiorna un servizio Gestione API alla piattaforma Stv2. Per informazioni dettagliate, vedere https://aka.ms/apim-migrate-stv2. Questa modifica non è reversibile. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Ripristina un backup di un servizio Gestione API creato usando l'operazione di ApiManagementService_Backup nel servizio corrente. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Ripristina un backup di un servizio Gestione API creato usando l'operazione di ApiManagementService_Backup nel servizio corrente. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Aggiorna un servizio Gestione API esistente.
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Aggiorna un servizio Gestione API esistente.
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)	Verifica la disponibilità e la correttezza di un nome per un servizio Gestione API.
get(string, string, ApiManagementServiceGetOptionalParams)	Ottiene una descrizione della risorsa del servizio Gestione API.
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)	Ottenere l'identificatore di proprietà del dominio personalizzato per un servizio Gestione API.
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)	Ottiene il token single-Sign-On per il servizio Gestione API valido per 5 minuti.
list(ApiManagementServiceListOptionalParams)	Elenca tutti i servizi di Gestione API all'interno di una sottoscrizione di Azure.
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)	Elencare tutti i servizi di Gestione API all'interno di un gruppo di risorse.

Dettagli metodo

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

Aggiorna la risorsa Microsoft.ApiManagement in esecuzione nella rete virtuale per selezionare le modifiche DNS aggiornate.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Parametri delle opzioni.

Restituisce

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

beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

Aggiorna la risorsa Microsoft.ApiManagement in esecuzione nella rete virtuale per selezionare le modifiche DNS aggiornate.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiManagementServiceResource>

beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Crea un backup del servizio Gestione API nell'account di archiviazione di Azure specificato. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

parameters

ApiManagementServiceBackupRestoreParameters

Parametri forniti all'operazione di ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

Parametri delle opzioni.

Restituisce

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

beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Crea un backup del servizio Gestione API nell'account di archiviazione di Azure specificato. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

parameters

ApiManagementServiceBackupRestoreParameters

Parametri forniti all'operazione di ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiManagementServiceResource>

beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Crea o aggiorna un servizio Gestione API. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

parameters

ApiManagementServiceResource

Parametri forniti all'operazione del servizio Gestione API CreateOrUpdate.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

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

beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Crea o aggiorna un servizio Gestione API. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

parameters

ApiManagementServiceResource

Parametri forniti all'operazione del servizio Gestione API CreateOrUpdate.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiManagementServiceResource>

beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)

Elimina un servizio Gestione API esistente.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

options

ApiManagementServiceDeleteOptionalParams

Parametri delle opzioni.

Restituisce

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

beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)

Elimina un servizio Gestione API esistente.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

options

ApiManagementServiceDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Aggiorna un servizio Gestione API alla piattaforma Stv2. Per informazioni dettagliate, vedere https://aka.ms/apim-migrate-stv2. Questa modifica non è reversibile. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

options

ApiManagementServiceMigrateToStv2OptionalParams

Parametri delle opzioni.

Restituisce

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

beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Aggiorna un servizio Gestione API alla piattaforma Stv2. Per informazioni dettagliate, vedere https://aka.ms/apim-migrate-stv2. Questa modifica non è reversibile. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

options

ApiManagementServiceMigrateToStv2OptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiManagementServiceResource>

beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Ripristina un backup di un servizio Gestione API creato usando l'operazione di ApiManagementService_Backup nel servizio corrente. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

parameters

ApiManagementServiceBackupRestoreParameters

Parametri forniti al servizio Gestione API di ripristino dall'operazione di backup.

options

ApiManagementServiceRestoreOptionalParams

Parametri delle opzioni.

Restituisce

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

beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Ripristina un backup di un servizio Gestione API creato usando l'operazione di ApiManagementService_Backup nel servizio corrente. Si tratta di un'operazione a esecuzione prolungata e il completamento potrebbe richiedere alcuni minuti.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

parameters

ApiManagementServiceBackupRestoreParameters

Parametri forniti al servizio Gestione API di ripristino dall'operazione di backup.

options

ApiManagementServiceRestoreOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiManagementServiceResource>

beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Aggiorna un servizio Gestione API esistente.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

parameters

ApiManagementServiceUpdateParameters

Parametri forniti all'operazione del servizio Gestione API CreateOrUpdate.

options

ApiManagementServiceUpdateOptionalParams

Parametri delle opzioni.

Restituisce

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

beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Aggiorna un servizio Gestione API esistente.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

parameters

ApiManagementServiceUpdateParameters

Parametri forniti all'operazione del servizio Gestione API CreateOrUpdate.

options

ApiManagementServiceUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiManagementServiceResource>

checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)

Verifica la disponibilità e la correttezza di un nome per un servizio Gestione API.

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

Parametri

parameters

ApiManagementServiceCheckNameAvailabilityParameters

Parametri forniti all'operazione CheckNameAvailability.

options

ApiManagementServiceCheckNameAvailabilityOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiManagementServiceNameAvailabilityResult>

get(string, string, ApiManagementServiceGetOptionalParams)

Ottiene una descrizione della risorsa del servizio Gestione API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

options

ApiManagementServiceGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiManagementServiceResource>

getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)

Ottenere l'identificatore di proprietà del dominio personalizzato per un servizio Gestione API.

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

Parametri

options

ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>

getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)

Ottiene il token single-Sign-On per il servizio Gestione API valido per 5 minuti.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

options

ApiManagementServiceGetSsoTokenOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiManagementServiceGetSsoTokenResult>

list(ApiManagementServiceListOptionalParams)

Elenca tutti i servizi di Gestione API all'interno di una sottoscrizione di Azure.

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

Parametri

options

ApiManagementServiceListOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>

listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)

Elencare tutti i servizi di Gestione API all'interno di un gruppo di risorse.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

options

ApiManagementServiceListByResourceGroupOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>