ApiIssues Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface ApiIssues

Resource collection API of ApiIssues.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new IssueContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String apiId, String issueId, String ifMatch) Deletes the specified Issue from an API.
abstract void	deleteById(String id) Deletes the specified Issue from an API.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Deletes the specified Issue from an API.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String ifMatch, Context context) Deletes the specified Issue from an API.
abstract IssueContract	get(String resourceGroupName, String serviceName, String apiId, String issueId) Gets the details of the Issue for an API specified by its identifier.
abstract IssueContract	getById(String id) Gets the details of the Issue for an API specified by its identifier.
abstract Response<IssueContract>	getByIdWithResponse(String id, Boolean expandCommentsAttachments, Context context) Gets the details of the Issue for an API specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String apiId, String issueId) Gets the entity state (Etag) version of the Issue for an API specified by its identifier.
abstract ApiIssuesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, Context context) Gets the entity state (Etag) version of the Issue for an API specified by its identifier.
abstract Response<IssueContract>	getWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, Boolean expandCommentsAttachments, Context context) Gets the details of the Issue for an API specified by its identifier.
abstract PagedIterable<IssueContract>	listByService(String resourceGroupName, String serviceName, String apiId) Lists all issues associated with the specified API.
abstract PagedIterable<IssueContract>	listByService(String resourceGroupName, String serviceName, String apiId, String filter, Boolean expandCommentsAttachments, Integer top, Integer skip, Context context) Lists all issues associated with the specified API.

Method Details

define

public abstract IssueContract.DefinitionStages.Blank define(String name)

Begins definition for a new IssueContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new IssueContract definition.

delete

public abstract void delete(String resourceGroupName, String serviceName, String apiId, String issueId, String ifMatch)

Deletes the specified Issue from an API.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

ifMatch - 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.

deleteById

public abstract void deleteById(String id)

Deletes the specified Issue from an API.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, Context context)

Deletes the specified Issue from an API.

Parameters:

id - the resource ID.

ifMatch - 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.

context - The context to associate with this operation.

Returns:

the Response<T>.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String ifMatch, Context context)

Deletes the specified Issue from an API.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

ifMatch - 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.

context - The context to associate with this operation.

Returns:

the Response<T>.

get

public abstract IssueContract get(String resourceGroupName, String serviceName, String apiId, String issueId)

Gets the details of the Issue for an API specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

Returns:

the details of the Issue for an API specified by its identifier.

getById

public abstract IssueContract getById(String id)

Gets the details of the Issue for an API specified by its identifier.

Parameters:

id - the resource ID.

Returns:

the details of the Issue for an API specified by its identifier.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Boolean expandCommentsAttachments, Context context)

Gets the details of the Issue for an API specified by its identifier.

Parameters:

id - the resource ID.

expandCommentsAttachments - Expand the comment attachments.

context - The context to associate with this operation.

Returns:

the details of the Issue for an API specified by its identifier.

getEntityTag

public abstract void getEntityTag(String resourceGroupName, String serviceName, String apiId, String issueId)

Gets the entity state (Etag) version of the Issue for an API specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

getEntityTagWithResponse

public abstract ApiIssuesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, Context context)

Gets the entity state (Etag) version of the Issue for an API specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the entity state (Etag) version of the Issue for an API specified by its identifier.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, Boolean expandCommentsAttachments, Context context)

Gets the details of the Issue for an API specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

expandCommentsAttachments - Expand the comment attachments.

context - The context to associate with this operation.

Returns:

the details of the Issue for an API specified by its identifier.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String apiId)

Lists all issues associated with the specified API.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API identifier. Must be unique in the current API Management service instance.

Returns:

paged Issue list representation as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String apiId, String filter, Boolean expandCommentsAttachments, Integer top, Integer skip, Context context)

Lists all issues associated with the specified API.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

apiId - API identifier. Must be unique in the current API Management service instance.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| state | filter | eq | |</br>.

expandCommentsAttachments - Expand the comment attachments.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged Issue list representation as paginated response with PagedIterable<T>.