Topology interface
Interface representing a Topology.
Methods
| get(string, string, string, Topology |
Gets a specific topology component. |
| list(Topology |
Gets a list that allows to build a topology view of a subscription. |
| list |
Gets a list that allows to build a topology view of a subscription and location. |
Method Details
get(string, string, string, TopologyGetOptionalParams)
Gets a specific topology component.
function get(resourceGroupName: string, ascLocation: string, topologyResourceName: string, options?: TopologyGetOptionalParams): Promise<TopologyResource>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- ascLocation
-
string
The location where ASC stores the data of the subscription. can be retrieved from Get locations
- topologyResourceName
-
string
Name of a topology resources collection.
- options
- TopologyGetOptionalParams
The options parameters.
Returns
Promise<TopologyResource>
list(TopologyListOptionalParams)
Gets a list that allows to build a topology view of a subscription.
function list(options?: TopologyListOptionalParams): PagedAsyncIterableIterator<TopologyResource, TopologyResource[], PageSettings>Parameters
- options
- TopologyListOptionalParams
The options parameters.
Returns
listByHomeRegion(string, TopologyListByHomeRegionOptionalParams)
Gets a list that allows to build a topology view of a subscription and location.
function listByHomeRegion(ascLocation: string, options?: TopologyListByHomeRegionOptionalParams): PagedAsyncIterableIterator<TopologyResource, TopologyResource[], PageSettings>Parameters
- ascLocation
-
string
The location where ASC stores the data of the subscription. can be retrieved from Get locations
The options parameters.