ApiIssueComment interface
Интерфейс, представляющий ApiIssueComment.
Методы
| create |
Создает новый комментарий к проблеме в API или обновляет существующий. |
| delete(string, string, string, string, string, string, Api |
Удаляет указанный комментарий из проблемы. |
| get(string, string, string, string, string, Api |
Возвращает сведения о комментарии к проблеме для API, указанного его идентификатором. |
| get |
Возвращает версию состояния сущности (Etag) комментария проблемы для API, указанного его идентификатором. |
| list |
Выводит список всех комментариев к проблеме, связанной с указанным API. |
Сведения о методе
createOrUpdate(string, string, string, string, string, IssueCommentContract, ApiIssueCommentCreateOrUpdateOptionalParams)
Создает новый комментарий к проблеме в API или обновляет существующий.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, parameters: IssueCommentContract, options?: ApiIssueCommentCreateOrUpdateOptionalParams): Promise<ApiIssueCommentCreateOrUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
- issueId
-
string
Идентификатор проблемы. Должен быть уникальным в текущем экземпляре службы Управление API.
- commentId
-
string
Идентификатор комментария в проблеме. Должен быть уникальным в текущей проблеме.
- parameters
- IssueCommentContract
Создание параметров.
Параметры параметров.
Возвращаемое значение
delete(string, string, string, string, string, string, ApiIssueCommentDeleteOptionalParams)
Удаляет указанный комментарий из проблемы.
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, ifMatch: string, options?: ApiIssueCommentDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
- issueId
-
string
Идентификатор проблемы. Должен быть уникальным в текущем экземпляре службы Управление API.
- commentId
-
string
Идентификатор комментария в проблеме. Должен быть уникальным в текущей проблеме.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
Параметры параметров.
Возвращаемое значение
Promise<void>
get(string, string, string, string, string, ApiIssueCommentGetOptionalParams)
Возвращает сведения о комментарии к проблеме для API, указанного его идентификатором.
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetOptionalParams): Promise<ApiIssueCommentGetResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
- issueId
-
string
Идентификатор проблемы. Должен быть уникальным в текущем экземпляре службы Управление API.
- commentId
-
string
Идентификатор комментария в проблеме. Должен быть уникальным в текущей проблеме.
- options
- ApiIssueCommentGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<ApiIssueCommentGetResponse>
getEntityTag(string, string, string, string, string, ApiIssueCommentGetEntityTagOptionalParams)
Возвращает версию состояния сущности (Etag) комментария проблемы для API, указанного его идентификатором.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetEntityTagOptionalParams): Promise<ApiIssueCommentGetEntityTagHeaders>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
- issueId
-
string
Идентификатор проблемы. Должен быть уникальным в текущем экземпляре службы Управление API.
- commentId
-
string
Идентификатор комментария в проблеме. Должен быть уникальным в текущей проблеме.
Параметры параметров.
Возвращаемое значение
Promise<ApiIssueCommentGetEntityTagHeaders>
listByService(string, string, string, string, ApiIssueCommentListByServiceOptionalParams)
Выводит список всех комментариев к проблеме, связанной с указанным API.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueCommentListByServiceOptionalParams): PagedAsyncIterableIterator<IssueCommentContract, IssueCommentContract[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
- issueId
-
string
Идентификатор проблемы. Должен быть уникальным в текущем экземпляре службы Управление API.
Параметры параметров.