Interface CustomLocation


public interface CustomLocation
An immutable client-side representation of CustomLocation.
  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.
    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.
    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.
    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.
    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.
    • identity

      Identity identity()
      Gets the identity property: Identity for the resource.
      Returns:
      the identity value.
    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
      Returns:
      the systemData value.
    • authentication

      Gets the authentication property: This is optional input that contains the authentication that should be used to generate the namespace.
      Returns:
      the authentication value.
    • clusterExtensionIds

      List<String> clusterExtensionIds()
      Gets the clusterExtensionIds property: Contains the reference to the add-on that contains charts to deploy CRDs and operators.
      Returns:
      the clusterExtensionIds value.
    • displayName

      String displayName()
      Gets the displayName property: Display name for the Custom Locations location.
      Returns:
      the displayName value.
    • hostResourceId

      String hostResourceId()
      Gets the hostResourceId property: Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions.
      Returns:
      the hostResourceId value.
    • hostType

      HostType hostType()
      Gets the hostType property: Type of host the Custom Locations is referencing (Kubernetes, etc...).
      Returns:
      the hostType value.
    • namespace

      String namespace()
      Gets the namespace property: Kubernetes namespace that will be created on the specified cluster.
      Returns:
      the namespace value.
    • provisioningState

      String provisioningState()
      Gets the provisioningState property: Provisioning State for the Custom Location.
      Returns:
      the provisioningState value.
    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.
    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.
    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.
    • innerModel

      CustomLocationInner innerModel()
      Gets the inner com.azure.resourcemanager.extendedlocation.fluent.models.CustomLocationInner object.
      Returns:
      the inner object.
    • update

      Begins update for the CustomLocation resource.
      Returns:
      the stage of resource update.
    • refresh

      CustomLocation refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.
    • refresh

      CustomLocation refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.
    • findTargetResourceGroup

      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:
      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(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:
      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.