ApiPolicy interface

Paquet:

@azure/arm-apimanagement

Interface représentant une ApiPolicy.

Méthodes

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)	Crée ou met à jour la configuration de stratégie pour l’API.
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)	Supprime la configuration de stratégie de l’API.
get(string, string, string, string, ApiPolicyGetOptionalParams)	Obtient la configuration de stratégie au niveau de l’API.
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)	Obtient la version d’état d’entité (Etag) de la stratégie d’API spécifiée par son identificateur.
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)	Obtient la configuration de stratégie au niveau de l’API.

Détails de la méthode

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

Crée ou met à jour la configuration de stratégie pour l’API.

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

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.

policyId

string

Identificateur de la stratégie.

parameters

PolicyContract

Contenu de la stratégie à appliquer.

options

ApiPolicyCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<ApiPolicyCreateOrUpdateResponse>

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

Supprime la configuration de stratégie de l’API.

function delete(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, ifMatch: string, options?: ApiPolicyDeleteOptionalParams): 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.

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

ApiPolicyDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

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

Obtient la configuration de stratégie au niveau de l’API.

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

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.

policyId

string

Identificateur de la stratégie.

options

ApiPolicyGetOptionalParams

Paramètres d’options.

Retours

Promise<ApiPolicyGetResponse>

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

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

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

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.

policyId

string

Identificateur de la stratégie.

options

ApiPolicyGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<ApiPolicyGetEntityTagHeaders>

listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

Obtient la configuration de stratégie au niveau de l’API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): 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.

options

ApiPolicyListByApiOptionalParams

Paramètres d’options.

Retours

Promise<PolicyCollection>