Edit

Share via

branchSite resource type (deprecated)

  • Article

Namespace: microsoft.graph.networkaccess

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Important

Deprecated and to be retired soon. Use the remoteNetwork resource type and its associated methods instead.

A branch connects the Customer Premises Equipment (CPE) to the Global Secure Access services edge network.

Inherits from microsoft.graph.entity.

Methods

Method Return type Description
List microsoft.graph.networkaccess.branchSite collection Get a list of the microsoft.graph.networkaccess.branchSite objects and their properties.
Create microsoft.graph.networkaccess.branchSite Create a new microsoft.graph.networkaccess.branchSite object.
Get microsoft.graph.networkaccess.branchSite Read the properties and relationships of a microsoft.graph.networkaccess.branchSite object.
Update microsoft.graph.networkaccess.branchSite Update the properties of a microsoft.graph.networkaccess.branchSite object.
Delete None Delete a microsoft.graph.networkaccess.branchSite object.

Properties

Property Type Description
bandwidthCapacity Int64 Determines the maximum allowed Mbps (megabits per second) bandwidth from a branch site. The possible values are:250,500,750,1000.
connectivityState microsoft.graph.networkaccess.connectivityState Determines the branch site status. The possible values are: pending, connected, inactive, error.
id String Identifier for the branch. Inherited from microsoft.graph.entity.
lastModifiedDateTime DateTimeOffset last modified time.
name String Name.
region microsoft.graph.networkaccess.region Specify the region closest to your remote network. The possible value are: eastUS, eastUS2, westUS, westUS2, westUS3, centralUS, northCentralUS, southCentralUS, northEurope, westEurope, franceCentral, germanyWestCentral, switzerlandNorth, ukSouth, canadaEast, canadaCentral, southAfricaWest, southAfricaNorth, uaeNorth, australiaEast, westCentralUS, centralIndia, southEastAsia, swedenCentral, southIndia, australiaSouthEast, koreaCentral, koreaSouth, polandCentral, brazilSouth, japanEast, japanWest, koreaSouth, italyNorth, franceSouth, israelCentral, unknownFutureValue.
version String The branch version.
country (deprecated) String The branch site is created in the specified country. DO NOT USE.

Relationships

Relationship Type Description
connectivityConfiguration microsoft.graph.networkaccess.branchConnectivityConfiguration collection Specifies the connectivity details of all device links associated with a branch.
deviceLinks microsoft.graph.networkaccess.deviceLink collection Each unique CPE device associated with a branch is specified. Supports $expand.
forwardingProfiles microsoft.graph.networkaccess.forwardingProfile collection Each forwarding profile associated with a branch site is specified. Supports $expand.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.networkaccess.branchSite",
  "id": "String (identifier)",
  "name": "String",
  "country": "String",
  "region": "String",
  "connectivityState": "String",
  "bandwidthCapacity": "Integer",
  "version": "String",
  "lastModifiedDateTime": "String (timestamp)"
}