Class: Azure::Network::Mgmt::V2019_11_01::VpnServerConfigurationsAssociatedWithVirtualWan

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-11-01/generated/azure_mgmt_network/vpn_server_configurations_associated_with_virtual_wan.rb

Overview

VpnServerConfigurationsAssociatedWithVirtualWan

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ VpnServerConfigurationsAssociatedWithVirtualWan

Creates and initializes a new instance of the VpnServerConfigurationsAssociatedWithVirtualWan class.

Parameters:

  • client

    service class for accessing basic functionality.


17
18
19
# File 'lib/2019-11-01/generated/azure_mgmt_network/vpn_server_configurations_associated_with_virtual_wan.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientNetworkManagementClient (readonly)

Returns reference to the NetworkManagementClient.

Returns:


22
23
24
# File 'lib/2019-11-01/generated/azure_mgmt_network/vpn_server_configurations_associated_with_virtual_wan.rb', line 22

def client
  @client
end

Instance Method Details

#begin_list(resource_group_name, virtual_wanname, custom_headers: nil) ⇒ VpnServerConfigurationsResponse

Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group.

VpnServerConfigurations is 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 whose associated

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

    A hash of custom headers that

Returns:

  • (VpnServerConfigurationsResponse)

    operation results.


81
82
83
84
# File 'lib/2019-11-01/generated/azure_mgmt_network/vpn_server_configurations_associated_with_virtual_wan.rb', line 81

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

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

Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group.

VpnServerConfigurations is needed. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The resource group name.

  • virtual_wanname (String)

    The name of the VirtualWAN whose associated

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.


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
# File 'lib/2019-11-01/generated/azure_mgmt_network/vpn_server_configurations_associated_with_virtual_wan.rb', line 114

def begin_list_async(resource_group_name, virtual_wanname, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.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, '@client.api_version is nil' if @client.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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnServerConfigurations'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'virtualWANName' => virtual_wanname},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, 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 || status_code == 202
      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::V2019_11_01::Models::VpnServerConfigurationsResponse.mapper()
        result.body = @client.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

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

Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group.

VpnServerConfigurations is 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 whose associated

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.


98
99
100
# File 'lib/2019-11-01/generated/azure_mgmt_network/vpn_server_configurations_associated_with_virtual_wan.rb', line 98

def begin_list_with_http_info(resource_group_name, virtual_wanname, custom_headers:nil)
  begin_list_async(resource_group_name, virtual_wanname, custom_headers:custom_headers).value!
end

#list(resource_group_name, virtual_wanname, custom_headers: nil) ⇒ VpnServerConfigurationsResponse

Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group.

VpnServerConfigurations is 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 whose associated

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

    A hash of custom headers that

Returns:

  • (VpnServerConfigurationsResponse)

    operation results.


36
37
38
39
# File 'lib/2019-11-01/generated/azure_mgmt_network/vpn_server_configurations_associated_with_virtual_wan.rb', line 36

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

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

VpnServerConfigurations is needed. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The resource group name.

  • virtual_wanname (String)

    The name of the VirtualWAN whose associated

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/2019-11-01/generated/azure_mgmt_network/vpn_server_configurations_associated_with_virtual_wan.rb', line 51

def list_async(resource_group_name, virtual_wanname, custom_headers:nil)
  # Send request
  promise = begin_list_async(resource_group_name, virtual_wanname, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Network::Mgmt::V2019_11_01::Models::VpnServerConfigurationsResponse.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method, FinalStateVia::LOCATION)
  end

  promise
end