Interface TopologiesClient


public interface TopologiesClient
An instance of this class provides access to all the operations defined in TopologiesClient.
  • Method Summary

    Modifier and Type
    Method
    Description
    get(String resourceGroupName, String ascLocation, String topologyResourceName)
    Gets a specific topology component.
    com.azure.core.http.rest.Response<TopologyResourceInner>
    getWithResponse(String resourceGroupName, String ascLocation, String topologyResourceName, com.azure.core.util.Context context)
    Gets a specific topology component.
    com.azure.core.http.rest.PagedIterable<TopologyResourceInner>
    Gets a list that allows to build a topology view of a subscription.
    com.azure.core.http.rest.PagedIterable<TopologyResourceInner>
    list(com.azure.core.util.Context context)
    Gets a list that allows to build a topology view of a subscription.
    com.azure.core.http.rest.PagedIterable<TopologyResourceInner>
    listByHomeRegion(String ascLocation)
    Gets a list that allows to build a topology view of a subscription and location.
    com.azure.core.http.rest.PagedIterable<TopologyResourceInner>
    listByHomeRegion(String ascLocation, com.azure.core.util.Context context)
    Gets a list that allows to build a topology view of a subscription and location.
  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<TopologyResourceInner> list()
      Gets a list that allows to build a topology view of a subscription.
      Returns:
      a list that allows to build a topology view of a 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<TopologyResourceInner> list(com.azure.core.util.Context context)
      Gets a list that allows to build a topology view of a subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      a list that allows to build a topology view of a 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.
    • listByHomeRegion

      com.azure.core.http.rest.PagedIterable<TopologyResourceInner> listByHomeRegion(String ascLocation)
      Gets a list that allows to build a topology view of a subscription and location.
      Parameters:
      ascLocation - The location where ASC stores the data of the subscription. can be retrieved from Get locations.
      Returns:
      a list that allows to build a topology view of a subscription and location 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.
    • listByHomeRegion

      com.azure.core.http.rest.PagedIterable<TopologyResourceInner> listByHomeRegion(String ascLocation, com.azure.core.util.Context context)
      Gets a list that allows to build a topology view of a subscription and location.
      Parameters:
      ascLocation - The location where ASC stores the data of the subscription. can be retrieved from Get locations.
      context - The context to associate with this operation.
      Returns:
      a list that allows to build a topology view of a subscription and location 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.
    • get

      TopologyResourceInner get(String resourceGroupName, String ascLocation, String topologyResourceName)
      Gets a specific topology component.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      ascLocation - The location where ASC stores the data of the subscription. can be retrieved from Get locations.
      topologyResourceName - Name of a topology resources collection.
      Returns:
      a specific topology component.
      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<TopologyResourceInner> getWithResponse(String resourceGroupName, String ascLocation, String topologyResourceName, com.azure.core.util.Context context)
      Gets a specific topology component.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      ascLocation - The location where ASC stores the data of the subscription. can be retrieved from Get locations.
      topologyResourceName - Name of a topology resources collection.
      context - The context to associate with this operation.
      Returns:
      a specific topology component 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.