PortalConfig interface

Pacote:

@azure/arm-apimanagement

Interface que representa um PortalConfig.

Métodos

createOrUpdate(string, string, string, string, PortalConfigContract, PortalConfigCreateOrUpdateOptionalParams)	Crie ou atualize a configuração do portal do desenvolvedor.
get(string, string, string, PortalConfigGetOptionalParams)	Obtenha a configuração do portal do desenvolvedor.
getEntityTag(string, string, string, PortalConfigGetEntityTagOptionalParams)	Obtém a versão de estado da entidade (Etag) da configuração do portal do desenvolvedor.
listByService(string, string, PortalConfigListByServiceOptionalParams)	Lista as configurações do portal do desenvolvedor.
update(string, string, string, string, PortalConfigContract, PortalConfigUpdateOptionalParams)	Atualize a configuração do portal do desenvolvedor.

Detalhes do método

createOrUpdate(string, string, string, string, PortalConfigContract, PortalConfigCreateOrUpdateOptionalParams)

Crie ou atualize a configuração do portal do desenvolvedor.

function createOrUpdate(resourceGroupName: string, serviceName: string, portalConfigId: string, ifMatch: string, parameters: PortalConfigContract, options?: PortalConfigCreateOrUpdateOptionalParams): Promise<PortalConfigContract>

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.

portalConfigId

string

Identificador de configuração do portal.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

parameters

PortalConfigContract

Atualize a configuração do portal do desenvolvedor.

options

PortalConfigCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<PortalConfigContract>

get(string, string, string, PortalConfigGetOptionalParams)

Obtenha a configuração do portal do desenvolvedor.

function get(resourceGroupName: string, serviceName: string, portalConfigId: string, options?: PortalConfigGetOptionalParams): Promise<PortalConfigGetResponse>

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.

portalConfigId

string

Identificador de configuração do portal.

options

PortalConfigGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<PortalConfigGetResponse>

getEntityTag(string, string, string, PortalConfigGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) da configuração do portal do desenvolvedor.

function getEntityTag(resourceGroupName: string, serviceName: string, portalConfigId: string, options?: PortalConfigGetEntityTagOptionalParams): Promise<PortalConfigGetEntityTagHeaders>

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.

portalConfigId

string

Identificador de configuração do portal.

options

PortalConfigGetEntityTagOptionalParams

Os parâmetros de opções.

Retornos

Promise<PortalConfigGetEntityTagHeaders>

listByService(string, string, PortalConfigListByServiceOptionalParams)

Lista as configurações do portal do desenvolvedor.

function listByService(resourceGroupName: string, serviceName: string, options?: PortalConfigListByServiceOptionalParams): Promise<PortalConfigCollection>

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.

options

PortalConfigListByServiceOptionalParams

Os parâmetros de opções.

Retornos

Promise<PortalConfigCollection>

update(string, string, string, string, PortalConfigContract, PortalConfigUpdateOptionalParams)

Atualize a configuração do portal do desenvolvedor.

function update(resourceGroupName: string, serviceName: string, portalConfigId: string, ifMatch: string, parameters: PortalConfigContract, options?: PortalConfigUpdateOptionalParams): Promise<PortalConfigContract>

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.

portalConfigId

string

Identificador de configuração do portal.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

parameters

PortalConfigContract

Atualize a configuração do portal do desenvolvedor.

options

PortalConfigUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<PortalConfigContract>