Class: Azure::Network::Mgmt::V2017_03_01::NetworkManagementClient
- Inherits:
-
MsRestAzure::AzureServiceClient
- Object
- MsRestAzure::AzureServiceClient
- Azure::Network::Mgmt::V2017_03_01::NetworkManagementClient
- Includes:
- MsRestAzure, MsRestAzure::Serialization
- Defined in:
- lib/2017-03-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
-
#accept_language ⇒ String
Gets or sets the preferred language for the response.
-
#api_version ⇒ String
readonly
Client API version.
-
#application_gateways ⇒ ApplicationGateways
readonly
Application_gateways.
-
#base_url ⇒ String
The base URI of the service.
-
#bgp_service_communities ⇒ BgpServiceCommunities
readonly
Bgp_service_communities.
-
#credentials ⇒ Object
readonly
Credentials needed for the client to connect to Azure.
-
#express_route_circuit_authorizations ⇒ ExpressRouteCircuitAuthorizations
readonly
express_route_circuit_authorizations.
-
#express_route_circuit_peerings ⇒ ExpressRouteCircuitPeerings
readonly
Express_route_circuit_peerings.
-
#express_route_circuits ⇒ ExpressRouteCircuits
readonly
Express_route_circuits.
-
#express_route_service_providers ⇒ ExpressRouteServiceProviders
readonly
Express_route_service_providers.
-
#generate_client_request_id ⇒ Boolean
is generated and included in each request.
-
#load_balancers ⇒ LoadBalancers
readonly
Load_balancers.
-
#local_network_gateways ⇒ LocalNetworkGateways
readonly
Local_network_gateways.
-
#long_running_operation_retry_timeout ⇒ Integer
Running Operations.
-
#network_interfaces ⇒ NetworkInterfaces
readonly
Network_interfaces.
-
#network_security_groups ⇒ NetworkSecurityGroups
readonly
Network_security_groups.
-
#network_watchers ⇒ NetworkWatchers
readonly
Network_watchers.
-
#packet_captures ⇒ PacketCaptures
readonly
Packet_captures.
-
#public_ipaddresses ⇒ PublicIPAddresses
readonly
Public_ipaddresses.
-
#route_filter_rules ⇒ RouteFilterRules
readonly
Route_filter_rules.
-
#route_filters ⇒ RouteFilters
readonly
Route_filters.
-
#route_tables ⇒ RouteTables
readonly
Route_tables.
-
#routes ⇒ Routes
readonly
Routes.
-
#security_rules ⇒ SecurityRules
readonly
Security_rules.
-
#subnets ⇒ Subnets
readonly
Subnets.
-
#subscription_id ⇒ String
Microsoft Azure subscription.
-
#usages ⇒ Usages
readonly
Usages.
-
#virtual_network_gateway_connections ⇒ VirtualNetworkGatewayConnections
readonly
virtual_network_gateway_connections.
-
#virtual_network_gateways ⇒ VirtualNetworkGateways
readonly
Virtual_network_gateways.
-
#virtual_network_peerings ⇒ VirtualNetworkPeerings
readonly
Virtual_network_peerings.
-
#virtual_networks ⇒ VirtualNetworks
readonly
Virtual_networks.
Instance Method Summary collapse
-
#check_dns_name_availability(location, domain_name_label = nil, custom_headers = nil) ⇒ DnsNameAvailabilityResult
Checks whether a domain name in the cloudapp.net zone is available for use.
-
#check_dns_name_availability_async(location, domain_name_label = nil, custom_headers = nil) ⇒ Concurrent::Promise
Checks whether a domain name in the cloudapp.net zone is available for use.
-
#check_dns_name_availability_with_http_info(location, domain_name_label = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Checks whether a domain name in the cloudapp.net zone is available for use.
-
#initialize(credentials = nil, base_url = nil, options = nil) ⇒ NetworkManagementClient
constructor
Creates initializes a new instance of the NetworkManagementClient class.
-
#make_request(method, path, options = {}) ⇒ Hash{String=>String}
Makes a request and returns the body of the response.
-
#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise
Makes a request asynchronously.
-
#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse
Makes a request and returns the operation response.
Constructor Details
#initialize(credentials = nil, base_url = nil, options = nil) ⇒ NetworkManagementClient
Creates initializes a new instance of the NetworkManagementClient class.
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 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 119 def initialize(credentials = nil, base_url = nil, = nil) super(credentials, ) @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) @express_route_circuit_authorizations = ExpressRouteCircuitAuthorizations.new(self) @express_route_circuit_peerings = ExpressRouteCircuitPeerings.new(self) @express_route_circuits = ExpressRouteCircuits.new(self) @express_route_service_providers = ExpressRouteServiceProviders.new(self) @load_balancers = LoadBalancers.new(self) @network_interfaces = NetworkInterfaces.new(self) @network_security_groups = NetworkSecurityGroups.new(self) @security_rules = SecurityRules.new(self) @network_watchers = NetworkWatchers.new(self) @packet_captures = PacketCaptures.new(self) @public_ipaddresses = PublicIPAddresses.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) @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) @api_version = '2017-03-01' @accept_language = 'en-US' @long_running_operation_retry_timeout = 30 @generate_client_request_id = true add_telemetry end |
Instance Attribute Details
#accept_language ⇒ String
Returns Gets or sets the preferred language for the response.
29 30 31 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 29 def accept_language @accept_language end |
#api_version ⇒ String (readonly)
Returns Client API version.
26 27 28 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 26 def api_version @api_version end |
#application_gateways ⇒ ApplicationGateways (readonly)
Returns application_gateways.
40 41 42 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 40 def application_gateways @application_gateways end |
#base_url ⇒ String
Returns the base URI of the service.
15 16 17 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 15 def base_url @base_url end |
#bgp_service_communities ⇒ BgpServiceCommunities (readonly)
Returns bgp_service_communities.
89 90 91 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 89 def bgp_service_communities @bgp_service_communities end |
#credentials ⇒ Object (readonly)
Returns Credentials needed for the client to connect to Azure.
18 19 20 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 18 def credentials @credentials end |
#express_route_circuit_authorizations ⇒ ExpressRouteCircuitAuthorizations (readonly)
express_route_circuit_authorizations
44 45 46 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 44 def @express_route_circuit_authorizations end |
#express_route_circuit_peerings ⇒ ExpressRouteCircuitPeerings (readonly)
Returns express_route_circuit_peerings.
47 48 49 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 47 def express_route_circuit_peerings @express_route_circuit_peerings end |
#express_route_circuits ⇒ ExpressRouteCircuits (readonly)
Returns express_route_circuits.
50 51 52 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 50 def express_route_circuits @express_route_circuits end |
#express_route_service_providers ⇒ ExpressRouteServiceProviders (readonly)
Returns express_route_service_providers.
53 54 55 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 53 def express_route_service_providers @express_route_service_providers end |
#generate_client_request_id ⇒ Boolean
is generated and included in each request. Default is true.
37 38 39 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 37 def generate_client_request_id @generate_client_request_id end |
#load_balancers ⇒ LoadBalancers (readonly)
Returns load_balancers.
56 57 58 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 56 def load_balancers @load_balancers end |
#local_network_gateways ⇒ LocalNetworkGateways (readonly)
Returns local_network_gateways.
111 112 113 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 111 def local_network_gateways @local_network_gateways end |
#long_running_operation_retry_timeout ⇒ Integer
Running Operations. Default value is 30.
33 34 35 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 33 def long_running_operation_retry_timeout @long_running_operation_retry_timeout end |
#network_interfaces ⇒ NetworkInterfaces (readonly)
Returns network_interfaces.
59 60 61 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 59 def network_interfaces @network_interfaces end |
#network_security_groups ⇒ NetworkSecurityGroups (readonly)
Returns network_security_groups.
62 63 64 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 62 def network_security_groups @network_security_groups end |
#network_watchers ⇒ NetworkWatchers (readonly)
Returns network_watchers.
68 69 70 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 68 def network_watchers @network_watchers end |
#packet_captures ⇒ PacketCaptures (readonly)
Returns packet_captures.
71 72 73 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 71 def packet_captures @packet_captures end |
#public_ipaddresses ⇒ PublicIPAddresses (readonly)
Returns public_ipaddresses.
74 75 76 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 74 def public_ipaddresses @public_ipaddresses end |
#route_filter_rules ⇒ RouteFilterRules (readonly)
Returns route_filter_rules.
80 81 82 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 80 def route_filter_rules @route_filter_rules end |
#route_filters ⇒ RouteFilters (readonly)
Returns route_filters.
77 78 79 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 77 def route_filters @route_filters end |
#route_tables ⇒ RouteTables (readonly)
Returns route_tables.
83 84 85 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 83 def route_tables @route_tables end |
#routes ⇒ Routes (readonly)
Returns routes.
86 87 88 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 86 def routes @routes end |
#security_rules ⇒ SecurityRules (readonly)
Returns security_rules.
65 66 67 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 65 def security_rules @security_rules end |
#subnets ⇒ Subnets (readonly)
Returns subnets.
98 99 100 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 98 def subnets @subnets end |
#subscription_id ⇒ String
Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
23 24 25 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 23 def subscription_id @subscription_id end |
#usages ⇒ Usages (readonly)
Returns usages.
92 93 94 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 92 def usages @usages end |
#virtual_network_gateway_connections ⇒ VirtualNetworkGatewayConnections (readonly)
virtual_network_gateway_connections
108 109 110 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 108 def virtual_network_gateway_connections @virtual_network_gateway_connections end |
#virtual_network_gateways ⇒ VirtualNetworkGateways (readonly)
Returns virtual_network_gateways.
104 105 106 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 104 def virtual_network_gateways @virtual_network_gateways end |
#virtual_network_peerings ⇒ VirtualNetworkPeerings (readonly)
Returns virtual_network_peerings.
101 102 103 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 101 def virtual_network_peerings @virtual_network_peerings end |
#virtual_networks ⇒ VirtualNetworks (readonly)
Returns virtual_networks.
95 96 97 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 95 def virtual_networks @virtual_networks end |
Instance Method Details
#check_dns_name_availability(location, domain_name_label = nil, custom_headers = nil) ⇒ DnsNameAvailabilityResult
Checks whether a domain name in the cloudapp.net 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.
223 224 225 226 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 223 def check_dns_name_availability(location, domain_name_label = nil, custom_headers = nil) response = check_dns_name_availability_async(location, domain_name_label, custom_headers).value! response.body unless response.nil? end |
#check_dns_name_availability_async(location, domain_name_label = nil, custom_headers = nil) ⇒ Concurrent::Promise
Checks whether a domain name in the cloudapp.net zone is available for use.
conform to the following regular expression: ^[a-z][a-z0-9-]1,61$. to the HTTP request.
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 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 254 def check_dns_name_availability_async(location, domain_name_label = nil, custom_headers = nil) fail ArgumentError, 'location is nil' if location.nil? fail ArgumentError, 'api_version is nil' if api_version.nil? fail ArgumentError, 'subscription_id is nil' if subscription_id.nil? request_headers = {} # 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 = { 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, ) 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? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::Network::Mgmt::V2017_03_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., e.backtrace, result) end end result end promise.execute end |
#check_dns_name_availability_with_http_info(location, domain_name_label = nil, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse
Checks whether a domain name in the cloudapp.net 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.
239 240 241 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 239 def check_dns_name_availability_with_http_info(location, domain_name_label = nil, custom_headers = nil) check_dns_name_availability_async(location, domain_name_label, 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"
= {
body: request_content,
query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, )
173 174 175 176 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 173 def make_request(method, path, = {}) result = make_request_with_http_info(method, path, ) result.body unless result.nil? end |
#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise
Makes a request asynchronously.
198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 198 def make_request_async(method, path, = {}) fail ArgumentError, 'method is nil' if method.nil? fail ArgumentError, 'path is nil' if path.nil? request_url = [:base_url] || @base_url request_headers = @request_headers request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil? .merge!({headers: request_headers.merge([:headers] || {})}) .merge!({credentials: @credentials}) unless @credentials.nil? super(request_url, method, path, ) end |
#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse
Makes a request and returns the operation response.
185 186 187 188 189 |
# File 'lib/2017-03-01/generated/azure_mgmt_network/network_management_client.rb', line 185 def make_request_with_http_info(method, path, = {}) result = make_request_async(method, path, ).value! result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body) result end |