Package com.azure.resourcemanager.apimanagement.fluent

Interface DeletedServicesClient

public interface DeletedServicesClient

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

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DeletedServiceContractInner>,DeletedServiceContractInner>	beginPurge(String serviceName, String location)	Purges Api Management Service (deletes it with no option to undelete).
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DeletedServiceContractInner>,DeletedServiceContractInner>	beginPurge(String serviceName, String location, com.azure.core.util.Context context)	Purges Api Management Service (deletes it with no option to undelete).
DeletedServiceContractInner	getByName(String serviceName, String location)	Get soft-deleted Api Management Service by name.
com.azure.core.http.rest.Response<DeletedServiceContractInner>	getByNameWithResponse(String serviceName, String location, com.azure.core.util.Context context)	Get soft-deleted Api Management Service by name.
com.azure.core.http.rest.PagedIterable<DeletedServiceContractInner>	list()	Lists all soft-deleted services available for undelete for the given subscription.
com.azure.core.http.rest.PagedIterable<DeletedServiceContractInner>	list(com.azure.core.util.Context context)	Lists all soft-deleted services available for undelete for the given subscription.
DeletedServiceContractInner	purge(String serviceName, String location)	Purges Api Management Service (deletes it with no option to undelete).
DeletedServiceContractInner	purge(String serviceName, String location, com.azure.core.util.Context context)	Purges Api Management Service (deletes it with no option to undelete).

Method Detail

list

com.azure.core.http.rest.PagedIterable<DeletedServiceContractInner> list()

Lists all soft-deleted services available for undelete for the given subscription.

Returns:

paged deleted API Management Services List Representation as paginated response with PagedIterable.

Throws:

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.

list

com.azure.core.http.rest.PagedIterable<DeletedServiceContractInner> list(com.azure.core.util.Context context)

Lists all soft-deleted services available for undelete for the given subscription.

Parameters:

context - The context to associate with this operation.

Returns:

paged deleted API Management Services 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.

getByName

DeletedServiceContractInner getByName(String serviceName,
                                      String location)

Get soft-deleted Api Management Service by name.

Parameters:

serviceName - The name of the API Management service.

location - The location of the deleted API Management service.

Returns:

soft-deleted Api Management Service by name.

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.

getByNameWithResponse

com.azure.core.http.rest.Response<DeletedServiceContractInner> getByNameWithResponse(String serviceName,
                                                                                     String location,
                                                                                     com.azure.core.util.Context context)

Get soft-deleted Api Management Service by name.

Parameters:

serviceName - The name of the API Management service.

location - The location of the deleted API Management service.

context - The context to associate with this operation.

Returns:

soft-deleted Api Management Service by name along with 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.

beginPurge

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DeletedServiceContractInner>,DeletedServiceContractInner> beginPurge(String serviceName,
                                                                                                                                                               String location)

Purges Api Management Service (deletes it with no option to undelete).

Parameters:

serviceName - The name of the API Management service.

location - The location of the deleted API Management service.

Returns:

the SyncPoller for polling of long-running operation.

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.

beginPurge

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<DeletedServiceContractInner>,DeletedServiceContractInner> beginPurge(String serviceName,
                                                                                                                                                               String location,
                                                                                                                                                               com.azure.core.util.Context context)

Purges Api Management Service (deletes it with no option to undelete).

Parameters:

serviceName - The name of the API Management service.

location - The location of the deleted API Management service.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of long-running operation.

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.

purge

DeletedServiceContractInner purge(String serviceName,
                                  String location)

Purges Api Management Service (deletes it with no option to undelete).

Parameters:

serviceName - The name of the API Management service.

location - The location of the deleted API Management service.

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.

purge

DeletedServiceContractInner purge(String serviceName,
                                  String location,
                                  com.azure.core.util.Context context)

Purges Api Management Service (deletes it with no option to undelete).

Parameters:

serviceName - The name of the API Management service.

location - The location of the deleted API Management service.

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.