Documentations Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

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

public interface Documentations

Resource collection API of Documentations.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new DocumentationContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String documentationId, String ifMatch) Deletes the specified Documentation from an API.
abstract void	deleteById(String id) Deletes the specified Documentation from an API.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Deletes the specified Documentation from an API.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String documentationId, String ifMatch, Context context) Deletes the specified Documentation from an API.
abstract DocumentationContract	get(String resourceGroupName, String serviceName, String documentationId) Gets the details of the Documentation specified by its identifier.
abstract DocumentationContract	getById(String id) Gets the details of the Documentation specified by its identifier.
abstract Response<DocumentationContract>	getByIdWithResponse(String id, Context context) Gets the details of the Documentation specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String documentationId) Gets the entity state (Etag) version of the Documentation by its identifier.
abstract DocumentationsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String documentationId, Context context) Gets the entity state (Etag) version of the Documentation by its identifier.
abstract Response<DocumentationContract>	getWithResponse(String resourceGroupName, String serviceName, String documentationId, Context context) Gets the details of the Documentation specified by its identifier.
abstract PagedIterable<DocumentationContract>	listByService(String resourceGroupName, String serviceName) Lists all Documentations of the API Management service instance.
abstract PagedIterable<DocumentationContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context) Lists all Documentations of the API Management service instance.

Method Details

define

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

Begins definition for a new DocumentationContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new DocumentationContract definition.

delete

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

Deletes the specified Documentation from an API.

Parameters:

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

serviceName - The name of the API Management service.

documentationId - Documentation 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 Documentation from an API.

Parameters:

id - the resource ID.

deleteByIdWithResponse

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

Deletes the specified Documentation 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 documentationId, String ifMatch, Context context)

Deletes the specified Documentation from an API.

Parameters:

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

serviceName - The name of the API Management service.

documentationId - Documentation 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 DocumentationContract get(String resourceGroupName, String serviceName, String documentationId)

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

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

Returns:

the details of the Documentation specified by its identifier.

getById

public abstract DocumentationContract getById(String id)

Gets the details of the Documentation specified by its identifier.

Parameters:

id - the resource ID.

Returns:

the details of the Documentation specified by its identifier.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Gets the details of the Documentation specified by its identifier.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the details of the Documentation specified by its identifier.

getEntityTag

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

Gets the entity state (Etag) version of the Documentation by its identifier.

Parameters:

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

serviceName - The name of the API Management service.

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

getEntityTagWithResponse

public abstract DocumentationsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String documentationId, Context context)

Gets the entity state (Etag) version of the Documentation by its identifier.

Parameters:

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

serviceName - The name of the API Management service.

documentationId - Documentation 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 Documentation by its identifier.

getWithResponse

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

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

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

context - The context to associate with this operation.

Returns:

the details of the Documentation specified by its identifier.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName)

Lists all Documentations of the API Management service instance.

Parameters:

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

serviceName - The name of the API Management service.

Returns:

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

listByService

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

Lists all Documentations of the API Management service instance.

Parameters:

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

serviceName - The name of the API Management service.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | eq | contains |</br>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

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