Class: Azure::ContainerRegistry::Mgmt::V2018_09_01::Registries

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-09-01/generated/azure_mgmt_container_registry/registries.rb

Overview

Registries

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Registries

Creates and initializes a new instance of the Registries class.

Parameters:

  • client

    service class for accessing basic functionality.



17
18
19
# File 'lib/2018-09-01/generated/azure_mgmt_container_registry/registries.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#clientContainerRegistryManagementClient (readonly)

Returns reference to the ContainerRegistryManagementClient.

Returns:



22
23
24
# File 'lib/2018-09-01/generated/azure_mgmt_container_registry/registries.rb', line 22

def client
  @client
end

Instance Method Details

#begin_schedule_run(resource_group_name, registry_name, run_request, custom_headers: nil) ⇒ Run

Schedules a new run based on the request parameters and add it to the run queue.

the container registry belongs. scheduled. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group to which

  • registry_name (String)

    The name of the container registry.

  • run_request (RunRequest)

    The parameters of a run that needs to

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

    A hash of custom headers that

Returns:

  • (Run)

    operation results.



188
189
190
191
# File 'lib/2018-09-01/generated/azure_mgmt_container_registry/registries.rb', line 188

def begin_schedule_run(resource_group_name, registry_name, run_request, custom_headers:nil)
  response = begin_schedule_run_async(resource_group_name, registry_name, run_request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_schedule_run_async(resource_group_name, registry_name, run_request, custom_headers: nil) ⇒ Concurrent::Promise

Schedules a new run based on the request parameters and add it to the run queue.

the container registry belongs. scheduled. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group to which

  • registry_name (String)

    The name of the container registry.

  • run_request (RunRequest)

    The parameters of a run that needs to

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
# File 'lib/2018-09-01/generated/azure_mgmt_container_registry/registries.rb', line 225

def begin_schedule_run_async(resource_group_name, registry_name, run_request, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'registry_name is nil' if registry_name.nil?
  fail ArgumentError, "'registry_name' should satisfy the constraint - 'MaxLength': '50'" if !registry_name.nil? && registry_name.length > 50
  fail ArgumentError, "'registry_name' should satisfy the constraint - 'MinLength': '5'" if !registry_name.nil? && registry_name.length < 5
  fail ArgumentError, "'registry_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9]*$'" if !registry_name.nil? && registry_name.match(Regexp.new('^^[a-zA-Z0-9]*$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'run_request is nil' if run_request.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?

  # Serialize Request
  request_mapper = Azure::ContainerRegistry::Mgmt::V2018_09_01::Models::RunRequest.mapper()
  request_content = @client.serialize(request_mapper,  run_request)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scheduleRun'

  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,'registryName' => registry_name},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      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 || status_code == 202
      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::ContainerRegistry::Mgmt::V2018_09_01::Models::Run.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

#begin_schedule_run_with_http_info(resource_group_name, registry_name, run_request, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Schedules a new run based on the request parameters and add it to the run queue.

the container registry belongs. scheduled. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group to which

  • registry_name (String)

    The name of the container registry.

  • run_request (RunRequest)

    The parameters of a run that needs to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



207
208
209
# File 'lib/2018-09-01/generated/azure_mgmt_container_registry/registries.rb', line 207

def begin_schedule_run_with_http_info(resource_group_name, registry_name, run_request, custom_headers:nil)
  begin_schedule_run_async(resource_group_name, registry_name, run_request, custom_headers:custom_headers).value!
end

#get_build_source_upload_url(resource_group_name, registry_name, custom_headers: nil) ⇒ SourceUploadDefinition

Get the upload location for the user to be able to upload the source.

the container registry belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group to which

  • registry_name (String)

    The name of the container registry.

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

    A hash of custom headers that

Returns:

  • (SourceUploadDefinition)

    operation results.



84
85
86
87
# File 'lib/2018-09-01/generated/azure_mgmt_container_registry/registries.rb', line 84

def get_build_source_upload_url(resource_group_name, registry_name, custom_headers:nil)
  response = get_build_source_upload_url_async(resource_group_name, registry_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_build_source_upload_url_async(resource_group_name, registry_name, custom_headers: nil) ⇒ Concurrent::Promise

Get the upload location for the user to be able to upload the source.

the container registry belongs. to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group to which

  • registry_name (String)

    The name of the container registry.

  • A (Hash{String => String})

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise)

    Promise object which holds the HTTP response.



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
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/2018-09-01/generated/azure_mgmt_container_registry/registries.rb', line 115

def get_build_source_upload_url_async(resource_group_name, registry_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'registry_name is nil' if registry_name.nil?
  fail ArgumentError, "'registry_name' should satisfy the constraint - 'MaxLength': '50'" if !registry_name.nil? && registry_name.length > 50
  fail ArgumentError, "'registry_name' should satisfy the constraint - 'MinLength': '5'" if !registry_name.nil? && registry_name.length < 5
  fail ArgumentError, "'registry_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z0-9]*$'" if !registry_name.nil? && registry_name.match(Regexp.new('^^[a-zA-Z0-9]*$$')).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['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listBuildSourceUploadUrl'

  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,'registryName' => registry_name},
      query_params: {'api-version' => @client.api_version},
      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 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::ContainerRegistry::Mgmt::V2018_09_01::Models::SourceUploadDefinition.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_build_source_upload_url_with_http_info(resource_group_name, registry_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the upload location for the user to be able to upload the source.

the container registry belongs. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group to which

  • registry_name (String)

    The name of the container registry.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse)

    HTTP response information.



100
101
102
# File 'lib/2018-09-01/generated/azure_mgmt_container_registry/registries.rb', line 100

def get_build_source_upload_url_with_http_info(resource_group_name, registry_name, custom_headers:nil)
  get_build_source_upload_url_async(resource_group_name, registry_name, custom_headers:custom_headers).value!
end

#schedule_run(resource_group_name, registry_name, run_request, custom_headers: nil) ⇒ Run

Schedules a new run based on the request parameters and add it to the run queue.

the container registry belongs. scheduled. will be added to the HTTP request.

Parameters:

  • resource_group_name (String)

    The name of the resource group to which

  • registry_name (String)

    The name of the container registry.

  • run_request (RunRequest)

    The parameters of a run that needs to

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

    A hash of custom headers that

Returns:

  • (Run)

    operation results.



38
39
40
41
# File 'lib/2018-09-01/generated/azure_mgmt_container_registry/registries.rb', line 38

def schedule_run(resource_group_name, registry_name, run_request, custom_headers:nil)
  response = schedule_run_async(resource_group_name, registry_name, run_request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#schedule_run_async(resource_group_name, registry_name, run_request, custom_headers: nil) ⇒ Concurrent::Promise

the container registry belongs. scheduled. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String)

    The name of the resource group to which

  • registry_name (String)

    The name of the container registry.

  • run_request (RunRequest)

    The parameters of a run that needs to

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise)

    promise which provides async access to http



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/2018-09-01/generated/azure_mgmt_container_registry/registries.rb', line 55

def schedule_run_async(resource_group_name, registry_name, run_request, custom_headers:nil)
  # Send request
  promise = begin_schedule_run_async(resource_group_name, registry_name, run_request, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::ContainerRegistry::Mgmt::V2018_09_01::Models::Run.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end