Documentation interface

Paquet:

@azure/arm-apimanagement

Interface représentant une documentation.

Méthodes

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)	Crée une documentation ou met à jour une documentation existante.
delete(string, string, string, string, DocumentationDeleteOptionalParams)	Supprime la documentation spécifiée d’une API.
get(string, string, string, DocumentationGetOptionalParams)	Obtient les détails de la documentation spécifiée par son identificateur.
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)	Obtient la version de l’état de l’entité (Etag) de la documentation par son identificateur.
listByService(string, string, DocumentationListByServiceOptionalParams)	Répertorie toutes les documentations du service Gestion des API instance.
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)	Mises à jour les détails de la documentation d’une API spécifiée par son identificateur.

Détails de la méthode

createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)

Crée une documentation ou met à jour une documentation existante.

function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>

Paramètres

resourceGroupName

string

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

serviceName

string

Nom du service Gestion des API.

documentationId

string

Identificateur de documentation. Doit être unique dans le instance de service Gestion des API actuel.

parameters

DocumentationContract

Créez des paramètres.

options

DocumentationCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<DocumentationCreateOrUpdateResponse>

delete(string, string, string, string, DocumentationDeleteOptionalParams)

Supprime la documentation spécifiée d’une API.

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

documentationId

string

Identificateur de documentation. Doit être unique dans le instance de service Gestion des API actuel.

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

DocumentationDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, string, DocumentationGetOptionalParams)

Obtient les détails de la documentation spécifiée par son identificateur.

function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>

Paramètres

resourceGroupName

string

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

serviceName

string

Nom du service Gestion des API.

documentationId

string

Identificateur de documentation. Doit être unique dans le instance de service Gestion des API actuel.

options

DocumentationGetOptionalParams

Paramètres d’options.

Retours

Promise<DocumentationGetResponse>

getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)

Obtient la version de l’état de l’entité (Etag) de la documentation par son identificateur.

function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>

Paramètres

resourceGroupName

string

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

serviceName

string

Nom du service Gestion des API.

documentationId

string

Identificateur de documentation. Doit être unique dans le instance de service Gestion des API actuel.

options

DocumentationGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<DocumentationGetEntityTagHeaders>

listByService(string, string, DocumentationListByServiceOptionalParams)

Répertorie toutes les documentations du service Gestion des API instance.

function listByService(resourceGroupName: string, serviceName: string, options?: DocumentationListByServiceOptionalParams): PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], 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.

options

DocumentationListByServiceOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>

update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)

Mises à jour les détails de la documentation d’une API spécifiée par son identificateur.

function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>

Paramètres

resourceGroupName

string

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

serviceName

string

Nom du service Gestion des API.

documentationId

string

Identificateur de documentation. Doit être unique dans le instance de service Gestion des API actuel.

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

DocumentationUpdateContract

Paramètres de mise à jour de la documentation.

options

DocumentationUpdateOptionalParams

Paramètres d’options.

Retours

Promise<DocumentationUpdateResponse>