ApiManagementService interface

Pacote:

@azure/arm-apimanagement

Interface que representa um ApiManagementService.

Métodos

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	Atualizações o recurso Microsoft.ApiManagement em execução na rede virtual para escolher as alterações de DNS atualizadas.
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)	Atualizações o recurso Microsoft.ApiManagement em execução na rede virtual para escolher as alterações de DNS atualizadas.
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Cria um backup do serviço Gerenciamento de API para a conta de Armazenamento do Azure fornecida. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Cria um backup do serviço Gerenciamento de API para a conta de Armazenamento do Azure fornecida. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Crie ou atualize um serviço do Gerenciamento de API. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Crie ou atualize um serviço do Gerenciamento de API. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)	Exclui um serviço de Gerenciamento de API.
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)	Exclui um serviço de Gerenciamento de API.
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Atualiza um serviço Gerenciamento de API para a plataforma Stv2. Para obter detalhes, consulte https://aka.ms/apim-migrate-stv2. Essa alteração não é reversível. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Atualiza um serviço Gerenciamento de API para a plataforma Stv2. Para obter detalhes, consulte https://aka.ms/apim-migrate-stv2. Essa alteração não é reversível. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Restaura um backup de um serviço de Gerenciamento de API criado usando a operação ApiManagementService_Backup no serviço atual. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Restaura um backup de um serviço de Gerenciamento de API criado usando a operação ApiManagementService_Backup no serviço atual. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Atualizações um serviço de Gerenciamento de API existente.
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Atualizações um serviço de Gerenciamento de API existente.
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)	Verifica a disponibilidade e a exatidão de um nome para um serviço de Gerenciamento de API.
get(string, string, ApiManagementServiceGetOptionalParams)	Obtém uma descrição do recurso de serviço Gerenciamento de API.
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)	Obtenha o identificador de propriedade de domínio personalizado para um serviço de Gerenciamento de API.
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)	Obtém o token de Logon Único para o Serviço de Gerenciamento de API que é válido por 5 minutos.
list(ApiManagementServiceListOptionalParams)	Lista todos os serviços Gerenciamento de API em uma assinatura do Azure.
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)	Liste todos os serviços Gerenciamento de API em um grupo de recursos.

Detalhes do método

beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

Atualizações o recurso Microsoft.ApiManagement em execução na rede virtual para escolher as alterações de DNS atualizadas.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Os parâmetros de opções.

Retornos

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

beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)

Atualizações o recurso Microsoft.ApiManagement em execução na rede virtual para escolher as alterações de DNS atualizadas.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiManagementServiceResource>

beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Cria um backup do serviço Gerenciamento de API para a conta de Armazenamento do Azure fornecida. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

parameters

ApiManagementServiceBackupRestoreParameters

Parâmetros fornecidos para a operação de ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

Os parâmetros de opções.

Retornos

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

beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Cria um backup do serviço Gerenciamento de API para a conta de Armazenamento do Azure fornecida. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

parameters

ApiManagementServiceBackupRestoreParameters

Parâmetros fornecidos para a operação de ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiManagementServiceResource>

beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Crie ou atualize um serviço do Gerenciamento de API. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

parameters

ApiManagementServiceResource

Parâmetros fornecidos para a operação de serviço Gerenciamento de API CreateOrUpdate.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

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

beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Crie ou atualize um serviço do Gerenciamento de API. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

parameters

ApiManagementServiceResource

Parâmetros fornecidos para a operação de serviço Gerenciamento de API CreateOrUpdate.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiManagementServiceResource>

beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)

Exclui um serviço de Gerenciamento de API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

options

ApiManagementServiceDeleteOptionalParams

Os parâmetros de opções.

Retornos

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

beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)

Exclui um serviço de Gerenciamento de API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

options

ApiManagementServiceDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Atualiza um serviço Gerenciamento de API para a plataforma Stv2. Para obter detalhes, consulte https://aka.ms/apim-migrate-stv2. Essa alteração não é reversível. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

options

ApiManagementServiceMigrateToStv2OptionalParams

Os parâmetros de opções.

Retornos

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

beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Atualiza um serviço Gerenciamento de API para a plataforma Stv2. Para obter detalhes, consulte https://aka.ms/apim-migrate-stv2. Essa alteração não é reversível. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

options

ApiManagementServiceMigrateToStv2OptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiManagementServiceResource>

beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Restaura um backup de um serviço de Gerenciamento de API criado usando a operação ApiManagementService_Backup no serviço atual. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

parameters

ApiManagementServiceBackupRestoreParameters

Parâmetros fornecidos para o serviço restaurar Gerenciamento de API da operação de backup.

options

ApiManagementServiceRestoreOptionalParams

Os parâmetros de opções.

Retornos

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

beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Restaura um backup de um serviço de Gerenciamento de API criado usando a operação ApiManagementService_Backup no serviço atual. Essa é uma operação de execução prolongada e pode levar vários minutos para ser concluída.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

parameters

ApiManagementServiceBackupRestoreParameters

Parâmetros fornecidos para o serviço restaurar Gerenciamento de API da operação de backup.

options

ApiManagementServiceRestoreOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiManagementServiceResource>

beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Atualizações um serviço de Gerenciamento de API existente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

parameters

ApiManagementServiceUpdateParameters

Parâmetros fornecidos para a operação de serviço Gerenciamento de API CreateOrUpdate.

options

ApiManagementServiceUpdateOptionalParams

Os parâmetros de opções.

Retornos

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

beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Atualizações um serviço de Gerenciamento de API existente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

parameters

ApiManagementServiceUpdateParameters

Parâmetros fornecidos para a operação de serviço Gerenciamento de API CreateOrUpdate.

options

ApiManagementServiceUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiManagementServiceResource>

checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)

Verifica a disponibilidade e a exatidão de um nome para um serviço de Gerenciamento de API.

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

Parâmetros

parameters

ApiManagementServiceCheckNameAvailabilityParameters

Parâmetros fornecidos para a operação CheckNameAvailability.

options

ApiManagementServiceCheckNameAvailabilityOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiManagementServiceNameAvailabilityResult>

get(string, string, ApiManagementServiceGetOptionalParams)

Obtém uma descrição do recurso de serviço Gerenciamento de API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

options

ApiManagementServiceGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiManagementServiceResource>

getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)

Obtenha o identificador de propriedade de domínio personalizado para um serviço de Gerenciamento de API.

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

Parâmetros

options

ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>

getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)

Obtém o token de Logon Único para o Serviço de Gerenciamento de API que é válido por 5 minutos.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

options

ApiManagementServiceGetSsoTokenOptionalParams

Os parâmetros de opções.

Retornos

Promise<ApiManagementServiceGetSsoTokenResult>

list(ApiManagementServiceListOptionalParams)

Lista todos os serviços Gerenciamento de API em uma assinatura do Azure.

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

Parâmetros

options

ApiManagementServiceListOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>

listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)

Liste todos os serviços Gerenciamento de API em um grupo de recursos.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

options

ApiManagementServiceListByResourceGroupOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>