Get-MgBetaNetworkAccessConnectivityBranchConnectivityConfiguration

Module:

Microsoft.Graph.Beta.NetworkAccess Module

Retrieve the IPSec tunnel configuration required to establish a bidirectional communication link between your organization's router and the Microsoft gateway. This information is vital for configuring your router (customer premise equipment) after creating a deviceLink.

Syntax

Get (Default)

Get-MgBetaNetworkAccessConnectivityBranchConnectivityConfiguration
    -BranchSiteId <string>
    [-ExpandProperty <string[]>]
    [-Property <string[]>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

GetViaIdentity

Get-MgBetaNetworkAccessConnectivityBranchConnectivityConfiguration

    -InputObject <INetworkAccessIdentity>
    [-ExpandProperty <string[]>]
    [-Property <string[]>]
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [<CommonParameters>]

Description

Retrieve the IPSec tunnel configuration required to establish a bidirectional communication link between your organization's router and the Microsoft gateway. This information is vital for configuring your router (customer premise equipment) after creating a deviceLink.

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	NetworkAccess.Read.All, NetworkAccess.ReadWrite.All,
Delegated (personal Microsoft account)	Not supported
Application	NetworkAccess.Read.All, NetworkAccess.ReadWrite.All,

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.NetworkAccess

Get-MgBetaNetworkAccessConnectivityBranchConnectivityConfiguration -BranchSiteId $branchSiteId

This example shows how to use the Get-MgBetaNetworkAccessConnectivityBranchConnectivityConfiguration Cmdlet.

Parameters

-BranchSiteId

The unique identifier of branchSite

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False

Parameter sets

Get

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ExpandProperty

Expand related entities

Parameter properties

Type:	System.String[]
Supports wildcards:	False
DontShow:	False
Aliases:	Expand

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:	System.Collections.IDictionary
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:	Microsoft.Graph.Beta.PowerShell.Models.INetworkAccessIdentity
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Property

Select properties to be returned

Parameter properties

Type:	System.String[]
Supports wildcards:	False
DontShow:	False
Aliases:	Select

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:	System.Uri
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:	System.Management.Automation.PSCredential
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:	System.String
Supports wildcards:	False
DontShow:	False
Aliases:	RHV

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.INetworkAccessIdentity

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphNetworkaccessBranchConnectivityConfiguration

{{ Fill in the Description }}

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <INetworkAccessIdentity>: Identity Parameter [ActivityPivotDateTime <DateTime?>]: Usage: activityPivotDateTime={activityPivotDateTime} [AggregatedBy <String>]: Usage: aggregatedBy='{aggregatedBy}' [AlertId <String>]: The unique identifier of alert [BranchSiteId <String>]: The unique identifier of branchSite [ConditionalAccessPolicyId <String>]: The unique identifier of conditionalAccessPolicy [ConnectionId <String>]: The unique identifier of connection [ConnectivityConfigurationLinkId <String>]: The unique identifier of connectivityConfigurationLink [DeviceLinkId <String>]: The unique identifier of deviceLink [DiscoveryPivotDateTime <DateTime?>]: Usage: discoveryPivotDateTime={discoveryPivotDateTime} [EndDateTime <DateTime?>]: Usage: endDateTime={endDateTime} [ExternalCertificateAuthorityCertificateId <String>]: The unique identifier of externalCertificateAuthorityCertificate [FilteringPolicyId <String>]: The unique identifier of filteringPolicy [FilteringProfileId <String>]: The unique identifier of filteringProfile [ForwardingPolicyId <String>]: The unique identifier of forwardingPolicy [ForwardingProfileId <String>]: The unique identifier of forwardingProfile [NetworkAccessTrafficTransactionId <String>]: The unique identifier of networkAccessTraffic [PolicyLinkId <String>]: The unique identifier of policyLink [PolicyRuleId <String>]: The unique identifier of policyRule [RemoteNetworkHealthEventId <String>]: The unique identifier of remoteNetworkHealthEvent [RemoteNetworkId <String>]: The unique identifier of remoteNetwork [StartDateTime <DateTime?>]: Usage: startDateTime={startDateTime} [ThreatIntelligencePolicyId <String>]: The unique identifier of threatIntelligencePolicy [TlsInspectionPolicyId <String>]: The unique identifier of tlsInspectionPolicy [Url <String>]: Usage: url='{url}'

Related Links

• Get-MgBetaNetworkAccessConnectivityBranchConnectivityConfiguration
• Graph API Reference