ApiOperationPolicy interface
Interface représentant une ApiOperationPolicy.
Méthodes
| create |
Crée ou met à jour la configuration de stratégie pour le niveau d’opération d’API. |
| delete(string, string, string, string, string, string, Api |
Supprime la configuration de la stratégie au niveau de l’opération d’API. |
| get(string, string, string, string, string, Api |
Obtenez la configuration de la stratégie au niveau de l’opération d’API. |
| get |
Obtient la version d’état d’entité (Etag) de la stratégie d’opération d’API spécifiée par son identificateur. |
| list |
Obtenez la liste de la configuration 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 d’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 l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service Gestion des API.
- policyId
-
string
Identificateur de la stratégie.
- parameters
- PolicyContract
Contenu de la stratégie à appliquer.
Paramètres d’options.
Retours
delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)
Supprime la configuration de la stratégie au niveau 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 l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service Gestion des API.
- policyId
-
string
Identificateur de la stratégie.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
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 d’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 l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service Gestion des API.
- policyId
-
string
Identificateur de la stratégie.
Paramètres d’options.
Retours
Promise<ApiOperationPolicyGetResponse>
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 l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service Gestion des API.
- policyId
-
string
Identificateur de la stratégie.
Paramètres d’options.
Retours
listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)
Obtenez la liste de la configuration 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 l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération dans une API. Doit être unique dans l’instance actuelle du service Gestion des API.
Paramètres d’options.
Retours
Promise<PolicyCollection>