Class: Azure::SecurityInsights::Mgmt::V2019_01_01_preview::EntitiesRelations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entities_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) ⇒ EntitiesRelations

Creates and initializes a new instance of the EntitiesRelations class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entities_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/entities_relations.rb', line 23

def client
  @client
end

Instance Method Details

#list(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, filter: nil, orderby: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ Array<Relation>

Gets all relations of an entity.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. Optional. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. 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

  • filter (String) (defaults to: nil) —

    Filters the results, based on a Boolean condition.

  • orderby (String) (defaults to: nil) —

    Sorts the results. Optional.

  • top (Integer) (defaults to: nil) —

    Returns only the first n results. Optional.

  • skip_token (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

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

    A hash of custom headers that

Returns:

  • (Array<Relation>) —

    operation results.



47
48
49
50
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entities_relations.rb', line 47

def list(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, filter:nil, orderby:nil, top:nil, skip_token:nil, custom_headers:nil)
  first_page = list_as_lazy(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, filter:filter, orderby:orderby, top:top, skip_token:skip_token, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, filter: nil, orderby: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ RelationList

Gets all relations of an entity.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. Optional. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. 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

  • filter (String) (defaults to: nil) —

    Filters the results, based on a Boolean condition.

  • orderby (String) (defaults to: nil) —

    Sorts the results. Optional.

  • top (Integer) (defaults to: nil) —

    Returns only the first n results. Optional.

  • skip_token (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

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

    A hash of custom headers that

Returns:

  • (RelationList) —

    which provide lazy access to pages of the response.



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entities_relations.rb', line 275

def list_as_lazy(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, filter:nil, orderby:nil, top:nil, skip_token:nil, custom_headers:nil)
  response = list_async(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, filter:filter, orderby:orderby, top:top, skip_token:skip_token, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, filter: nil, orderby: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets all relations of an entity.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. Optional. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. 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

  • filter (String) (defaults to: nil) —

    Filters the results, based on a Boolean condition.

  • orderby (String) (defaults to: nil) —

    Sorts the results. Optional.

  • top (Integer) (defaults to: nil) —

    Returns only the first n results. Optional.

  • skip_token (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entities_relations.rb', line 100

def list_async(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, filter:nil, orderby:nil, top:nil, skip_token:nil, 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?


  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'

  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},
      query_params: {'api-version' => @client.api_version,'$filter' => filter,'$orderby' => orderby,'$top' => top,'$skipToken' => skip_token},
      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::RelationList.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

#list_next(next_page_link, custom_headers: nil) ⇒ RelationList

Gets all relations of an entity.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (RelationList) —

    operation results.



173
174
175
176
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entities_relations.rb', line 173

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Gets all relations of an entity.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entities_relations.rb', line 202

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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::RelationList.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

#list_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all relations of an entity.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



188
189
190
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entities_relations.rb', line 188

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, filter: nil, orderby: nil, top: nil, skip_token: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all relations of an entity.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. Optional. returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. 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

  • filter (String) (defaults to: nil) —

    Filters the results, based on a Boolean condition.

  • orderby (String) (defaults to: nil) —

    Sorts the results. Optional.

  • top (Integer) (defaults to: nil) —

    Returns only the first n results. Optional.

  • skip_token (String) (defaults to: nil) —

    Skiptoken is only used if a previous operation

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



74
75
76
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/entities_relations.rb', line 74

def list_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, filter:nil, orderby:nil, top:nil, skip_token:nil, custom_headers:nil)
  list_async(resource_group_name, operational_insights_resource_provider, workspace_name, entity_id, filter:filter, orderby:orderby, top:top, skip_token:skip_token, custom_headers:custom_headers).value!
end