class Azure::Network::Mgmt::V2018_10_01::NetworkManagementClient

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

Attributes

accept_language[RW]

@return [String] The preferred language for the response.

api_version[R]

@return [String] Client API version.

application_gateways[R]

@return [ApplicationGateways] #application_gateways

application_security_groups[R]

@return [ApplicationSecurityGroups] #application_security_groups

available_delegations[R]

@return [AvailableDelegations] #available_delegations

available_endpoint_services[R]

@return [AvailableEndpointServices] #available_endpoint_services

available_resource_group_delegations[R]

@return [AvailableResourceGroupDelegations] #available_resource_group_delegations

azure_firewall_fqdn_tags[R]

@return [AzureFirewallFqdnTags] #azure_firewall_fqdn_tags

azure_firewalls[R]

@return [AzureFirewalls] #azure_firewalls

base_url[RW]

@return [String] the base URI of the service.

bgp_service_communities[R]

@return [BgpServiceCommunities] #bgp_service_communities

connection_monitors[R]

@return [ConnectionMonitors] #connection_monitors

credentials[R]

@return Credentials needed for the client to connect to Azure.

ddos_protection_plans[R]

@return [DdosProtectionPlans] #ddos_protection_plans

default_security_rules[R]

@return [DefaultSecurityRules] #default_security_rules

express_route_circuit_authorizations[R]

@return [ExpressRouteCircuitAuthorizations] #express_route_circuit_authorizations

express_route_circuit_connections[R]

@return [ExpressRouteCircuitConnections] #express_route_circuit_connections

express_route_circuit_peerings[R]

@return [ExpressRouteCircuitPeerings] #express_route_circuit_peerings

express_route_circuits[R]

@return [ExpressRouteCircuits] #express_route_circuits

express_route_connections[R]

@return [ExpressRouteConnections] #express_route_connections

express_route_cross_connection_peerings[R]

@return [ExpressRouteCrossConnectionPeerings] #express_route_cross_connection_peerings

express_route_cross_connections[R]

@return [ExpressRouteCrossConnections] #express_route_cross_connections

express_route_gateways[R]

@return [ExpressRouteGateways] #express_route_gateways

express_route_ports[R]

@return [ExpressRoutePorts] #express_route_ports

express_route_ports_locations[R]

@return [ExpressRoutePortsLocations] #express_route_ports_locations

express_route_service_providers[R]

@return [ExpressRouteServiceProviders] #express_route_service_providers

generate_client_request_id[RW]

@return [Boolean] Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

hub_virtual_network_connections[R]

@return [HubVirtualNetworkConnections] #hub_virtual_network_connections

inbound_nat_rules[R]

@return [InboundNatRules] #inbound_nat_rules

interface_endpoints[R]

@return [InterfaceEndpoints] #interface_endpoints

load_balancer_backend_address_pools[R]

@return [LoadBalancerBackendAddressPools] #load_balancer_backend_address_pools

load_balancer_frontend_ipconfigurations[R]

@return [LoadBalancerFrontendIPConfigurations] #load_balancer_frontend_ipconfigurations

load_balancer_load_balancing_rules[R]

@return [LoadBalancerLoadBalancingRules] #load_balancer_load_balancing_rules

load_balancer_network_interfaces[R]

@return [LoadBalancerNetworkInterfaces] #load_balancer_network_interfaces

load_balancer_outbound_rules[R]

@return [LoadBalancerOutboundRules] #load_balancer_outbound_rules

load_balancer_probes[R]

@return [LoadBalancerProbes] #load_balancer_probes

load_balancers[R]

@return [LoadBalancers] #load_balancers

local_network_gateways[R]

@return [LocalNetworkGateways] #local_network_gateways

long_running_operation_retry_timeout[RW]

@return [Integer] The retry timeout in seconds for Long Running Operations. Default value is 30.

network_interface_ipconfigurations[R]

@return [NetworkInterfaceIPConfigurations] #network_interface_ipconfigurations

network_interface_load_balancers[R]

@return [NetworkInterfaceLoadBalancers] #network_interface_load_balancers

network_interface_tap_configurations[R]

@return [NetworkInterfaceTapConfigurations] #network_interface_tap_configurations

network_interfaces[R]

@return [NetworkInterfaces] #network_interfaces

network_profiles[R]

@return [NetworkProfiles] #network_profiles

network_security_groups[R]

@return [NetworkSecurityGroups] #network_security_groups

network_watchers[R]

@return [NetworkWatchers] #network_watchers

operations[R]

@return [Operations] operations

p2s_vpn_gateways[R]

@return [P2sVpnGateways] #p2s_vpn_gateways

p2s_vpn_server_configurations[R]

@return [P2sVpnServerConfigurations] #p2s_vpn_server_configurations

packet_captures[R]

@return [PacketCaptures] #packet_captures

public_ipaddresses[R]

@return [PublicIPAddresses] #public_ipaddresses

public_ipprefixes[R]

@return [PublicIPPrefixes] #public_ipprefixes

route_filter_rules[R]

@return [RouteFilterRules] #route_filter_rules

route_filters[R]

