Compartilhar via

ProductPolicy interface

  • Referência
Pacote:
@azure/arm-apimanagement

Interface que representa um ProductPolicy.

Métodos

createOrUpdate(string, string, string, string, PolicyContract, ProductPolicyCreateOrUpdateOptionalParams)

Cria ou atualiza a configuração de política para o Produto.
delete(string, string, string, string, string, ProductPolicyDeleteOptionalParams)

Exclui a configuração de política no Produto.
get(string, string, string, string, ProductPolicyGetOptionalParams)

Obtenha a configuração de política no nível do produto.
getEntityTag(string, string, string, string, ProductPolicyGetEntityTagOptionalParams)

Obtenha a ETag da configuração de política no nível do produto.
listByProduct(string, string, string, ProductPolicyListByProductOptionalParams)

Obtenha a configuração de política no nível do produto.

Detalhes do método

createOrUpdate(string, string, string, string, PolicyContract, ProductPolicyCreateOrUpdateOptionalParams)

Cria ou atualiza a configuração de política para o Produto.

function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, policyId: string, parameters: PolicyContract, options?: ProductPolicyCreateOrUpdateOptionalParams): Promise<ProductPolicyCreateOrUpdateResponse>

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.

productId

string

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

policyId

string

O identificador da Política.

parameters
PolicyContract

O conteúdo da política a ser aplicado.

options
ProductPolicyCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<ProductPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, ProductPolicyDeleteOptionalParams)

Exclui a configuração de política no Produto.

function delete(resourceGroupName: string, serviceName: string, productId: string, policyId: string, ifMatch: string, options?: ProductPolicyDeleteOptionalParams): 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.

productId

string

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

policyId

string

O identificador da Política.

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.

options
ProductPolicyDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, string, string, string, ProductPolicyGetOptionalParams)

Obtenha a configuração de política no nível do produto.

function get(resourceGroupName: string, serviceName: string, productId: string, policyId: string, options?: ProductPolicyGetOptionalParams): Promise<ProductPolicyGetResponse>

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.

productId

string

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

policyId

string

O identificador da Política.

options
ProductPolicyGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<ProductPolicyGetResponse>

getEntityTag(string, string, string, string, ProductPolicyGetEntityTagOptionalParams)

Obtenha a ETag da configuração de política no nível do produto.

function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, policyId: string, options?: ProductPolicyGetEntityTagOptionalParams): Promise<ProductPolicyGetEntityTagHeaders>

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.

productId

string

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

policyId

string

O identificador da Política.

options
ProductPolicyGetEntityTagOptionalParams

Os parâmetros de opções.

Retornos

Promise<ProductPolicyGetEntityTagHeaders>

listByProduct(string, string, string, ProductPolicyListByProductOptionalParams)

Obtenha a configuração de política no nível do produto.

function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductPolicyListByProductOptionalParams): PagedAsyncIterableIterator<PolicyContract, PolicyContract[], 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.

productId

string

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

options
ProductPolicyListByProductOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<PolicyContract, PolicyContract[], PageSettings>