Share via


Update-MgBetaNetworkAccessConnectivityBranchDeviceLink

Update the device link associated with a specific branch or remote network.

Syntax

UpdateExpanded (Default)

Update-MgBetaNetworkAccessConnectivityBranchDeviceLink
    -BranchSiteId <string>
    -DeviceLinkId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-BandwidthCapacityInMbps <string>]
    [-BgpConfiguration <IMicrosoftGraphNetworkaccessBgpConfiguration>]
    [-DeviceVendor <string>]
    [-IPAddress <string>]
    [-Id <string>]
    [-LastModifiedDateTime <datetime>]
    [-Name <string>]
    [-RedundancyConfiguration <IMicrosoftGraphNetworkaccessRedundancyConfiguration>]
    [-TunnelConfiguration <IMicrosoftGraphNetworkaccessTunnelConfiguration>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update

Update-MgBetaNetworkAccessConnectivityBranchDeviceLink
    -BranchSiteId <string>
    -DeviceLinkId <string>
    -BodyParameter <IMicrosoftGraphNetworkaccessDeviceLink>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded

Update-MgBetaNetworkAccessConnectivityBranchDeviceLink
    -InputObject <INetworkAccessIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-BandwidthCapacityInMbps <string>]
    [-BgpConfiguration <IMicrosoftGraphNetworkaccessBgpConfiguration>]
    [-DeviceVendor <string>]
    [-IPAddress <string>]
    [-Id <string>]
    [-LastModifiedDateTime <datetime>]
    [-Name <string>]
    [-RedundancyConfiguration <IMicrosoftGraphNetworkaccessRedundancyConfiguration>]
    [-TunnelConfiguration <IMicrosoftGraphNetworkaccessTunnelConfiguration>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity

Update-MgBetaNetworkAccessConnectivityBranchDeviceLink
    -InputObject <INetworkAccessIdentity>
    -BodyParameter <IMicrosoftGraphNetworkaccessDeviceLink>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update the device link associated with a specific branch or remote network.

Permissions

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

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Beta.NetworkAccess

$params = @{
	name = "Backup Link"
}

Update-MgBetaNetworkAccessConnectivityBranchDeviceLink -BranchSiteId $branchSiteId -DeviceLinkId $deviceLinkId -BodyParameter $params

This example shows how to use the Update-MgBetaNetworkAccessConnectivityBranchDeviceLink Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

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

Parameter sets

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

-BandwidthCapacityInMbps

bandwidthCapacityInMbps

Parameter properties

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

Parameter sets

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

-BgpConfiguration

bgpConfiguration To construct, see NOTES section for BGPCONFIGURATION properties and create a hash table.

Parameter properties

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

Parameter sets

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

-BodyParameter

deviceLink To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

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

Parameter sets

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

-BranchSiteId

The unique identifier of branchSite

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

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

-DeviceLinkId

The unique identifier of deviceLink

Parameter properties

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

Parameter sets

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

-DeviceVendor

deviceVendor

Parameter properties

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

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
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

-Id

The unique identifier for an entity. Read-only.

Parameter properties

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

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
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

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

-IPAddress

The public IP address of your CPE (customer premise equipment) device.

Parameter properties

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

Parameter sets

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

-LastModifiedDateTime

last modified time.

Parameter properties

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

Parameter sets

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

-Name

Name.

Parameter properties

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

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
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

-RedundancyConfiguration

redundancyConfiguration To construct, see NOTES section for REDUNDANCYCONFIGURATION properties and create a hash table.

Parameter properties

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

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
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

-TunnelConfiguration

tunnelConfiguration To construct, see NOTES section for TUNNELCONFIGURATION properties and create a hash table.

Parameter properties

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

Parameter sets

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

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

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.IMicrosoftGraphNetworkaccessDeviceLink

{{ Fill in the Description }}

Microsoft.Graph.Beta.PowerShell.Models.INetworkAccessIdentity

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphNetworkaccessDeviceLink

{{ 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.

BGPCONFIGURATION <IMicrosoftGraphNetworkaccessBgpConfiguration>: bgpConfiguration [(Any) <Object>]: This indicates any property can be added to this object. [Asn <Int32?>]: Specifies the ASN of the BGP. [IPAddress <String>]: Specifies the BGP IP address. [LocalIPAddress <String>]: Specifies the BGP IP address of peer (Microsoft, in this case). [PeerIPAddress <String>]: Specifies the BGP IP address of customer's on-premise VPN router configuration.

BODYPARAMETER <IMicrosoftGraphNetworkaccessDeviceLink>: deviceLink [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [BandwidthCapacityInMbps <String>]: bandwidthCapacityInMbps [BgpConfiguration <IMicrosoftGraphNetworkaccessBgpConfiguration>]: bgpConfiguration [(Any) <Object>]: This indicates any property can be added to this object. [Asn <Int32?>]: Specifies the ASN of the BGP. [IPAddress <String>]: Specifies the BGP IP address. [LocalIPAddress <String>]: Specifies the BGP IP address of peer (Microsoft, in this case). [PeerIPAddress <String>]: Specifies the BGP IP address of customer's on-premise VPN router configuration. [DeviceVendor <String>]: deviceVendor [IPAddress <String>]: The public IP address of your CPE (customer premise equipment) device. [LastModifiedDateTime <DateTime?>]: last modified time. [Name <String>]: Name. [RedundancyConfiguration <IMicrosoftGraphNetworkaccessRedundancyConfiguration>]: redundancyConfiguration [(Any) <Object>]: This indicates any property can be added to this object. [RedundancyTier <String>]: redundancyTier [ZoneLocalIPAddress <String>]: Indicate the specific IP address used for establishing the Border Gateway Protocol (BGP) connection with Microsoft's network. [TunnelConfiguration <IMicrosoftGraphNetworkaccessTunnelConfiguration>]: tunnelConfiguration [(Any) <Object>]: This indicates any property can be added to this object. [PreSharedKey <String>]: A key to establish secure connection between the link and VPN tunnel on the edge. [ZoneRedundancyPreSharedKey <String>]: Another key for zone redundant tunnel. Required only when you select zoneRedundancy redindancyTier when creating a deviceLink.

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}'

REDUNDANCYCONFIGURATION <IMicrosoftGraphNetworkaccessRedundancyConfiguration>: redundancyConfiguration [(Any) <Object>]: This indicates any property can be added to this object. [RedundancyTier <String>]: redundancyTier [ZoneLocalIPAddress <String>]: Indicate the specific IP address used for establishing the Border Gateway Protocol (BGP) connection with Microsoft's network.

TUNNELCONFIGURATION <IMicrosoftGraphNetworkaccessTunnelConfiguration>: tunnelConfiguration [(Any) <Object>]: This indicates any property can be added to this object. [PreSharedKey <String>]: A key to establish secure connection between the link and VPN tunnel on the edge. [ZoneRedundancyPreSharedKey <String>]: Another key for zone redundant tunnel. Required only when you select zoneRedundancy redindancyTier when creating a deviceLink.