ApiWikis Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

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

public interface ApiWikis

Resource collection API of ApiWikis.

Method Summary

Modifier and Type	Method and Description
abstract WikiContract	createOrUpdate(String resourceGroupName, String serviceName, String apiId, WikiContractInner parameters) Creates a new Wiki for an API or updates an existing one.
abstract Response<WikiContract>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String apiId, WikiContractInner parameters, String ifMatch, Context context) Creates a new Wiki for an API or updates an existing one.
abstract void	delete(String resourceGroupName, String serviceName, String apiId, String ifMatch) Deletes the specified Wiki from an API.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String ifMatch, Context context) Deletes the specified Wiki from an API.
abstract WikiContract	get(String resourceGroupName, String serviceName, String apiId) Gets the details of the Wiki for an API specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String apiId) Gets the entity state (Etag) version of the Wiki for an API specified by its identifier.
abstract ApiWikisGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, Context context) Gets the entity state (Etag) version of the Wiki for an API specified by its identifier.
abstract Response<WikiContract>	getWithResponse(String resourceGroupName, String serviceName, String apiId, Context context) Gets the details of the Wiki for an API specified by its identifier.
abstract WikiContract	update(String resourceGroupName, String serviceName, String apiId, String ifMatch, WikiUpdateContract parameters) Updates the details of the Wiki for an API specified by its identifier.
abstract Response<WikiContract>	updateWithResponse(String resourceGroupName, String serviceName, String apiId, String ifMatch, WikiUpdateContract parameters, Context context) Updates the details of the Wiki for an API specified by its identifier.

Method Details

createOrUpdate

public abstract WikiContract createOrUpdate(String resourceGroupName, String serviceName, String apiId, WikiContractInner parameters)

Creates a new Wiki for an API or updates an existing one.

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.

parameters - Create parameters.

Returns:

wiki properties.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String resourceGroupName, String serviceName, String apiId, WikiContractInner parameters, String ifMatch, Context context)

Creates a new Wiki for an API or updates an existing one.

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.

parameters - Create parameters.

ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.

context - The context to associate with this operation.

Returns:

wiki properties.

delete

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

Deletes the specified Wiki 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.

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.

deleteWithResponse

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

Deletes the specified Wiki 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.

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 WikiContract get(String resourceGroupName, String serviceName, String apiId)

Gets the details of the Wiki 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.

Returns:

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

getEntityTag

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

Gets the entity state (Etag) version of the Wiki 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.

getEntityTagWithResponse

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

Gets the entity state (Etag) version of the Wiki 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.

context - The context to associate with this operation.

Returns:

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

getWithResponse

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

Gets the details of the Wiki 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.

context - The context to associate with this operation.

Returns:

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

update

public abstract WikiContract update(String resourceGroupName, String serviceName, String apiId, String ifMatch, WikiUpdateContract parameters)

Updates the details of the Wiki 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.

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.

parameters - Wiki Update parameters.

Returns:

wiki properties.

updateWithResponse

public abstract Response updateWithResponse(String resourceGroupName, String serviceName, String apiId, String ifMatch, WikiUpdateContract parameters, Context context)

Updates the details of the Wiki 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.

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.

parameters - Wiki Update parameters.

context - The context to associate with this operation.

Returns:

wiki properties.