Class: Azure::ResourcesManagement::Mgmt::V2018_01_01_preview::Entities

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-01-01-preview/generated/azure_mgmt_resources_management/entities.rb

Overview

The Azure Management Groups API enables consolidation of multiple subscriptions/resources into an organizational hierarchy and centrally manage access control, policies, alerting and reporting for those resources.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Entities

Creates and initializes a new instance of the Entities class.

Parameters:

  • client —

    service class for accessing basic functionality.



21
22
23
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/entities.rb', line 21

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ManagementGroupsAPI (readonly)

Returns reference to the ManagementGroupsAPI.

Returns:



26
27
28
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/entities.rb', line 26

def client
  @client
end

Instance Method Details

#list(group_name: nil, cache_control: 'no-cache', custom_headers: nil) ⇒ Array<EntityInfo>

List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.

a specific group. any caches. will be added to the HTTP request.

Parameters:

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

    A filter which allows the call to be filtered for

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (Array<EntityInfo>) —

    operation results.



42
43
44
45
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/entities.rb', line 42

def list(group_name:nil, cache_control:'no-cache', custom_headers:nil)
  first_page = list_as_lazy(group_name:group_name, cache_control:cache_control, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(group_name: nil, cache_control: 'no-cache', custom_headers: nil) ⇒ EntityListResult

List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.

a specific group. any caches. will be added to the HTTP request.

response.

Parameters:

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

    A filter which allows the call to be filtered for

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (EntityListResult) —

    which provide lazy access to pages of the



245
246
247
248
249
250
251
252
253
254
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/entities.rb', line 245

def list_as_lazy(group_name:nil, cache_control:'no-cache', custom_headers:nil)
  response = list_async(group_name:group_name, cache_control:cache_control, 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, cache_control:cache_control, custom_headers:custom_headers)
    end
    page
  end
end

#list_async(group_name: nil, cache_control: 'no-cache', custom_headers: nil) ⇒ Concurrent::Promise

List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.

a specific group. any caches. to the HTTP request.

Parameters:

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

    A filter which allows the call to be filtered for

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

  • 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
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/entities.rb', line 79

def list_async(group_name:nil, cache_control:'no-cache', custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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['Cache-Control'] = cache_control unless cache_control.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'providers/Microsoft.Management/getEntities'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'api-version' => @client.api_version,'$skiptoken' => @client.skiptoken,'groupName' => group_name},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, 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 MsRest::HttpOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ResourcesManagement::Mgmt::V2018_01_01_preview::Models::EntityListResult.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, cache_control: 'no-cache', custom_headers: nil) ⇒ EntityListResult

List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (EntityListResult) —

    operation results.



143
144
145
146
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/entities.rb', line 143

def list_next(next_page_link, cache_control:'no-cache', custom_headers:nil)
  response = list_next_async(next_page_link, cache_control:cache_control, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, cache_control: 'no-cache', custom_headers: nil) ⇒ Concurrent::Promise

List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.

to List operation. any caches. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/entities.rb', line 180

def list_next_async(next_page_link, cache_control:'no-cache', 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['Cache-Control'] = cache_control unless cache_control.nil?
  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(:post, 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 MsRest::HttpOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::ResourcesManagement::Mgmt::V2018_01_01_preview::Models::EntityListResult.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, cache_control: 'no-cache', custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.

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

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



162
163
164
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/entities.rb', line 162

def list_next_with_http_info(next_page_link, cache_control:'no-cache', custom_headers:nil)
  list_next_async(next_page_link, cache_control:cache_control, custom_headers:custom_headers).value!
end

#list_with_http_info(group_name: nil, cache_control: 'no-cache', custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List all entities (Management Groups, Subscriptions, etc.) for the authenticated user.

a specific group. any caches. will be added to the HTTP request.

Parameters:

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

    A filter which allows the call to be filtered for

  • cache_control (String) (defaults to: 'no-cache') —

    Indicates that the request shouldn’t utilize

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



61
62
63
 
# File 'lib/2018-01-01-preview/generated/azure_mgmt_resources_management/entities.rb', line 61

def list_with_http_info(group_name:nil, cache_control:'no-cache', custom_headers:nil)
  list_async(group_name:group_name, cache_control:cache_control, custom_headers:custom_headers).value!
end