Update-AzDatabricksVNetPeering
Update vNet Peering for workspace.
Syntax
Update-AzDatabricksVNetPeering
-Name <String>
-ResourceGroupName <String>
-WorkspaceName <String>
[-SubscriptionId <String>]
[-AllowForwardedTraffic <Boolean>]
[-AllowGatewayTransit <Boolean>]
[-AllowVirtualNetworkAccess <Boolean>]
[-DatabricksAddressSpacePrefix <String[]>]
[-DatabricksVirtualNetworkId <String>]
[-RemoteAddressSpacePrefix <String[]>]
[-RemoteVirtualNetworkId <String>]
[-UseRemoteGateway <Boolean>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-Confirm]
[-WhatIf]
[<CommonParameters>] Update-AzDatabricksVNetPeering
-InputObject <IDatabricksIdentity>
[-AllowForwardedTraffic <Boolean>]
[-AllowGatewayTransit <Boolean>]
[-AllowVirtualNetworkAccess <Boolean>]
[-DatabricksAddressSpacePrefix <String[]>]
[-DatabricksVirtualNetworkId <String>]
[-RemoteAddressSpacePrefix <String[]>]
[-RemoteVirtualNetworkId <String>]
[-UseRemoteGateway <Boolean>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-Confirm]
[-WhatIf]
[<CommonParameters>] Description
Update vNet Peering for workspace.
Examples
Example 1: Update AllowForwardedTraffic of vnet peering.
Update-AzDatabricksVNetPeering -Name vnet-peering-t1 -WorkspaceName azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db -AllowForwardedTraffic $True
Name ResourceGroupName
---- -----------------
vnet-peering-t1 azps_test_gp_dbThis command updates AllowForwardedTraffic of vnet peering.
Example 2: Update AllowForwardedTraffic of vnet peering by object.
Get-AzDatabricksVNetPeering -WorkspaceName azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db -Name vnet-peering-t1 | Update-AzDatabricksVNetPeering -AllowGatewayTransit $true
Name ResourceGroupName
---- -----------------
vnet-peering-t1 azps_test_gp_dbThis command updates AllowForwardedTraffic of vnet peering by object.
Parameters
-AllowForwardedTraffic
[System.Management.Automation.SwitchParameter] Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowGatewayTransit
[System.Management.Automation.SwitchParameter] If gateway links can be used in remote virtual networking to link to this virtual network.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowVirtualNetworkAccess
[System.Management.Automation.SwitchParameter] Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AsJob
Run the command as a job
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DatabricksAddressSpacePrefix
A list of address blocks reserved for this virtual network in CIDR notation.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DatabricksVirtualNetworkId
The Id of the databricks virtual network.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity parameter. To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IDatabricksIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the VNetPeering.
| Type: | String |
| Aliases: | PeeringName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemoteAddressSpacePrefix
A list of address blocks reserved for this virtual network in CIDR notation.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemoteVirtualNetworkId
The Id of the remote virtual network.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseRemoteGateway
[System.Management.Automation.SwitchParameter] If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WorkspaceName
The name of the workspace.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Notes
ALIASES
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 <IDatabricksIdentity>: Identity parameter.
[ConnectorName <String>]: The name of the azure databricks accessConnector.[GroupId <String>]: The name of the private link resource[Id <String>]: Resource identity path[PeeringName <String>]: The name of the workspace vNet peering.[PrivateEndpointConnectionName <String>]: The name of the private endpoint connection[ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.[SubscriptionId <String>]: The ID of the target subscription.[WorkspaceName <String>]: The name of the workspace.