ApiPolicy interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un'ApiPolicy.

Metodi

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)	Crea o aggiorna la configurazione dei criteri per l'API.
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)	Elimina la configurazione dei criteri nell'API.
get(string, string, string, string, ApiPolicyGetOptionalParams)	Ottenere la configurazione dei criteri a livello di API.
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)	Ottiene la versione dello stato dell'entità (Etag) dei criteri API specificati dal relativo identificatore.
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)	Ottenere la configurazione dei criteri a livello di API.

Dettagli metodo

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)

Crea o aggiorna la configurazione dei criteri per l'API.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, parameters: PolicyContract, options?: ApiPolicyCreateOrUpdateOptionalParams): Promise<ApiPolicyCreateOrUpdateResponse>

Parametri

resourceGroupName

string

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

serviceName

string

Nome del servizio Gestione API.

apiId

string

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

policyId

string

Identificatore del criterio.

parameters

PolicyContract

Contenuto dei criteri da applicare.

options

ApiPolicyCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)

Elimina la configurazione dei criteri nell'API.

function delete(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, ifMatch: string, options?: ApiPolicyDeleteOptionalParams): 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 Gestione API.

apiId

string

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

policyId

string

Identificatore del criterio.

ifMatch

string

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

options

ApiPolicyDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

get(string, string, string, string, ApiPolicyGetOptionalParams)

Ottenere la configurazione dei criteri a livello di API.

function get(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetOptionalParams): Promise<ApiPolicyGetResponse>

Parametri

resourceGroupName

string

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

serviceName

string

Nome del servizio Gestione API.

apiId

string

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

policyId

string

Identificatore del criterio.

options

ApiPolicyGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiPolicyGetResponse>

getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetEntityTagOptionalParams): Promise<ApiPolicyGetEntityTagHeaders>

Parametri

resourceGroupName

string

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

serviceName

string

Nome del servizio Gestione API.

apiId

string

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

policyId

string

Identificatore del criterio.

options

ApiPolicyGetEntityTagOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiPolicyGetEntityTagHeaders>

listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

Ottenere la configurazione dei criteri a livello di API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): 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 Gestione API.

apiId

string

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

options

ApiPolicyListByApiOptionalParams

Parametri delle opzioni.

Restituisce

Promise<PolicyCollection>