Class VirtualNetworkPeeringPropertiesFormat


  • public final class VirtualNetworkPeeringPropertiesFormat
    extends Object
    Properties of the virtual network peering.
    • Constructor Detail

      • VirtualNetworkPeeringPropertiesFormat

        public VirtualNetworkPeeringPropertiesFormat()
    • Method Detail

      • allowVirtualNetworkAccess

        public Boolean allowVirtualNetworkAccess()
        Get the allowVirtualNetworkAccess property: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
        Returns:
        the allowVirtualNetworkAccess value.
      • withAllowVirtualNetworkAccess

        public VirtualNetworkPeeringPropertiesFormat withAllowVirtualNetworkAccess​(Boolean allowVirtualNetworkAccess)
        Set the allowVirtualNetworkAccess property: Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
        Parameters:
        allowVirtualNetworkAccess - the allowVirtualNetworkAccess value to set.
        Returns:
        the VirtualNetworkPeeringPropertiesFormat object itself.
      • allowForwardedTraffic

        public Boolean allowForwardedTraffic()
        Get the allowForwardedTraffic property: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
        Returns:
        the allowForwardedTraffic value.
      • withAllowForwardedTraffic

        public VirtualNetworkPeeringPropertiesFormat withAllowForwardedTraffic​(Boolean allowForwardedTraffic)
        Set the allowForwardedTraffic property: Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
        Parameters:
        allowForwardedTraffic - the allowForwardedTraffic value to set.
        Returns:
        the VirtualNetworkPeeringPropertiesFormat object itself.
      • allowGatewayTransit

        public Boolean allowGatewayTransit()
        Get the allowGatewayTransit property: If gateway links can be used in remote virtual networking to link to this virtual network.
        Returns:
        the allowGatewayTransit value.
      • withAllowGatewayTransit

        public VirtualNetworkPeeringPropertiesFormat withAllowGatewayTransit​(Boolean allowGatewayTransit)
        Set the allowGatewayTransit property: If gateway links can be used in remote virtual networking to link to this virtual network.
        Parameters:
        allowGatewayTransit - the allowGatewayTransit value to set.
        Returns:
        the VirtualNetworkPeeringPropertiesFormat object itself.
      • useRemoteGateways

        public Boolean useRemoteGateways()
        Get the useRemoteGateways property: 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.
        Returns:
        the useRemoteGateways value.
      • withUseRemoteGateways

        public VirtualNetworkPeeringPropertiesFormat withUseRemoteGateways​(Boolean useRemoteGateways)
        Set the useRemoteGateways property: 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.
        Parameters:
        useRemoteGateways - the useRemoteGateways value to set.
        Returns:
        the VirtualNetworkPeeringPropertiesFormat object itself.
      • remoteVirtualNetwork

        public com.azure.core.management.SubResource remoteVirtualNetwork()
        Get the remoteVirtualNetwork property: The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).
        Returns:
        the remoteVirtualNetwork value.
      • withRemoteVirtualNetwork

        public VirtualNetworkPeeringPropertiesFormat withRemoteVirtualNetwork​(com.azure.core.management.SubResource remoteVirtualNetwork)
        Set the remoteVirtualNetwork property: The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).
        Parameters:
        remoteVirtualNetwork - the remoteVirtualNetwork value to set.
        Returns:
        the VirtualNetworkPeeringPropertiesFormat object itself.
      • remoteAddressSpace

        public AddressSpace remoteAddressSpace()
        Get the remoteAddressSpace property: The reference to the address space peered with the remote virtual network.
        Returns:
        the remoteAddressSpace value.
      • withRemoteAddressSpace

        public VirtualNetworkPeeringPropertiesFormat withRemoteAddressSpace​(AddressSpace remoteAddressSpace)
        Set the remoteAddressSpace property: The reference to the address space peered with the remote virtual network.
        Parameters:
        remoteAddressSpace - the remoteAddressSpace value to set.
        Returns:
        the VirtualNetworkPeeringPropertiesFormat object itself.
      • remoteVirtualNetworkAddressSpace

        public AddressSpace remoteVirtualNetworkAddressSpace()
        Get the remoteVirtualNetworkAddressSpace property: The reference to the current address space of the remote virtual network.
        Returns:
        the remoteVirtualNetworkAddressSpace value.
      • withRemoteVirtualNetworkAddressSpace

        public VirtualNetworkPeeringPropertiesFormat withRemoteVirtualNetworkAddressSpace​(AddressSpace remoteVirtualNetworkAddressSpace)
        Set the remoteVirtualNetworkAddressSpace property: The reference to the current address space of the remote virtual network.
        Parameters:
        remoteVirtualNetworkAddressSpace - the remoteVirtualNetworkAddressSpace value to set.
        Returns:
        the VirtualNetworkPeeringPropertiesFormat object itself.
      • remoteBgpCommunities

        public VirtualNetworkBgpCommunities remoteBgpCommunities()
        Get the remoteBgpCommunities property: The reference to the remote virtual network's Bgp Communities.
        Returns:
        the remoteBgpCommunities value.
      • withRemoteBgpCommunities

        public VirtualNetworkPeeringPropertiesFormat withRemoteBgpCommunities​(VirtualNetworkBgpCommunities remoteBgpCommunities)
        Set the remoteBgpCommunities property: The reference to the remote virtual network's Bgp Communities.
        Parameters:
        remoteBgpCommunities - the remoteBgpCommunities value to set.
        Returns:
        the VirtualNetworkPeeringPropertiesFormat object itself.
      • remoteVirtualNetworkEncryption

        public VirtualNetworkEncryption remoteVirtualNetworkEncryption()
        Get the remoteVirtualNetworkEncryption property: The reference to the remote virtual network's encryption.
        Returns:
        the remoteVirtualNetworkEncryption value.
      • peeringState

        public VirtualNetworkPeeringState peeringState()
        Get the peeringState property: The status of the virtual network peering.
        Returns:
        the peeringState value.
      • withPeeringState

        public VirtualNetworkPeeringPropertiesFormat withPeeringState​(VirtualNetworkPeeringState peeringState)
        Set the peeringState property: The status of the virtual network peering.
        Parameters:
        peeringState - the peeringState value to set.
        Returns:
        the VirtualNetworkPeeringPropertiesFormat object itself.
      • peeringSyncLevel

        public VirtualNetworkPeeringLevel peeringSyncLevel()
        Get the peeringSyncLevel property: The peering sync status of the virtual network peering.
        Returns:
        the peeringSyncLevel value.
      • withPeeringSyncLevel

        public VirtualNetworkPeeringPropertiesFormat withPeeringSyncLevel​(VirtualNetworkPeeringLevel peeringSyncLevel)
        Set the peeringSyncLevel property: The peering sync status of the virtual network peering.
        Parameters:
        peeringSyncLevel - the peeringSyncLevel value to set.
        Returns:
        the VirtualNetworkPeeringPropertiesFormat object itself.
      • provisioningState

        public ProvisioningState provisioningState()
        Get the provisioningState property: The provisioning state of the virtual network peering resource.
        Returns:
        the provisioningState value.
      • doNotVerifyRemoteGateways

        public Boolean doNotVerifyRemoteGateways()
        Get the doNotVerifyRemoteGateways property: If we need to verify the provisioning state of the remote gateway.
        Returns:
        the doNotVerifyRemoteGateways value.
      • withDoNotVerifyRemoteGateways

        public VirtualNetworkPeeringPropertiesFormat withDoNotVerifyRemoteGateways​(Boolean doNotVerifyRemoteGateways)
        Set the doNotVerifyRemoteGateways property: If we need to verify the provisioning state of the remote gateway.
        Parameters:
        doNotVerifyRemoteGateways - the doNotVerifyRemoteGateways value to set.
        Returns:
        the VirtualNetworkPeeringPropertiesFormat object itself.
      • resourceGuid

        public String resourceGuid()
        Get the resourceGuid property: The resourceGuid property of the Virtual Network peering resource.
        Returns:
        the resourceGuid value.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.