Package com.azure.resourcemanager.apimanagement.models

Interface ApiVersionSets

public interface ApiVersionSets

Resource collection API of ApiVersionSets.

Method Summary

Modifier and Type	Method	Description
ApiVersionSetContract.DefinitionStages.Blank	define(String name)	Begins definition for a new ApiVersionSetContract resource.
void	delete(String resourceGroupName, String serviceName, String versionSetId, String ifMatch)	Deletes specific Api Version Set.
void	deleteById(String id)	Deletes specific Api Version Set.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)	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.
ApiVersionSetContract	get(String resourceGroupName, String serviceName, String versionSetId)	Gets the details of the Api Version Set specified by its identifier.
ApiVersionSetContract	getById(String id)	Gets the details of the Api Version Set specified by its identifier.
com.azure.core.http.rest.Response<ApiVersionSetContract>	getByIdWithResponse(String id, com.azure.core.util.Context context)	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.
com.azure.core.http.rest.Response<ApiVersionSetContract>	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<ApiVersionSetContract>	listByService(String resourceGroupName, String serviceName)	Lists a collection of API Version Sets in the specified service instance.
com.azure.core.http.rest.PagedIterable<ApiVersionSetContract>	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.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<ApiVersionSetContract> 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<ApiVersionSetContract> 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

ApiVersionSetContract 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

com.azure.core.http.rest.Response<ApiVersionSetContract> 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.

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.

getById

ApiVersionSetContract getById(String id)

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

Parameters:

id - the resource ID.

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.

getByIdWithResponse

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

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

Parameters:

id - the resource ID.

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.

deleteById

void deleteById(String id)

Deletes specific Api Version Set.

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

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

ApiVersionSetContract.DefinitionStages.Blank define(String name)

Begins definition for a new ApiVersionSetContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ApiVersionSetContract definition.