ApiIssueComment interface
Interfejs reprezentujący interfejs APIIssueComment.
Metody
create |
Tworzy nowy komentarz dla problemu w interfejsie API lub aktualizuje istniejący. |
delete(string, string, string, string, string, string, Api |
Usuwa określony komentarz z problemu. |
get(string, string, string, string, string, Api |
Pobiera szczegóły problemu Komentarz dla interfejsu API określonego przez jego identyfikator. |
get |
Pobiera wersję stanu jednostki (Etag) problemu Komentarz dla interfejsu API określonego przez jego identyfikator. |
list |
Wyświetla wszystkie komentarze dotyczące problemu skojarzonego z określonym interfejsem API. |
Szczegóły metody
createOrUpdate(string, string, string, string, string, IssueCommentContract, ApiIssueCommentCreateOrUpdateOptionalParams)
Tworzy nowy komentarz dla problemu w interfejsie API lub aktualizuje istniejący.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, parameters: IssueCommentContract, options?: ApiIssueCommentCreateOrUpdateOptionalParams): Promise<ApiIssueCommentCreateOrUpdateResponse>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- apiId
-
string
Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- issueId
-
string
Identyfikator problemu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- commentId
-
string
Identyfikator komentarza w ramach problemu. Musi być unikatowa w bieżącym problemie.
- parameters
- IssueCommentContract
Utwórz parametry.
Parametry opcji.
Zwraca
delete(string, string, string, string, string, string, ApiIssueCommentDeleteOptionalParams)
Usuwa określony komentarz z problemu.
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, ifMatch: string, options?: ApiIssueCommentDeleteOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- apiId
-
string
Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- issueId
-
string
Identyfikator problemu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- commentId
-
string
Identyfikator komentarza w ramach problemu. Musi być unikatowa w bieżącym problemie.
- ifMatch
-
string
ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * w przypadku aktualizacji bezwarunkowej.
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, string, string, ApiIssueCommentGetOptionalParams)
Pobiera szczegóły problemu Komentarz dla interfejsu API określonego przez jego identyfikator.
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetOptionalParams): Promise<ApiIssueCommentGetResponse>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- apiId
-
string
Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- issueId
-
string
Identyfikator problemu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- commentId
-
string
Identyfikator komentarza w ramach problemu. Musi być unikatowa w bieżącym problemie.
- options
- ApiIssueCommentGetOptionalParams
Parametry opcji.
Zwraca
Promise<ApiIssueCommentGetResponse>
getEntityTag(string, string, string, string, string, ApiIssueCommentGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) problemu Komentarz dla interfejsu API określonego przez jego identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetEntityTagOptionalParams): Promise<ApiIssueCommentGetEntityTagHeaders>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- apiId
-
string
Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- issueId
-
string
Identyfikator problemu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- commentId
-
string
Identyfikator komentarza w ramach problemu. Musi być unikatowa w bieżącym problemie.
Parametry opcji.
Zwraca
Promise<ApiIssueCommentGetEntityTagHeaders>
listByService(string, string, string, string, ApiIssueCommentListByServiceOptionalParams)
Wyświetla wszystkie komentarze dotyczące problemu skojarzonego z określonym interfejsem API.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueCommentListByServiceOptionalParams): PagedAsyncIterableIterator<IssueCommentContract, IssueCommentContract[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- apiId
-
string
Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- issueId
-
string
Identyfikator problemu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
Parametry opcji.