Class: Azure::OperationalInsights::Mgmt::V2015_11_01_preview::OperationalInsightsManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_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) ⇒ OperationalInsightsManagementClient

Creates initializes a new instance of the OperationalInsightsManagementClient 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.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 58

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

  @linked_services = LinkedServices.new(self)
  @data_sources = DataSources.new(self)
  @workspaces = Workspaces.new(self)
  @operations = Operations.new(self)
  @api_version = '2015-11-01-preview'
  @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 The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



29
30
31
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 29

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns Client Api Version.

Returns:

  • (String) —

    Client Api Version.



26
27
28
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 26

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ Object (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/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 18

def credentials
  @credentials
end

#data_sources ⇒ DataSources (readonly)

Returns data_sources.

Returns:



44
45
46
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 44

def data_sources
  @data_sources
end

#generate_client_request_id ⇒ Boolean

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/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 38

def generate_client_request_id
  @generate_client_request_id
end

#linked_services ⇒ LinkedServices (readonly)

Returns linked_services.

Returns:



41
42
43
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 41

def linked_services
  @linked_services
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



33
34
35
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 33

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



50
51
52
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 50

def operations
  @operations
end

#subscription_id ⇒ String

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

Returns:

  • (String) —

    Gets subscription credentials which uniquely identify



23
24
25
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 23

def subscription_id
  @subscription_id
end

#workspaces ⇒ Workspaces (readonly)

Returns workspaces.

Returns:



47
48
49
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 47

def workspaces
  @workspaces
end

Instance Method Details

#get_async_operations_status(location, async_operation_id, custom_headers: nil) ⇒ OperationStatus

Get the status of an azure asynchronous operation.

will be added to the HTTP request.

Parameters:

  • location (String) —

    The region name of operation.

  • async_operation_id (String) —

    The operation Id.

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

    A hash of custom headers that

Returns:

  • (OperationStatus) —

    operation results.



144
145
146
147
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 144

def get_async_operations_status(location, async_operation_id, custom_headers:nil)
  response = get_async_operations_status_async(location, async_operation_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async_operations_status_async(location, async_operation_id, custom_headers: nil) ⇒ Concurrent::Promise

Get the status of an azure asynchronous operation.

to the HTTP request.

Parameters:

  • location (String) —

    The region name of operation.

  • async_operation_id (String) —

    The operation Id.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



173
174
175
176
177
178
179
180
181
182
183
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
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 173

def get_async_operations_status_async(location, async_operation_id, custom_headers:nil)
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, 'async_operation_id is nil' if async_operation_id.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.OperationalInsights/locations/{location}/operationStatuses/{asyncOperationId}'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'location' => location,'asyncOperationId' => async_operation_id,'subscriptionId' => subscription_id},
      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 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::OperationalInsights::Mgmt::V2015_11_01_preview::Models::OperationStatus.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

#get_async_operations_status_with_http_info(location, async_operation_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the status of an azure asynchronous operation.

will be added to the HTTP request.

Parameters:

  • location (String) —

    The region name of operation.

  • async_operation_id (String) —

    The operation Id.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



159
160
161
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 159

def get_async_operations_status_with_http_info(location, async_operation_id, custom_headers:nil)
  get_async_operations_status_async(location, async_operation_id, 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.



92
93
94
95
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 92

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.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 117

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.



104
105
106
107
108
 
# File 'lib/2015-11-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 104

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