WorkspaceApiOperationPolicy interface

Paket:

@azure/arm-apimanagement

Schnittstelle, die eine WorkspaceApiOperationPolicy darstellt.

Methoden

createOrUpdate(string, string, string, string, string, string, PolicyContract, WorkspaceApiOperationPolicyCreateOrUpdateOptionalParams)	Erstellt oder aktualisiert die Richtlinienkonfiguration auf Ebene des API-Vorgangs
delete(string, string, string, string, string, string, string, WorkspaceApiOperationPolicyDeleteOptionalParams)	Löscht die Richtlinienkonfiguration aus dem API-Vorgang
get(string, string, string, string, string, string, WorkspaceApiOperationPolicyGetOptionalParams)	Rufen Sie die Richtlinienkonfiguration auf API-Vorgangsebene ab.
getEntityTag(string, string, string, string, string, string, WorkspaceApiOperationPolicyGetEntityTagOptionalParams)	Ruft die Entitätsstatusversion (Etag) der API-Vorgangsrichtlinie ab, die durch den Bezeichner angegeben wird.
listByOperation(string, string, string, string, string, WorkspaceApiOperationPolicyListByOperationOptionalParams)	Ruft die Liste der Richtlinienkonfigurationen auf Ebene des API-Vorgangs ab

Details zur Methode

createOrUpdate(string, string, string, string, string, string, PolicyContract, WorkspaceApiOperationPolicyCreateOrUpdateOptionalParams)

Erstellt oder aktualisiert die Richtlinienkonfiguration auf Ebene des API-Vorgangs

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: WorkspaceApiOperationPolicyCreateOrUpdateOptionalParams): Promise<WorkspaceApiOperationPolicyCreateOrUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

apiId

string

API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

policyId

string

Der Bezeichner der Richtlinie.

parameters

PolicyContract

Der anzuwendende Richtlinieninhalt.

options

WorkspaceApiOperationPolicyCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<WorkspaceApiOperationPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, string, string, WorkspaceApiOperationPolicyDeleteOptionalParams)

Löscht die Richtlinienkonfiguration aus dem API-Vorgang

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

apiId

string

API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

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 bedingungslose Aktualisierung sein.

options

WorkspaceApiOperationPolicyDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, string, string, string, WorkspaceApiOperationPolicyGetOptionalParams)

Rufen Sie die Richtlinienkonfiguration auf API-Vorgangsebene ab.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, policyId: string, options?: WorkspaceApiOperationPolicyGetOptionalParams): Promise<WorkspaceApiOperationPolicyGetResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

apiId

string

API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

policyId

string

Der Bezeichner der Richtlinie.

options

WorkspaceApiOperationPolicyGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<WorkspaceApiOperationPolicyGetResponse>

getEntityTag(string, string, string, string, string, string, WorkspaceApiOperationPolicyGetEntityTagOptionalParams)

Ruft die Entitätsstatusversion (Etag) der API-Vorgangsrichtlinie ab, die durch den Bezeichner angegeben wird.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, policyId: string, options?: WorkspaceApiOperationPolicyGetEntityTagOptionalParams): Promise<WorkspaceApiOperationPolicyGetEntityTagHeaders>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

apiId

string

API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

policyId

string

Der Bezeichner der Richtlinie.

options

WorkspaceApiOperationPolicyGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<WorkspaceApiOperationPolicyGetEntityTagHeaders>

listByOperation(string, string, string, string, string, WorkspaceApiOperationPolicyListByOperationOptionalParams)

Ruft die Liste der Richtlinienkonfigurationen auf Ebene des API-Vorgangs ab

function listByOperation(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationPolicyListByOperationOptionalParams): PagedAsyncIterableIterator<PolicyContract, PolicyContract[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

apiId

string

API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

operationId

string

Vorgangsbezeichner innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

options

WorkspaceApiOperationPolicyListByOperationOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<PolicyContract, PolicyContract[], PageSettings>