Compartilhar via

Policy interface

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

Interface que representa uma Política.

Métodos

createOrUpdate(string, string, string, PolicyContract, PolicyCreateOrUpdateOptionalParams)

Cria ou atualiza a configuração de política global do serviço de Gerenciamento de API.
delete(string, string, string, string, PolicyDeleteOptionalParams)

Exclui a configuração de política global do serviço de Gerenciamento de API.
get(string, string, string, PolicyGetOptionalParams)

Obtenha a definição de política global do serviço de Gerenciamento de API.
getEntityTag(string, string, string, PolicyGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) da definição de política global no serviço de Gerenciamento de API.
listByService(string, string, PolicyListByServiceOptionalParams)

Lista todas as definições de política global do serviço de Gerenciamento de API.

Detalhes do método

createOrUpdate(string, string, string, PolicyContract, PolicyCreateOrUpdateOptionalParams)

Cria ou atualiza a configuração de política global do serviço de Gerenciamento de API.

function createOrUpdate(resourceGroupName: string, serviceName: string, policyId: string, parameters: PolicyContract, options?: PolicyCreateOrUpdateOptionalParams): Promise<PolicyCreateOrUpdateResponse>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço Gerenciamento de API.

policyId

string

O identificador da Política.

parameters
PolicyContract

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

options
PolicyCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicyCreateOrUpdateResponse>

delete(string, string, string, string, PolicyDeleteOptionalParams)

Exclui a configuração de política global do serviço de Gerenciamento de API.

function delete(resourceGroupName: string, serviceName: string, policyId: string, ifMatch: string, options?: PolicyDeleteOptionalParams): Promise<void>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço 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
PolicyDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, string, string, PolicyGetOptionalParams)

Obtenha a definição de política global do serviço de Gerenciamento de API.

function get(resourceGroupName: string, serviceName: string, policyId: string, options?: PolicyGetOptionalParams): Promise<PolicyGetResponse>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço Gerenciamento de API.

policyId

string

O identificador da Política.

options
PolicyGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicyGetResponse>

getEntityTag(string, string, string, PolicyGetEntityTagOptionalParams)

Obtém a versão de estado da entidade (Etag) da definição de política global no serviço de Gerenciamento de API.

function getEntityTag(resourceGroupName: string, serviceName: string, policyId: string, options?: PolicyGetEntityTagOptionalParams): Promise<PolicyGetEntityTagHeaders>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço Gerenciamento de API.

policyId

string

O identificador da Política.

options
PolicyGetEntityTagOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicyGetEntityTagHeaders>

listByService(string, string, PolicyListByServiceOptionalParams)

Lista todas as definições de política global do serviço de Gerenciamento de API.

function listByService(resourceGroupName: string, serviceName: string, options?: PolicyListByServiceOptionalParams): Promise<PolicyCollection>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço Gerenciamento de API.

options
PolicyListByServiceOptionalParams

Os parâmetros de opções.

Retornos

Promise<PolicyCollection>