ApiIssue interface
Интерфейс, представляющий ApiIssue.
Методы
| create |
Создает новую проблему для API или обновляет существующую. |
| delete(string, string, string, string, string, Api |
Удаляет указанную проблему из API. |
| get(string, string, string, string, Api |
Возвращает сведения о проблеме для API, указанного его идентификатором. |
| get |
Возвращает версию состояния сущности (Etag) проблемы для API, указанного ее идентификатором. |
| list |
Выводит список всех проблем, связанных с указанным API. |
| update(string, string, string, string, string, Issue |
Обновления существующей проблемы с API. |
Сведения о методе
createOrUpdate(string, string, string, string, IssueContract, ApiIssueCreateOrUpdateOptionalParams)
Создает новую проблему для API или обновляет существующую.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, parameters: IssueContract, options?: ApiIssueCreateOrUpdateOptionalParams): Promise<ApiIssueCreateOrUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
- issueId
-
string
Идентификатор проблемы. Должен быть уникальным в текущем экземпляре службы Управление API.
- parameters
- IssueContract
Создайте параметры.
Параметры параметров.
Возвращаемое значение
Promise<ApiIssueCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiIssueDeleteOptionalParams)
Удаляет указанную проблему из API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, options?: ApiIssueDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
- issueId
-
string
Идентификатор проблемы. Должен быть уникальным в текущем экземпляре службы Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- options
- ApiIssueDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
get(string, string, string, string, ApiIssueGetOptionalParams)
Возвращает сведения о проблеме для API, указанного его идентификатором.
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetOptionalParams): Promise<ApiIssueGetResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
- issueId
-
string
Идентификатор проблемы. Должен быть уникальным в текущем экземпляре службы Управление API.
- options
- ApiIssueGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<ApiIssueGetResponse>
getEntityTag(string, string, string, string, ApiIssueGetEntityTagOptionalParams)
Возвращает версию состояния сущности (Etag) проблемы для API, указанного ее идентификатором.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetEntityTagOptionalParams): Promise<ApiIssueGetEntityTagHeaders>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
- issueId
-
string
Идентификатор проблемы. Должен быть уникальным в текущем экземпляре службы Управление API.
Параметры параметров.
Возвращаемое значение
Promise<ApiIssueGetEntityTagHeaders>
listByService(string, string, string, ApiIssueListByServiceOptionalParams)
Выводит список всех проблем, связанных с указанным API.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiIssueListByServiceOptionalParams): PagedAsyncIterableIterator<IssueContract, IssueContract[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
Параметры параметров.
Возвращаемое значение
update(string, string, string, string, string, IssueUpdateContract, ApiIssueUpdateOptionalParams)
Обновления существующей проблемы с API.
function update(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, parameters: IssueUpdateContract, options?: ApiIssueUpdateOptionalParams): Promise<ApiIssueUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
- issueId
-
string
Идентификатор проблемы. Должен быть уникальным в текущем экземпляре службы Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- parameters
- IssueUpdateContract
Обновление параметров.
- options
- ApiIssueUpdateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<ApiIssueUpdateResponse>