Class: Azure::Security::Mgmt::V2020_08_06_preview::DevicesForSubscription

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-08-06-preview/generated/azure_mgmt_security/devices_for_subscription.rb

Overview

API spec for Microsoft.Security (Azure Security Center) resource provider

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ DevicesForSubscription

Creates and initializes a new instance of the DevicesForSubscription class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/devices_for_subscription.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SecurityCenter (readonly)

Returns reference to the SecurityCenter.

Returns:



22
23
24
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/devices_for_subscription.rb', line 22

def client
  @client
end

Instance Method Details

#list(limit: nil, skip_token: nil, device_management_type: nil, custom_headers: nil) ⇒ Array<Device>

Get list of the devices by their subscription.

specific type, Managed or Unmanaged. Possible values include: ‘Managed’, ‘Unmanaged’ will be added to the HTTP request.

Parameters:

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

    Limit the number of items returned in a single page

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

    Skip token used for pagination

  • device_management_type (ManagementState) (defaults to: nil) —

    Get devices only from

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

    A hash of custom headers that

Returns:

  • (Array<Device>) —

    operation results.



37
38
39
40
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/devices_for_subscription.rb', line 37

def list(limit:nil, skip_token:nil, device_management_type:nil, custom_headers:nil)
  first_page = list_as_lazy(limit:limit, skip_token:skip_token, device_management_type:device_management_type, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(limit: nil, skip_token: nil, device_management_type: nil, custom_headers: nil) ⇒ DeviceList

Get list of the devices by their subscription.

specific type, Managed or Unmanaged. Possible values include: ‘Managed’, ‘Unmanaged’ will be added to the HTTP request.

Parameters:

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

    Limit the number of items returned in a single page

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

    Skip token used for pagination

  • device_management_type (ManagementState) (defaults to: nil) —

    Get devices only from

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

    A hash of custom headers that

Returns:

  • (DeviceList) —

    which provide lazy access to pages of the response.



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/devices_for_subscription.rb', line 229

def list_as_lazy(limit:nil, skip_token:nil, device_management_type:nil, custom_headers:nil)
  response = list_async(limit:limit, skip_token:skip_token, device_management_type:device_management_type, 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(limit: nil, skip_token: nil, device_management_type: nil, custom_headers: nil) ⇒ Concurrent::Promise

Get list of the devices by their subscription.

specific type, Managed or Unmanaged. Possible values include: ‘Managed’, ‘Unmanaged’ to the HTTP request.

Parameters:

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

    Limit the number of items returned in a single page

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

    Skip token used for pagination

  • device_management_type (ManagementState) (defaults to: nil) —

    Get devices only from

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
121
122
123
124
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/devices_for_subscription.rb', line 72

def list_async(limit:nil, skip_token:nil, device_management_type:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  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?


  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}/providers/Microsoft.Security/devices'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version,'$limit' => limit,'$skipToken' => skip_token,'deviceManagementType' => device_management_type},
      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::Security::Mgmt::V2020_08_06_preview::Models::DeviceList.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) ⇒ DeviceList

Get list of the devices by their subscription.

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:

  • (DeviceList) —

    operation results.



136
137
138
139
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/devices_for_subscription.rb', line 136

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

Get list of the devices by their subscription.

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.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/devices_for_subscription.rb', line 165

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::Security::Mgmt::V2020_08_06_preview::Models::DeviceList.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

Get list of the devices by their subscription.

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.



151
152
153
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/devices_for_subscription.rb', line 151

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(limit: nil, skip_token: nil, device_management_type: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get list of the devices by their subscription.

specific type, Managed or Unmanaged. Possible values include: ‘Managed’, ‘Unmanaged’ will be added to the HTTP request.

Parameters:

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

    Limit the number of items returned in a single page

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

    Skip token used for pagination

  • device_management_type (ManagementState) (defaults to: nil) —

    Get devices only from

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



55
56
57
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/devices_for_subscription.rb', line 55

def list_with_http_info(limit:nil, skip_token:nil, device_management_type:nil, custom_headers:nil)
  list_async(limit:limit, skip_token:skip_token, device_management_type:device_management_type, custom_headers:custom_headers).value!
end