Class: Azure::Network::Mgmt::V2018_12_01::Models::VirtualNetworkPeering

Inherits:
SubResource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-12-01/generated/azure_mgmt_network/models/virtual_network_peering.rb

Overview

Peerings in a virtual network resource.

Instance Attribute Summary collapse

Attributes inherited from SubResource

#id

Class Method Summary collapse

Instance Attribute Details

#allow_forwarded_traffic ⇒ Boolean

remote virtual network will be allowed/disallowed.

Returns:

  • (Boolean) —

    Whether the forwarded traffic from the VMs in the



21
22
23
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/models/virtual_network_peering.rb', line 21

def allow_forwarded_traffic
  @allow_forwarded_traffic
end

#allow_gateway_transit ⇒ Boolean

networking to link to this virtual network.

Returns:

  • (Boolean) —

    If gateway links can be used in remote virtual



25
26
27
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/models/virtual_network_peering.rb', line 25

def allow_gateway_transit
  @allow_gateway_transit
end

#allow_virtual_network_access ⇒ Boolean

would be able to access all the VMs in local Virtual network space.

Returns:

  • (Boolean) —

    Whether the VMs in the linked virtual network space



17
18
19
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/models/virtual_network_peering.rb', line 17

def allow_virtual_network_access
  @allow_virtual_network_access
end

#etag ⇒ String

resource is updated.

Returns:

  • (String) —

    A unique read-only string that changes whenever the



59
60
61
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/models/virtual_network_peering.rb', line 59

def etag
  @etag
end

#name ⇒ String

resource group. This name can be used to access the resource.

Returns:

  • (String) —

    The name of the resource that is unique within a



55
56
57
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/models/virtual_network_peering.rb', line 55

def name
  @name
end

#peering_state ⇒ VirtualNetworkPeeringState

peering. Possible values are ‘Initiated’, ‘Connected’, and ‘Disconnected’. Possible values include: ‘Initiated’, ‘Connected’, ‘Disconnected’

Returns:



48
49
50
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/models/virtual_network_peering.rb', line 48

def peering_state
  @peering_state
end

#provisioning_state ⇒ String

Returns The provisioning state of the resource.

Returns:

  • (String) —

    The provisioning state of the resource.



51
52
53
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/models/virtual_network_peering.rb', line 51

def provisioning_state
  @provisioning_state
end

#remote_address_space ⇒ AddressSpace

address space.

Returns:

  • (AddressSpace) —

    The reference of the remote virtual network



42
43
44
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/models/virtual_network_peering.rb', line 42

def remote_address_space
  @remote_address_space
end

#remote_virtual_network ⇒ SubResource

remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering).

Returns:

  • (SubResource) —

    The reference of the remote virtual network. The



38
39
40
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/models/virtual_network_peering.rb', line 38

def remote_virtual_network
  @remote_virtual_network
end

#use_remote_gateways ⇒ Boolean

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:

  • (Boolean) —

    If remote gateways can be used on this virtual



32
33
34
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/models/virtual_network_peering.rb', line 32

def use_remote_gateways
  @use_remote_gateways
end

Class Method Details

.mapper ⇒ Object

Mapper for VirtualNetworkPeering class as Ruby Hash. This will be used for serialization/deserialization.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/2018-12-01/generated/azure_mgmt_network/models/virtual_network_peering.rb', line 66

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'VirtualNetworkPeering',
    type: {
      name: 'Composite',
      class_name: 'VirtualNetworkPeering',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        allow_virtual_network_access: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.allowVirtualNetworkAccess',
          type: {
            name: 'Boolean'
          }
        },
        allow_forwarded_traffic: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.allowForwardedTraffic',
          type: {
            name: 'Boolean'
          }
        },
        allow_gateway_transit: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.allowGatewayTransit',
          type: {
            name: 'Boolean'
          }
        },
        use_remote_gateways: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.useRemoteGateways',
          type: {
            name: 'Boolean'
          }
        },
        remote_virtual_network: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.remoteVirtualNetwork',
          type: {
            name: 'Composite',
            class_name: 'SubResource'
          }
        },
        remote_address_space: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.remoteAddressSpace',
          type: {
            name: 'Composite',
            class_name: 'AddressSpace'
          }
        },
        peering_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.peeringState',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        etag: {
          client_side_validation: true,
          required: false,
          serialized_name: 'etag',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end