Class: Azure::Network::Mgmt::V2018_08_01::NetworkManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ NetworkManagementClient

Creates initializes a new instance of the NetworkManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil)

    credentials to authorize HTTP requests made by the service client.

  • base_url (String) (defaults to: nil)

    the base URI of the service.

  • options (Array) (defaults to: nil)

    filters to be applied to the HTTP requests.


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 249

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @application_gateways = ApplicationGateways.new(self)
  @application_security_groups = ApplicationSecurityGroups.new(self)
  @available_delegations = AvailableDelegations.new(self)
  @available_resource_group_delegations = AvailableResourceGroupDelegations.new(self)
  @azure_firewalls = AzureFirewalls.new(self)
  @azure_firewall_fqdn_tags = AzureFirewallFqdnTags.new(self)
  @ddos_protection_plans = DdosProtectionPlans.new(self)
  @available_endpoint_services = AvailableEndpointServices.new(self)
  @express_route_circuit_authorizations = ExpressRouteCircuitAuthorizations.new(self)
  @express_route_circuit_peerings = ExpressRouteCircuitPeerings.new(self)
  @express_route_circuit_connections = ExpressRouteCircuitConnections.new(self)
  @express_route_circuits = ExpressRouteCircuits.new(self)
  @express_route_service_providers = ExpressRouteServiceProviders.new(self)
  @express_route_cross_connections = ExpressRouteCrossConnections.new(self)
  @express_route_cross_connection_peerings = ExpressRouteCrossConnectionPeerings.new(self)
  @express_route_gateways = ExpressRouteGateways.new(self)
  @express_route_connections = ExpressRouteConnections.new(self)
  @interface_endpoints = InterfaceEndpoints.new(self)
  @load_balancers = LoadBalancers.new(self)
  @load_balancer_backend_address_pools = LoadBalancerBackendAddressPools.new(self)
  @load_balancer_frontend_ipconfigurations = LoadBalancerFrontendIPConfigurations.new(self)
  @inbound_nat_rules = InboundNatRules.new(self)
  @load_balancer_load_balancing_rules = LoadBalancerLoadBalancingRules.new(self)
  @load_balancer_outbound_rules = LoadBalancerOutboundRules.new(self)
  @load_balancer_network_interfaces = LoadBalancerNetworkInterfaces.new(self)
  @load_balancer_probes = LoadBalancerProbes.new(self)
  @network_interfaces = NetworkInterfaces.new(self)
  @network_interface_ipconfigurations = NetworkInterfaceIPConfigurations.new(self)
  @network_interface_load_balancers = NetworkInterfaceLoadBalancers.new(self)
  @network_interface_tap_configurations = NetworkInterfaceTapConfigurations.new(self)
  @network_profiles = NetworkProfiles.new(self)
  @network_security_groups = NetworkSecurityGroups.new(self)
  @security_rules = SecurityRules.new(self)
  @default_security_rules = DefaultSecurityRules.new(self)
  @network_watchers = NetworkWatchers.new(self)
  @packet_captures = PacketCaptures.new(self)
  @connection_monitors = ConnectionMonitors.new(self)
  @operations = Operations.new(self)
  @public_ipaddresses = PublicIPAddresses.new(self)
  @public_ipprefixes = PublicIPPrefixes.new(self)
  @route_filters = RouteFilters.new(self)
  @route_filter_rules = RouteFilterRules.new(self)
  @route_tables = RouteTables.new(self)
  @routes = Routes.new(self)
  @bgp_service_communities = BgpServiceCommunities.new(self)
  @service_endpoint_policies = ServiceEndpointPolicies.new(self)
  @service_endpoint_policy_definitions = ServiceEndpointPolicyDefinitions.new(self)
  @usages = Usages.new(self)
  @virtual_networks = VirtualNetworks.new(self)
  @subnets = Subnets.new(self)
  @virtual_network_peerings = VirtualNetworkPeerings.new(self)
  @virtual_network_taps = VirtualNetworkTaps.new(self)
  @virtual_network_gateways = VirtualNetworkGateways.new(self)
  @virtual_network_gateway_connections = VirtualNetworkGatewayConnections.new(self)
  @local_network_gateways = LocalNetworkGateways.new(self)
  @virtual_wans = VirtualWans.new(self)
  @vpn_sites = VpnSites.new(self)
  @vpn_sites_configuration = VpnSitesConfiguration.new(self)
  @virtual_hubs = VirtualHubs.new(self)
  @hub_virtual_network_connections = HubVirtualNetworkConnections.new(self)
  @vpn_gateways = VpnGateways.new(self)
  @vpn_connections = VpnConnections.new(self)
  @p2s_vpn_server_configurations = P2sVpnServerConfigurations.new(self)
  @p2s_vpn_gateways = P2sVpnGateways.new(self)
  @api_version = '2018-08-01'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_languageString

