Policy interface
Interface que representa uma Política.
Métodos
create |
Cria ou atualiza a configuração de política global do serviço de Gestão de API. |
delete(string, string, string, string, Policy |
Elimina a configuração de política global do Serviço de Gestão de API. |
get(string, string, string, Policy |
Obtenha a definição de política Global do serviço de Gestão de API. |
get |
Obtém a versão do estado da entidade (Etag) da definição de política Global no serviço de Gestão de API. |
list |
Lista todas as definições de Política Global do serviço de Gestão de API. |
Detalhes de Método
createOrUpdate(string, string, string, PolicyContract, PolicyCreateOrUpdateOptionalParams)
Cria ou atualiza a configuração de política global do serviço de Gestão 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- policyId
-
string
O identificador da Política.
- parameters
- PolicyContract
O conteúdo da política a aplicar.
Os parâmetros de opções.
Devoluções
Promise<PolicyCreateOrUpdateResponse>
delete(string, string, string, string, PolicyDeleteOptionalParams)
Elimina a configuração de política global do Serviço de Gestão 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão 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 do pedido GET ou deve ser * para atualização incondicional.
- options
- PolicyDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, PolicyGetOptionalParams)
Obtenha a definição de política Global do serviço de Gestão 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- policyId
-
string
O identificador da Política.
- options
- PolicyGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<PolicyGetResponse>
getEntityTag(string, string, string, PolicyGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) da definição de política Global no serviço de Gestão 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- policyId
-
string
O identificador da Política.
- options
- PolicyGetEntityTagOptionalParams
Os parâmetros de opções.
Devoluções
Promise<PolicyGetEntityTagHeaders>
listByService(string, string, PolicyListByServiceOptionalParams)
Lista todas as definições de Política Global do serviço de Gestão de API.
function listByService(resourceGroupName: string, serviceName: string, options?: PolicyListByServiceOptionalParams): Promise<PolicyCollection>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
Os parâmetros de opções.
Devoluções
Promise<PolicyCollection>