Package com.azure.resourcemanager.apimanagement.fluent

Interface ApiVersionSetsClient

public interface ApiVersionSetsClient

An instance of this class provides access to all the operations defined in ApiVersionSetsClient.

Method Summary

Modifier and Type	Method	Description
ApiVersionSetContractInner	createOrUpdate(String resourceGroupName, String serviceName, String versionSetId, ApiVersionSetContractInner parameters)	Creates or Updates a Api Version Set.
ApiVersionSetsCreateOrUpdateResponse	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String versionSetId, ApiVersionSetContractInner parameters, String ifMatch, com.azure.core.util.Context context)	Creates or Updates a Api Version Set.
void	delete(String resourceGroupName, String serviceName, String versionSetId, String ifMatch)	Deletes specific Api Version Set.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String versionSetId, String ifMatch, com.azure.core.util.Context context)	Deletes specific Api Version Set.
ApiVersionSetContractInner	get(String resourceGroupName, String serviceName, String versionSetId)	Gets the details of the Api Version Set specified by its identifier.
void	getEntityTag(String resourceGroupName, String serviceName, String versionSetId)	Gets the entity state (Etag) version of the Api Version Set specified by its identifier.
ApiVersionSetsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String versionSetId, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the Api Version Set specified by its identifier.
ApiVersionSetsGetResponse	getWithResponse(String resourceGroupName, String serviceName, String versionSetId, com.azure.core.util.Context context)	Gets the details of the Api Version Set specified by its identifier.
com.azure.core.http.rest.PagedIterable<ApiVersionSetContractInner>	listByService(String resourceGroupName, String serviceName)	Lists a collection of API Version Sets in the specified service instance.
com.azure.core.http.rest.PagedIterable<ApiVersionSetContractInner>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Lists a collection of API Version Sets in the specified service instance.
ApiVersionSetContractInner	update(String resourceGroupName, String serviceName, String versionSetId, String ifMatch, ApiVersionSetUpdateParameters parameters)	Updates the details of the Api VersionSet specified by its identifier.
ApiVersionSetsUpdateResponse	updateWithResponse(String resourceGroupName, String serviceName, String versionSetId, String ifMatch, ApiVersionSetUpdateParameters parameters, com.azure.core.util.Context context)	Updates the details of the Api VersionSet specified by its identifier.

Method Detail

listByService

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

Lists a collection of API Version Sets in the specified service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

paged API Version Set list representation 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<ApiVersionSetContractInner> listByService(String resourceGroupName,
                                                                                 String serviceName,
                                                                                 String filter,
                                                                                 Integer top,
                                                                                 Integer skip,
                                                                                 com.azure.core.util.Context context)

Lists a collection of API Version Sets in the specified 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>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged API Version Set list representation 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 versionSetId)

Gets the entity state (Etag) version of the Api Version Set specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

versionSetId - Api Version Set 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

ApiVersionSetsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                            String serviceName,
                                                            String versionSetId,
                                                            com.azure.core.util.Context context)

Gets the entity state (Etag) version of the Api Version Set specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

versionSetId - Api Version Set 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 Api Version Set 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

ApiVersionSetContractInner get(String resourceGroupName,
                               String serviceName,
                               String versionSetId)

Gets the details of the Api Version Set specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

versionSetId - Api Version Set identifier. Must be unique in the current API Management service instance.

Returns:

the details of the Api Version Set 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

ApiVersionSetsGetResponse getWithResponse(String resourceGroupName,
                                          String serviceName,
                                          String versionSetId,
                                          com.azure.core.util.Context context)

Gets the details of the Api Version Set specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

versionSetId - Api Version Set identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the details of the Api Version Set 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.

createOrUpdate

ApiVersionSetContractInner createOrUpdate(String resourceGroupName,
                                          String serviceName,
                                          String versionSetId,
                                          ApiVersionSetContractInner parameters)

Creates or Updates a Api Version Set.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

versionSetId - Api Version Set identifier. Must be unique in the current API Management service instance.

parameters - Create or update parameters.

Returns:

aPI Version Set 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.

createOrUpdateWithResponse

ApiVersionSetsCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName,
                                                                String serviceName,
                                                                String versionSetId,
                                                                ApiVersionSetContractInner parameters,
                                                                String ifMatch,
                                                                com.azure.core.util.Context context)

Creates or Updates a Api Version Set.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

versionSetId - Api Version Set identifier. Must be unique in the current API Management service instance.

parameters - Create or update parameters.

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 Version Set 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.

update

ApiVersionSetContractInner update(String resourceGroupName,
                                  String serviceName,
                                  String versionSetId,
                                  String ifMatch,
                                  ApiVersionSetUpdateParameters parameters)

Updates the details of the Api VersionSet specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

versionSetId - Api Version Set 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.

parameters - Update parameters.

Returns:

aPI Version Set 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.

updateWithResponse

ApiVersionSetsUpdateResponse updateWithResponse(String resourceGroupName,
                                                String serviceName,
                                                String versionSetId,
                                                String ifMatch,
                                                ApiVersionSetUpdateParameters parameters,
                                                com.azure.core.util.Context context)

Updates the details of the Api VersionSet specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

versionSetId - Api Version Set 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.

parameters - Update parameters.

context - The context to associate with this operation.

Returns:

aPI Version Set 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 versionSetId,
            String ifMatch)

Deletes specific Api Version Set.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

versionSetId - Api Version Set 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 versionSetId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Deletes specific Api Version Set.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

versionSetId - Api Version Set 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.