Package com.azure.resourcemanager.apimanagement.models

Interface ApiExports

public interface ApiExports

Resource collection API of ApiExports.

Method Summary

Modifier and Type	Method	Description
ApiExportResult	get(String resourceGroupName, String serviceName, String apiId, ExportFormat format, ExportApi export)	Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.
com.azure.core.http.rest.Response<ApiExportResult>	getWithResponse(String resourceGroupName, String serviceName, String apiId, ExportFormat format, ExportApi export, com.azure.core.util.Context context)	Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.

Method Detail

get

ApiExportResult get(String resourceGroupName,
                    String serviceName,
                    String apiId,
                    ExportFormat format,
                    ExportApi export)

Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.

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.

format - Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes.

export - Query parameter required to export the API details.

Returns:

the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.

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<ApiExportResult> getWithResponse(String resourceGroupName,
                                                                   String serviceName,
                                                                   String apiId,
                                                                   ExportFormat format,
                                                                   ExportApi export,
                                                                   com.azure.core.util.Context context)

Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.

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.

format - Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes.

export - Query parameter required to export the API details.

context - The context to associate with this operation.

Returns:

the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes 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.