Interface CustomLocationsClient
public interface CustomLocationsClient
An instance of this class provides access to all the operations defined in CustomLocationsClient.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CustomLocationInner>,
CustomLocationInner> beginCreateOrUpdate
(String resourceGroupName, String resourceName, CustomLocationInner parameters) Creates or updates a Custom Location in the specified Subscription and Resource Group.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CustomLocationInner>,
CustomLocationInner> beginCreateOrUpdate
(String resourceGroupName, String resourceName, CustomLocationInner parameters, com.azure.core.util.Context context) Creates or updates a Custom Location in the specified Subscription and Resource Group.beginDelete
(String resourceGroupName, String resourceName) Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.beginDelete
(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.createOrUpdate
(String resourceGroupName, String resourceName, CustomLocationInner parameters) Creates or updates a Custom Location in the specified Subscription and Resource Group.createOrUpdate
(String resourceGroupName, String resourceName, CustomLocationInner parameters, com.azure.core.util.Context context) Creates or updates a Custom Location in the specified Subscription and Resource Group.void
Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.void
Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.findTargetResourceGroup
(String resourceGroupName, String resourceName, CustomLocationFindTargetResourceGroupProperties parameters) Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request.com.azure.core.http.rest.Response<CustomLocationFindTargetResourceGroupResultInner>
findTargetResourceGroupWithResponse
(String resourceGroupName, String resourceName, CustomLocationFindTargetResourceGroupProperties parameters, com.azure.core.util.Context context) Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request.getByResourceGroup
(String resourceGroupName, String resourceName) Gets the details of the customLocation with a specified resource group and name.com.azure.core.http.rest.Response<CustomLocationInner>
getByResourceGroupWithResponse
(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Gets the details of the customLocation with a specified resource group and name.com.azure.core.http.rest.PagedIterable<CustomLocationInner>
list()
Gets a list of Custom Locations in the specified subscription.com.azure.core.http.rest.PagedIterable<CustomLocationInner>
list
(com.azure.core.util.Context context) Gets a list of Custom Locations in the specified subscription.com.azure.core.http.rest.PagedIterable<CustomLocationInner>
listByResourceGroup
(String resourceGroupName) Gets a list of Custom Locations in the specified subscription and resource group.com.azure.core.http.rest.PagedIterable<CustomLocationInner>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Gets a list of Custom Locations in the specified subscription and resource group.com.azure.core.http.rest.PagedIterable<EnabledResourceTypeInner>
listEnabledResourceTypes
(String resourceGroupName, String resourceName) Gets the list of the Enabled Resource Types.com.azure.core.http.rest.PagedIterable<EnabledResourceTypeInner>
listEnabledResourceTypes
(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Gets the list of the Enabled Resource Types.com.azure.core.http.rest.PagedIterable<CustomLocationOperationInner>
Lists all available Custom Locations operations.com.azure.core.http.rest.PagedIterable<CustomLocationOperationInner>
listOperations
(com.azure.core.util.Context context) Lists all available Custom Locations operations.update
(String resourceGroupName, String resourceName, PatchableCustomLocations parameters) Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription.com.azure.core.http.rest.Response<CustomLocationInner>
updateWithResponse
(String resourceGroupName, String resourceName, PatchableCustomLocations parameters, com.azure.core.util.Context context) Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription.
-
Method Details
-
listOperations
com.azure.core.http.rest.PagedIterable<CustomLocationOperationInner> listOperations()Lists all available Custom Locations operations.- Returns:
- lists of Custom Locations operations 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.
-
listOperations
com.azure.core.http.rest.PagedIterable<CustomLocationOperationInner> listOperations(com.azure.core.util.Context context) Lists all available Custom Locations operations.- Parameters:
context
- The context to associate with this operation.- Returns:
- lists of Custom Locations operations 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.
-
list
com.azure.core.http.rest.PagedIterable<CustomLocationInner> list()Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location.- Returns:
- a list of Custom Locations in the specified subscription 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<CustomLocationInner> list(com.azure.core.util.Context context) Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location.- Parameters:
context
- The context to associate with this operation.- Returns:
- a list of Custom Locations in the specified subscription 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.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<CustomLocationInner> listByResourceGroup(String resourceGroupName) Gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.- Returns:
- a list of Custom Locations in the specified subscription and resource group 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.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<CustomLocationInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context) Gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.context
- The context to associate with this operation.- Returns:
- a list of Custom Locations in the specified subscription and resource group 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.
-
getByResourceGroup
Gets the details of the customLocation with a specified resource group and name.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.- Returns:
- the details of the customLocation with a specified resource group and 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.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<CustomLocationInner> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Gets the details of the customLocation with a specified resource group and name.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.context
- The context to associate with this operation.- Returns:
- the details of the customLocation with a specified resource group and 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CustomLocationInner>,CustomLocationInner> beginCreateOrUpdate(String resourceGroupName, String resourceName, CustomLocationInner parameters) Creates or updates a Custom Location in the specified Subscription and Resource Group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.parameters
- Parameters supplied to create or update a Custom Location.- Returns:
- the
SyncPoller
for polling of custom Locations definition. - 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CustomLocationInner>,CustomLocationInner> beginCreateOrUpdate(String resourceGroupName, String resourceName, CustomLocationInner parameters, com.azure.core.util.Context context) Creates or updates a Custom Location in the specified Subscription and Resource Group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.parameters
- Parameters supplied to create or update a Custom Location.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of custom Locations definition. - 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
CustomLocationInner createOrUpdate(String resourceGroupName, String resourceName, CustomLocationInner parameters) Creates or updates a Custom Location in the specified Subscription and Resource Group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.parameters
- Parameters supplied to create or update a Custom Location.- Returns:
- custom Locations definition.
- 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
CustomLocationInner createOrUpdate(String resourceGroupName, String resourceName, CustomLocationInner parameters, com.azure.core.util.Context context) Creates or updates a Custom Location in the specified Subscription and Resource Group.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.parameters
- Parameters supplied to create or update a Custom Location.context
- The context to associate with this operation.- Returns:
- custom Locations definition.
- 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String resourceName) Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.- 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.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.
-
delete
Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations 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.
-
delete
Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.context
- The context to associate with this 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.
-
update
CustomLocationInner update(String resourceGroupName, String resourceName, PatchableCustomLocations parameters) Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.parameters
- The updatable fields of an existing Custom Location.- Returns:
- custom Locations definition.
- 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
com.azure.core.http.rest.Response<CustomLocationInner> updateWithResponse(String resourceGroupName, String resourceName, PatchableCustomLocations parameters, com.azure.core.util.Context context) Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.parameters
- The updatable fields of an existing Custom Location.context
- The context to associate with this operation.- Returns:
- custom Locations definition 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.
-
listEnabledResourceTypes
com.azure.core.http.rest.PagedIterable<EnabledResourceTypeInner> listEnabledResourceTypes(String resourceGroupName, String resourceName) Gets the list of the Enabled Resource Types.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.- Returns:
- the list of the Enabled Resource Types 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.
-
listEnabledResourceTypes
com.azure.core.http.rest.PagedIterable<EnabledResourceTypeInner> listEnabledResourceTypes(String resourceGroupName, String resourceName, com.azure.core.util.Context context) Gets the list of the Enabled Resource Types.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.context
- The context to associate with this operation.- Returns:
- the list of the Enabled Resource Types 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.
-
findTargetResourceGroup
CustomLocationFindTargetResourceGroupResultInner findTargetResourceGroup(String resourceGroupName, String resourceName, CustomLocationFindTargetResourceGroupProperties parameters) Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.parameters
- Parameters of the find target resource group request.- Returns:
- the Find Target Resource Group operation 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.
-
findTargetResourceGroupWithResponse
com.azure.core.http.rest.Response<CustomLocationFindTargetResourceGroupResultInner> findTargetResourceGroupWithResponse(String resourceGroupName, String resourceName, CustomLocationFindTargetResourceGroupProperties parameters, com.azure.core.util.Context context) Returns the target resource group associated with the resource sync rules of the Custom Location that match the rules passed in with the Find Target Resource Group Request.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.resourceName
- Custom Locations name.parameters
- Parameters of the find target resource group request.context
- The context to associate with this operation.- Returns:
- the Find Target Resource Group operation response 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.
-