Interface ExtensionsClient
public interface ExtensionsClient
An instance of this class provides access to all the operations defined in ExtensionsClient.
-
Method Summary
Modifier and TypeMethodDescriptioncreateOrUpdate(String resourceGroupName, String farmBeatsResourceName, String extensionId) Install or Update extension.com.azure.core.http.rest.Response<ExtensionInner> createOrUpdateWithResponse(String resourceGroupName, String farmBeatsResourceName, String extensionId, ExtensionInstallationRequest requestBody, com.azure.core.util.Context context) Install or Update extension.voidUninstall extension.com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String farmBeatsResourceName, String extensionId, com.azure.core.util.Context context) Uninstall extension.Get installed extension details by extension id.com.azure.core.http.rest.Response<ExtensionInner> getWithResponse(String resourceGroupName, String farmBeatsResourceName, String extensionId, com.azure.core.util.Context context) Get installed extension details by extension id.com.azure.core.http.rest.PagedIterable<ExtensionInner> listByFarmBeats(String resourceGroupName, String farmBeatsResourceName) Get installed extensions details.com.azure.core.http.rest.PagedIterable<ExtensionInner> listByFarmBeats(String resourceGroupName, String farmBeatsResourceName, List<String> extensionIds, List<String> extensionCategories, Integer maxPageSize, String skipToken, com.azure.core.util.Context context) Get installed extensions details.
-
Method Details
-
createOrUpdateWithResponse
com.azure.core.http.rest.Response<ExtensionInner> createOrUpdateWithResponse(String resourceGroupName, String farmBeatsResourceName, String extensionId, ExtensionInstallationRequest requestBody, com.azure.core.util.Context context) Install or Update extension. AdditionalApiProperties are merged patch and if the extension is updated to a new version then the obsolete entries will be auto deleted from AdditionalApiProperties.- Parameters:
resourceGroupName- The name of the resource group. The name is case insensitive.farmBeatsResourceName- FarmBeats resource name.extensionId- Id of extension resource.requestBody- Extension resource request body.context- The context to associate with this operation.- Returns:
- extension resource 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.
-
createOrUpdate
ExtensionInner createOrUpdate(String resourceGroupName, String farmBeatsResourceName, String extensionId) Install or Update extension. AdditionalApiProperties are merged patch and if the extension is updated to a new version then the obsolete entries will be auto deleted from AdditionalApiProperties.- Parameters:
resourceGroupName- The name of the resource group. The name is case insensitive.farmBeatsResourceName- FarmBeats resource name.extensionId- Id of extension resource.- Returns:
- extension resource.
- 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<ExtensionInner> getWithResponse(String resourceGroupName, String farmBeatsResourceName, String extensionId, com.azure.core.util.Context context) Get installed extension details by extension id.- Parameters:
resourceGroupName- The name of the resource group. The name is case insensitive.farmBeatsResourceName- FarmBeats resource name.extensionId- Id of extension resource.context- The context to associate with this operation.- Returns:
- installed extension details by extension id 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.
-
get
Get installed extension details by extension id.- Parameters:
resourceGroupName- The name of the resource group. The name is case insensitive.farmBeatsResourceName- FarmBeats resource name.extensionId- Id of extension resource.- Returns:
- installed extension details by extension 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.
-
deleteWithResponse
com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String farmBeatsResourceName, String extensionId, com.azure.core.util.Context context) Uninstall extension.- Parameters:
resourceGroupName- The name of the resource group. The name is case insensitive.farmBeatsResourceName- FarmBeats resource name.extensionId- Id of extension resource.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.
-
delete
Uninstall extension.- Parameters:
resourceGroupName- The name of the resource group. The name is case insensitive.farmBeatsResourceName- FarmBeats resource name.extensionId- Id of extension resource.- 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.
-
listByFarmBeats
com.azure.core.http.rest.PagedIterable<ExtensionInner> listByFarmBeats(String resourceGroupName, String farmBeatsResourceName) Get installed extensions details.- Parameters:
resourceGroupName- The name of the resource group. The name is case insensitive.farmBeatsResourceName- FarmBeats resource name.- Returns:
- installed extensions details 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.
-
listByFarmBeats
com.azure.core.http.rest.PagedIterable<ExtensionInner> listByFarmBeats(String resourceGroupName, String farmBeatsResourceName, List<String> extensionIds, List<String> extensionCategories, Integer maxPageSize, String skipToken, com.azure.core.util.Context context) Get installed extensions details.- Parameters:
resourceGroupName- The name of the resource group. The name is case insensitive.farmBeatsResourceName- FarmBeats resource name.extensionIds- Installed extension ids.extensionCategories- Installed extension categories.maxPageSize- Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.skipToken- Skip token for getting next set of results.context- The context to associate with this operation.- Returns:
- installed extensions details 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.
-