ApiIssue interface
Interfejs reprezentujący interfejs APIIssue.
Metody
| create |
Tworzy nowy problem dla interfejsu API lub aktualizuje istniejący. |
| delete(string, string, string, string, string, Api |
Usuwa określony problem z interfejsu API. |
| get(string, string, string, string, Api |
Pobiera szczegóły problemu dla interfejsu API określonego przez jego identyfikator. |
| get |
Pobiera wersję stanu jednostki (Etag) problemu dla interfejsu API określonego przez jego identyfikator. |
| list |
Wyświetla listę wszystkich problemów skojarzonych z określonym interfejsem API. |
| update(string, string, string, string, string, Issue |
Aktualizuje istniejący problem dotyczący interfejsu API. |
Szczegóły metody
createOrUpdate(string, string, string, string, IssueContract, ApiIssueCreateOrUpdateOptionalParams)
Tworzy nowy problem dla interfejsu API lub aktualizuje istniejący.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, parameters: IssueContract, options?: ApiIssueCreateOrUpdateOptionalParams): Promise<ApiIssueCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na 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.
- parameters
- IssueContract
Utwórz parametry.
Parametry opcji.
Zwraca
Promise<ApiIssueCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiIssueDeleteOptionalParams)
Usuwa określony problem z interfejsu API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, options?: ApiIssueDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na 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.
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
- options
- ApiIssueDeleteOptionalParams
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, string, ApiIssueGetOptionalParams)
Pobiera szczegóły problemu dla interfejsu API określonego przez jego identyfikator.
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetOptionalParams): Promise<ApiIssueGetResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na 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.
- options
- ApiIssueGetOptionalParams
Parametry opcji.
Zwraca
Promise<ApiIssueGetResponse>
getEntityTag(string, string, string, string, ApiIssueGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) problemu dla interfejsu API określonego przez jego identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetEntityTagOptionalParams): Promise<ApiIssueGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na 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.
Zwraca
Promise<ApiIssueGetEntityTagHeaders>
listByService(string, string, string, ApiIssueListByServiceOptionalParams)
Wyświetla listę wszystkich problemów skojarzonych z określonym interfejsem API.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiIssueListByServiceOptionalParams): PagedAsyncIterableIterator<IssueContract, IssueContract[], PageSettings>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na 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.
Parametry opcji.
Zwraca
update(string, string, string, string, string, IssueUpdateContract, ApiIssueUpdateOptionalParams)
Aktualizuje istniejący problem dotyczący interfejsu API.
function update(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, parameters: IssueUpdateContract, options?: ApiIssueUpdateOptionalParams): Promise<ApiIssueUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na 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.
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
- parameters
- IssueUpdateContract
Aktualizuj parametry.
- options
- ApiIssueUpdateOptionalParams
Parametry opcji.
Zwraca
Promise<ApiIssueUpdateResponse>