Package com.azure.resourcemanager.extendedlocation.models

Interface CustomLocations

public interface CustomLocations
Resource collection API of CustomLocations.

  • Method Details

    • listOperations

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

      CustomLocation getByResourceGroup(String resourceGroupName, String resourceName)
      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<CustomLocation> 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.

    • deleteByResourceGroup

      void deleteByResourceGroup(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.
      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 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.
      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<EnabledResourceType> 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<EnabledResourceType> 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

      CustomLocationFindTargetResourceGroupResult 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<CustomLocationFindTargetResourceGroupResult> 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.

    • getById

      CustomLocation getById(String id)
      Gets the details of the customLocation with a specified resource group and name.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<CustomLocation> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets the details of the customLocation with a specified resource group and name.
      Parameters:
      id - the resource ID.
      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.

    • deleteById

      void deleteById(String id)
      Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.
      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

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id.
      Parameters:
      id - the resource ID.
      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.

    • define

      CustomLocation.DefinitionStages.Blank define(String name)
      Begins definition for a new CustomLocation resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new CustomLocation definition.