Returns The preferred language for the response.

Returns:

  • (String)

    The preferred language for the response.


29
30
31
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 29

def accept_language
  @accept_language
end

#api_versionString (readonly)

Returns Client API version.

Returns:

  • (String)

    Client API version.


26
27
28
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 26

def api_version
  @api_version
end

#application_gatewaysApplicationGateways (readonly)

Returns application_gateways.

Returns:


41
42
43
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 41

def application_gateways
  @application_gateways
end

#application_security_groupsApplicationSecurityGroups (readonly)

Returns application_security_groups.

Returns:


44
45
46
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 44

def application_security_groups
  @application_security_groups
end

#available_delegationsAvailableDelegations (readonly)

Returns available_delegations.

Returns:


47
48
49
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 47

def available_delegations
  @available_delegations
end

#available_endpoint_servicesAvailableEndpointServices (readonly)

Returns available_endpoint_services.

Returns:


63
64
65
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 63

def available_endpoint_services
  @available_endpoint_services
end

#available_resource_group_delegationsAvailableResourceGroupDelegations (readonly)

available_resource_group_delegations


51
52
53
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 51

def available_resource_group_delegations
  @available_resource_group_delegations
end

#azure_firewall_fqdn_tagsAzureFirewallFqdnTags (readonly)

Returns azure_firewall_fqdn_tags.

Returns:


57
58
59
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 57

def azure_firewall_fqdn_tags
  @azure_firewall_fqdn_tags
end

#azure_firewallsAzureFirewalls (readonly)

Returns azure_firewalls.

Returns:


54
55
56
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 54

def azure_firewalls
  @azure_firewalls
end

#base_urlString

Returns the base URI of the service.

Returns:

  • (String)

    the base URI of the service.


15
16
17
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 15

def base_url
  @base_url
end

#bgp_service_communitiesBgpServiceCommunities (readonly)

Returns bgp_service_communities.

Returns:


182
183
184
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 182

def bgp_service_communities
  @bgp_service_communities
end

#connection_monitorsConnectionMonitors (readonly)

Returns connection_monitors.

Returns:


158
159
160
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 158

def connection_monitors
  @connection_monitors
end

#credentialsObject (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.


18
19
20
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 18

def credentials
  @credentials
end

#ddos_protection_plansDdosProtectionPlans (readonly)

Returns ddos_protection_plans.

Returns:


60
61
62
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 60

def ddos_protection_plans
  @ddos_protection_plans
end

#default_security_rulesDefaultSecurityRules (readonly)

Returns default_security_rules.

Returns:


149
150
151
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 149

def default_security_rules
  @default_security_rules
end

#express_route_circuit_authorizationsExpressRouteCircuitAuthorizations (readonly)

express_route_circuit_authorizations


67
68
69
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 67

def express_route_circuit_authorizations
  @express_route_circuit_authorizations
end

#express_route_circuit_connectionsExpressRouteCircuitConnections (readonly)

express_route_circuit_connections


74
75
76
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 74

def express_route_circuit_connections
  @express_route_circuit_connections
end

#express_route_circuit_peeringsExpressRouteCircuitPeerings (readonly)

Returns express_route_circuit_peerings.

Returns:


70
71
72
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 70

def express_route_circuit_peerings
  @express_route_circuit_peerings
end

#express_route_circuitsExpressRouteCircuits (readonly)

Returns express_route_circuits.

Returns:


77
78
79
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 77

def express_route_circuits
  @express_route_circuits
end

#express_route_connectionsExpressRouteConnections (readonly)

Returns express_route_connections.

Returns:


93
94
95
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 93

def express_route_connections
  @express_route_connections
end

#express_route_cross_connection_peeringsExpressRouteCrossConnectionPeerings (readonly)

express_route_cross_connection_peerings


87
88
89
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 87

def express_route_cross_connection_peerings
  @express_route_cross_connection_peerings
end

#express_route_cross_connectionsExpressRouteCrossConnections (readonly)

Returns express_route_cross_connections.

Returns:


83
84
85
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 83

def express_route_cross_connections
  @express_route_cross_connections
