ApiOperationPolicy interface
Interface que representa uma ApiOperationPolicy.
Métodos
| create |
Cria ou atualiza a configuração da política para o nível de Operação de API. |
| delete(string, string, string, string, string, string, Api |
Elimina a configuração da política na Operação de API. |
| get(string, string, string, string, string, Api |
Obtenha a configuração da política ao nível da Operação de API. |
| get |
Obtém a versão do estado da entidade (Etag) da política de operação da API especificada pelo respetivo identificador. |
| list |
Obtenha a lista de configuração de políticas ao nível da Operação de API. |
Detalhes de Método
createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)
Cria ou atualiza a configuração da política para o nível de Operação de API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>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 do 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.
- operationId
-
string
Identificador de operação numa API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- 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
delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)
Elimina a configuração da política na Operação de API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, ifMatch: string, options?: ApiOperationPolicyDeleteOptionalParams): 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 do 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.
- operationId
-
string
Identificador de operação numa API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- 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.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)
Obtenha a configuração da política ao nível da Operação de API.
function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>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 do 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.
- operationId
-
string
Identificador de operação numa API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- policyId
-
string
O identificador da Política.
Os parâmetros de opções.
Devoluções
Promise<ApiOperationPolicyGetResponse>
getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) da política de operação da API especificada pelo respetivo identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagHeaders>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 do 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.
- operationId
-
string
Identificador de operação numa API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- policyId
-
string
O identificador da Política.
Os parâmetros de opções.
Devoluções
listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)
Obtenha a lista de configuração de políticas ao nível da Operação de API.
function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): 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 do 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.
- operationId
-
string
Identificador de operação numa API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
Os parâmetros de opções.
Devoluções
Promise<PolicyCollection>