Package com.azure.resourcemanager.apimanagement.models

Interface GlobalSchemas

public interface GlobalSchemas

Resource collection API of GlobalSchemas.

Method Summary

Modifier and Type	Method	Description
GlobalSchemaContract.DefinitionStages.Blank	define(String name)	Begins definition for a new GlobalSchemaContract resource.
void	delete(String resourceGroupName, String serviceName, String schemaId, String ifMatch)	Deletes specific Schema.
void	deleteById(String id)	Deletes specific Schema.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)	Deletes specific Schema.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String schemaId, String ifMatch, com.azure.core.util.Context context)	Deletes specific Schema.
GlobalSchemaContract	get(String resourceGroupName, String serviceName, String schemaId)	Gets the details of the Schema specified by its identifier.
GlobalSchemaContract	getById(String id)	Gets the details of the Schema specified by its identifier.
com.azure.core.http.rest.Response<GlobalSchemaContract>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets the details of the Schema specified by its identifier.
void	getEntityTag(String resourceGroupName, String serviceName, String schemaId)	Gets the entity state (Etag) version of the Schema specified by its identifier.
GlobalSchemasGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, 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<GlobalSchemaContract>	getWithResponse(String resourceGroupName, String serviceName, String schemaId, com.azure.core.util.Context context)	Gets the details of the Schema specified by its identifier.
com.azure.core.http.rest.PagedIterable<GlobalSchemaContract>	listByService(String resourceGroupName, String serviceName)	Lists a collection of schemas registered with service instance.
com.azure.core.http.rest.PagedIterable<GlobalSchemaContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Lists a collection of schemas registered with service instance.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<GlobalSchemaContract> listByService(String resourceGroupName,
                                                                           String serviceName)

Lists a collection of schemas registered with service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

the response of the list schema operation 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.

listByService

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

Lists a collection of schemas registered with service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | 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 response of the list schema operation 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 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.

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

GlobalSchemasGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           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.

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

GlobalSchemaContract get(String resourceGroupName,
                         String serviceName,
                         String schemaId)

Gets the details of the Schema specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

Returns:

the details 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.

getWithResponse

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

Gets the details of the Schema specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

context - The context to associate with this operation.

Returns:

the details 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.

delete

void delete(String resourceGroupName,
            String serviceName,
            String schemaId,
            String ifMatch)

Deletes specific Schema.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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 schemaId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Deletes specific Schema.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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.

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

GlobalSchemaContract getById(String id)

Gets the details of the Schema specified by its identifier.

Parameters:

id - the resource ID.

Returns:

the details 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.

getByIdWithResponse

com.azure.core.http.rest.Response<GlobalSchemaContract> getByIdWithResponse(String id,
                                                                            com.azure.core.util.Context context)

Gets the details of the Schema specified by its identifier.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the details 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.

deleteById

void deleteById(String id)

Deletes specific Schema.

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,
                                                               com.azure.core.util.Context context)

Deletes specific Schema.

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.

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

GlobalSchemaContract.DefinitionStages.Blank define(String name)

Begins definition for a new GlobalSchemaContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new GlobalSchemaContract definition.