end

#express_route_gatewaysExpressRouteGateways (readonly)

Returns express_route_gateways.

Returns:


90
91
92
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 90

def express_route_gateways
  @express_route_gateways
end

#express_route_service_providersExpressRouteServiceProviders (readonly)

Returns express_route_service_providers.

Returns:


80
81
82
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 80

def express_route_service_providers
  @express_route_service_providers
end

#generate_client_request_idBoolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean)

    Whether a unique x-ms-client-request-id should be


38
39
40
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 38

def generate_client_request_id
  @generate_client_request_id
end

#hub_virtual_network_connectionsHubVirtualNetworkConnections (readonly)

Returns hub_virtual_network_connections.

Returns:


229
230
231
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 229

def hub_virtual_network_connections
  @hub_virtual_network_connections
end

#inbound_nat_rulesInboundNatRules (readonly)

Returns inbound_nat_rules.

Returns:


110
111
112
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 110

def inbound_nat_rules
  @inbound_nat_rules
end

#interface_endpointsInterfaceEndpoints (readonly)

Returns interface_endpoints.

Returns:


96
97
98
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 96

def interface_endpoints
  @interface_endpoints
end

#load_balancer_backend_address_poolsLoadBalancerBackendAddressPools (readonly)

load_balancer_backend_address_pools


103
104
105
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 103

def load_balancer_backend_address_pools
  @load_balancer_backend_address_pools
end

#load_balancer_frontend_ipconfigurationsLoadBalancerFrontendIPConfigurations (readonly)

load_balancer_frontend_ipconfigurations


107
108
109
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 107

def load_balancer_frontend_ipconfigurations
  @load_balancer_frontend_ipconfigurations
end

#load_balancer_load_balancing_rulesLoadBalancerLoadBalancingRules (readonly)

load_balancer_load_balancing_rules


114
115
116
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 114

def load_balancer_load_balancing_rules
  @load_balancer_load_balancing_rules
end

#load_balancer_network_interfacesLoadBalancerNetworkInterfaces (readonly)

Returns load_balancer_network_interfaces.

Returns:


120
121
122
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 120

def load_balancer_network_interfaces
  @load_balancer_network_interfaces
end

#load_balancer_outbound_rulesLoadBalancerOutboundRules (readonly)

Returns load_balancer_outbound_rules.

Returns:


117
118
119
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 117

def load_balancer_outbound_rules
  @load_balancer_outbound_rules
end

#load_balancer_probesLoadBalancerProbes (readonly)

Returns load_balancer_probes.

Returns:


123
124
125
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 123

def load_balancer_probes
  @load_balancer_probes
end

#load_balancersLoadBalancers (readonly)

Returns load_balancers.

Returns:


99
100
101
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 99

def load_balancers
  @load_balancers
end

#local_network_gatewaysLocalNetworkGateways (readonly)

Returns local_network_gateways.

Returns:


214
215
216
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 214

def local_network_gateways
  @local_network_gateways
end

#long_running_operation_retry_timeoutInteger

Operations. Default value is 30.

Returns:

  • (Integer)

    The retry timeout in seconds for Long Running


33
34
35
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 33

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#network_interface_ipconfigurationsNetworkInterfaceIPConfigurations (readonly)

network_interface_ipconfigurations


130
131
132
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 130

def network_interface_ipconfigurations
  @network_interface_ipconfigurations
end

#network_interface_load_balancersNetworkInterfaceLoadBalancers (readonly)

Returns network_interface_load_balancers.

Returns:


133
134
135
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 133

def network_interface_load_balancers
  @network_interface_load_balancers
end

#network_interface_tap_configurationsNetworkInterfaceTapConfigurations (readonly)

network_interface_tap_configurations


137
138
139
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 137

def network_interface_tap_configurations
  @network_interface_tap_configurations
end

#network_interfacesNetworkInterfaces (readonly)

Returns network_interfaces.

Returns:


126
127
128
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 126

def network_interfaces
  @network_interfaces
end

#network_profilesNetworkProfiles (readonly)

Returns network_profiles.

Returns:


140
141
142
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 140

def network_profiles
  @network_profiles
end

#network_security_groupsNetworkSecurityGroups (readonly)

Returns network_security_groups.

Returns:


143
144
145
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 143

def network_security_groups
  @network_security_groups
end

#network_watchersNetworkWatchers (readonly)

Returns network_watchers.

Returns:


152
153
154
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 152

def network_watchers
  @network_watchers
