ApiPolicy interface

Paket:

@azure/arm-apimanagement

Schnittstelle, die eine ApiPolicy darstellt.

Methoden

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)	Erstellt oder aktualisiert die Richtlinienkonfiguration für die API
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)	Löscht die Richtlinienkonfiguration aus der API
get(string, string, string, string, ApiPolicyGetOptionalParams)	Ruft die Richtlinienkonfiguration auf API-Ebene ab
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)	Ruft die Etag-Version (Entity State) der API-Richtlinie ab, die durch den Bezeichner angegeben wird.
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)	Ruft die Richtlinienkonfiguration auf API-Ebene ab

Details zur Methode

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

Erstellt oder aktualisiert die Richtlinienkonfiguration für die API

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

policyId

string

Der Bezeichner der Richtlinie.

parameters

PolicyContract

Der anzuwendende Richtlinieninhalt.

options

ApiPolicyCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiPolicyCreateOrUpdateResponse>

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

Löscht die Richtlinienkonfiguration aus der API

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

policyId

string

Der Bezeichner der Richtlinie.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.

options

ApiPolicyDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

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

Ruft die Richtlinienkonfiguration auf API-Ebene ab

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

policyId

string

Der Bezeichner der Richtlinie.

options

ApiPolicyGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiPolicyGetResponse>

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

Ruft die Etag-Version (Entity State) der API-Richtlinie ab, die durch den Bezeichner angegeben wird.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

policyId

string

Der Bezeichner der Richtlinie.

options

ApiPolicyGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<ApiPolicyGetEntityTagHeaders>

listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

Ruft die Richtlinienkonfiguration auf API-Ebene ab

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): Promise<PolicyCollection>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API Management-Diensts.

apiId

string

API-Revisionsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Nicht aktuelle Revision hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

options

ApiPolicyListByApiOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<PolicyCollection>