ApiOperationPolicy interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un oggetto ApiOperationPolicy.

Metodi

createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)	Crea o aggiorna la configurazione dei criteri per il livello dell'operazione API.
delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)	Elimina la configurazione dei criteri nell'operazione API.
get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)	Ottenere la configurazione dei criteri a livello di operazione API.
getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)	Ottiene la versione dello stato dell'entità (Etag) dei criteri dell'operazione API specificati dal relativo identificatore.
listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)	Ottenere l'elenco di configurazione dei criteri a livello di operazione API.

Dettagli metodo

createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)

Crea o aggiorna la configurazione dei criteri per il livello dell'operazione API.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.

operationId

string

Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

policyId

string

Identificatore del criterio.

parameters

PolicyContract

Contenuto dei criteri da applicare.

options

ApiOperationPolicyCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiOperationPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)

Elimina la configurazione dei criteri nell'operazione API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.

operationId

string

Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

policyId

string

Identificatore del criterio.

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

options

ApiOperationPolicyDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)

Ottenere la configurazione dei criteri a livello di operazione API.

function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.

operationId

string

Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

policyId

string

Identificatore del criterio.

options

ApiOperationPolicyGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiOperationPolicyGetResponse>

getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)

Ottiene la versione dello stato dell'entità (Etag) dei criteri dell'operazione API specificati dal relativo identificatore.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagHeaders>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.

operationId

string

Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

policyId

string

Identificatore del criterio.

options

ApiOperationPolicyGetEntityTagOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiOperationPolicyGetEntityTagHeaders>

listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)

Ottenere l'elenco di configurazione dei criteri a livello di operazione API.

function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): Promise<PolicyCollection>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.

operationId

string

Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

ApiOperationPolicyListByOperationOptionalParams

Parametri delle opzioni.

Restituisce

Promise<PolicyCollection>