end

#operationsOperations (readonly)

Returns operations.

Returns:


161
162
163
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 161

def operations
  @operations
end

#p2s_vpn_gatewaysP2sVpnGateways (readonly)

Returns p2s_vpn_gateways.

Returns:


241
242
243
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 241

def p2s_vpn_gateways
  @p2s_vpn_gateways
end

#p2s_vpn_server_configurationsP2sVpnServerConfigurations (readonly)

Returns p2s_vpn_server_configurations.

Returns:


238
239
240
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 238

def p2s_vpn_server_configurations
  @p2s_vpn_server_configurations
end

#packet_capturesPacketCaptures (readonly)

Returns packet_captures.

Returns:


155
156
157
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 155

def packet_captures
  @packet_captures
end

#public_ipaddressesPublicIPAddresses (readonly)

Returns public_ipaddresses.

Returns:


164
165
166
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 164

def public_ipaddresses
  @public_ipaddresses
end

#public_ipprefixesPublicIPPrefixes (readonly)

Returns public_ipprefixes.

Returns:


167
168
169
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 167

def public_ipprefixes
  @public_ipprefixes
end

#route_filter_rulesRouteFilterRules (readonly)

Returns route_filter_rules.

Returns:


173
174
175
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 173

def route_filter_rules
  @route_filter_rules
end

#route_filtersRouteFilters (readonly)

Returns route_filters.

Returns:


170
171
172
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 170

def route_filters
  @route_filters
end

#route_tablesRouteTables (readonly)

Returns route_tables.

Returns:


176
177
178
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 176

def route_tables
  @route_tables
end

#routesRoutes (readonly)

Returns routes.

Returns:


179
180
181
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 179

def routes
  @routes
end

#security_rulesSecurityRules (readonly)

Returns security_rules.

Returns:


146
147
148
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 146

def security_rules
  @security_rules
end

#service_endpoint_policiesServiceEndpointPolicies (readonly)

Returns service_endpoint_policies.

Returns:


185
186
187
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 185

def service_endpoint_policies
  @service_endpoint_policies
end

#service_endpoint_policy_definitionsServiceEndpointPolicyDefinitions (readonly)

service_endpoint_policy_definitions


189
190
191
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 189

def service_endpoint_policy_definitions
  @service_endpoint_policy_definitions
end

#subnetsSubnets (readonly)

Returns subnets.

Returns:


198
199
200
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 198

def subnets
  @subnets
end

#subscription_idString

Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Returns:

  • (String)

    The subscription credentials which uniquely identify the


23
24
25
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 23

def subscription_id
  @subscription_id
end

#usagesUsages (readonly)

Returns usages.

Returns:


192
193
194
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 192

def usages
  @usages
end

#virtual_hubsVirtualHubs (readonly)

Returns virtual_hubs.

Returns:


226
227
228
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 226

def virtual_hubs
  @virtual_hubs
end

#virtual_network_gateway_connectionsVirtualNetworkGatewayConnections (readonly)

virtual_network_gateway_connections


211
212
213
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 211

def virtual_network_gateway_connections
  @virtual_network_gateway_connections
end

#virtual_network_gatewaysVirtualNetworkGateways (readonly)

Returns virtual_network_gateways.

Returns:


207
208
209
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 207

def virtual_network_gateways
  @virtual_network_gateways
end

#virtual_network_peeringsVirtualNetworkPeerings (readonly)

Returns virtual_network_peerings.

Returns:


201
202
203
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 201

def virtual_network_peerings
  @virtual_network_peerings
end

#virtual_network_tapsVirtualNetworkTaps (readonly)

Returns virtual_network_taps.

Returns:


204
205
206
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 204

def virtual_network_taps
  @virtual_network_taps
end

#virtual_networksVirtualNetworks (readonly)

Returns virtual_networks.

Returns:


195
196
197
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 195

def virtual_networks
  @virtual_networks
end

#virtual_wansVirtualWans (readonly)

Returns virtual_wans.

Returns:


217
218
219
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 217

def virtual_wans
  @virtual_wans
end

#vpn_connectionsVpnConnections (readonly)

Returns vpn_connections.

Returns:


235
236
237
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 235

def vpn_connections
  @vpn_connections
end

#vpn_gatewaysVpnGateways (readonly)

Returns vpn_gateways.

Returns:


232
233
234
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 232

def vpn_gateways
  @vpn_gateways
end

#vpn_sitesVpnSites (readonly)

Returns vpn_sites.

