Interface Topology

Package version

Interface representing a Topology.

Hierarchy

Topology

Implemented by

TopologyImpl

Index

Methods

Methods

get

get(resourceGroupName: string, ascLocation: string, topologyResourceName: string, options?: TopologyGetOptionalParams): Promise<TopologyGetResponse>

- Defined in operationsInterfaces/topology.ts:47
Gets a specific topology component.

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.
- Optional options: TopologyGetOptionalParams
  
  The options parameters.
Returns Promise<TopologyGetResponse>

list

list(options?: TopologyListOptionalParams): PagedAsyncIterableIterator<TopologyResource>

- Defined in operationsInterfaces/topology.ts:25
Gets a list that allows to build a topology view of a subscription.

Parameters
- Optional options: TopologyListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TopologyResource>

listByHomeRegion

listByHomeRegion(ascLocation: string, options?: TopologyListByHomeRegionOptionalParams): PagedAsyncIterableIterator<TopologyResource>

- Defined in operationsInterfaces/topology.ts:34
Gets a list that allows to build a topology view of a subscription and location.

Parameters
- ascLocation: string
  
  The location where ASC stores the data of the subscription. can be retrieved from Get locations
- Optional options: TopologyListByHomeRegionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TopologyResource>

Generated using TypeDoc