ApiSchemas Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

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

public interface ApiSchemas

Resource collection API of ApiSchemas.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new SchemaContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String apiId, String schemaId, String ifMatch) Deletes the schema configuration at the Api.
abstract void	deleteById(String id) Deletes the schema configuration at the Api.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Boolean force, Context context) Deletes the schema configuration at the Api.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String schemaId, String ifMatch, Boolean force, Context context) Deletes the schema configuration at the Api.
abstract SchemaContract	get(String resourceGroupName, String serviceName, String apiId, String schemaId) Get the schema configuration at the API level.
abstract SchemaContract	getById(String id) Get the schema configuration at the API level.
abstract Response<SchemaContract>	getByIdWithResponse(String id, Context context) Get the schema configuration at the API level.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String apiId, String schemaId) Gets the entity state (Etag) version of the schema specified by its identifier.
abstract ApiSchemasGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String schemaId, Context context) Gets the entity state (Etag) version of the schema specified by its identifier.
abstract Response<SchemaContract>	getWithResponse(String resourceGroupName, String serviceName, String apiId, String schemaId, Context context) Get the schema configuration at the API level.
abstract PagedIterable<SchemaContract>	listByApi(String resourceGroupName, String serviceName, String apiId) Get the schema configuration at the API level.
abstract PagedIterable<SchemaContract>	listByApi(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, Context context) Get the schema configuration at the API level.

Method Details

define

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

Begins definition for a new SchemaContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new SchemaContract definition.

delete

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

Deletes the schema configuration at the Api.

Parameters:

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

serviceName - The name of the API Management service.

apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

schemaId - Schema id 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 schema configuration at the Api.

Parameters:

id - the resource ID.

deleteByIdWithResponse

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

Deletes the schema configuration at the 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.

force - If true removes all references to the schema before deleting it.

context - The context to associate with this operation.

Returns:

the Response<T>.

deleteWithResponse

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

Deletes the schema configuration at the Api.

Parameters:

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

serviceName - The name of the API Management service.

apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

schemaId - Schema id 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.

force - If true removes all references to the schema before deleting it.

context - The context to associate with this operation.

Returns:

the Response<T>.

get

public abstract SchemaContract get(String resourceGroupName, String serviceName, String apiId, String schemaId)

Get the schema configuration at the API level.

Parameters:

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

serviceName - The name of the API Management service.

apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

schemaId - Schema id identifier. Must be unique in the current API Management service instance.

Returns:

the schema configuration at the API level.

getById

public abstract SchemaContract getById(String id)

Get the schema configuration at the API level.

Parameters:

id - the resource ID.

Returns:

the schema configuration at the API level.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Get the schema configuration at the API level.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the schema configuration at the API level.

getEntityTag

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

Gets the entity state (Etag) version of the schema 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 revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

schemaId - Schema id identifier. Must be unique in the current API Management service instance.

getEntityTagWithResponse

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

Gets the entity state (Etag) version of the schema 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 revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

schemaId - Schema id 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 schema specified by its identifier.

getWithResponse

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

Get the schema configuration at the API level.

Parameters:

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

serviceName - The name of the API Management service.

apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

schemaId - Schema id identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the schema configuration at the API level.

listByApi

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

Get the schema configuration at the API level.

Parameters:

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

serviceName - The name of the API Management service.

apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

Returns:

the schema configuration at the API level as paginated response with PagedIterable<T>.

listByApi

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

Get the schema configuration at the API level.

Parameters:

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

serviceName - The name of the API Management service.

apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

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

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

the schema configuration at the API level as paginated response with PagedIterable<T>.