ApiOperation interface

Paquet:

@azure/arm-apimanagement

Interface représentant une ApiOperation.

Méthodes

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)	Crée une opération dans l’API ou met à jour une opération existante.
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)	Supprime l’opération spécifiée dans l’API.
get(string, string, string, string, ApiOperationGetOptionalParams)	Obtient les détails de l’opération d’API spécifiée par son identificateur.
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)	Obtient la version d’état d’entité (Etag) de l’opération d’API spécifiée par son identificateur.
listByApi(string, string, string, ApiOperationListByApiOptionalParams)	Répertorie une collection des opérations pour l’API spécifiée.
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)	Met à jour les détails de l’opération dans l’API spécifiée par son identificateur.

Détails de la méthode

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)

Crée une opération dans l’API ou met à jour une opération existante.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, parameters: OperationContract, options?: ApiOperationCreateOrUpdateOptionalParams): Promise<ApiOperationCreateOrUpdateResponse>

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.

parameters

OperationContract

Créez des paramètres.

options

ApiOperationCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<ApiOperationCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

Supprime l’opération spécifiée dans l’API.

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

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.

options

ApiOperationDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, string, string, ApiOperationGetOptionalParams)

Obtient les détails de l’opération d’API spécifiée par son identificateur.

function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetOptionalParams): Promise<ApiOperationGetResponse>

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.

options

ApiOperationGetOptionalParams

Paramètres d’options.

Retours

Promise<ApiOperationGetResponse>

getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetEntityTagOptionalParams): Promise<ApiOperationGetEntityTagHeaders>

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.

options

ApiOperationGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<ApiOperationGetEntityTagHeaders>

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Répertorie une collection des opérations pour l’API spécifiée.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

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.

options

ApiOperationListByApiOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

Met à jour les détails de l’opération dans l’API spécifiée par son identificateur.

function update(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: ApiOperationUpdateOptionalParams): Promise<ApiOperationUpdateResponse>

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.

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.

parameters

OperationUpdateContract

Paramètres de mise à jour des opérations d’API.

options

ApiOperationUpdateOptionalParams

Paramètres d’options.

Retours

Promise<ApiOperationUpdateResponse>