ApiGateway interface

Pacote:

@azure/arm-apimanagement

Interface que representa um ApiGateway.

Métodos

beginCreateOrUpdate(string, string, ApiManagementGatewayResource, ApiGatewayCreateOrUpdateOptionalParams)	Cria ou atualiza um gateway de Gerenciamento de API. Esta é uma operação de longa duração e pode levar vários minutos para ser concluída.
beginCreateOrUpdateAndWait(string, string, ApiManagementGatewayResource, ApiGatewayCreateOrUpdateOptionalParams)	Cria ou atualiza um gateway de Gerenciamento de API. Esta é uma operação de longa duração e pode levar vários minutos para ser concluída.
beginDelete(string, string, ApiGatewayDeleteOptionalParams)	Exclui um gateway de Gerenciamento de API existente.
beginDeleteAndWait(string, string, ApiGatewayDeleteOptionalParams)	Exclui um gateway de Gerenciamento de API existente.
beginUpdate(string, string, ApiManagementGatewayUpdateParameters, ApiGatewayUpdateOptionalParams)	Atualiza um gateway de gerenciamento de API existente.
beginUpdateAndWait(string, string, ApiManagementGatewayUpdateParameters, ApiGatewayUpdateOptionalParams)	Atualiza um gateway de gerenciamento de API existente.
get(string, string, ApiGatewayGetOptionalParams)	Obtém uma descrição de recurso do gateway de Gerenciamento de API.
list(ApiGatewayListOptionalParams)	Liste todos os gateways de Gerenciamento de API em uma assinatura.
listByResourceGroup(string, ApiGatewayListByResourceGroupOptionalParams)	Liste todos os gateways de Gerenciamento de API dentro de um grupo de recursos.

Detalhes de Método

beginCreateOrUpdate(string, string, ApiManagementGatewayResource, ApiGatewayCreateOrUpdateOptionalParams)

Cria ou atualiza um gateway de Gerenciamento de API. Esta é uma operação de longa duração e pode levar vários minutos para ser concluída.

function beginCreateOrUpdate(resourceGroupName: string, gatewayName: string, parameters: ApiManagementGatewayResource, options?: ApiGatewayCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementGatewayResource>, ApiManagementGatewayResource>>

Parâmetros

resourceGroupName

string

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

gatewayName

string

O nome do gateway de Gerenciamento de API.

parameters

ApiManagementGatewayResource

Parâmetros fornecidos para a operação do gateway de gerenciamento de API CreateOrUpdate.

options

ApiGatewayCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

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

beginCreateOrUpdateAndWait(string, string, ApiManagementGatewayResource, ApiGatewayCreateOrUpdateOptionalParams)

Cria ou atualiza um gateway de Gerenciamento de API. Esta é uma operação de longa duração e pode levar vários minutos para ser concluída.

function beginCreateOrUpdateAndWait(resourceGroupName: string, gatewayName: string, parameters: ApiManagementGatewayResource, options?: ApiGatewayCreateOrUpdateOptionalParams): Promise<ApiManagementGatewayResource>

Parâmetros

resourceGroupName

string

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

gatewayName

string

O nome do gateway de Gerenciamento de API.

parameters

ApiManagementGatewayResource

Parâmetros fornecidos para a operação do gateway de gerenciamento de API CreateOrUpdate.

options

ApiGatewayCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiManagementGatewayResource>

beginDelete(string, string, ApiGatewayDeleteOptionalParams)

Exclui um gateway de Gerenciamento de API existente.

function beginDelete(resourceGroupName: string, gatewayName: string, options?: ApiGatewayDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ApiGatewayDeleteResponse>, ApiGatewayDeleteResponse>>

Parâmetros

resourceGroupName

string

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

gatewayName

string

O nome do gateway de Gerenciamento de API.

options

ApiGatewayDeleteOptionalParams

Os parâmetros de opções.

Devoluções

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

beginDeleteAndWait(string, string, ApiGatewayDeleteOptionalParams)

Exclui um gateway de Gerenciamento de API existente.

function beginDeleteAndWait(resourceGroupName: string, gatewayName: string, options?: ApiGatewayDeleteOptionalParams): Promise<ApiGatewayDeleteResponse>

Parâmetros

resourceGroupName

string

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

gatewayName

string

O nome do gateway de Gerenciamento de API.

options

ApiGatewayDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiGatewayDeleteResponse>

beginUpdate(string, string, ApiManagementGatewayUpdateParameters, ApiGatewayUpdateOptionalParams)

Atualiza um gateway de gerenciamento de API existente.

function beginUpdate(resourceGroupName: string, gatewayName: string, parameters: ApiManagementGatewayUpdateParameters, options?: ApiGatewayUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementGatewayResource>, ApiManagementGatewayResource>>

Parâmetros

resourceGroupName

string

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

gatewayName

string

O nome do gateway de Gerenciamento de API.

parameters

ApiManagementGatewayUpdateParameters

Parâmetros fornecidos para a operação do gateway de gerenciamento de API CreateOrUpdate.

options

ApiGatewayUpdateOptionalParams

Os parâmetros de opções.

Devoluções

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

beginUpdateAndWait(string, string, ApiManagementGatewayUpdateParameters, ApiGatewayUpdateOptionalParams)

Atualiza um gateway de gerenciamento de API existente.

function beginUpdateAndWait(resourceGroupName: string, gatewayName: string, parameters: ApiManagementGatewayUpdateParameters, options?: ApiGatewayUpdateOptionalParams): Promise<ApiManagementGatewayResource>

Parâmetros

resourceGroupName

string

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

gatewayName

string

O nome do gateway de Gerenciamento de API.

parameters

ApiManagementGatewayUpdateParameters

Parâmetros fornecidos para a operação do gateway de gerenciamento de API CreateOrUpdate.

options

ApiGatewayUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiManagementGatewayResource>

get(string, string, ApiGatewayGetOptionalParams)

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

function get(resourceGroupName: string, gatewayName: string, options?: ApiGatewayGetOptionalParams): Promise<ApiManagementGatewayResource>

Parâmetros

resourceGroupName

string

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

gatewayName

string

O nome do gateway de Gerenciamento de API.

options

ApiGatewayGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiManagementGatewayResource>

list(ApiGatewayListOptionalParams)

Liste todos os gateways de Gerenciamento de API em uma assinatura.

function list(options?: ApiGatewayListOptionalParams): PagedAsyncIterableIterator<ApiManagementGatewayResource, ApiManagementGatewayResource[], PageSettings>

Parâmetros

options

ApiGatewayListOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ApiManagementGatewayResource, ApiManagementGatewayResource[], PageSettings>

listByResourceGroup(string, ApiGatewayListByResourceGroupOptionalParams)

Liste todos os gateways de Gerenciamento de API dentro de um grupo de recursos.

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

Parâmetros

resourceGroupName

string

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

options

ApiGatewayListByResourceGroupOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ApiManagementGatewayResource, ApiManagementGatewayResource[], PageSettings>