Partager via


ApiOperationPolicy interface

Interface représentant une ApiOperationPolicy.

Méthodes

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

Crée ou met à jour la configuration de stratégie pour le niveau de l’opération d’API.

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

Supprime la configuration de stratégie de l’opération d’API.

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

Obtenez la configuration de la stratégie au niveau de l’opération de l’API.

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

Obtient la version d’état d’entité (Etag) de la stratégie d’opération d’API spécifiée par son identificateur.

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

Obtient la liste de configurations de stratégie au niveau de l’opération d’API.

Détails de la méthode

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

Crée ou met à jour la configuration de stratégie pour le niveau de l’opération d’API.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.

operationId

string

Identificateur d’opération au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.

policyId

string

Identificateur de la stratégie.

parameters
PolicyContract

Contenu de la stratégie à appliquer.

options
ApiOperationPolicyCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

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

Supprime la configuration de stratégie de l’opération d’API.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.

operationId

string

Identificateur d’opération au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.

policyId

string

Identificateur de la stratégie.

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

options
ApiOperationPolicyDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

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

Obtenez la configuration de la stratégie au niveau de l’opération de l’API.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.

operationId

string

Identificateur d’opération au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.

policyId

string

Identificateur de la stratégie.

options
ApiOperationPolicyGetOptionalParams

Paramètres d’options.

Retours

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

Obtient la version d’état d’entité (Etag) de la stratégie d’opération d’API spécifiée par son identificateur.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.

operationId

string

Identificateur d’opération au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.

policyId

string

Identificateur de la stratégie.

options
ApiOperationPolicyGetEntityTagOptionalParams

Paramètres d’options.

Retours

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

Obtient la liste de configurations de stratégie au niveau de l’opération d’API.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

apiId

string

Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.

operationId

string

Identificateur d’opération au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.

options
ApiOperationPolicyListByOperationOptionalParams

Paramètres d’options.

Retours

Promise<PolicyCollection>