ApiPolicy interface
Interface que representa uma ApiPolicy.
Métodos
| create |
Cria ou atualiza a configuração da política para a API. |
| delete(string, string, string, string, string, Api |
Elimina a configuração da política na API. |
| get(string, string, string, string, Api |
Obtenha a configuração da política ao nível da API. |
| get |
Obtém a versão de estado da entidade (Etag) da política de API especificada pelo identificador. |
| list |
Obtenha a configuração da política ao nível da API. |
Detalhes de Método
createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)
Cria ou atualiza a configuração da política para a API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, parameters: PolicyContract, options?: ApiPolicyCreateOrUpdateOptionalParams): Promise<ApiPolicyCreateOrUpdateResponse>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.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço de Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- 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<ApiPolicyCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)
Elimina a configuração da política na API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, ifMatch: string, options?: ApiPolicyDeleteOptionalParams): 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.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço de Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- policyId
-
string
O identificador da Política.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- options
- ApiPolicyDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, ApiPolicyGetOptionalParams)
Obtenha a configuração da política ao nível da API.
function get(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetOptionalParams): Promise<ApiPolicyGetResponse>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.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço de Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- policyId
-
string
O identificador da Política.
- options
- ApiPolicyGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiPolicyGetResponse>
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)
Obtém a versão de estado da entidade (Etag) da política de API especificada pelo identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetEntityTagOptionalParams): Promise<ApiPolicyGetEntityTagHeaders>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.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço de Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- policyId
-
string
O identificador da Política.
Os parâmetros de opções.
Devoluções
Promise<ApiPolicyGetEntityTagHeaders>
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)
Obtenha a configuração da política ao nível da API.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): 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.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço de Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- options
- ApiPolicyListByApiOptionalParams
Os parâmetros de opções.
Devoluções
Promise<PolicyCollection>