@return [RouteFilters] #route_filters

route_tables[R]

@return [RouteTables] #route_tables

routes[R]

@return [Routes] routes

security_rules[R]

@return [SecurityRules] #security_rules

service_endpoint_policies[R]

@return [ServiceEndpointPolicies] #service_endpoint_policies

service_endpoint_policy_definitions[R]

@return [ServiceEndpointPolicyDefinitions] #service_endpoint_policy_definitions

subnets[R]

@return [Subnets] subnets

subscription_id[RW]

@return [String] The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

usages[R]

@return [Usages] usages

virtual_hubs[R]

@return [VirtualHubs] #virtual_hubs

virtual_network_gateway_connections[R]

@return [VirtualNetworkGatewayConnections] #virtual_network_gateway_connections

virtual_network_gateways[R]

@return [VirtualNetworkGateways] #virtual_network_gateways

virtual_network_peerings[R]

@return [VirtualNetworkPeerings] #virtual_network_peerings

virtual_network_taps[R]

@return [VirtualNetworkTaps] #virtual_network_taps

virtual_networks[R]

@return [VirtualNetworks] #virtual_networks

virtual_wans[R]

@return [VirtualWans] #virtual_wans

vpn_connections[R]

@return [VpnConnections] #vpn_connections

vpn_gateways[R]

@return [VpnGateways] #vpn_gateways

vpn_sites[R]

@return [VpnSites] #vpn_sites

vpn_sites_configuration[R]

@return [VpnSitesConfiguration] #vpn_sites_configuration

Public Class Methods

new(credentials = nil, base_url = nil, options = nil) click to toggle source

Creates initializes a new instance of the NetworkManagementClient class. @param credentials [MsRest::ServiceClientCredentials] credentials to authorize HTTP requests made by the service client. @param #base_url [String] the base URI of the service. @param options [Array] filters to be applied to the HTTP requests.

Calls superclass method
# File lib/2018-10-01/generated/azure_mgmt_network/network_management_client.rb, line 257
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)
  @express_route_ports_locations = ExpressRoutePortsLocations.new(self)
  @express_route_ports = ExpressRoutePorts.new(self)
  @express_route_links = ExpressRouteLinks.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_gateways = VirtualNetworkGateways.new(self)
  @virtual_network_gateway_connections = VirtualNetworkGatewayConnections.new(self)
  @local_network_gateways = LocalNetworkGateways.new(self)
  @virtual_network_taps = VirtualNetworkTaps.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-10-01'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Public Instance Methods

check_dns_name_availability(location, domain_name_label, custom_headers:nil) click to toggle source

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

@param location [String] The location of the domain name. @param domain_name_label [String] The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}$. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [DnsNameAvailabilityResult] operation results.

# File lib/2018-10-01/generated/azure_mgmt_network/network_management_client.rb, line 408
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) click to toggle source

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

@param location [String] The location of the domain name. @param domain_name_label [String] The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}$. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2018-10-01/generated/azure_mgmt_network/network_management_client.rb, line 441
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_10_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) click to toggle source

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

@param location [String] The location of the domain name. @param domain_name_label [String] The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}$. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2018-10-01/generated/azure_mgmt_network/network_management_client.rb, line 425
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 = {}) click to toggle source

Makes a request and returns the body of the response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Hash{String=>String}] containing 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)
# File lib/2018-10-01/generated/azure_mgmt_network/network_management_client.rb, line 354
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 = {}) click to toggle source

Makes a request asynchronously. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Concurrent::Promise] Promise object which holds the HTTP response.

Calls superclass method
# File lib/2018-10-01/generated/azure_mgmt_network/network_management_client.rb, line 379
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 = {}) click to toggle source

Makes a request and returns the operation response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.

# File lib/2018-10-01/generated/azure_mgmt_network/network_management_client.rb, line 366
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) click to toggle source

Gives the supported security providers for the virtual wan.

@param resource_group_name [String] The resource group name. @param virtual_wanname [String] The name of the VirtualWAN for which supported security providers are needed. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [VirtualWanSecurityProviders] operation results.

# File lib/2018-10-01/generated/azure_mgmt_network/network_management_client.rb, line 507
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) click to toggle source

Gives the supported security providers for the virtual wan.

@param resource_group_name [String] The resource group name. @param virtual_wanname [String] The name of the VirtualWAN for which supported security providers are needed. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2018-10-01/generated/azure_mgmt_network/network_management_client.rb, line 538
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_10_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) click to toggle source

Gives the supported security providers for the virtual wan.

@param resource_group_name [String] The resource group name. @param virtual_wanname [String] The name of the VirtualWAN for which supported security providers are needed. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2018-10-01/generated/azure_mgmt_network/network_management_client.rb, line 523
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

Private Instance Methods

add_telemetry() click to toggle source

Adds telemetry information.

# File lib/2018-10-01/generated/azure_mgmt_network/network_management_client.rb, line 598
def add_telemetry
    sdk_information = 'azure_mgmt_network'
    sdk_information = "#{sdk_information}/0.19.0"
    add_user_agent_information(sdk_information)
end