ApiManagementService interface

Paquete:

@azure/arm-apimanagement

Interfaz que representa apiManagementService.

Métodos

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	Actualiza el recurso Microsoft.ApiManagement que se ejecuta en la red virtual para elegir los cambios de DNS actualizados.
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	Actualiza el recurso Microsoft.ApiManagement que se ejecuta en la red virtual para elegir los cambios de DNS actualizados.
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Crea una copia de seguridad del servicio API Management en la cuenta de Azure Storage especificada. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Crea una copia de seguridad del servicio API Management en la cuenta de Azure Storage especificada. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Crea o actualiza un servicio de API Management. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Crea o actualiza un servicio de API Management. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)	Elimina un servicio de API Management existente.
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)	Elimina un servicio de API Management existente.
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Actualiza un servicio API Management a la plataforma Stv2. Para obtener más información, consulte https://aka.ms/apim-migrate-stv2. Este cambio no es reversible. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Actualiza un servicio API Management a la plataforma Stv2. Para obtener más información, consulte https://aka.ms/apim-migrate-stv2. Este cambio no es reversible. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Restaura una copia de seguridad de un servicio de API Management creado mediante la operación ApiManagementService_Backup en el servicio actual. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Restaura una copia de seguridad de un servicio de API Management creado mediante la operación ApiManagementService_Backup en el servicio actual. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Actualiza un servicio de API Management existente.
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Actualiza un servicio de API Management existente.
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)	Comprueba la disponibilidad y corrección de un nombre para un servicio de API Management.
get(string, string, ApiManagementServiceGetOptionalParams)	Obtiene una descripción del recurso del servicio API Management.
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)	Obtenga el identificador de propiedad de dominio personalizado para un servicio API Management.
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)	Obtiene el token deSign-On único para el servicio API Management que es válido durante 5 minutos.
list(ApiManagementServiceListOptionalParams)	Enumera todos los servicios de API Management dentro de una suscripción de Azure.
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)	Enumere todos los servicios de API Management dentro de un grupo de recursos.

Detalles del método

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

Actualiza el recurso Microsoft.ApiManagement que se ejecuta en la red virtual para elegir los cambios de DNS actualizados.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Parámetros de opciones.

Devoluciones

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

beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

Actualiza el recurso Microsoft.ApiManagement que se ejecuta en la red virtual para elegir los cambios de DNS actualizados.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiManagementServiceResource>

beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Crea una copia de seguridad del servicio API Management en la cuenta de Azure Storage especificada. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

parameters

ApiManagementServiceBackupRestoreParameters

Parámetros proporcionados a la operación de ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

Parámetros de opciones.

Devoluciones

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

beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Crea una copia de seguridad del servicio API Management en la cuenta de Azure Storage especificada. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

parameters

ApiManagementServiceBackupRestoreParameters

Parámetros proporcionados a la operación de ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiManagementServiceResource>

beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Crea o actualiza un servicio de API Management. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

parameters

ApiManagementServiceResource

Parámetros proporcionados a la operación del servicio CreateOrUpdate API Management.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

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

beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Crea o actualiza un servicio de API Management. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

parameters

ApiManagementServiceResource

Parámetros proporcionados a la operación del servicio CreateOrUpdate API Management.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiManagementServiceResource>

beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)

Elimina un servicio de API Management existente.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

options

ApiManagementServiceDeleteOptionalParams

Parámetros de opciones.

Devoluciones

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

beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)

Elimina un servicio de API Management existente.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

options

ApiManagementServiceDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Actualiza un servicio API Management a la plataforma Stv2. Para obtener más información, consulte https://aka.ms/apim-migrate-stv2. Este cambio no es reversible. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

options

ApiManagementServiceMigrateToStv2OptionalParams

Parámetros de opciones.

Devoluciones

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

beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Actualiza un servicio API Management a la plataforma Stv2. Para obtener más información, consulte https://aka.ms/apim-migrate-stv2. Este cambio no es reversible. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

options

ApiManagementServiceMigrateToStv2OptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiManagementServiceResource>

beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Restaura una copia de seguridad de un servicio de API Management creado mediante la operación ApiManagementService_Backup en el servicio actual. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

parameters

ApiManagementServiceBackupRestoreParameters

Parámetros proporcionados al servicio Restore API Management desde la operación de copia de seguridad.

options

ApiManagementServiceRestoreOptionalParams

Parámetros de opciones.

Devoluciones

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

beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Restaura una copia de seguridad de un servicio de API Management creado mediante la operación ApiManagementService_Backup en el servicio actual. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

parameters

ApiManagementServiceBackupRestoreParameters

Parámetros proporcionados al servicio Restore API Management desde la operación de copia de seguridad.

options

ApiManagementServiceRestoreOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiManagementServiceResource>

beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Actualiza un servicio de API Management existente.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

parameters

ApiManagementServiceUpdateParameters

Parámetros proporcionados a la operación del servicio CreateOrUpdate API Management.

options

ApiManagementServiceUpdateOptionalParams

Parámetros de opciones.

Devoluciones

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

beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Actualiza un servicio de API Management existente.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

parameters

ApiManagementServiceUpdateParameters

Parámetros proporcionados a la operación del servicio CreateOrUpdate API Management.

options

ApiManagementServiceUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiManagementServiceResource>

checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)

Comprueba la disponibilidad y corrección de un nombre para un servicio de API Management.

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

Parámetros

parameters

ApiManagementServiceCheckNameAvailabilityParameters

Parámetros proporcionados a la operación CheckNameAvailability.

options

ApiManagementServiceCheckNameAvailabilityOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiManagementServiceNameAvailabilityResult>

get(string, string, ApiManagementServiceGetOptionalParams)

Obtiene una descripción del recurso del servicio API Management.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

options

ApiManagementServiceGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiManagementServiceResource>

getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)

Obtenga el identificador de propiedad de dominio personalizado para un servicio API Management.

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

Parámetros

options

ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>

getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)

Obtiene el token deSign-On único para el servicio API Management que es válido durante 5 minutos.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

options

ApiManagementServiceGetSsoTokenOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ApiManagementServiceGetSsoTokenResult>

list(ApiManagementServiceListOptionalParams)

Enumera todos los servicios de API Management dentro de una suscripción de Azure.

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

Parámetros

options

ApiManagementServiceListOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>

listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)

Enumere todos los servicios de API Management dentro de un grupo de recursos.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

options

ApiManagementServiceListByResourceGroupOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>