Class: Azure::OperationalInsights::Mgmt::V2020_08_01::OperationalInsightsManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2020-08-01/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.



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
129
130
131
132
133
134
135
136
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 104

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

  @data_exports = DataExports.new(self)
  @data_sources = DataSources.new(self)
  @intelligence_packs = IntelligencePacks.new(self)
  @linked_services = LinkedServices.new(self)
  @linked_storage_accounts = LinkedStorageAccounts.new(self)
  @management_groups = ManagementGroups.new(self)
  @operations = Operations.new(self)
  @operation_statuses = OperationStatuses.new(self)
  @shared_keys_operations = SharedKeysOperations.new(self)
  @usages = Usages.new(self)
  @workspaces = Workspaces.new(self)
  @deleted_workspaces = DeletedWorkspaces.new(self)
  @clusters = Clusters.new(self)
  @storage_insight_configs = StorageInsightConfigs.new(self)
  @saved_searches = SavedSearches.new(self)
  @available_service_tiers = AvailableServiceTiers.new(self)
  @gateways = Gateways.new(self)
  @schema = Schema.new(self)
  @workspace_purge = WorkspacePurge.new(self)
  @tables = Tables.new(self)
  @api_version = '2020-08-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 The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



27
28
29
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 27

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns The API version to use for this operation.

Returns:

  • (String) —

    The API version to use for this operation.



21
22
23
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 21

def api_version
  @api_version
end

#available_service_tiers ⇒ AvailableServiceTiers (readonly)

Returns available_service_tiers.

Returns:



84
85
86
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 84

def available_service_tiers
  @available_service_tiers
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 15

def base_url
  @base_url
end

#clusters ⇒ Clusters (readonly)

Returns clusters.

Returns:



75
76
77
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 75

def clusters
  @clusters
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/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 18

def credentials
  @credentials
end

#data_exports ⇒ DataExports (readonly)

Returns data_exports.

Returns:



39
40
41
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 39

def data_exports
  @data_exports
end

#data_sources ⇒ DataSources (readonly)

Returns data_sources.

Returns:



42
43
44
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 42

def data_sources
  @data_sources
end

#deleted_workspaces ⇒ DeletedWorkspaces (readonly)

Returns deleted_workspaces.

Returns:



72
73
74
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 72

def deleted_workspaces
  @deleted_workspaces
end

#gateways ⇒ Gateways (readonly)

Returns gateways.

Returns:



87
88
89
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 87

def gateways
  @gateways
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



36
37
38
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 36

def generate_client_request_id
  @generate_client_request_id
end

#intelligence_packs ⇒ IntelligencePacks (readonly)

Returns intelligence_packs.

Returns:



45
46
47
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 45

def intelligence_packs
  @intelligence_packs
end

#linked_services ⇒ LinkedServices (readonly)

Returns linked_services.

Returns:



48
49
50
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 48

def linked_services
  @linked_services
end

#linked_storage_accounts ⇒ LinkedStorageAccounts (readonly)

Returns linked_storage_accounts.

Returns:



51
52
53
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 51

def linked_storage_accounts
  @linked_storage_accounts
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



31
32
33
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 31

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#management_groups ⇒ ManagementGroups (readonly)

Returns management_groups.

Returns:



54
55
56
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 54

def management_groups
  @management_groups
end

#operation_statuses ⇒ OperationStatuses (readonly)

Returns operation_statuses.

Returns:



60
61
62
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 60

def operation_statuses
  @operation_statuses
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



57
58
59
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 57

def operations
  @operations
end

#saved_searches ⇒ SavedSearches (readonly)

Returns saved_searches.

Returns:



81
82
83
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 81

def saved_searches
  @saved_searches
end

#schema ⇒ Schema (readonly)

Returns schema.

Returns:



90
91
92
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 90

def schema
  @schema
end

#shared_keys_operations ⇒ SharedKeysOperations (readonly)

Returns shared_keys_operations.

Returns:



63
64
65
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 63

def shared_keys_operations
  @shared_keys_operations
end

#storage_insight_configs ⇒ StorageInsightConfigs (readonly)

Returns storage_insight_configs.

Returns:



78
79
80
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 78

def storage_insight_configs
  @storage_insight_configs
end

#subscription_id ⇒ String

Returns The ID of the target subscription.

Returns:

  • (String) —

    The ID of the target subscription.



24
25
26
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 24

def subscription_id
  @subscription_id
end

#tables ⇒ Tables (readonly)

Returns tables.

Returns:



96
97
98
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 96

def tables
  @tables
end

#usages ⇒ Usages (readonly)

Returns usages.

Returns:



66
67
68
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 66

def usages
  @usages
end

#workspace_purge ⇒ WorkspacePurge (readonly)

Returns workspace_purge.

Returns:



93
94
95
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 93

def workspace_purge
  @workspace_purge
end

#workspaces ⇒ Workspaces (readonly)

Returns workspaces.

Returns:



69
70
71
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 69

def workspaces
  @workspaces
end

Instance Method Details

#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.



154
155
156
157
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 154

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.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 179

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.



166
167
168
169
170
 
# File 'lib/2020-08-01/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb', line 166

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