Interface ApiSchemasClient
-
public interface ApiSchemasClient
An instance of this class provides access to all the operations defined in ApiSchemasClient.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SchemaContractInner>,SchemaContractInner>
beginCreateOrUpdate(String resourceGroupName, String serviceName, String apiId, String schemaId, SchemaContractInner parameters, String ifMatch)
Creates or updates schema configuration for the API.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SchemaContractInner>,SchemaContractInner>
beginCreateOrUpdate(String resourceGroupName, String serviceName, String apiId, String schemaId, SchemaContractInner parameters, String ifMatch, com.azure.core.util.Context context)
Creates or updates schema configuration for the API.SchemaContractInner
createOrUpdate(String resourceGroupName, String serviceName, String apiId, String schemaId, SchemaContractInner parameters)
Creates or updates schema configuration for the API.SchemaContractInner
createOrUpdate(String resourceGroupName, String serviceName, String apiId, String schemaId, SchemaContractInner parameters, String ifMatch)
Creates or updates schema configuration for the API.SchemaContractInner
createOrUpdate(String resourceGroupName, String serviceName, String apiId, String schemaId, SchemaContractInner parameters, String ifMatch, com.azure.core.util.Context context)
Creates or updates schema configuration for the API.void
delete(String resourceGroupName, String serviceName, String apiId, String schemaId, String ifMatch)
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.SchemaContractInner
get(String resourceGroupName, String serviceName, String apiId, String schemaId)
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.ApiSchemasGetResponse
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<SchemaContractInner>
listByApi(String resourceGroupName, String serviceName, String apiId)
Get the schema configuration at the API level.com.azure.core.http.rest.PagedIterable<SchemaContractInner>
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<SchemaContractInner> 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<SchemaContractInner> 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
SchemaContractInner 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
ApiSchemasGetResponse 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SchemaContractInner>,SchemaContractInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String apiId, String schemaId, SchemaContractInner parameters, String ifMatch)
Creates or updates schema configuration for 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.parameters
- The schema contents to apply.ifMatch
- ETag of the Entity. Not required when creating an entity, but required when updating an entity.- Returns:
- the
SyncPoller
for polling of aPI Schema Contract details. - 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SchemaContractInner>,SchemaContractInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String apiId, String schemaId, SchemaContractInner parameters, String ifMatch, com.azure.core.util.Context context)
Creates or updates schema configuration for 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.parameters
- The schema contents to apply.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:
- the
SyncPoller
for polling of aPI Schema Contract details. - 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.
-
createOrUpdate
SchemaContractInner createOrUpdate(String resourceGroupName, String serviceName, String apiId, String schemaId, SchemaContractInner parameters, String ifMatch)
Creates or updates schema configuration for 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.parameters
- The schema contents to apply.ifMatch
- ETag of the Entity. Not required when creating an entity, but required when updating an entity.- Returns:
- aPI Schema Contract details.
- 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.
-
createOrUpdate
SchemaContractInner createOrUpdate(String resourceGroupName, String serviceName, String apiId, String schemaId, SchemaContractInner parameters)
Creates or updates schema configuration for 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.parameters
- The schema contents to apply.- Returns:
- aPI Schema Contract details.
- 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.
-
createOrUpdate
SchemaContractInner createOrUpdate(String resourceGroupName, String serviceName, String apiId, String schemaId, SchemaContractInner parameters, String ifMatch, com.azure.core.util.Context context)
Creates or updates schema configuration for 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.parameters
- The schema contents to apply.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:
- aPI Schema Contract details.
- 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.
-
-