GatewayApi interface

Pacote:

@azure/arm-apimanagement

Interface que representa uma GatewayApi.

Métodos

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)	Adiciona uma API ao Gateway especificado.
delete(string, string, string, string, GatewayApiDeleteOptionalParams)	Exclui a API especificada do Gateway especificado.
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)	Verifica se a entidade da API especificada pelo identificador está associada à entidade Gateway.
listByService(string, string, string, GatewayApiListByServiceOptionalParams)	Lista uma coleção de APIs associadas a um gateway.

Detalhes de Método

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)

Adiciona uma API ao Gateway especificado.

function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço de Gerenciamento de API.

gatewayId

string

Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'

apiId

string

Identificador de API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options

GatewayApiCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

Promise<ApiContract>

delete(string, string, string, string, GatewayApiDeleteOptionalParams)

Exclui a API especificada do Gateway especificado.

function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): Promise<void>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço de Gerenciamento de API.

gatewayId

string

Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'

apiId

string

Identificador de API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options

GatewayApiDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)

Verifica se a entidade da API especificada pelo identificador está associada à entidade Gateway.

function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço de Gerenciamento de API.

gatewayId

string

Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'

apiId

string

Identificador de API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options

GatewayApiGetEntityTagOptionalParams

Os parâmetros de opções.

Devoluções

Promise<GatewayApiGetEntityTagHeaders>

listByService(string, string, string, GatewayApiListByServiceOptionalParams)

Lista uma coleção de APIs associadas a um gateway.

function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço de Gerenciamento de API.

gatewayId

string

Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'

options

GatewayApiListByServiceOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>