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 uma cópia de segurança do serviço Gestão de API para a Conta de Armazenamento do Azure especificada. Esta operação é de execução prolongada e pode demorar vários minutos a ser concluída.
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)	Cria uma cópia de segurança do serviço Gestão de API para a Conta de Armazenamento do Azure especificada. Esta operação é de execução prolongada e pode demorar vários minutos a ser concluída.
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Cria ou atualiza um serviço Gestão de API. Esta operação é de execução prolongada e pode demorar vários minutos a ser concluída.
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)	Cria ou atualiza um serviço Gestão de API. Esta operação é de execução prolongada e pode demorar vários minutos a ser concluída.
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)	Elimina um serviço de Gestão de API existente.
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)	Elimina um serviço de Gestão de API existente.
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Atualiza um serviço Gestão de API para a plataforma Stv2. Para obter detalhes, veja https://aka.ms/apim-migrate-stv2. Esta alteração não é reversível. Esta operação é de execução prolongada e pode demorar vários minutos a concluir.
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)	Atualiza um serviço Gestão de API para a plataforma Stv2. Para obter detalhes, veja https://aka.ms/apim-migrate-stv2. Esta alteração não é reversível. Esta operação é de execução prolongada e pode demorar vários minutos a concluir.
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Restaura uma cópia de segurança de um serviço Gestão de API criado com a operação de ApiManagementService_Backup no serviço atual. Trata-se de uma operação de execução prolongada e pode demorar vários minutos a concluir.
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)	Restaura uma cópia de segurança de um serviço Gestão de API criado com a operação de ApiManagementService_Backup no serviço atual. Trata-se de uma operação de execução prolongada e pode demorar vários minutos a concluir.
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Atualizações um serviço de Gestão de API existente.
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)	Atualizações um serviço de Gestão de API existente.
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)	Verifica a disponibilidade e a correção de um nome para um serviço Gestão de API.
get(string, string, ApiManagementServiceGetOptionalParams)	Obtém uma descrição do recurso de serviço Gestão de API.
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)	Obtenha o identificador de propriedade de domínio personalizado para um serviço Gestão de API.
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)	Obtém o token de Início de Sessão Único para o Serviço de Gestão de API, que é válido durante 5 Minutos.
list(ApiManagementServiceListOptionalParams)	Lista todos os serviços Gestão de API numa subscrição do Azure.
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)	Listar todos os serviços Gestão de API num grupo de recursos.

Detalhes de 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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Os parâmetros de opções.

Devoluções

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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

options

ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiManagementServiceResource>

beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Cria uma cópia de segurança do serviço Gestão de API para a Conta de Armazenamento do Azure especificada. Esta operação é de execução prolongada e pode demorar vários minutos a 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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

parameters

ApiManagementServiceBackupRestoreParameters

Parâmetros fornecidos à operação de ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

Os parâmetros de opções.

Devoluções

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

beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)

Cria uma cópia de segurança do serviço Gestão de API para a Conta de Armazenamento do Azure especificada. Esta operação é de execução prolongada e pode demorar vários minutos a 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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

parameters

ApiManagementServiceBackupRestoreParameters

Parâmetros fornecidos à operação de ApiManagementService_Backup.

options

ApiManagementServiceBackupOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiManagementServiceResource>

beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Cria ou atualiza um serviço Gestão de API. Esta operação é de execução prolongada e pode demorar vários minutos a 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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

parameters

ApiManagementServiceResource

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

options

ApiManagementServiceCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

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

beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)

Cria ou atualiza um serviço Gestão de API. Esta operação é de execução prolongada e pode demorar vários minutos a 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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

parameters

ApiManagementServiceResource

Parâmetros fornecidos para a operação createOrUpdate Gestão de API serviço.

options

ApiManagementServiceCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiManagementServiceResource>

beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)

Elimina um serviço de Gestão de API existente.

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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

options

ApiManagementServiceDeleteOptionalParams

Os parâmetros de opções.

Devoluções

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

beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)

Elimina um serviço de Gestão de API existente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

options

ApiManagementServiceDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Atualiza um serviço Gestão de API para a plataforma Stv2. Para obter detalhes, veja https://aka.ms/apim-migrate-stv2. Esta alteração não é reversível. Esta operação é de execução prolongada e pode demorar vários minutos a concluir.

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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

options

ApiManagementServiceMigrateToStv2OptionalParams

Os parâmetros de opções.

Devoluções

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

beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)

Atualiza um serviço Gestão de API para a plataforma Stv2. Para obter detalhes, veja https://aka.ms/apim-migrate-stv2. Esta alteração não é reversível. Esta operação é de execução prolongada e pode demorar vários minutos a concluir.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

options

ApiManagementServiceMigrateToStv2OptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiManagementServiceResource>

beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Restaura uma cópia de segurança de um serviço Gestão de API criado com a operação de ApiManagementService_Backup no serviço atual. Trata-se de uma operação de execução prolongada e pode demorar vários minutos a concluir.

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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

parameters

ApiManagementServiceBackupRestoreParameters

Parâmetros fornecidos ao serviço Restaurar Gestão de API a partir da operação de cópia de segurança.

options

ApiManagementServiceRestoreOptionalParams

Os parâmetros de opções.

Devoluções

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

beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)

Restaura uma cópia de segurança de um serviço Gestão de API criado com a operação de ApiManagementService_Backup no serviço atual. Trata-se de uma operação de execução prolongada e pode demorar vários minutos a concluir.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

parameters

ApiManagementServiceBackupRestoreParameters

Parâmetros fornecidos ao serviço Restaurar Gestão de API a partir da operação de cópia de segurança.

options

ApiManagementServiceRestoreOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiManagementServiceResource>

beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Atualizações um serviço de Gestão 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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

parameters

ApiManagementServiceUpdateParameters

Parâmetros fornecidos para a operação createOrUpdate Gestão de API serviço.

options

ApiManagementServiceUpdateOptionalParams

Os parâmetros de opções.

Devoluções

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

beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)

Atualizações um serviço de Gestão 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 não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

parameters

ApiManagementServiceUpdateParameters

Parâmetros fornecidos para a operação createOrUpdate Gestão de API serviço.

options

ApiManagementServiceUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiManagementServiceResource>

checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)

Verifica a disponibilidade e a correção de um nome para um serviço Gestão 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.

Devoluções

Promise<ApiManagementServiceNameAvailabilityResult>

get(string, string, ApiManagementServiceGetOptionalParams)

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

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

options

ApiManagementServiceGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiManagementServiceResource>

getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)

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

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

Parâmetros

options

ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>

getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)

Obtém o token de Início de Sessão Único para o Serviço de Gestão de API, que é válido durante 5 Minutos.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName

string

O nome do serviço Gestão de API.

options

ApiManagementServiceGetSsoTokenOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiManagementServiceGetSsoTokenResult>

list(ApiManagementServiceListOptionalParams)

Lista todos os serviços Gestão de API numa subscrição do Azure.

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

Parâmetros

options

ApiManagementServiceListOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>

listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)

Listar todos os serviços Gestão de API num 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 não é sensível a maiúsculas e minúsculas.

options

ApiManagementServiceListByResourceGroupOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>