class Azure::OperationalInsights::Mgmt::V2020_03_01_preview::OperationalInsightsManagementClient

A service client - single point of access to the REST API.

Attributes

accept_language[RW]

@return [String] The preferred language for the response.

api_version[R]

@return [String] The API version to use for this operation.

available_service_tiers[R]

@return [AvailableServiceTiers] available_service_tiers

base_url[RW]

@return [String] the base URI of the service.

clusters[R]

@return [Clusters] clusters

credentials[R]

@return Credentials needed for the client to connect to Azure.

data_collector_logs[R]

@return [DataCollectorLogs] data_collector_logs

data_exports[R]

@return [DataExports] data_exports

data_sources[R]

@return [DataSources] data_sources

deleted_workspaces[R]

@return [DeletedWorkspaces] deleted_workspaces

gateways[R]

@return [Gateways] gateways

generate_client_request_id[RW]

@return [Boolean] Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

intelligence_packs[R]

@return [IntelligencePacks] intelligence_packs

linked_services[R]

@return [LinkedServices] linked_services

linked_storage_accounts[R]

@return [LinkedStorageAccounts] linked_storage_accounts

long_running_operation_retry_timeout[RW]

@return [Integer] The retry timeout in seconds for Long Running Operations. Default value is 30.

management_groups[R]

@return [ManagementGroups] management_groups

operation_statuses[R]

@return [OperationStatuses] operation_statuses

operations[R]

@return [Operations] operations

saved_searches[R]

@return [SavedSearches] saved_searches

schema[R]

@return [Schema] schema

shared_keys_operations[R]

@return [SharedKeysOperations] shared_keys_operations

storage_insight_configs[R]

@return [StorageInsightConfigs] storage_insight_configs

subscription_id[RW]

@return [String] The ID of the target subscription.

tables[R]

@return [Tables] tables

usages[R]

@return [Usages] usages

workspace_purge[R]

@return [WorkspacePurge] workspace_purge

workspaces[R]

@return [Workspaces] workspaces

Public Class Methods

new(credentials = nil, base_url = nil, options = nil) click to toggle source

Creates initializes a new instance of the OperationalInsightsManagementClient class. @param credentials [MsRest::ServiceClientCredentials] credentials to authorize HTTP requests made by the service client. @param base_url [String] the base URI of the service. @param options [Array] filters to be applied to the HTTP requests.

Calls superclass method
# File lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb, line 107
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)
  @data_collector_logs = DataCollectorLogs.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-03-01-preview'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Public Instance Methods

make_request(method, path, options = {}) click to toggle source

Makes a request and returns the body of the response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Hash{String=>String}] containing 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)
# File lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb, line 158
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 = {}) click to toggle source

Makes a request asynchronously. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Concurrent::Promise] Promise object which holds the HTTP response.

Calls superclass method
# File lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb, line 183
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 = {}) click to toggle source

Makes a request and returns the operation response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.

# File lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb, line 170
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

Private Instance Methods

add_telemetry() click to toggle source

Adds telemetry information.

# File lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/operational_insights_management_client.rb, line 205
def add_telemetry
    sdk_information = 'azure_mgmt_operational_insights'
    sdk_information = "#{sdk_information}/0.20.0"
    add_user_agent_information(sdk_information)
end