Class: Azure::Web::Mgmt::V2016_06_01::ConnectionGatewayInstallations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-06-01/generated/azure_mgmt_web/connection_gateway_installations.rb

Overview

ConnectionGatewayInstallations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ConnectionGatewayInstallations

Creates and initializes a new instance of the ConnectionGatewayInstallations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2016-06-01/generated/azure_mgmt_web/connection_gateway_installations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ LogicAppsManagementClient (readonly)

Returns reference to the LogicAppsManagementClient.

Returns:



22
23
24
 
# File 'lib/2016-06-01/generated/azure_mgmt_web/connection_gateway_installations.rb', line 22

def client
  @client
end

Instance Method Details

#get(subscription_id, location, gateway_id, api_version, custom_headers: nil) ⇒ ConnectionGatewayInstallationDefinition

Gets an installed gateway that the user is an admin of

Get a specific installed gateway that the user is an admin of, in a specific subscription and at a certain location

will be added to the HTTP request.

Parameters:

  • subscription_id (String) —

    Subscription Id

  • location (String) —

    The location

  • gateway_id (String) —

    Gateway ID

  • api_version (String) —

    API Version

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

    A hash of custom headers that

Returns:

  • (ConnectionGatewayInstallationDefinition) —

    operation results.



145
146
147
148
 
# File 'lib/2016-06-01/generated/azure_mgmt_web/connection_gateway_installations.rb', line 145

def get(subscription_id, location, gateway_id, api_version, custom_headers:nil)
  response = get_async(subscription_id, location, gateway_id, api_version, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(subscription_id, location, gateway_id, api_version, custom_headers: nil) ⇒ Concurrent::Promise

Gets an installed gateway that the user is an admin of

Get a specific installed gateway that the user is an admin of, in a specific subscription and at a certain location

to the HTTP request.

Parameters:

  • subscription_id (String) —

    Subscription Id

  • location (String) —

    The location

  • gateway_id (String) —

    Gateway ID

  • api_version (String) —

    API Version

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/2016-06-01/generated/azure_mgmt_web/connection_gateway_installations.rb', line 184

def get_async(subscription_id, location, gateway_id, api_version, custom_headers:nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'gateway_id is nil' if gateway_id.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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/connectionGatewayInstallations/{gatewayId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id,'location' => location,'gatewayId' => gateway_id},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.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::Web::Mgmt::V2016_06_01::Models::ConnectionGatewayInstallationDefinition.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

#get_with_http_info(subscription_id, location, gateway_id, api_version, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets an installed gateway that the user is an admin of

Get a specific installed gateway that the user is an admin of, in a specific subscription and at a certain location

will be added to the HTTP request.

Parameters:

  • subscription_id (String) —

    Subscription Id

  • location (String) —

    The location

  • gateway_id (String) —

    Gateway ID

  • api_version (String) —

    API Version

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



165
166
167
 
# File 'lib/2016-06-01/generated/azure_mgmt_web/connection_gateway_installations.rb', line 165

def get_with_http_info(subscription_id, location, gateway_id, api_version, custom_headers:nil)
  get_async(subscription_id, location, gateway_id, api_version, custom_headers:custom_headers).value!
end

#list(subscription_id, location, api_version, custom_headers: nil) ⇒ ConnectionGatewayInstallationDefinitionCollection

Gets a list of installed gateways that the user is an admin of

Gets a list of installed gateways that the user is an admin of, in a specific subscription and at a certain location

will be added to the HTTP request.

results.

Parameters:

  • subscription_id (String) —

    Subscription Id

  • location (String) —

    The location

  • api_version (String) —

    API Version

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

    A hash of custom headers that

Returns:

  • (ConnectionGatewayInstallationDefinitionCollection) —

    operation



39
40
41
42
 
# File 'lib/2016-06-01/generated/azure_mgmt_web/connection_gateway_installations.rb', line 39

def list(subscription_id, location, api_version, custom_headers:nil)
  response = list_async(subscription_id, location, api_version, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_async(subscription_id, location, api_version, custom_headers: nil) ⇒ Concurrent::Promise

Gets a list of installed gateways that the user is an admin of

Gets a list of installed gateways that the user is an admin of, in a specific subscription and at a certain location

to the HTTP request.

Parameters:

  • subscription_id (String) —

    Subscription Id

  • location (String) —

    The location

  • api_version (String) —

    API Version

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2016-06-01/generated/azure_mgmt_web/connection_gateway_installations.rb', line 76

def list_async(subscription_id, location, api_version, custom_headers:nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.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'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/connectionGatewayInstallations'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id,'location' => location},
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.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::Web::Mgmt::V2016_06_01::Models::ConnectionGatewayInstallationDefinitionCollection.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

#list_with_http_info(subscription_id, location, api_version, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of installed gateways that the user is an admin of

Gets a list of installed gateways that the user is an admin of, in a specific subscription and at a certain location

will be added to the HTTP request.

Parameters:

  • subscription_id (String) —

    Subscription Id

  • location (String) —

    The location

  • api_version (String) —

    API Version

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



58
59
60
 
# File 'lib/2016-06-01/generated/azure_mgmt_web/connection_gateway_installations.rb', line 58

def list_with_http_info(subscription_id, location, api_version, custom_headers:nil)
  list_async(subscription_id, location, api_version, custom_headers:custom_headers).value!
end