ApiIssueComment interface
Interface représentant une APIIssueComment.
Méthodes
| create |
Crée un commentaire pour le problème dans une API ou met à jour un commentaire existant. |
| delete(string, string, string, string, string, string, Api |
Supprime le commentaire spécifié d’un problème. |
| get(string, string, string, string, string, Api |
Obtient les détails du problème Comment pour une API spécifiée par son identificateur. |
| get |
Obtient la version d’état d’entité (Etag) du problème Comment pour une API spécifiée par son identificateur. |
| list |
Répertorie tous les commentaires relatifs au problème associé à l’API spécifiée. |
Détails de la méthode
createOrUpdate(string, string, string, string, string, IssueCommentContract, ApiIssueCommentCreateOrUpdateOptionalParams)
Crée un commentaire pour le problème dans une API ou met à jour un commentaire existant.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, parameters: IssueCommentContract, options?: ApiIssueCommentCreateOrUpdateOptionalParams): Promise<ApiIssueCommentCreateOrUpdateResponse>
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 d’API. Doit être unique dans l’instance actuelle du service Gestion des API.
- issueId
-
string
Identificateur de problème. Doit être unique dans l’instance actuelle du service Gestion des API.
- commentId
-
string
Identificateur de commentaire dans un problème. Doit être unique dans le problème actuel.
- parameters
- IssueCommentContract
Créez des paramètres.
Paramètres d’options.
Retours
delete(string, string, string, string, string, string, ApiIssueCommentDeleteOptionalParams)
Supprime le commentaire spécifié d’un problème.
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, ifMatch: string, options?: ApiIssueCommentDeleteOptionalParams): 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 d’API. Doit être unique dans l’instance actuelle du service Gestion des API.
- issueId
-
string
Identificateur de problème. Doit être unique dans l’instance actuelle du service Gestion des API.
- commentId
-
string
Identificateur de commentaire dans un problème. Doit être unique dans le problème 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.
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, string, string, ApiIssueCommentGetOptionalParams)
Obtient les détails du problème Comment pour une API spécifiée par son identificateur.
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetOptionalParams): Promise<ApiIssueCommentGetResponse>
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 d’API. Doit être unique dans l’instance actuelle du service Gestion des API.
- issueId
-
string
Identificateur de problème. Doit être unique dans l’instance actuelle du service Gestion des API.
- commentId
-
string
Identificateur de commentaire dans un problème. Doit être unique dans le problème actuel.
- options
- ApiIssueCommentGetOptionalParams
Paramètres d’options.
Retours
Promise<ApiIssueCommentGetResponse>
getEntityTag(string, string, string, string, string, ApiIssueCommentGetEntityTagOptionalParams)
Obtient la version d’état d’entité (Etag) du problème Comment pour une API spécifiée par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetEntityTagOptionalParams): Promise<ApiIssueCommentGetEntityTagHeaders>
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 d’API. Doit être unique dans l’instance actuelle du service Gestion des API.
- issueId
-
string
Identificateur de problème. Doit être unique dans l’instance actuelle du service Gestion des API.
- commentId
-
string
Identificateur de commentaire dans un problème. Doit être unique dans le problème actuel.
Paramètres d’options.
Retours
Promise<ApiIssueCommentGetEntityTagHeaders>
listByService(string, string, string, string, ApiIssueCommentListByServiceOptionalParams)
Répertorie tous les commentaires relatifs au problème associé à l’API spécifiée.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueCommentListByServiceOptionalParams): PagedAsyncIterableIterator<IssueCommentContract, IssueCommentContract[], 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 d’API. Doit être unique dans l’instance actuelle du service Gestion des API.
- issueId
-
string
Identificateur de problème. Doit être unique dans l’instance actuelle du service Gestion des API.
Paramètres d’options.