Class: Azure::SecurityInsights::Mgmt::V2019_01_01_preview::EntityRelations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entity_relations.rb

Overview

API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ EntityRelations

Creates and initializes a new instance of the EntityRelations class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entity_relations.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SecurityInsights (readonly)

Returns reference to the SecurityInsights.

Returns:



23
24
25
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entity_relations.rb', line 23

def client
  @client
end

Instance Method Details

#get_relation(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, relation_name, custom_headers: nil) ⇒ Relation

Gets an entity relation.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • entity_id (String) —

    entity ID

  • relation_name (String) —

    Relation Name

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

    A hash of custom headers that

Returns:

  • (Relation) —

    operation results.



40
41
42
43
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entity_relations.rb', line 40

def get_relation(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, relation_name, custom_headers:nil)
  response = get_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, relation_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, relation_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets an entity relation.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • entity_id (String) —

    entity ID

  • relation_name (String) —

    Relation Name

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entity_relations.rb', line 79

def get_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, relation_name, custom_headers:nil)
  @client.api_version = '2019-01-01-preview'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'Pattern': '^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$'" if !@client.subscription_id.nil? && @client.subscription_id.match(Regexp.new('^^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$$')).nil?
  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, 'operational_insights_resource_provider is nil' if operational_insights_resource_provider.nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '90'" if !workspace_name.nil? && workspace_name.length > 90
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '1'" if !workspace_name.nil? && workspace_name.length < 1
  fail ArgumentError, 'entity_id is nil' if entity_id.nil?
  fail ArgumentError, 'relation_name is nil' if relation_name.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}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/relations/{relationName}'

  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,'operationalInsightsResourceProvider' => operational_insights_resource_provider,'workspaceName' => workspace_name,'entityId' => entity_id,'relationName' => relation_name},
      query_params: {'api-version' => @client.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::SecurityInsights::Mgmt::V2019_01_01_preview::Models::Relation.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_relation_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, relation_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets an entity relation.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • entity_id (String) —

    entity ID

  • relation_name (String) —

    Relation Name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



60
61
62
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entity_relations.rb', line 60

def get_relation_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, relation_name, custom_headers:nil)
  get_relation_async(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, relation_name, custom_headers:custom_headers).value!
end