ApiOperationPolicy interface
Schnittstelle, die eine ApiOperationPolicy darstellt.
Methoden
| create |
Erstellt oder aktualisiert die Richtlinienkonfiguration für die API-Vorgangsebene. |
| delete(string, string, string, string, string, string, Api |
Löscht die Richtlinienkonfiguration beim API-Vorgang. |
| get(string, string, string, string, string, Api |
Rufen Sie die Richtlinienkonfiguration auf API-Vorgangsebene ab. |
| get |
Ruft die Entitätsstatusversion (Etag) der API-Vorgangsrichtlinie ab, die durch den Bezeichner angegeben wird. |
| list |
Rufen Sie die Liste der Richtlinienkonfiguration auf API-Vorgangsebene ab. |
Details zur Methode
createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)
Erstellt oder aktualisiert die Richtlinienkonfiguration für die API-Vorgangsebene.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- 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.
Die Optionsparameter.
Gibt zurück
delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)
Löscht die Richtlinienkonfiguration beim API-Vorgang.
function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, ifMatch: string, options?: ApiOperationPolicyDeleteOptionalParams): 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.
- 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.
Die Optionsparameter.
Gibt zurück
Promise<void>
get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)
Rufen Sie die Richtlinienkonfiguration auf API-Vorgangsebene ab.
function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- 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.
Die Optionsparameter.
Gibt zurück
Promise<ApiOperationPolicyGetResponse>
getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)
Ruft die Entitätsstatusversion (Etag) der API-Vorgangsrichtlinie ab, die durch den Bezeichner angegeben wird.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagHeaders>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- 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.
Die Optionsparameter.
Gibt zurück
listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)
Rufen Sie die Liste der Richtlinienkonfiguration auf API-Vorgangsebene ab.
function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): Promise<PolicyCollection>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API-Verwaltungsdiensts.
- 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.
Die Optionsparameter.
Gibt zurück
Promise<PolicyCollection>