Class: Azure::Compute::Mgmt::V2020_09_30_preview::SharedGalleryImageVersions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb

Overview

SharedGalleryImageVersions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ SharedGalleryImageVersions

Creates and initializes a new instance of the SharedGalleryImageVersions class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ComputeManagementClient (readonly)

Returns reference to the ComputeManagementClient.

Returns:



22
23
24
 
# File 'lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb', line 22

def client
  @client
end

Instance Method Details

#get(location, gallery_unique_name, gallery_image_name, gallery_image_version_name, custom_headers: nil) ⇒ SharedGalleryImageVersion

Get a shared gallery image version by subscription id or tenant id.

Definition from which the Image Versions are to be listed. version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> will be added to the HTTP request.

Parameters:

  • location (String) —

    Resource location.

  • gallery_unique_name (String) —

    The unique name of the Shared Gallery.

  • gallery_image_name (String) —

    The name of the Shared Gallery Image

  • gallery_image_version_name (String) —

    The name of the gallery image

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

    A hash of custom headers that

Returns:

  • (SharedGalleryImageVersion) —

    operation results.



150
151
152
153
 
# File 'lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb', line 150

def get(location, gallery_unique_name, gallery_image_name, gallery_image_version_name, custom_headers:nil)
  response = get_async(location, gallery_unique_name, gallery_image_name, gallery_image_version_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(location, gallery_unique_name, gallery_image_name, gallery_image_version_name, custom_headers: nil) ⇒ Concurrent::Promise

Get a shared gallery image version by subscription id or tenant id.

Definition from which the Image Versions are to be listed. version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> to the HTTP request.

Parameters:

  • location (String) —

    Resource location.

  • gallery_unique_name (String) —

    The unique name of the Shared Gallery.

  • gallery_image_name (String) —

    The name of the Shared Gallery Image

  • gallery_image_version_name (String) —

    The name of the gallery image

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb', line 191

def get_async(location, gallery_unique_name, gallery_image_name, gallery_image_version_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'gallery_unique_name is nil' if gallery_unique_name.nil?
  fail ArgumentError, 'gallery_image_name is nil' if gallery_image_name.nil?
  fail ArgumentError, 'gallery_image_version_name is nil' if gallery_image_version_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}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions/{galleryImageVersionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'location' => location,'galleryUniqueName' => gallery_unique_name,'galleryImageName' => gallery_image_name,'galleryImageVersionName' => gallery_image_version_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::Compute::Mgmt::V2020_09_30_preview::Models::SharedGalleryImageVersion.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_with_http_info(location, gallery_unique_name, gallery_image_name, gallery_image_version_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get a shared gallery image version by subscription id or tenant id.

Definition from which the Image Versions are to be listed. version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> will be added to the HTTP request.

Parameters:

  • location (String) —

    Resource location.

  • gallery_unique_name (String) —

    The unique name of the Shared Gallery.

  • gallery_image_name (String) —

    The name of the Shared Gallery Image

  • gallery_image_version_name (String) —

    The name of the gallery image

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



171
172
173
 
# File 'lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb', line 171

def get_with_http_info(location, gallery_unique_name, gallery_image_name, gallery_image_version_name, custom_headers:nil)
  get_async(location, gallery_unique_name, gallery_image_name, gallery_image_version_name, custom_headers:custom_headers).value!
end

#list(location, gallery_unique_name, gallery_image_name, shared_to: nil, custom_headers: nil) ⇒ Array<SharedGalleryImageVersion>

List shared gallery image versions by subscription id or tenant id.

Definition from which the Image Versions are to be listed. galleries to fetch when doing listing operations. Possible values include: 'tenant' will be added to the HTTP request.

Parameters:

  • location (String) —

    Resource location.

  • gallery_unique_name (String) —

    The unique name of the Shared Gallery.

  • gallery_image_name (String) —

    The name of the Shared Gallery Image

  • shared_to (SharedToValues) (defaults to: nil) —

    The query parameter to decide what shared

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

    A hash of custom headers that

Returns:

  • (Array<SharedGalleryImageVersion>) —

    operation results.



39
40
41
42
 
# File 'lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb', line 39

def list(location, gallery_unique_name, gallery_image_name, shared_to:nil, custom_headers:nil)
  first_page = list_as_lazy(location, gallery_unique_name, gallery_image_name, shared_to:shared_to, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(location, gallery_unique_name, gallery_image_name, shared_to: nil, custom_headers: nil) ⇒ SharedGalleryImageVersionList

List shared gallery image versions by subscription id or tenant id.

Definition from which the Image Versions are to be listed. galleries to fetch when doing listing operations. Possible values include: 'tenant' will be added to the HTTP request.

the response.

Parameters:

  • location (String) —

    Resource location.

  • gallery_unique_name (String) —

    The unique name of the Shared Gallery.

  • gallery_image_name (String) —

    The name of the Shared Gallery Image

  • shared_to (SharedToValues) (defaults to: nil) —

    The query parameter to decide what shared

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

    A hash of custom headers that

Returns:

  • (SharedGalleryImageVersionList) —

    which provide lazy access to pages of



354
355
356
357
358
359
360
361
362
363
 
# File 'lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb', line 354

def list_as_lazy(location, gallery_unique_name, gallery_image_name, shared_to:nil, custom_headers:nil)
  response = list_async(location, gallery_unique_name, gallery_image_name, shared_to:shared_to, 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(location, gallery_unique_name, gallery_image_name, shared_to: nil, custom_headers: nil) ⇒ Concurrent::Promise

List shared gallery image versions by subscription id or tenant id.

Definition from which the Image Versions are to be listed. galleries to fetch when doing listing operations. Possible values include: 'tenant' to the HTTP request.

Parameters:

  • location (String) —

    Resource location.

  • gallery_unique_name (String) —

    The unique name of the Shared Gallery.

  • gallery_image_name (String) —

    The name of the Shared Gallery Image

  • shared_to (SharedToValues) (defaults to: nil) —

    The query parameter to decide what shared

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
125
126
127
128
129
130
131
132
 
# File 'lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb', line 78

def list_async(location, gallery_unique_name, gallery_image_name, shared_to:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'location is nil' if location.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'gallery_unique_name is nil' if gallery_unique_name.nil?
  fail ArgumentError, 'gallery_image_name is nil' if gallery_image_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}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'location' => location,'galleryUniqueName' => gallery_unique_name,'galleryImageName' => gallery_image_name},
      query_params: {'api-version' => @client.api_version,'sharedTo' => shared_to},
      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::Compute::Mgmt::V2020_09_30_preview::Models::SharedGalleryImageVersionList.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) ⇒ SharedGalleryImageVersionList

List shared gallery image versions by subscription id or tenant id.

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:

  • (SharedGalleryImageVersionList) —

    operation results.



258
259
260
261
 
# File 'lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb', line 258

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

List shared gallery image versions by subscription id or tenant id.

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.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb', line 287

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::Compute::Mgmt::V2020_09_30_preview::Models::SharedGalleryImageVersionList.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

List shared gallery image versions by subscription id or tenant id.

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.



273
274
275
 
# File 'lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb', line 273

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(location, gallery_unique_name, gallery_image_name, shared_to: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List shared gallery image versions by subscription id or tenant id.

Definition from which the Image Versions are to be listed. galleries to fetch when doing listing operations. Possible values include: 'tenant' will be added to the HTTP request.

Parameters:

  • location (String) —

    Resource location.

  • gallery_unique_name (String) —

    The unique name of the Shared Gallery.

  • gallery_image_name (String) —

    The name of the Shared Gallery Image

  • shared_to (SharedToValues) (defaults to: nil) —

    The query parameter to decide what shared

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



59
60
61
 
# File 'lib/2020-09-30-preview/generated/azure_mgmt_compute/shared_gallery_image_versions.rb', line 59

def list_with_http_info(location, gallery_unique_name, gallery_image_name, shared_to:nil, custom_headers:nil)
  list_async(location, gallery_unique_name, gallery_image_name, shared_to:shared_to, custom_headers:custom_headers).value!
end