Package com.azure.resourcemanager.apimanagement.models

Interface ApiSchemas

public interface ApiSchemas

Resource collection API of ApiSchemas.

Method Summary

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

Method Detail

listByApi

com.azure.core.http.rest.PagedIterable<SchemaContract> listByApi(String resourceGroupName,
                                                                 String serviceName,
                                                                 String apiId)

Get the schema configuration at the API level.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByApi

com.azure.core.http.rest.PagedIterable<SchemaContract> listByApi(String resourceGroupName,
                                                                 String serviceName,
                                                                 String apiId,
                                                                 String filter,
                                                                 Integer top,
                                                                 Integer skip,
                                                                 com.azure.core.util.Context context)

Get the schema configuration at the API level.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getEntityTag

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.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getEntityTagWithResponse

ApiSchemasGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                        String serviceName,
                                                        String apiId,
                                                        String schemaId,
                                                        com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

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.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<SchemaContract> getWithResponse(String resourceGroupName,
                                                                  String serviceName,
                                                                  String apiId,
                                                                  String schemaId,
                                                                  com.azure.core.util.Context context)

Get the schema configuration at the API level.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

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.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           String apiId,
                                                           String schemaId,
                                                           String ifMatch,
                                                           Boolean force,
                                                           com.azure.core.util.Context context)

Deletes the schema configuration at the Api.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getById

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIdWithResponse

com.azure.core.http.rest.Response<SchemaContract> getByIdWithResponse(String id,
                                                                      com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteById

void deleteById(String id)

Deletes the schema configuration at the Api.

Parameters:

id - the resource ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               String ifMatch,
                                                               Boolean force,
                                                               com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

define

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.