ApiIssue interface
Interface representing a ApiIssue.
Methods
| create |
Creates a new Issue for an API or updates an existing one. |
| delete(string, string, string, string, string, Api |
Deletes the specified Issue from an API. |
| get(string, string, string, string, Api |
Gets the details of the Issue for an API specified by its identifier. |
| get |
Gets the entity state (Etag) version of the Issue for an API specified by its identifier. |
| list |
Lists all issues associated with the specified API. |
| update(string, string, string, string, string, Issue |
Updates an existing issue for an API. |
Method Details
createOrUpdate(string, string, string, string, IssueContract, ApiIssueCreateOrUpdateOptionalParams)
Creates a new Issue for an API or updates an existing one.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, parameters: IssueContract, options?: ApiIssueCreateOrUpdateOptionalParams): Promise<ApiIssueCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- apiId
-
string
API identifier. Must be unique in the current API Management service instance.
- issueId
-
string
Issue identifier. Must be unique in the current API Management service instance.
- parameters
- IssueContract
Create parameters.
The options parameters.
Returns
Promise<ApiIssueCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiIssueDeleteOptionalParams)
Deletes the specified Issue from an API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, options?: ApiIssueDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- apiId
-
string
API identifier. Must be unique in the current API Management service instance.
- issueId
-
string
Issue identifier. Must be unique in the current API Management service instance.
- ifMatch
-
string
ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- options
- ApiIssueDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, ApiIssueGetOptionalParams)
Gets the details of the Issue for an API specified by its identifier.
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetOptionalParams): Promise<ApiIssueGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- apiId
-
string
API identifier. Must be unique in the current API Management service instance.
- issueId
-
string
Issue identifier. Must be unique in the current API Management service instance.
- options
- ApiIssueGetOptionalParams
The options parameters.
Returns
Promise<ApiIssueGetResponse>
getEntityTag(string, string, string, string, ApiIssueGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the Issue for an API specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetEntityTagOptionalParams): Promise<ApiIssueGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- apiId
-
string
API identifier. Must be unique in the current API Management service instance.
- issueId
-
string
Issue identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<ApiIssueGetEntityTagHeaders>
listByService(string, string, string, ApiIssueListByServiceOptionalParams)
Lists all issues associated with the specified API.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiIssueListByServiceOptionalParams): PagedAsyncIterableIterator<IssueContract, IssueContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- apiId
-
string
API identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
update(string, string, string, string, string, IssueUpdateContract, ApiIssueUpdateOptionalParams)
Updates an existing issue for an API.
function update(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, parameters: IssueUpdateContract, options?: ApiIssueUpdateOptionalParams): Promise<ApiIssueUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- apiId
-
string
API identifier. Must be unique in the current API Management service instance.
- issueId
-
string
Issue identifier. Must be unique in the current API Management service instance.
- ifMatch
-
string
ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- parameters
- IssueUpdateContract
Update parameters.
- options
- ApiIssueUpdateOptionalParams
The options parameters.
Returns
Promise<ApiIssueUpdateResponse>