Returns:


220
221
222
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 220

def vpn_sites
  @vpn_sites
end

#vpn_sites_configurationVpnSitesConfiguration (readonly)

Returns vpn_sites_configuration.

Returns:


223
224
225
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 223

def vpn_sites_configuration
  @vpn_sites_configuration
end

Instance Method Details

#check_dns_name_availability(location, domain_name_label, custom_headers: nil) ⇒ DnsNameAvailabilityResult

Checks whether a domain name in the cloudapp.azure.com zone is available for use.

conform to the following regular expression: ^[a-z][a-z0-9-]1,61$. will be added to the HTTP request.

Parameters:

  • location (String)

    The location of the domain name.

  • domain_name_label (String)

    The domain name to be verified. It must

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (DnsNameAvailabilityResult)

    operation results.


397
398
399
400
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 397

def check_dns_name_availability(location, domain_name_label, custom_headers:nil)
  response = check_dns_name_availability_async(location, domain_name_label, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#check_dns_name_availability_async(location, domain_name_label, custom_headers: nil) ⇒ Concurrent::Promise

Checks whether a domain name in the cloudapp.azure.com zone is available for use.

conform to the following regular expression: ^[a-z][a-z0-9-]1,61$. to the HTTP request.

Parameters:

  • location (String)

    The location of the domain name.

  • domain_name_label (String)

    The domain name to be verified. It must

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 430

def check_dns_name_availability_async(location, domain_name_label, custom_headers:nil)
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'domain_name_label is nil' if domain_name_label.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'location' => location,'subscriptionId' => subscription_id},
      query_params: {'domainNameLabel' => domain_name_label,'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2018_08_01::Models::DnsNameAvailabilityResult.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#check_dns_name_availability_with_http_info(location, domain_name_label, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Checks whether a domain name in the cloudapp.azure.com zone is available for use.

conform to the following regular expression: ^[a-z][a-z0-9-]1,61$. will be added to the HTTP request.

Parameters:

  • location (String)

    The location of the domain name.

  • domain_name_label (String)

    The domain name to be verified. It must

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


414
415
416
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 414

def check_dns_name_availability_with_http_info(location, domain_name_label, custom_headers:nil)
  check_dns_name_availability_async(location, domain_name_label, custom_headers:custom_headers).value!
end

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol)

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String)

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {})

    specifying any request options like :body.

Returns:

  • (Hash{String=>String})

    containing the body of the response.


343
344
345
346
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 343

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol)

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String)

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {})

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 368

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol)

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String)

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {})

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse)

    Operation response containing the request, response and status.


355
356
357
358
359
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 355

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end

#supported_security_providers(resource_group_name, virtual_wanname, custom_headers: nil) ⇒ VirtualWanSecurityProviders

Gives the supported security providers for the virtual wan.

supported security providers are needed. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name.

  • virtual_wanname (String)

    The name of the VirtualWAN for which

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (VirtualWanSecurityProviders)

    operation results.


496
497
498
499
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 496

def supported_security_providers(resource_group_name, virtual_wanname, custom_headers:nil)
  response = supported_security_providers_async(resource_group_name, virtual_wanname, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#supported_security_providers_async(resource_group_name, virtual_wanname, custom_headers: nil) ⇒ Concurrent::Promise

Gives the supported security providers for the virtual wan.

supported security providers are needed. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name.

  • virtual_wanname (String)

    The name of the VirtualWAN for which

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 527

def supported_security_providers_async(resource_group_name, virtual_wanname, custom_headers:nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'virtual_wanname is nil' if virtual_wanname.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = accept_language unless accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/supportedSecurityProviders'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id,'resourceGroupName' => resource_group_name,'virtualWANName' => virtual_wanname},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Network::Mgmt::V2018_08_01::Models::VirtualWanSecurityProviders.mapper()
        result.body = self.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#supported_security_providers_with_http_info(resource_group_name, virtual_wanname, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gives the supported security providers for the virtual wan.

supported security providers are needed. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name.

  • virtual_wanname (String)

    The name of the VirtualWAN for which

  • custom_headers (Hash{String => String}) (defaults to: nil)

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


512
513
514
# File 'lib/2018-08-01/generated/azure_mgmt_network/network_management_client.rb', line 512

def supported_security_providers_with_http_info(resource_group_name, virtual_wanname, custom_headers:nil)
  supported_security_providers_async(resource_group_name, virtual_wanname, custom_headers:custom_headers).value!
end