Class: Azure::OperationalInsights::Mgmt::V2020_03_01_preview::Gateways

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/gateways.rb

Overview

Operational Insights Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Gateways

Creates and initializes a new instance of the Gateways class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/gateways.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ OperationalInsightsManagementClient (readonly)

Returns reference to the OperationalInsightsManagementClient.

Returns:



22
23
24
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/gateways.rb', line 22

def client
  @client
end

Instance Method Details

#delete(resource_group_name, workspace_name, gateway_id, custom_headers: nil) ⇒ Object

Delete a Log Analytics gateway.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace.

  • gateway_id (String) —

    The Log Analytics gateway Id.

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

    A hash of custom headers that



35
36
37
38
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/gateways.rb', line 35

def delete(resource_group_name, workspace_name, gateway_id, custom_headers:nil)
  response = delete_async(resource_group_name, workspace_name, gateway_id, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, workspace_name, gateway_id, custom_headers: nil) ⇒ Concurrent::Promise

Delete a Log Analytics gateway.

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace.

  • gateway_id (String) —

    The Log Analytics gateway Id.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



68
69
70
71
72
73
74
75
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
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/gateways.rb', line 68

def delete_async(resource_group_name, workspace_name, gateway_id, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '63'" if !workspace_name.nil? && workspace_name.length > 63
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '4'" if !workspace_name.nil? && workspace_name.length < 4
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$'" if !workspace_name.nil? && workspace_name.match(Regexp.new('^^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$$')).nil?
  fail ArgumentError, 'gateway_id is nil' if gateway_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1


  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.OperationalInsights/workspaces/{workspaceName}/gateways/{gatewayId}'

  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,'workspaceName' => workspace_name,'gatewayId' => gateway_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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?

    result
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, workspace_name, gateway_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete a Log Analytics gateway.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • workspace_name (String) —

    The name of the workspace.

  • gateway_id (String) —

    The Log Analytics gateway Id.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



52
53
54
 
# File 'lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/gateways.rb', line 52

def delete_with_http_info(resource_group_name, workspace_name, gateway_id, custom_headers:nil)
  delete_async(resource_group_name, workspace_name, gateway_id, custom_headers:custom_headers).value!
end